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

95
backend/schema/paths/nginx/dead-hosts/post.json Normal file
View File

@ -0,0 +1,95 @@
{
"operationId": "create404Host",
"summary": "Create a 404 Host",
"tags": ["404 Hosts"],
"security": [
{
"BearerAuth": ["dead_hosts"]
}
],
"requestBody": {
"description": "404 Host Payload",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": ["domain_names"],
"properties": {
"domain_names": {
"$ref": "../../../components/dead-host-object.json#/properties/domain_names"
},
"certificate_id": {
"$ref": "../../../components/dead-host-object.json#/properties/certificate_id"
},
"ssl_forced": {
"$ref": "../../../components/dead-host-object.json#/properties/ssl_forced"
},
"hsts_enabled": {
"$ref": "../../../components/dead-host-object.json#/properties/hsts_enabled"
},
"hsts_subdomains": {
"$ref": "../../../components/dead-host-object.json#/properties/hsts_subdomains"
},
"http2_support": {
"$ref": "../../../components/dead-host-object.json#/properties/http2_support"
},
"advanced_config": {
"$ref": "../../../components/dead-host-object.json#/properties/advanced_config"
},
"meta": {
"$ref": "../../../components/dead-host-object.json#/properties/meta"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201 response",
"content": {
"application/json": {
"examples": {
"default": {
"value": {
"id": 1,
"created_on": "2024-10-09T01:38:52.000Z",
"modified_on": "2024-10-09T01:38:52.000Z",
"owner_user_id": 1,
"domain_names": ["test.example.com"],
"certificate_id": 0,
"ssl_forced": 0,
"advanced_config": "",
"meta": {},
"http2_support": 0,
"enabled": 1,
"hsts_enabled": 0,
"hsts_subdomains": 0,
"certificate": null,
"owner": {
"id": 1,
"created_on": "2024-10-09T00:59:56.000Z",
"modified_on": "2024-10-09T00:59:56.000Z",
"is_deleted": 0,
"is_disabled": 0,
"email": "admin@example.com",
"name": "Administrator",
"nickname": "Admin",
"avatar": "",
"roles": ["admin"]
},
"use_default_location": true,
"ipv6": true
}
}
},
"schema": {
"$ref": "../../../components/dead-host-object.json"
}
}
}
}
}
}