endpoint example

GET|POST|PUT|DELETE /endpoint/path

Brief description.

Request

Brief description. Put nothing more than a *No request content*

Headers

Header	Value
header-example	example-value1; example-value2; ...; example-valuen
example-header	write a description

Body

If present put example structure, otherwise *no body*

{
  "teapot": true,
  "status": 418,
  "error": {
    "message": "Ain't gonna brew no coffee",
    "stacktrace": "..."
  }
}

Body Attributes

teapot

Type: boolean
Description:
A brief description of the attribute.
Examples:

• true
• false

status

Type: integer
Description:
A brief description of the attribute.
Examples:

• 200
• 418

error

Type: object
Description:
A brief description of the attribute.
Attributes:

• message:
  • Type: string
  • Description: A brief description of the attribute.
• stacktrace:
  • Type: string
  • Description: A brief description of the attribute.

Response

Brief description.

Headers

Header	Value
content-type	application/json

Body

{
  "teapot": true,
  "status": 418,
  "error": "Ain't gonna brew no coffee"
}

Body Attributes

teapot

Type: boolean
Description:
A brief description of the attribute.
Examples:

• true
• false ...