API reference

Status: pilot. Draft — needs review before publishing.

The reference is generated from the live schema, never hand-written. Field names and types come from one place:

https://api.omnicanon.com/api/schema/ — OpenAPI schema;
https://api.omnicanon.com/api/docs/ — interactive explorer;
https://api.omnicanon.com/api/redoc/ — reference rendering.

Generating the reference

bash

curl -sS https://api.omnicanon.com/api/schema/ -o openapi.json

Render it with Scalar or Redocly. Wire it into the build so the published reference cannot drift from the running backend.

What is documented by hand

Only the parts the schema does not spell out:

Authentication — how a token is obtained and where it must live;
Errors — the error envelope and what each status means.

Everything else — paths, fields, types — read from the schema above.