Skip to content
Workloom
Menu

Registry API

Health and spec

Liveness, a readiness check against the database, and the live OpenAPI document.

/v1/health reports in-process state; /health/deep makes a real database round trip, so it fails when the database is unreachable. /v1/openapi.json serves the document generated by the running server.

Operations

Health and spec operations
RequestWhat it does
GET /v1/healthHealth checkin spec
GET /health/deepReadiness check with a database round trip
GET /v1/openapi.jsonServe the OpenAPI document

Operations are the routes the server registers; this site checks its list against the route definitions. Operations marked “in spec” are also described in the committed OpenAPI file (apps/api/openapi.json), which does not yet cover every route. Only the public catalog and the health check work without a token.