Created
November 13, 2017 12:55
-
-
Save skalee/b9d0d9e70e73f15cf7fed815da8e5cb5 to your computer and use it in GitHub Desktop.
How fixture resolving in Ribose API docs could look like
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ## Group Space | |
| ### Spaces [/spaces] | |
| #### Index [GET] | |
| + Request (application/json) | |
| + Response 200 (application/json) | |
| + Attributes (object) | |
| + spaces (array[Space]) - list of spaces | |
| + Body | |
| :[](fixture:spaces.json) | |
| #### Create [POST] | |
| + Request (application/json) | |
| + Attributes (object) | |
| + space (Space) - new space attributes | |
| + Response 200 (application/json) | |
| + Attributes (object) | |
| + space (Space) - created space | |
| + Body | |
| :[](fixture:space.json) | |
| #### Show [GET /spaces/{space_id}] | |
| + Parameters | |
| + `space_id` (id) | |
| + Request (application/json) | |
| + Response 200 (application/json) | |
| + Attributes (object) | |
| + space (Space) - retrieved space | |
| + Body | |
| :[](fixture:space.json) | |
| #### Update [PUT /spaces/{space_id}] | |
| + Parameters | |
| + `space_id` (id) | |
| + Request (application/json) | |
| + Attributes (object) | |
| + space (Space) - space update | |
| + Response 200 (application/json) | |
| + Attributes (object) | |
| + space (Space) - updated space | |
| + Body | |
| :[](fixture:space.json) | |
| #### Delete [DELETE /spaces/{space_id}] | |
| + Parameters | |
| + `space_id` (id) | |
| + Request (application/json) | |
| + Response 200 (application/json) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Looks good! 👍