[add]: health endpoint

This commit was merged in pull request #22.
This commit is contained in:
VivianDee
2025-10-15 11:21:53 +01:00
parent 4a697f14c8
commit f4bc554396
2 changed files with 82 additions and 1 deletions
+37
View File
@@ -103,6 +103,10 @@
"description": "Find out more",
"url": "https://www.simbrellang.net"
}
},
{
"name": "Health",
"description": "System health check including DB status."
}
],
"paths": {
@@ -138,6 +142,39 @@
},
"/transaction-offers": {
"$ref": "../swagger/paths/TransactionOffers.json"
},
"/health": {
"get": {
"tags": ["Health"],
"summary": "Health Check",
"description": "Returns service health information including DB connection status.",
"responses": {
"200": {
"description": "Health check successful",
"content": {
"application/json": {
"example": {
"status": "ok",
"db_status": "Connection Successful",
"error": []
}
}
}
},
"500": {
"description": "Health check failed",
"content": {
"application/json": {
"example": {
"status": "ok",
"db_status": "Connection Failed",
"error":["could not connect to server: Connection refused"]
}
}
}
}
}
}
}
},
"components": {