This contract, served by the running instance (password-protected)
The embedded copy of this OpenAPI document — backs the reference UI above and is handy for local codegen against a running instance. Same Basic Auth gate as /docs.
View as MarkdownAuthorization
docsBasic Gates /docs and /docs/openapi.yaml only. Credentials come from the DOCS_USER/DOCS_PASSWORD env vars; if either is unset the routes are not registered at all (404), never served open.
In: header
Response Body
text/plain
curl -X GET "https://example.com/docs/openapi.yaml""string"API reference UI (password-protected)
Scalar API reference for the running instance, gated by HTTP Basic Auth (DOCS_USER/DOCS_PASSWORD) — not linked from any product surface. The route is only registered at all when both env vars are set; an unconfigured deployment 404s here instead of serving it open. Served at the root, never under BASE_PATH, so the URL is the same however the service is routed.
Local-disk storage dev fallback (never present in production)
Only registered when the service falls back to local-disk file storage because no R2 credentials are configured AND the service is not running in production (see internal/storage/local.go) — the route does not exist at all otherwise. Serves the file an HMAC-signed "key"/"exp"/"sig" query string authorizes, standing in for a real R2 presigned URL. Unauthenticated by design: the signature is the credential, scoped to a single key and short TTL, and this whole code path never runs in production.