seahaven-ap/packages/api/openapi/paths/ready.yaml
Adam Moussa cc637e3732
feat(api): serve portal-shaped health and error envelope
Move liveness to GET /api/health { stage, sha } with a Node 24 image on 8080 so ALB probes and deploy verify do not need auth or a database ping.
2026-09-22 12:33:19 -04:00

39 lines
1.1 KiB
YAML

get:
tags:
- Health
summary: Check API database readiness
description: Pings the configured database. Not the ALB target. Optional for operators and deploy verify.
operationId: get-api-ready
security: []
responses:
"200":
description: Database answered.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/ReadyResponse
example:
status: ok
database: up
"400":
description: Bad request.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error
example:
error:
code: VALIDATION_ERROR
message: Bad request.
correlationId: 11111111-1111-4111-8111-111111111111
"503":
description: Database ping failed.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error
example:
error:
code: DATABASE_UNAVAILABLE
message: Database is unavailable.
correlationId: 11111111-1111-4111-8111-111111111111