Skip to content

Health API

Implemented

GET /health/live

Process liveness only. Returns HTTP 200 even if MongoDB is down.

GET /health/ready

Performs a MongoDB ping with a dedicated timeout. Returns 200 when healthy, 503 when unavailable.

GET /health/details

Disabled by default. Enable with HEALTH_DETAILS_ENABLED=true. Returns uptime, version metadata, environment, and MongoDB status/latency without secrets.

GET /

Returns service name, version, and environment.

Interactive documentation

GET /docs/ (also GET /docs → /docs/)

Embedded Swagger UI (offline; no CDN). Loads the live OpenAPI document from /openapi.yaml.

GET /openapi.yaml

Serves the embedded OpenAPI 3 document (api/openapi.yaml at build time). Available even when AUTH_ENABLED=true. Protected operations still require Bearer auth per the OpenAPI security schemes when authentication is enabled.