Quick reference

URI Pattern

 

HTTP VerbDefault PermissionActionArguments

/foo/bar/baz

 

One of: GET, POST, PUT, DELETE

Allow / Deny

Description plus link to section with full reference.

NOTE: Rand will add links to sections.

List arguments in POST body, query params, or path.

Operation name

Brief description goes here.

 

POST /modelName

 

Arguments

  • List of all arguments in POST data or query string

Example

Request: 

curl -X POST -H "Content-Type:application/json"
-d '{... JSON ... }'
http://localhost:3000/foo

Response:

// Response JSON

 

Errors

List error codes and return JSON format if applicable.