cybertk / cybertk/abao

Support for 1.0 RAML

Open
#57 83 comments 37 reactions 0 assignees View on GitHub
feature request
Dominant language
CoffeeScript
Stars
352
Forks
57
PR merge metrics
No merged PRs in 30d

Description

Please add support for 1.0 version of raml.

Atleast support for multiple examples at once.

```
example: A string with a single example for the body.
examples: A mapping of examples, where the key is the name of the example

examples:
adminUser:
description: An `admin` user has the `admin` property set to `true` and has the `allowed-operations` collection populated with the all the actions it can perform
example: |
{ an example of the JSON here }
normalUser:
description: A `normal` user does not have the `admin` property turned on.
example: |
{ an example of the JSON here }
```

It will help to validate multiple responses without hooks.

Let's say I would like to check url `/client/{id}` for `200` and `404`. I could add two examples. One would provide correct ID for existing (stubbed) user and second would not.
`Abao` would validate, that both responses are correct.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing RAML support and the RAML 1.0 examples described in the issue. Confirm how Abao currently validates a single response, then define the completion criteria around accepting multiple named examples and validating both 200 and 404 responses without hooks.

Written by the indexing model from the issue text.

Assessment

Domain
api, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.