API Reference

This section is the endpoint contract layer. Use this for exact method and schema details.

Documentation order

  1. Feature and implementation docs (what to do and why).
  2. OpenAPI contract (what the request/response must be).
  3. Endpoint index (quick lookup).

Contract source

  • File: openapi/api-v1.json
  • Base route: /api/v1

Release process

When behavior changes:

  • update source contract in the app,
  • sync openapi/api-v1.json in this repo,
  • update this documentation and changelog in the same release.

results matching ""

    No results matching ""