Skip to content

Commit 5d66b2e

Browse files
Merge pull request #1045 from Immaculate0606/feature/issue-743-health-probe
docs: Add /api/health/health dependency probe
2 parents 38696eb + 36555cb commit 5d66b2e

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

docs/openapi.json

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,37 @@
194194
}
195195
}
196196
},
197+
"/api/health/health": {
198+
"get": {
199+
"summary": "Health Dependency Probe",
200+
"description": "A dependency-level health probe that enumerates configured external dependencies (database, Soroban RPC, Horizon) with individual status, response time, and sanitized error information.",
201+
"tags": [
202+
"Health"
203+
],
204+
"responses": {
205+
"200": {
206+
"description": "Dependencies are healthy or partially degraded",
207+
"content": {
208+
"application/json": {
209+
"schema": {
210+
"$ref": "#/components/schemas/HealthResponse"
211+
}
212+
}
213+
}
214+
},
215+
"503": {
216+
"description": "Dependencies are down or probe failed",
217+
"content": {
218+
"application/json": {
219+
"schema": {
220+
"$ref": "#/components/schemas/ErrorResponse"
221+
}
222+
}
223+
}
224+
}
225+
}
226+
}
227+
},
197228
"/api/rate-limit/health": {
198229
"get": {
199230
"summary": "Check rate-limit subsystem health",
@@ -6254,4 +6285,3 @@
62546285
}
62556286
}
62566287
}
6257-
}

0 commit comments

Comments
 (0)