Contributing to API spec docs

The API docs follow the OpenAPI 3 specification.

Where the docs are located

We auto-generate the documentation from api_v0.yml within the /docs directory. We use ReDoc to turn the OpenAPI 3 format into a readable and searchable HTML documentation.

Updating API docs

Whenever you make changes to the API docs, make sure to bump the version in api_v0.yml.

Running and editing the docs locally

If you want to browse the documentation locally you can use:

yarn api-docs:serve

This will let you browse the auto-generated version of the doc locally, and it will reload the doc after every modification of the spec file.

If you have Visual Studio Code, we suggest you install the following extensions that enable validation and navigation within the spec file: