API reference

The full OrderUp REST API reference is rendered from the Fastify OpenAPI specification at /api-reference/.

That page is generated by the redocusaurus plugin against static/openapi.json, which itself is regenerated on every push to main that touches apps/api/** or packages/schemas/**. The dump script is apps/api/scripts/dump-openapi.ts; the GitHub Action that wires it up is .github/workflows/docs-openapi-sync.yml.

If you spot a route whose schema is incomplete (e.g. a response listed as additionalProperties: true), open an issue against the apps/api/components/routes/ file in question — the OpenAPI dump only documents what the Fastify schemas declare.