Skip to content

Instantly share code, notes, and snippets.

@adilwali
Created May 5, 2014 22:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save adilwali/45a77c65a912037dfb28 to your computer and use it in GitHub Desktop.
Save adilwali/45a77c65a912037dfb28 to your computer and use it in GitHub Desktop.
resourceTypes:
- collection:
usage: This resourceType should be used for any collection of items.
description: The collection of <<resourcePathName>>
get:
description: Get all <<resourcePathName>>
responses:
200:
body:
schema: <<resourcePathName>>
post:
description: Create new <<resourcePathName | !singularize>>
body:
schema: <<resourcePathName | !singularize>>
responses:
200:
body:
schema: <<resourcePathName | !singularize>>
- member:
usage: This resourceType should be used for any member.
description: The resource <<resourcePathName>>
get:
description: Get a single <<resourcePathName | !singularize>>
responses:
200:
body:
schema: <<resourcePathName | !singularize>>
put:
description: Update a single <<resourcePathName | !singularize>>
responses:
200:
body:
schema: <<resourcePathName | !singularize>>
delete:
description: This method will *delete* an individual **<<resourcePathName | !singularize>>**
responses:
204:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment