nginx-proxy-manager-zh/backend/schema/paths/settings/settingID/get.json
Jamie Curnow dfe2588523
Refactor API Schema and validation
- /schema now returns full openapi/swagger schema
- That schema is used to validate incoming requests
- And used as a contract in future integration tests
- Moved route files up one level
- Fixed incorrect 404 reponses when getting objects
- Fixed saving new objects and passing jsonschemavalidation
2024-10-09 18:05:15 +10:00

47 lines
834 B
JSON

{
"operationId": "getSetting",
"summary": "Get a setting",
"tags": ["Settings"],
"security": [
{
"BearerAuth": ["settings"]
}
],
"parameters": [
{
"in": "path",
"name": "settingID",
"schema": {
"type": "string",
"minLength": 1
},
"required": true,
"description": "Setting ID",
"example": "default-site"
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"id": "default-site",
"name": "Default Site",
"description": "What to show when Nginx is hit with an unknown Host",
"value": "congratulations",
"meta": {}
}
}
},
"schema": {
"$ref": "../../../components/setting-object.json"
}
}
}
}
}
}