← 9. The API · Contents

OpenAPI reference

This is the same document the backend serves live at /docs, exported to a file and embedded here so it travels with the documentation rather than needing a running backend to read.

It is generated, not written by hand: backend/src/openapi.ts is the one definition, shared by the live endpoint and this page, so the two can never describe two different APIs. Regenerate it with:

cd backend && pnpm install && pnpm run export:openapi

make docs runs that step before building the site, and CI does the same before every deploy.

Rendered by fetching assets/openapi.json, so it needs the page served over HTTP: mkdocs serve, or the deployed site. Opening the HTML file directly from disk will not fetch it.

For the rules a generated reference cannot state, the guarantees behind authentication, confinement and pagination, see 9. The API.

Note: The full OpenAPI documentation is now hosted on its own dedicated page. Access the OpenAPI Reference →