115 lines
3.1 KiB
JSON
115 lines
3.1 KiB
JSON
{
|
|
"openapi": "3.0.3",
|
|
"info": {
|
|
"title": "No-as-a-Service API",
|
|
"description": "A lightweight API that returns random rejection or \"no\" reasons. Perfect for any scenario: personal, professional, student life, dev life, or just because.",
|
|
"version": "1.0.0",
|
|
"contact": {
|
|
"name": "herel",
|
|
"url": "https://gitea.parano.ch/herel/no-as-a-service"
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://no.parano.ch",
|
|
"description": "Production server"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/": {
|
|
"get": {
|
|
"summary": "Get a random rejection reason",
|
|
"description": "Returns a randomly selected excuse or rejection reason from a collection of 1000+ universal \"no\" responses.",
|
|
"operationId": "getRandomReason",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response with a random rejection reason",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ReasonResponse"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "Rate limit exceeded",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/health": {
|
|
"get": {
|
|
"summary": "Health check endpoint",
|
|
"description": "Returns the health status of the service for Kubernetes readiness probes.",
|
|
"operationId": "getHealth",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Service is healthy",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/HealthResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"ReasonResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "A randomly selected rejection reason",
|
|
"example": "This feels like something Future Me would yell at Present Me for agreeing to."
|
|
}
|
|
},
|
|
"required": ["reason"]
|
|
},
|
|
"HealthResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Health status of the service",
|
|
"example": "ok"
|
|
}
|
|
},
|
|
"required": ["status"]
|
|
},
|
|
"ErrorResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"error": {
|
|
"type": "string",
|
|
"description": "Error message",
|
|
"example": "Too many requests, please try again later. (120 reqs/min/IP)"
|
|
}
|
|
},
|
|
"required": ["error"]
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Reasons",
|
|
"description": "Endpoints for getting random rejection reasons"
|
|
},
|
|
{
|
|
"name": "Health",
|
|
"description": "Health check endpoints"
|
|
}
|
|
]
|
|
} |