mirror of
https://github.com/NginxProxyManager/nginx-proxy-manager.git
synced 2025-06-18 10:06:26 +00:00
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
This commit is contained in:
53
backend/schema/components/setting-object.json
Normal file
53
backend/schema/components/setting-object.json
Normal file
@ -0,0 +1,53 @@
|
||||
{
|
||||
"type": "object",
|
||||
"description": "Setting object",
|
||||
"required": ["id", "name", "description", "value", "meta"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Setting ID",
|
||||
"minLength": 1,
|
||||
"example": "default-site"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Setting Display Name",
|
||||
"minLength": 1,
|
||||
"example": "Default Site"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "Meaningful description",
|
||||
"minLength": 1,
|
||||
"example": "What to show when Nginx is hit with an unknown Host"
|
||||
},
|
||||
"value": {
|
||||
"description": "Value in almost any form",
|
||||
"example": "congratulations",
|
||||
"oneOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
{
|
||||
"type": "integer"
|
||||
},
|
||||
{
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"type": "number"
|
||||
},
|
||||
{
|
||||
"type": "array"
|
||||
}
|
||||
]
|
||||
},
|
||||
"meta": {
|
||||
"description": "Extra metadata",
|
||||
"example": {},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user