48 lines
1.5 KiB
JSON
48 lines
1.5 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "BluWave Uptime",
|
|
"summary": "BlueWave Uptime OpenAPI Specifications",
|
|
"description": "BlueWave Uptime is an open source server monitoring application used to track the operational status and performance of servers and websites. It regularly checks whether a server/website is accessible and performs optimally, providing real-time alerts and reports on the monitored services' availability, downtime, and response time.",
|
|
"contact": {
|
|
"name": "API Support",
|
|
"url": "mailto:support@bluewavelabs.ca",
|
|
"email": "support@bluewavelabs.ca"
|
|
},
|
|
"license": {
|
|
"name": "AGPLv3",
|
|
"url": "https://github.com/bluewave-labs/bluewave-uptime/tree/HEAD/LICENSE"
|
|
},
|
|
"version": "1.0"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://bluewavelabs.ca/{API_PATH}",
|
|
"description": "Remote Development Server",
|
|
"variables": {
|
|
"API_PATH": {
|
|
"description": "API Base Path",
|
|
"enum": ["api/v1", "api/v1.1", "api/v2"],
|
|
"default": "api/v1"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"url": "http://localhost:{PORT}/{API_PATH}",
|
|
"description": "Local Development Server",
|
|
"variables": {
|
|
"PORT": {
|
|
"description": "API Port",
|
|
"enum": ["5000", "3000", "8080"],
|
|
"default": "5000"
|
|
},
|
|
"API_PATH": {
|
|
"description": "API Base Path",
|
|
"enum": ["api/v1", "api/v1.1", "api/v2"],
|
|
"default": "api/v1"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|