HTTP API reference
The project offers two interactive viewers of the same checked-in OpenAPI specification:
- Open Scalar for the API reference and request examples.
- Open Swagger UI for operations, request schemas, and responses.
- Download OpenAPI YAML for client generation and other tools.
For a compact list of every registered route and its implementation status, see API route status.
These links work on the complete Caddy site (make serve-docs). The VitePress-only development/preview server serves project docs; it does not supply the viewers or specification endpoint.
Contract generation
Run go run ./tools/cli generate openapi from the repository root after changing Huma operations. Review the tracked api/openapi.yaml and rebuild the docs image. The offline generator registers modules without connecting to a database or broker. The site build uses the checked-in specification and does not silently regenerate it.
Success examples on documentation-first operations describe intended payloads. Those operations currently return 501 for valid requests; bearer requirements listed on their contracts are not evidence of working permission enforcement. See implementation status and the owning service's guide.
Management API contracts lists the doctor profile, affiliation, team, account administration and credential-review additions, with validation and actor boundaries.
The configured OpenAPI servers point to deployed API domains. Choose the intended server in the viewer; serving the documentation locally does not automatically select a local API. Legacy Chi handlers do not automatically appear in the Huma specification.
The implemented success response audit lists every implemented route, its data schema, pagination fields, and changes to the shared response envelope.