Files
runtipi/apps/scalar/apidocs/health.json
alexz 3aadd164f0
Some checks failed
Test / test (push) Has been cancelled
.
2026-01-09 10:42:41 +00:00

77 lines
1.8 KiB
JSON

{
"openapi": "3.0.0",
"info": {
"title": "REST4i - Health Services",
"description": "Health check endpoints for service monitoring and liveness probes.",
"version": "1.0.7-rest4i",
"contact": {
"name": "API Support",
"url": "https://github.com/rest4i"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"servers": [
{
"url": "/rest4i/api"
}
],
"tags": [
{
"name": "Health",
"description": "Health check endpoints for service monitoring and liveness probes."
}
],
"paths": {
"/v1/health/ping": {
"get": {
"tags": ["Health"],
"summary": "Ping",
"description": "Lightweight liveness check.",
"operationId": "get_api_v1_health_ping",
"responses": {
"200": {
"description": "Service is alive",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": ["ok"]
},
"examples": {
"ok": {
"value": {
"ok": true
}
}
}
}
}
}
},
"security": [
{
"basicAuth": []
}
]
}
}
},
"components": {
"schemas": {},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
}
}
}
}