Skip to content

Commit

Permalink
[update] updated documentation for all amenity methods
Browse files Browse the repository at this point in the history
  • Loading branch information
Nukemenonai committed Apr 30, 2020
1 parent 3c43514 commit 83a9633
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 19 deletions.
8 changes: 4 additions & 4 deletions api/v1/views/documentation/amenity/get_amenity.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
gets all amenities of a place
gets amenity by ID
---
tags:
- Amenities
parameters:
- name: place_id
- name: amenity_id
in: path
type: string
required: true
description: The id of the place to look at
description: The id of the amenity
responses:
404:
description: place id is not linked to any place.
description: amenity not found.
200:
description: request executed successfully
23 changes: 11 additions & 12 deletions api/v1/views/documentation/amenity/post_amenity.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,17 @@
tags:
- Amenities
parameters:
- name: place_id
in: path
type: string
required: false
description: The id of the place
- name: amenity_id
in: path
type: string
required: false
description: The id of the amenity
in: body
required: true
requires:
- name
properties:
name:
type: string

responses:
404:
description: amenity or place not found!
200:
400:
description: Not a JSON
201:
description: request executed successfully
10 changes: 7 additions & 3 deletions api/v1/views/documentation/amenity/put_amenity.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
This is the language awesomeness API
Call this api passing a language name and get back its features
Updates an amenity
---
tags:
- Amenities
parameters:
- name: amenity_id
in: path
type: string
required: false
required: true
description: The id of the amenity
- name: update_request
in: body
required: true
responses:
404:
description: resource not found!
400:
description: Not a JSON
200:
description: request executed successfully

0 comments on commit 83a9633

Please sign in to comment.