ThatGuyJack/nginx-proxy-manager
1
0
Fork 0
mirror of https://github.com/NginxProxyManager/nginx-proxy-manager.git synced 2025-06-18 10:06:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Refactor API Schema and validation

Browse Source 
- /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:
Jamie Curnow
2024-10-09 18:05:15 +10:00
parent 63d06da8a8
commit dfe2588523
123 changed files with 5363 additions and 2574 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
backend/schema/paths/settings/get.json Normal file
View File

@ -0,0 +1,35 @@
{
"operationId": "getSettings",
"summary": "Get all settings",
"tags": ["Settings"],
"security": [
{
"BearerAuth": ["settings"]
}
],
"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-list.json"
}
}
}
}
}
}

46
backend/schema/paths/settings/settingID/get.json Normal file
View File

@ -0,0 +1,46 @@
{
"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"
}
}
}
}
}
}

67
backend/schema/paths/settings/settingID/put.json Normal file
View File

@ -0,0 +1,67 @@
{
"operationId": "updateSetting",
"summary": "Update 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"
}
],
"requestBody": {
"description": "Setting Payload",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"value": {
"$ref": "../../../components/setting-object.json#/properties/value"
},
"meta": {
"$ref": "../../../components/setting-object.json#/properties/meta"
}
}
}
}
}
},
"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"
}
}
}
}
}
}