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

Moved v3 code from NginxProxyManager/nginx-proxy-manager-3 to NginxProxyManager/nginx-proxy-manager

Browse Source
This commit is contained in:
Jamie Curnow
2022-05-12 08:47:31 +10:00
parent 4db34f5894
commit 2110ecc382
830 changed files with 38168 additions and 36635 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
backend/embed/api_docs/paths/host-templates/get.json Normal file
View File

@ -0,0 +1,79 @@
{
"operationId": "getHostTemplates",
"summary": "Get a list of Host Templates",
"tags": ["Hosts"],
"parameters": [
{
"in": "query",
"name": "offset",
"schema": {
"type": "number"
},
"description": "The pagination row offset, default 0",
"example": 0
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "number"
},
"description": "The pagination row limit, default 10",
"example": 10
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "string"
},
"description": "The sorting of the list",
"example": "id,name.asc,value.desc"
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"required": ["result"],
"properties": {
"result": {
"$ref": "#/components/schemas/HostTemplateList"
}
}
},
"examples": {
"default": {
"value": {
"result": {
"total": 1,
"offset": 0,
"limit": 10,
"sort": [
{
"field": "created_on",
"direction": "ASC"
}
],
"items": [
{
"id": 1,
"created_on": 1646218093,
"modified_on": 1646218093,
"user_id": 1,
"name": "Default Proxy Template",
"host_type": "proxy",
"template": "# this is a proxy template"
}
]
}
}
}
}
}
}
}
}
}

58
backend/embed/api_docs/paths/host-templates/hostTemplateID/delete.json Normal file
View File

@ -0,0 +1,58 @@
{
"operationId": "deleteHostTemplate",
"summary": "Delete a Host Template",
"tags": ["Host Templates"],
"parameters": [
{
"in": "path",
"name": "hostTemplateID",
"schema": {
"type": "integer",
"minimum": 1
},
"required": true,
"description": "Numeric ID of the Host Template",
"example": 1
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedItemResponse"
},
"examples": {
"default": {
"value": {
"result": true
}
}
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedItemResponse"
},
"examples": {
"default": {
"value": {
"result": null,
"error": {
"code": 400,
"message": "You cannot delete a host template that is in use!"
}
}
}
}
}
}
}
}
}

50
backend/embed/api_docs/paths/host-templates/hostTemplateID/get.json Normal file
View File

@ -0,0 +1,50 @@
{
"operationId": "getHostTemplate",
"summary": "Get a Host Template object by ID",
"tags": ["Hosts"],
"parameters": [
{
"in": "path",
"name": "hostTemplateID",
"schema": {
"type": "integer",
"minimum": 1
},
"required": true,
"description": "ID of the Host Template",
"example": 1
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"required": ["result"],
"properties": {
"result": {
"$ref": "#/components/schemas/HostTemplateObject"
}
}
},
"examples": {
"default": {
"value": {
"result": {
"id": 1,
"created_on": 1646218093,
"modified_on": 1646218093,
"user_id": 1,
"name": "Default Host Template",
"host_type": "proxy",
"template": "# this is a proxy template"
}
}
}
}
}
}
}
}
}

59
backend/embed/api_docs/paths/host-templates/hostTemplateID/put.json Normal file
View File

@ -0,0 +1,59 @@
{
"operationId": "updateHostTemplate",
"summary": "Update an existing Host Template",
"tags": ["Hosts"],
"parameters": [
{
"in": "path",
"name": "hostTemplateID",
"schema": {
"type": "integer",
"minimum": 1
},
"required": true,
"description": "ID of the Host Template",
"example": 1
}
],
"requestBody": {
"description": "Host Template details to update",
"required": true,
"content": {
"application/json": {
"schema": "{{schema.UpdateHostTemplate}}"
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"required": ["result"],
"properties": {
"result": {
"$ref": "#/components/schemas/HostTemplateObject"
}
}
},
"examples": {
"default": {
"value": {
"result": {
"id": 1,
"created_on": 1646218093,
"modified_on": 1646218093,
"user_id": 1,
"name": "My renamed proxy template",
"host_type": "proxy",
"template": "# this is a proxy template"
}
}
}
}
}
}
}
}
}

46
backend/embed/api_docs/paths/host-templates/post.json Normal file
View File

@ -0,0 +1,46 @@
{
"operationId": "createHost",
"summary": "Create a new Host",
"tags": ["Hosts"],
"requestBody": {
"description": "Host to Create",
"required": true,
"content": {
"application/json": {
"schema": "{{schema.CreateHostTemplate}}"
}
}
},
"responses": {
"201": {
"description": "201 response",
"content": {
"application/json": {
"schema": {
"required": ["result"],
"properties": {
"result": {
"$ref": "#/components/schemas/HostTemplateObject"
}
}
},
"examples": {
"default": {
"value": {
"result": {
"id": 10,
"created_on": 1646218093,
"modified_on": 1646218093,
"user_id": 1,
"name": "My proxy template",
"host_type": "proxy",
"template": "# this is a proxy template"
}
}
}
}
}
}
}
}
}