Document conventions

Endpoints are described with an HTTP method and a path. Example:

GET /raven/v3/codes

Curly braces, in the path indicate a placeholder value that you must replace. Example:

PUT /jacaerys/v1/forwards/{id}

The body of requests and responses for each resource is described in a JSON format table. Each table lists a resource's properties, their data types, whether or not they're read-only, whether or not they're required, and descriptions.