seahaven-ap/packages/api/openapi/paths/health.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

28 lines
803 B
YAML

get:
tags:
- Health
summary: Check API process liveness
description: Returns stage and build SHA. ALB target-group probes call this without auth or a database ping.
operationId: get-api-health
security: []
responses:
"200":
description: API process is up.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/HealthResponse
example:
stage: local
sha: deadbeef
"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