Reading the API Documentation

Wasabi AiR API documentation follows simple formatting practices to make it easy to read.

Code

Code or field names are displayed as gray text. Blocks of code, or example JSON, are presented as:

{
    "key": "value"
}

If there are placeholders inside the JSON, a bulleted list following the code block explains each. For example:

{
    "location_id": "{id}"
}

RESTful API requests are described using the HTTP method and path:

GET /something

If the request has a body, it immediately follows the request line:

POST /something
{
    "body": true
}

Responses are usually just a code block of JSON:

{
    "key1": "value",
    "key2": "value2"
}

Placeholders inside URLs are written using braces, followed by a description of each parameter:

GET /something/{id}/{detail}