mirror of
https://github.com/Sea-Haven-Industries/seahaven-ap.git
synced 2026-09-30 05:43:18 +00:00
29 lines
822 B
YAML
29 lines
822 B
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
|
||
|
|
"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
|