shelly-smoke-alamos/docs/swagger.json
2025-11-10 19:06:04 +01:00

59 lines
No EOL
1.6 KiB
JSON

{
"swagger": "2.0",
"info": {
"description": "{{.Description}}",
"title": "{{.Title}}",
"contact": {},
"license": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/health": {
"get": {
"description": "returns always OK if the application is running",
"tags": [
"health"
],
"summary": "Readiness Probe",
"responses": {
"200": {}
}
}
},
"/api/health/liveness": {
"get": {
"description": "returns OK if all services are connected",
"tags": [
"health"
],
"summary": "Liveness Probe",
"responses": {
"200": {}
}
}
},
"/api/webhook/{secret}": {
"get": {
"description": "Webhook for smoke detector to trigger alarm",
"tags": [
"webhook"
],
"summary": "Webhook",
"parameters": [
{
"type": "string",
"description": "Smoke Detector secret",
"name": "secret",
"in": "path",
"required": true
}
],
"responses": {
"200": {}
}
}
}
}
}