Skip to content

Service contracts

Each service publishes its contract at /openapi.json. The current contracts contain liveness and readiness operations.

Operation Meaning
GET /health/live Returns HTTP 200 when the Worker can serve requests.
GET /health/ready Returns HTTP 503 while product capabilities remain unconfigured.
GET /openapi.json Returns the service’s OpenAPI document.

A successful liveness response confirms transport availability. Use readiness to determine whether a service can accept product work.

Service clients are generated from their owning OpenAPI contracts. Keep the client and service contract compatible when integrating an application.