82 lines
1.9 KiB
JSON
82 lines
1.9 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "yet-another-nginx-proxy-manager",
|
|
"description": "",
|
|
"license": {
|
|
"name": ""
|
|
},
|
|
"version": "0.1.0"
|
|
},
|
|
"paths": {
|
|
"/api/health/info": {
|
|
"get": {
|
|
"tags": [
|
|
"Health"
|
|
],
|
|
"summary": "Health check endpoint",
|
|
"description": "Returns the health status, version, uptime, and any errors if unhealthy.",
|
|
"operationId": "get_health_info",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Health information retrieved successfully",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HealthInfo"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Health information not found"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"HealthInfo": {
|
|
"type": "object",
|
|
"description": "System health information",
|
|
"required": [
|
|
"status",
|
|
"version",
|
|
"up_since"
|
|
],
|
|
"properties": {
|
|
"errors": {
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "List of error messages if unhealthy"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Health status: \"healthy\" or \"unhealthy\""
|
|
},
|
|
"up_since": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "RFC 3339 formatted timestamp"
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"description": "Application version"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Health",
|
|
"description": "Health information API"
|
|
}
|
|
]
|
|
} |