Conventions

Documentation Syntax

One or More Words in Angle Brackets

One or more words appearing within angle brackets represent a type of value that should be replaced with an actual value of the named type. Any unconventional type is documented as a resource. A type is considered unconventional if it is not a standard JSON type such as <string>. View a complete list of resources by clicking "Resources" in the sidebar to the left.

Example

An endpoint listed /category/<id> is not meant to be requested literally at the url /category/<id>. Supposing there were a category with id 1, the endpoint would be accessed as /category/1.