mirror of
				https://github.com/NginxProxyManager/nginx-proxy-manager.git
				synced 2025-11-04 01:15:14 +00:00 
			
		
		
		
	Moved v3 code from NginxProxyManager/nginx-proxy-manager-3 to NginxProxyManager/nginx-proxy-manager
This commit is contained in:
		
							
								
								
									
										55
									
								
								backend/embed/api_docs/paths/settings/name/get.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										55
									
								
								backend/embed/api_docs/paths/settings/name/get.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,55 @@
 | 
			
		||||
{
 | 
			
		||||
	"operationId": "getSetting",
 | 
			
		||||
	"summary": "Get a setting object by name",
 | 
			
		||||
	"tags": [
 | 
			
		||||
		"Settings"
 | 
			
		||||
	],
 | 
			
		||||
	"parameters": [
 | 
			
		||||
		{
 | 
			
		||||
			"in": "path",
 | 
			
		||||
			"name": "name",
 | 
			
		||||
			"schema": {
 | 
			
		||||
				"type": "string",
 | 
			
		||||
				"minLength": 2
 | 
			
		||||
			},
 | 
			
		||||
			"required": true,
 | 
			
		||||
			"description": "Name of the setting",
 | 
			
		||||
			"example": "default-site"
 | 
			
		||||
		}
 | 
			
		||||
	],
 | 
			
		||||
	"responses": {
 | 
			
		||||
		"200": {
 | 
			
		||||
			"description": "200 response",
 | 
			
		||||
			"content": {
 | 
			
		||||
				"application/json": {
 | 
			
		||||
					"schema": {
 | 
			
		||||
						"required": [
 | 
			
		||||
							"result"
 | 
			
		||||
						],
 | 
			
		||||
						"properties": {
 | 
			
		||||
							"result": {
 | 
			
		||||
								"$ref": "#/components/schemas/SettingObject"
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					},
 | 
			
		||||
					"examples": {
 | 
			
		||||
						"default": {
 | 
			
		||||
							"value": {
 | 
			
		||||
								"result": {
 | 
			
		||||
									"id": 2,
 | 
			
		||||
									"created_on": 1578010090,
 | 
			
		||||
									"modified_on": 1578010095,
 | 
			
		||||
									"name": "default-site",
 | 
			
		||||
									"value": {
 | 
			
		||||
										"html": "<p>not found</p>",
 | 
			
		||||
										"type": "custom"
 | 
			
		||||
									}
 | 
			
		||||
								}
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										64
									
								
								backend/embed/api_docs/paths/settings/name/put.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								backend/embed/api_docs/paths/settings/name/put.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,64 @@
 | 
			
		||||
{
 | 
			
		||||
	"operationId": "updateSetting",
 | 
			
		||||
	"summary": "Update an existing Setting",
 | 
			
		||||
	"tags": [
 | 
			
		||||
		"Settings"
 | 
			
		||||
	],
 | 
			
		||||
	"parameters": [
 | 
			
		||||
		{
 | 
			
		||||
			"in": "path",
 | 
			
		||||
			"name": "name",
 | 
			
		||||
			"schema": {
 | 
			
		||||
				"type": "string",
 | 
			
		||||
				"minLength": 2
 | 
			
		||||
			},
 | 
			
		||||
			"required": true,
 | 
			
		||||
			"description": "Name of the setting",
 | 
			
		||||
			"example": "default-site"
 | 
			
		||||
		}
 | 
			
		||||
	],
 | 
			
		||||
	"requestBody": {
 | 
			
		||||
		"description": "Setting details to update",
 | 
			
		||||
		"required": true,
 | 
			
		||||
		"content": {
 | 
			
		||||
			"application/json": {
 | 
			
		||||
				"schema": "{{schema.UpdateSetting}}"
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	},
 | 
			
		||||
	"responses": {
 | 
			
		||||
		"200": {
 | 
			
		||||
			"description": "200 response",
 | 
			
		||||
			"content": {
 | 
			
		||||
				"application/json": {
 | 
			
		||||
					"schema": {
 | 
			
		||||
						"required": [
 | 
			
		||||
							"result"
 | 
			
		||||
						],
 | 
			
		||||
						"properties": {
 | 
			
		||||
							"result": {
 | 
			
		||||
								"$ref": "#/components/schemas/SettingObject"
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					},
 | 
			
		||||
					"examples": {
 | 
			
		||||
						"default": {
 | 
			
		||||
							"value": {
 | 
			
		||||
								"result": {
 | 
			
		||||
									"id": 2,
 | 
			
		||||
									"created_on": 1578010090,
 | 
			
		||||
									"modified_on": 1578010090,
 | 
			
		||||
									"name": "default-site",
 | 
			
		||||
									"value": {
 | 
			
		||||
										"html": "<p>not found</p>",
 | 
			
		||||
										"type": "custom"
 | 
			
		||||
									}
 | 
			
		||||
								}
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user