diff --git a/agent/app/api/v2/disk.go b/agent/app/api/v2/disk.go index e1f26daa0d03..b0a28d09644d 100644 --- a/agent/app/api/v2/disk.go +++ b/agent/app/api/v2/disk.go @@ -10,7 +10,7 @@ import ( // @Summary Get complete disk information // @Description Get information about all disks including partitioned and unpartitioned disks // @Produce json -// @Success 200 {object} dto.CompleteDiskInfo +// @Success 200 {object} response.CompleteDiskInfo // @Security ApiKeyAuth // @Security Timestamp // @Router /disks [get] diff --git a/agent/app/api/v2/group.go b/agent/app/api/v2/group.go index a40f5dec3c56..45c54c850b06 100644 --- a/agent/app/api/v2/group.go +++ b/agent/app/api/v2/group.go @@ -13,7 +13,7 @@ import ( // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /agent/groups [post] +// @Router /groups [post] // @x-panel-log {"bodyKeys":["name","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建组 [name][type]","formatEN":"create group [name][type]"} func (b *BaseApi) CreateGroup(c *gin.Context) { var req dto.GroupCreate @@ -35,7 +35,7 @@ func (b *BaseApi) CreateGroup(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /agent/groups/del [post] +// @Router /groups/del [post] // @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"groups","output_column":"name","output_value":"name"},{"input_column":"id","input_value":"id","isList":false,"db":"groups","output_column":"type","output_value":"type"}],"formatZH":"删除组 [type][name]","formatEN":"delete group [type][name]"} func (b *BaseApi) DeleteGroup(c *gin.Context) { var req dto.OperateByID @@ -57,7 +57,7 @@ func (b *BaseApi) DeleteGroup(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /agent/groups/update [post] +// @Router /groups/update [post] // @x-panel-log {"bodyKeys":["name","type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新组 [name][type]","formatEN":"update group [name][type]"} func (b *BaseApi) UpdateGroup(c *gin.Context) { var req dto.GroupUpdate @@ -79,7 +79,7 @@ func (b *BaseApi) UpdateGroup(c *gin.Context) { // @Success 200 {array} dto.OperateByType // @Security ApiKeyAuth // @Security Timestamp -// @Router /agent/groups/search [post] +// @Router /groups/search [post] func (b *BaseApi) ListGroup(c *gin.Context) { var req dto.OperateByType if err := helper.CheckBindAndValidate(&req, c); err != nil { diff --git a/agent/app/api/v2/runtime.go b/agent/app/api/v2/runtime.go index 406b3a68d700..03c8bef60105 100644 --- a/agent/app/api/v2/runtime.go +++ b/agent/app/api/v2/runtime.go @@ -497,7 +497,7 @@ func (b *BaseApi) OperateSupervisorProcessFile(c *gin.Context) { // @Tags Runtime // @Summary Update PHP container config // @Accept json -// @Param request body request.PHPContainerUpdate true "request" +// @Param request body request.PHPContainerConfig true "request" // @Success 200 // @Security ApiKeyAuth // @Security Timestamp @@ -518,7 +518,7 @@ func (b *BaseApi) UpdatePHPContainer(c *gin.Context) { // @Summary Get PHP container config // @Accept json // @Param id path integer true "request" -// @Success 200 {object} response.PHPContainerConfig +// @Success 200 {object} request.PHPContainerConfig // @Security ApiKeyAuth // @Security Timestamp // @Router /runtimes/php/container/:id [get] @@ -539,7 +539,7 @@ func (b *BaseApi) GetPHPContainerConfig(c *gin.Context) { // @Tags Runtime // @Summary Update runtime remark // @Accept json -// @Param request body request.RuntimeRemarkUpdate true "request" +// @Param request body request.RuntimeRemark true "request" // @Success 200 // @Security ApiKeyAuth // @Security Timestamp diff --git a/core/app/api/v2/script_library.go b/core/app/api/v2/script_library.go index e33f3fbdb0dc..a2bda3697ae2 100644 --- a/core/app/api/v2/script_library.go +++ b/core/app/api/v2/script_library.go @@ -26,7 +26,7 @@ import ( // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /script [post] +// @Router /core/script [post] // @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"添加脚本库脚本 [name]","formatEN":"add script [name]"} func (b *BaseApi) CreateScript(c *gin.Context) { var req dto.ScriptOperate @@ -48,7 +48,7 @@ func (b *BaseApi) CreateScript(c *gin.Context) { // @Success 200 {object} dto.PageResult // @Security ApiKeyAuth // @Security Timestamp -// @Router /script/search [post] +// @Router /core/script/search [post] func (b *BaseApi) SearchScript(c *gin.Context) { var req dto.SearchPageWithGroup if err := helper.CheckBindAndValidate(&req, c); err != nil { @@ -74,7 +74,7 @@ func (b *BaseApi) SearchScript(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /script/del [post] +// @Router /core/script/del [post] // @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"script_librarys","output_column":"name","output_value":"names"}],"formatZH":"删除脚本库脚本 [names]","formatEN":"delete script [names]"} func (b *BaseApi) DeleteScript(c *gin.Context) { var req dto.OperateByIDs @@ -96,7 +96,7 @@ func (b *BaseApi) DeleteScript(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /script/sync [post] +// @Router /core/script/sync [post] // @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"同步脚本库脚本","formatEN":"sync scripts"} func (b *BaseApi) SyncScript(c *gin.Context) { var req dto.OperateByTaskID @@ -117,7 +117,7 @@ func (b *BaseApi) SyncScript(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /script/update [post] +// @Router /core/script/update [post] // @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"cronjobs","output_column":"name","output_value":"name"}],"formatZH":"更新脚本库脚本 [name]","formatEN":"update script [name]"} func (b *BaseApi) UpdateScript(c *gin.Context) { var req dto.ScriptOperate diff --git a/core/app/api/v2/setting.go b/core/app/api/v2/setting.go index 45251affb1c5..448e418c2a63 100644 --- a/core/app/api/v2/setting.go +++ b/core/app/api/v2/setting.go @@ -402,7 +402,7 @@ func (b *BaseApi) ReloadSSL(c *gin.Context) { // @Success 200 {string} key // @Security ApiKeyAuth // @Security Timestamp -// @Router /settings/api/config/generate/key [post] +// @Router /core/settings/api/config/generate/key [post] // @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"生成 API 接口密钥","formatEN":"generate api key"} func (b *BaseApi) GenerateApiKey(c *gin.Context) { panelToken := c.GetHeader("1Panel-Token") @@ -425,7 +425,7 @@ func (b *BaseApi) GenerateApiKey(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /settings/api/config/update [post] +// @Router /core/settings/api/config/update [post] // @x-panel-log {"bodyKeys":["ipWhiteList"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新 API 接口配置 => IP 白名单: [ipWhiteList]","formatEN":"update api config => IP White List: [ipWhiteList]"} func (b *BaseApi) UpdateApiConfig(c *gin.Context) { panelToken := c.GetHeader("1Panel-Token") @@ -452,7 +452,7 @@ func (b *BaseApi) UpdateApiConfig(c *gin.Context) { // @Success 200 // @Security ApiKeyAuth // @Security Timestamp -// @Router /settings/apps/store/update [post] +// @Router /core/settings/apps/store/update [post] func (b *BaseApi) UpdateAppstoreConfig(c *gin.Context) { var req dto.AppstoreUpdate if err := helper.CheckBindAndValidate(&req, c); err != nil { @@ -471,7 +471,7 @@ func (b *BaseApi) UpdateAppstoreConfig(c *gin.Context) { // @Success 200 {object} dto.AppstoreConfig // @Security ApiKeyAuth // @Security Timestamp -// @Router /settings/apps/store/config [get] +// @Router /core/settings/apps/store/config [get] func (b *BaseApi) GetAppstoreConfig(c *gin.Context) { res, err := settingService.GetAppstoreConfig() if err != nil { diff --git a/core/cmd/server/docs/docs.go b/core/cmd/server/docs/docs.go index e8abcfd5ab47..4e12691d21d0 100644 --- a/core/cmd/server/docs/docs.go +++ b/core/cmd/server/docs/docs.go @@ -18,198 +18,6 @@ const docTemplate = `{ "host": "localhost", "basePath": "/api/v2", "paths": { - "/agent/groups": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.GroupCreate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Create group", - "tags": [ - "System Group" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name", - "type" - ], - "formatEN": "create group [name][type]", - "formatZH": "创建组 [name][type]", - "paramKeys": [] - } - } - }, - "/agent/groups/del": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.OperateByID" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Delete group", - "tags": [ - "System Group" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "groups", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - }, - { - "db": "groups", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "type", - "output_value": "type" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "delete group [type][name]", - "formatZH": "删除组 [type][name]", - "paramKeys": [] - } - } - }, - "/agent/groups/search": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.GroupSearch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/dto.OperateByType" - }, - "type": "array" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "List groups", - "tags": [ - "System Group" - ] - } - }, - "/agent/groups/update": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.GroupUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Update group", - "tags": [ - "System Group" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name", - "type" - ], - "formatEN": "update group [name][type]", - "formatZH": "更新组 [name][type]", - "paramKeys": [] - } - } - }, "/ai/domain/bind": { "post": { "consumes": [ @@ -748,7 +556,49 @@ const docTemplate = `{ ] } }, - "/apps/ignored": { + "/apps/ignored/cancel": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.ReqWithID" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Cancel Ignore Upgrade App", + "tags": [ + "App" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "Cancel ignore application upgrade", + "formatZH": "取消忽略应用升级", + "paramKeys": [] + } + } + }, + "/apps/ignored/detail": { "get": { "consumes": [ "application/json" @@ -758,7 +608,7 @@ const docTemplate = `{ "description": "OK", "schema": { "items": { - "$ref": "#/definitions/response.IgnoredApp" + "$ref": "#/definitions/model.AppIgnoreUpgrade" }, "type": "array" } @@ -772,7 +622,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get Ignore App", + "summary": "List Upgrade Ignored App", "tags": [ "App" ] @@ -1035,7 +885,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.AppInstalledIgnoreUpgrade" + "$ref": "#/definitions/request.AppIgnoreUpgradeReq" } } ], @@ -1052,34 +902,38 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "ignore App Update", + "summary": "Ignore Upgrade App", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "installId" - ], - "formatEN": "Application param update [installId]", - "formatZH": "忽略应用 [installId] 版本升级", + "bodyKeys": [], + "formatEN": "Ignore application upgrade", + "formatZH": "忽略应用升级", "paramKeys": [] } } }, - "/apps/installed/list": { + "/apps/installed/info/:appInstallId": { "get": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "App install id", + "in": "path", + "name": "appInstallId", + "required": true, + "type": "integer" + } + ], "responses": { "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/dto.AppInstallInfo" - }, - "type": "array" + "$ref": "#/definitions/dto.AppInstallInfo" } } }, @@ -1091,24 +945,54 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List app installed", + "summary": "Get app install info", "tags": [ "App" ] } }, - "/apps/installed/loadport": { - "post": { + "/apps/installed/list": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.AppInstallInfo" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List app installed", + "tags": [ + "App" + ] + } + }, + "/apps/installed/loadport": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } @@ -1513,46 +1397,8 @@ const docTemplate = `{ ] } }, - "/apps/store/config": { - "get": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.AppstoreConfig" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Get appstore config", - "tags": [ - "App" - ] - } - }, - "/apps/store/update": { + "/apps/sync/local": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.AppstoreUpdate" - } - } - ], "responses": { "200": { "description": "OK" @@ -1566,13 +1412,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update appstore config", + "summary": "Sync local app list", "tags": [ "App" - ] + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "App store synchronization", + "formatZH": "应用商店同步", + "paramKeys": [] + } } }, - "/apps/sync/local": { + "/apps/sync/remote": { "post": { "responses": { "200": { @@ -1587,7 +1440,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Sync local app list", + "summary": "Sync remote app list", "tags": [ "App" ], @@ -1600,8 +1453,22 @@ const docTemplate = `{ } } }, - "/apps/sync/remote": { + "/backup/record/description/update": { "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.UpdateDescription" + } + } + ], "responses": { "200": { "description": "OK" @@ -1615,17 +1482,10 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Sync remote app list", + "summary": "Update backup record description", "tags": [ - "App" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "App store synchronization", - "formatZH": "应用商店同步", - "paramKeys": [] - } + "Backup Account" + ] } }, "/backup/record/download": { @@ -2239,6 +2099,50 @@ const docTemplate = `{ } } }, + "/backups/upload": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.UploadForRecover" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Upload file for recover", + "tags": [ + "Backup Account" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "filePath" + ], + "formatEN": "upload backup file [filePath]", + "formatZH": "上传备份文件 [filePath]", + "paramKeys": [] + } + } + }, "/buckets": { "post": { "consumes": [ @@ -3152,10 +3056,7 @@ const docTemplate = `{ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.ContainerPruneReport" - } + "description": "OK" } }, "security": [ @@ -3239,7 +3140,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchWithPage" + "$ref": "#/definitions/dto.PageImage" } } ], @@ -3474,7 +3375,7 @@ const docTemplate = `{ "description": "OK", "schema": { "items": { - "type": "string" + "$ref": "#/definitions/dto.ContainerOptions" }, "type": "array" } @@ -3494,6 +3395,39 @@ const docTemplate = `{ ] } }, + "/containers/list/byimage": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.ContainerOptions" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List containers by image", + "tags": [ + "Container" + ] + } + }, "/containers/list/stats": { "get": { "responses": { @@ -3783,10 +3717,7 @@ const docTemplate = `{ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.ContainerPruneReport" - } + "description": "OK" } }, "security": [ @@ -3944,7 +3875,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ImageRepoDelete" + "$ref": "#/definitions/dto.OperateByID" } } ], @@ -3973,17 +3904,17 @@ const docTemplate = `{ { "db": "image_repos", "input_column": "id", - "input_value": "ids", - "isList": true, + "input_value": "id", + "isList": false, "output_column": "name", - "output_value": "names" + "output_value": "name" } ], "bodyKeys": [ - "ids" + "id" ], - "formatEN": "delete image repo [names]", - "formatZH": "删除镜像仓库 [names]", + "formatEN": "delete image repo [name]", + "formatZH": "删除镜像仓库 [name]", "paramKeys": [] } } @@ -4215,7 +4146,7 @@ const docTemplate = `{ "in": "path", "name": "id", "required": true, - "type": "integer" + "type": "string" } ], "responses": { @@ -4579,6 +4510,50 @@ const docTemplate = `{ } } }, + "/containers/users": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperationWithName" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load container users", + "tags": [ + "Container" + ] + } + }, "/containers/volume": { "get": { "consumes": [ @@ -4739,51 +4714,6 @@ const docTemplate = `{ ] } }, - "/core/app/launcher/show": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SettingUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Update app Launcher", - "tags": [ - "App Launcher" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "app launcher [key] =\u003e show: [value]", - "formatZH": "首页应用 [key] =\u003e 显示：[value]", - "paramKeys": [] - } - } - }, "/core/auth/captcha": { "get": { "responses": { @@ -6110,7 +6040,7 @@ const docTemplate = `{ ] } }, - "/core/settings/bind/update": { + "/core/script": { "post": { "consumes": [ "application/json" @@ -6122,7 +6052,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.BindInfo" + "$ref": "#/definitions/dto.ScriptOperate" } } ], @@ -6139,23 +6069,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system bind info", + "summary": "Add script", "tags": [ - "System Setting" + "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "ipv6", - "bindAddress" + "name" ], - "formatEN": "update system bind info =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", - "formatZH": "修改系统监听信息 =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", + "formatEN": "add script [name]", + "formatZH": "添加脚本库脚本 [name]", "paramKeys": [] } } }, - "/core/settings/expired/handle": { + "/core/script/del": { "post": { "consumes": [ "application/json" @@ -6167,7 +6096,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PasswordUpdate" + "$ref": "#/definitions/dto.OperateByIDs" } } ], @@ -6184,32 +6113,51 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Reset system password expired", + "summary": "Delete script", "tags": [ - "System Setting" + "ScriptLibrary" ], "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "reset an expired Password", - "formatZH": "重置过期密码", + "BeforeFunctions": [ + { + "db": "script_librarys", + "input_column": "id", + "input_value": "ids", + "isList": true, + "output_column": "name", + "output_value": "names" + } + ], + "bodyKeys": [ + "ids" + ], + "formatEN": "delete script [names]", + "formatZH": "删除脚本库脚本 [names]", "paramKeys": [] } } }, - "/core/settings/interface": { - "get": { + "/core/script/search": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SearchPageWithGroup" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -6221,13 +6169,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load system address", + "summary": "Page script", "tags": [ - "System Setting" + "ScriptLibrary" ] } }, - "/core/settings/menu/update": { + "/core/script/sync": { "post": { "consumes": [ "application/json" @@ -6239,7 +6187,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SettingUpdate" + "$ref": "#/definitions/dto.OperateByTaskID" } } ], @@ -6256,20 +6204,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system setting", + "summary": "Sync script from remote", "tags": [ - "System Setting" + "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], - "formatEN": "Hide advanced feature menu.", - "formatZH": "隐藏高级功能菜单", + "formatEN": "sync scripts", + "formatZH": "同步脚本库脚本", "paramKeys": [] } } }, - "/core/settings/mfa": { + "/core/script/update": { "post": { "consumes": [ "application/json" @@ -6281,16 +6229,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MfaCredential" + "$ref": "#/definitions/dto.ScriptOperate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/mfa.Otp" - } + "description": "OK" } }, "security": [ @@ -6301,31 +6246,41 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load mfa info", + "summary": "Update script", "tags": [ - "System Setting" - ] + "ScriptLibrary" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "update script [name]", + "formatZH": "更新脚本库脚本 [name]", + "paramKeys": [] + } } }, - "/core/settings/mfa/bind": { + "/core/settings/api/config/generate/key": { "post": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.MfaCredential" - } - } - ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "string" + } } }, "security": [ @@ -6336,20 +6291,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Bind mfa", + "summary": "generate api key", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], - "formatEN": "bind mfa", - "formatZH": "mfa 绑定", + "formatEN": "generate api key", + "formatZH": "生成 API 接口密钥", "paramKeys": [] } } }, - "/core/settings/password/update": { + "/core/settings/api/config/update": { "post": { "consumes": [ "application/json" @@ -6361,7 +6316,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PasswordUpdate" + "$ref": "#/definitions/dto.ApiInterfaceConfig" } } ], @@ -6378,20 +6333,46 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system password", + "summary": "Update api config", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "update system password", - "formatZH": "修改系统密码", + "bodyKeys": [ + "ipWhiteList" + ], + "formatEN": "update api config =\u003e IP White List: [ipWhiteList]", + "formatZH": "更新 API 接口配置 =\u003e IP 白名单: [ipWhiteList]", "paramKeys": [] } } }, - "/core/settings/port/update": { + "/core/settings/apps/store/config": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.AppstoreConfig" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get appstore config", + "tags": [ + "App" + ] + } + }, + "/core/settings/apps/store/update": { "post": { "consumes": [ "application/json" @@ -6403,7 +6384,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PortUpdate" + "$ref": "#/definitions/dto.AppstoreUpdate" } } ], @@ -6420,22 +6401,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system port", + "summary": "Update appstore config", "tags": [ - "System Setting" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "serverPort" - ], - "formatEN": "update system port =\u003e [serverPort]", - "formatZH": "修改系统端口 =\u003e [serverPort]", - "paramKeys": [] - } + "App" + ] } }, - "/core/settings/proxy/update": { + "/core/settings/bind/update": { "post": { "consumes": [ "application/json" @@ -6447,7 +6419,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ProxyUpdate" + "$ref": "#/definitions/dto.BindInfo" } } ], @@ -6464,23 +6436,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update proxy setting", + "summary": "Update system bind info", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "proxyUrl", - "proxyPort" + "ipv6", + "bindAddress" ], - "formatEN": "set proxy [proxyPort]:[proxyPort].", - "formatZH": "服务器代理配置 [proxyPort]:[proxyPort]", + "formatEN": "update system bind info =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", + "formatZH": "修改系统监听信息 =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", "paramKeys": [] } } }, - "/core/settings/rollback": { + "/core/settings/expired/handle": { "post": { "consumes": [ "application/json" @@ -6492,7 +6464,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.PasswordUpdate" } } ], @@ -6509,103 +6481,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Upgrade", + "summary": "Reset system password expired", "tags": [ "System Setting" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "upgrade_logs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "old_version", - "output_value": "version" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "rollback system =\u003e [version]", - "formatZH": "回滚系统 =\u003e [version]", + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "reset an expired Password", + "formatZH": "重置过期密码", "paramKeys": [] } } }, - "/core/settings/search": { - "post": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.SettingInfo" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load system setting info", - "tags": [ - "System Setting" - ] - } - }, - "/core/settings/search/available": { + "/core/settings/interface": { "get": { - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load system available status", - "tags": [ - "System Setting" - ] - } - }, - "/core/settings/ssl/download": { - "post": { - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } + "consumes": [ + "application/json" ], - "summary": "Download system cert", - "tags": [ - "System Setting" - ] - } - }, - "/core/settings/ssl/info": { - "get": { "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.SSLInfo" + "items": { + "type": "string" + }, + "type": "array" } } }, @@ -6617,13 +6518,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load system cert info", + "summary": "Load system address", "tags": [ "System Setting" ] } }, - "/core/settings/ssl/update": { + "/core/settings/menu/update": { "post": { "consumes": [ "application/json" @@ -6635,7 +6536,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SSLUpdate" + "$ref": "#/definitions/dto.SettingUpdate" } } ], @@ -6652,28 +6553,40 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system ssl", + "summary": "Update system setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "ssl" - ], - "formatEN": "update system ssl =\u003e [ssl]", - "formatZH": "修改系统 ssl =\u003e [ssl]", + "bodyKeys": [], + "formatEN": "Hide advanced feature menu.", + "formatZH": "隐藏高级功能菜单", "paramKeys": [] } } }, - "/core/settings/terminal/search": { + "/core/settings/mfa": { "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.MfaCredential" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.TerminalInfo" + "$ref": "#/definitions/mfa.Otp" } } }, @@ -6685,13 +6598,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load system terminal setting info", + "summary": "Load mfa info", "tags": [ "System Setting" ] } }, - "/core/settings/terminal/update": { + "/core/settings/mfa/bind": { "post": { "consumes": [ "application/json" @@ -6703,7 +6616,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.TerminalInfo" + "$ref": "#/definitions/dto.MfaCredential" } } ], @@ -6720,20 +6633,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system terminal setting", + "summary": "Bind mfa", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], - "formatEN": "update system terminal setting", - "formatZH": "修改系统终端配置", + "formatEN": "bind mfa", + "formatZH": "mfa 绑定", "paramKeys": [] } } }, - "/core/settings/update": { + "/core/settings/password/update": { "post": { "consumes": [ "application/json" @@ -6745,7 +6658,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SettingUpdate" + "$ref": "#/definitions/dto.PasswordUpdate" } } ], @@ -6762,59 +6675,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update system setting", + "summary": "Update system password", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "update system setting [key] =\u003e [value]", - "formatZH": "修改系统配置 [key] =\u003e [value]", + "bodyKeys": [], + "formatEN": "update system password", + "formatZH": "修改系统密码", "paramKeys": [] } } }, - "/core/settings/upgrade": { - "get": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.Upgrade" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load release notes by version", - "tags": [ - "System Setting" - ] - }, + "/core/settings/port/update": { "post": { "consumes": [ "application/json" @@ -6826,7 +6700,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.Upgrade" + "$ref": "#/definitions/dto.PortUpdate" } } ], @@ -6843,22 +6717,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Upgrade", + "summary": "Update system port", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "version" + "serverPort" ], - "formatEN": "upgrade system =\u003e [version]", - "formatZH": "更新系统 =\u003e [version]", + "formatEN": "update system port =\u003e [serverPort]", + "formatZH": "修改系统端口 =\u003e [serverPort]", "paramKeys": [] } } }, - "/cronjobs": { + "/core/settings/proxy/update": { "post": { "consumes": [ "application/json" @@ -6870,7 +6744,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobCreate" + "$ref": "#/definitions/dto.ProxyUpdate" } } ], @@ -6887,23 +6761,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create cronjob", + "summary": "Update proxy setting", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "type", - "name" + "proxyUrl", + "proxyPort" ], - "formatEN": "create cronjob [type][name]", - "formatZH": "创建计划任务 [type][name]", + "formatEN": "set proxy [proxyPort]:[proxyPort].", + "formatZH": "服务器代理配置 [proxyPort]:[proxyPort]", "paramKeys": [] } } }, - "/cronjobs/del": { + "/core/settings/rollback": { "post": { "consumes": [ "application/json" @@ -6915,7 +6789,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobBatchDelete" + "$ref": "#/definitions/dto.OperateByID" } } ], @@ -6932,46 +6806,56 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete cronjob", + "summary": "Upgrade", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { - "db": "cronjobs", + "db": "upgrade_logs", "input_column": "id", - "input_value": "ids", - "isList": true, - "output_column": "name", - "output_value": "names" + "input_value": "id", + "isList": false, + "output_column": "old_version", + "output_value": "version" } ], "bodyKeys": [ - "ids" + "id" ], - "formatEN": "delete cronjob [names]", - "formatZH": "删除计划任务 [names]", + "formatEN": "rollback system =\u003e [version]", + "formatZH": "回滚系统 =\u003e [version]", "paramKeys": [] } } }, - "/cronjobs/download": { + "/core/settings/search": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/dto.CronjobDownload" + "$ref": "#/definitions/dto.SettingInfo" } } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } ], + "summary": "Load system setting info", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/search/available": { + "get": { "responses": { "200": { "description": "OK" @@ -6985,31 +6869,58 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Download cronjob records", + "summary": "Load system available status", "tags": [ - "Cronjob" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "job_records", - "input_column": "id", - "input_value": "recordID", - "isList": false, - "output_column": "file", - "output_value": "file" - } - ], - "bodyKeys": [ - "recordID" - ], - "formatEN": "download the cronjob record [file]", - "formatZH": "下载计划任务记录 [file]", - "paramKeys": [] - } + "System Setting" + ] } }, - "/cronjobs/handle": { + "/core/settings/ssl/download": { + "post": { + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Download system cert", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/ssl/info": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.SSLInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load system cert info", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/ssl/update": { "post": { "consumes": [ "application/json" @@ -7021,7 +6932,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.SSLUpdate" } } ], @@ -7038,31 +6949,46 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Handle cronjob once", + "summary": "Update system ssl", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "ssl" ], - "formatEN": "manually execute the cronjob [name]", - "formatZH": "手动执行计划任务 [name]", + "formatEN": "update system ssl =\u003e [ssl]", + "formatZH": "修改系统 ssl =\u003e [ssl]", "paramKeys": [] } } }, - "/cronjobs/next": { + "/core/settings/terminal/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.TerminalInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load system terminal setting info", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/terminal/update": { "post": { "consumes": [ "application/json" @@ -7074,7 +7000,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobSpec" + "$ref": "#/definitions/dto.TerminalInfo" } } ], @@ -7091,13 +7017,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load cronjob spec time", + "summary": "Update system terminal setting", "tags": [ - "Cronjob" - ] + "System Setting" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "update system terminal setting", + "formatZH": "修改系统终端配置", + "paramKeys": [] + } } }, - "/cronjobs/records/clean": { + "/core/settings/update": { "post": { "consumes": [ "application/json" @@ -7109,7 +7042,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobClean" + "$ref": "#/definitions/dto.SettingUpdate" } } ], @@ -7126,31 +7059,45 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Clean job records", + "summary": "Update system setting", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "key", + "value" ], - "formatEN": "clean cronjob [name] records", - "formatZH": "清空计划任务记录 [name]", + "formatEN": "update system setting [key] =\u003e [value]", + "formatZH": "修改系统配置 [key] =\u003e [value]", "paramKeys": [] } } }, - "/cronjobs/records/log": { + "/core/settings/upgrade": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.UpgradeInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load upgrade info", + "tags": [ + "System Setting" + ] + }, "post": { "consumes": [ "application/json" @@ -7162,16 +7109,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.Upgrade" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -7182,13 +7126,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load Cronjob record log", + "summary": "Upgrade", "tags": [ - "Cronjob" - ] + "System Setting" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "version" + ], + "formatEN": "upgrade system =\u003e [version]", + "formatZH": "更新系统 =\u003e [version]", + "paramKeys": [] + } } }, - "/cronjobs/search": { + "/core/settings/upgrade/notes": { "post": { "consumes": [ "application/json" @@ -7200,7 +7153,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageCronjob" + "$ref": "#/definitions/dto.Upgrade" } } ], @@ -7208,7 +7161,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "type": "string" } } }, @@ -7220,33 +7173,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page cronjobs", + "summary": "Load release notes by version", "tags": [ - "Cronjob" + "System Setting" ] } }, - "/cronjobs/search/records": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SearchRecord" - } - } - ], + "/core/settings/upgrade/releases": { + "get": { "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "items": { + "$ref": "#/definitions/dto.ReleasesNotes" + }, + "type": "array" } } }, @@ -7258,13 +7200,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page job records", + "summary": "Load upgrade notes", "tags": [ - "Cronjob" + "System Setting" ] } }, - "/cronjobs/status": { + "/cronjobs": { "post": { "consumes": [ "application/json" @@ -7276,7 +7218,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobUpdateStatus" + "$ref": "#/definitions/dto.CronjobOperate" } } ], @@ -7293,32 +7235,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update cronjob status", + "summary": "Create cronjob", "tags": [ "Cronjob" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id", - "status" + "type", + "name" ], - "formatEN": "change the status of cronjob [name] to [status].", - "formatZH": "修改计划任务 [name] 状态为 [status]", + "formatEN": "create cronjob [type][name]", + "formatZH": "创建计划任务 [type][name]", "paramKeys": [] } } }, - "/cronjobs/update": { + "/cronjobs/del": { "post": { "consumes": [ "application/json" @@ -7330,7 +7263,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobUpdate" + "$ref": "#/definitions/dto.CronjobBatchDelete" } } ], @@ -7347,7 +7280,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update cronjob", + "summary": "Delete cronjob", "tags": [ "Cronjob" ], @@ -7356,31 +7289,1410 @@ const docTemplate = `{ { "db": "cronjobs", "input_column": "id", - "input_value": "id", - "isList": false, + "input_value": "ids", + "isList": true, "output_column": "name", - "output_value": "name" + "output_value": "names" } ], "bodyKeys": [ - "id" + "ids" + ], + "formatEN": "delete cronjob [names]", + "formatZH": "删除计划任务 [names]", + "paramKeys": [] + } + } + }, + "/cronjobs/export": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByIDs" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Export cronjob list", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/group/update": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeGroup" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update cronjob group", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "update cronjob group [name]", + "formatZH": "更新计划任务分组 [name]", + "paramKeys": [] + } + } + }, + "/cronjobs/handle": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByID" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Handle cronjob once", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "manually execute the cronjob [name]", + "formatZH": "手动执行计划任务 [name]", + "paramKeys": [] + } + } + }, + "/cronjobs/import": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobImport" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Import cronjob list", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/load/info": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByID" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load cronjob info", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/next": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobSpec" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load cronjob spec time", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/records/clean": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobClean" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Clean job records", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "clean cronjob [name] records", + "formatZH": "清空计划任务记录 [name]", + "paramKeys": [] + } + } + }, + "/cronjobs/records/log": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByID" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load Cronjob record log", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/script/options": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.ScriptOptions" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load script options", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.PageCronjob" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Page cronjobs", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/search/records": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SearchRecord" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Page job records", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/status": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobUpdateStatus" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update cronjob status", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id", + "status" + ], + "formatEN": "change the status of cronjob [name] to [status].", + "formatZH": "修改计划任务 [name] 状态为 [status]", + "paramKeys": [] + } + } + }, + "/cronjobs/update": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobOperate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update cronjob", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "update cronjob [name]", + "formatZH": "更新计划任务 [name]", + "paramKeys": [] + } + } + }, + "/dashboard/app/launcher": { + "get": { + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "Array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load app launcher", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/app/launcher/option": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SearchByFilter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "Array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load app launcher options", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/app/launcher/show": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SettingUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update app Launcher", + "tags": [ + "Dashboard" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "key", + "value" + ], + "formatEN": "app launcher [key] =\u003e show: [value]", + "formatZH": "首页应用 [key] =\u003e 显示：[value]", + "paramKeys": [] + } + } + }, + "/dashboard/base/:ioOption/:netOption": { + "get": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "ioOption", + "required": true, + "type": "string" + }, + { + "description": "request", + "in": "path", + "name": "netOption", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DashboardBase" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load dashboard base info", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/base/os": { + "get": { + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.OsInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load os info", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/current/:ioOption/:netOption": { + "get": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "ioOption", + "required": true, + "type": "string" + }, + { + "description": "request", + "in": "path", + "name": "netOption", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DashboardCurrent" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load dashboard current info", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/current/node": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.NodeCurrent" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load dashboard current info for node", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/quick/change": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeQuicks" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update quick jump", + "tags": [ + "Dashboard" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "change quick jump", + "formatZH": "切换快速跳转", + "paramKeys": [] + } + } + }, + "/dashboard/quick/option": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "Array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load quick jump options", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/system/restart/:operation": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "operation", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "System restart", + "tags": [ + "Dashboard" + ] + } + }, + "/databases": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.MysqlDBCreate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Create mysql database", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name" + ], + "formatEN": "create mysql database [name]", + "formatZH": "创建 mysql 数据库 [name]", + "paramKeys": [] + } + } + }, + "/databases/bind": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.BindUser" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Bind user of mysql database", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "database", + "username" + ], + "formatEN": "bind mysql database [database] [username]", + "formatZH": "绑定 mysql 数据库名 [database] [username]", + "paramKeys": [] + } + } + }, + "/databases/change/access": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeDBInfo" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Change mysql access", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "Update database [name] access", + "formatZH": "更新数据库 [name] 访问权限", + "paramKeys": [] + } + } + }, + "/databases/change/password": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeDBInfo" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Change mysql password", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "Update database [name] password", + "formatZH": "更新数据库 [name] 密码", + "paramKeys": [] + } + } + }, + "/databases/common/info": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperationWithNameAndType" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DBBaseInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load base info", + "tags": [ + "Database Common" + ] + } + }, + "/databases/common/load/file": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperationWithNameAndType" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load Database conf", + "tags": [ + "Database Common" + ] + } + }, + "/databases/common/update/conf": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DBConfUpdateByFile" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update conf by upload file", + "tags": [ + "Database Common" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "type", + "database" + ], + "formatEN": "update the [type] [database] database configuration information", + "formatZH": "更新 [type] 数据库 [database] 配置信息", + "paramKeys": [] + } + } + }, + "/databases/db": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseCreate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Create database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name", + "type" + ], + "formatEN": "create database [name][type]", + "formatZH": "创建远程数据库 [name][type]", + "paramKeys": [] + } + } + }, + "/databases/db/:name": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DatabaseInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get databases", + "tags": [ + "Database" + ] + } + }, + "/databases/db/check": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseCreate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Check database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name", + "type" ], - "formatEN": "update cronjob [name]", - "formatZH": "更新计划任务 [name]", + "formatEN": "check if database [name][type] is connectable", + "formatZH": "检测远程数据库 [name][type] 连接性", "paramKeys": [] } } }, - "/dashboard/app/launcher": { - "get": { + "/databases/db/del": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseDelete" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Delete database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "databases", + "input_column": "id", + "input_value": "ids", + "isList": true, + "output_column": "name", + "output_value": "names" + } + ], + "bodyKeys": [ + "ids" + ], + "formatEN": "delete database [names]", + "formatZH": "删除远程数据库 [names]", + "paramKeys": [] + } + } + }, + "/databases/db/item/:type": { + "get": { "responses": { "200": { "description": "OK", "schema": { - "type": "Array" + "items": { + "$ref": "#/definitions/dto.DatabaseItem" + }, + "type": "array" } } }, @@ -7392,13 +8704,40 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load app launcher", + "summary": "List databases", "tags": [ - "Dashboard" + "Database" ] } }, - "/dashboard/app/launcher/option": { + "/databases/db/list/:type": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.DatabaseOption" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List databases", + "tags": [ + "Database" + ] + } + }, + "/databases/db/search": { "post": { "consumes": [ "application/json" @@ -7410,7 +8749,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchByFilter" + "$ref": "#/definitions/dto.DatabaseSearch" } } ], @@ -7418,7 +8757,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "type": "Array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -7430,39 +8769,75 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load app launcher options", + "summary": "Page databases", "tags": [ - "Dashboard" + "Database" ] } }, - "/dashboard/base/:ioOption/:netOption": { - "get": { + "/databases/db/update": { + "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "ioOption", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.DatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] }, + { + "Timestamp": [] + } + ], + "summary": "Update database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name" + ], + "formatEN": "update database [name]", + "formatZH": "更新远程数据库 [name]", + "paramKeys": [] + } + } + }, + "/databases/del": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ { "description": "request", - "in": "path", - "name": "netOption", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.MysqlDBDelete" + } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.DashboardBase" - } + "description": "OK" } }, "security": [ @@ -7473,22 +8848,54 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load dashboard base info", + "summary": "Delete mysql database", "tags": [ - "Dashboard" - ] + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "delete mysql database [name]", + "formatZH": "删除 mysql 数据库 [name]", + "paramKeys": [] + } } }, - "/dashboard/base/os": { - "get": { + "/databases/del/check": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.MysqlDBDeleteCheck" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.OsInfo" + "items": { + "type": "string" + }, + "type": "array" } } }, @@ -7500,39 +8907,31 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load os info", + "summary": "Check before delete mysql database", "tags": [ - "Dashboard" + "Database Mysql" ] } }, - "/dashboard/current/:ioOption/:netOption": { - "get": { + "/databases/description/update": { + "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "ioOption", - "required": true, - "type": "string" - }, - { - "description": "request", - "in": "path", - "name": "netOption", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.UpdateDescription" + } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.DashboardCurrent" - } + "description": "OK" } }, "security": [ @@ -7543,22 +8942,48 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load dashboard current info", + "summary": "Update mysql database description", "tags": [ - "Dashboard" - ] + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id", + "description" + ], + "formatEN": "The description of the mysql database [name] is modified =\u003e [description]", + "formatZH": "mysql 数据库 [name] 描述信息修改 [description]", + "paramKeys": [] + } } }, - "/dashboard/current/node": { - "get": { - "responses": { - "200": { - "description": "OK", + "/databases/load": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "$ref": "#/definitions/dto.NodeCurrent" + "$ref": "#/definitions/dto.MysqlLoadDB" } } - }, + ], + "responses": {}, "security": [ { "ApiKeyAuth": [] @@ -7567,29 +8992,37 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load dashboard current info for node", + "summary": "Load mysql database from remote", "tags": [ - "Dashboard" + "Database Mysql" ] } }, - "/dashboard/system/restart/:operation": { - "post": { + "/databases/options": { + "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "operation", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.PageInfo" + } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.MysqlOption" + }, + "type": "array" + } } }, "security": [ @@ -7600,13 +9033,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "System restart", + "summary": "List mysql database names", "tags": [ - "Dashboard" + "Database Mysql" ] } }, - "/databases": { + "/databases/pg": { "post": { "consumes": [ "application/json" @@ -7618,7 +9051,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBCreate" + "$ref": "#/definitions/dto.PostgresqlDBCreate" } } ], @@ -7635,22 +9068,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create mysql database", + "summary": "Create postgresql database", "tags": [ - "Database Mysql" + "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], - "formatEN": "create mysql database [name]", - "formatZH": "创建 mysql 数据库 [name]", + "formatEN": "create postgresql database [name]", + "formatZH": "创建 postgresql 数据库 [name]", "paramKeys": [] } } }, - "/databases/bind": { + "/databases/pg/:database/load": { "post": { "consumes": [ "application/json" @@ -7662,15 +9095,11 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.BindUser" + "$ref": "#/definitions/dto.PostgresqlLoadDB" } } ], - "responses": { - "200": { - "description": "OK" - } - }, + "responses": {}, "security": [ { "ApiKeyAuth": [] @@ -7679,23 +9108,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Bind user of mysql database", + "summary": "Load postgresql database from remote", "tags": [ - "Database Mysql" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "database", - "username" - ], - "formatEN": "bind mysql database [database] [username]", - "formatZH": "绑定 mysql 数据库名 [database] [username]", - "paramKeys": [] - } + "Database PostgreSQL" + ] } }, - "/databases/change/access": { + "/databases/pg/bind": { "post": { "consumes": [ "application/json" @@ -7707,7 +9126,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/dto.PostgresqlBindUser" } } ], @@ -7724,31 +9143,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change mysql access", + "summary": "Bind postgresql user", "tags": [ - "Database Mysql" + "Database PostgreSQL" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_mysqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "name", + "username" ], - "formatEN": "Update database [name] access", - "formatZH": "更新数据库 [name] 访问权限", + "formatEN": "bind postgresql database [name] user [username]", + "formatZH": "绑定 postgresql 数据库 [name] 用户 [username]", "paramKeys": [] } } }, - "/databases/change/password": { + "/databases/pg/del": { "post": { "consumes": [ "application/json" @@ -7760,7 +9171,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/dto.PostgresqlDBDelete" } } ], @@ -7777,14 +9188,14 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change mysql password", + "summary": "Delete postgresql database", "tags": [ - "Database Mysql" + "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [ { - "db": "database_mysqls", + "db": "database_postgresqls", "input_column": "id", "input_value": "id", "isList": false, @@ -7795,13 +9206,13 @@ const docTemplate = `{ "bodyKeys": [ "id" ], - "formatEN": "Update database [name] password", - "formatZH": "更新数据库 [name] 密码", + "formatEN": "delete postgresql database [name]", + "formatZH": "删除 postgresql 数据库 [name]", "paramKeys": [] } } }, - "/databases/common/info": { + "/databases/pg/del/check": { "post": { "consumes": [ "application/json" @@ -7813,7 +9224,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" + "$ref": "#/definitions/dto.PostgresqlDBDeleteCheck" } } ], @@ -7821,7 +9232,10 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.DBBaseInfo" + "items": { + "type": "string" + }, + "type": "array" } } }, @@ -7833,13 +9247,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load base info", + "summary": "Check before delete postgresql database", "tags": [ - "Database Common" + "Database PostgreSQL" ] } }, - "/databases/common/load/file": { + "/databases/pg/description": { "post": { "consumes": [ "application/json" @@ -7851,16 +9265,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" + "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -7871,13 +9282,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load Database conf", + "summary": "Update postgresql database description", "tags": [ - "Database Common" - ] + "Database PostgreSQL" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_postgresqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id", + "description" + ], + "formatEN": "The description of the postgresql database [name] is modified =\u003e [description]", + "formatZH": "postgresql 数据库 [name] 描述信息修改 [description]", + "paramKeys": [] + } } }, - "/databases/common/update/conf": { + "/databases/pg/password": { "post": { "consumes": [ "application/json" @@ -7889,7 +9319,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DBConfUpdateByFile" + "$ref": "#/definitions/dto.ChangeDBInfo" } } ], @@ -7906,23 +9336,31 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update conf by upload file", + "summary": "Change postgresql password", "tags": [ - "Database Common" + "Database PostgreSQL" ], "x-panel-log": { - "BeforeFunctions": [], + "BeforeFunctions": [ + { + "db": "database_postgresqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], "bodyKeys": [ - "type", - "database" + "id" ], - "formatEN": "update the [type] [database] database configuration information", - "formatZH": "更新 [type] 数据库 [database] 配置信息", + "formatEN": "Update database [name] password", + "formatZH": "更新数据库 [name] 密码", "paramKeys": [] } } }, - "/databases/db": { + "/databases/pg/privileges": { "post": { "consumes": [ "application/json" @@ -7934,7 +9372,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseCreate" + "$ref": "#/definitions/dto.ChangeDBInfo" } } ], @@ -7951,29 +9389,43 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create database", + "summary": "Change postgresql privileges", "tags": [ - "Database" + "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "name", - "type" + "database", + "username" ], - "formatEN": "create database [name][type]", - "formatZH": "创建远程数据库 [name][type]", + "formatEN": "Update [user] privileges of database [database]", + "formatZH": "更新数据库 [database] 用户 [username] 权限", "paramKeys": [] } } }, - "/databases/db/:name": { - "get": { + "/databases/pg/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.PostgresqlDBSearch" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.DatabaseInfo" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -7985,13 +9437,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get databases", + "summary": "Page postgresql databases", "tags": [ - "Database" + "Database PostgreSQL" ] } }, - "/databases/db/check": { + "/databases/redis/conf": { "post": { "consumes": [ "application/json" @@ -8003,7 +9455,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseCreate" + "$ref": "#/definitions/dto.LoadRedisStatus" } } ], @@ -8011,7 +9463,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "type": "boolean" + "$ref": "#/definitions/dto.RedisConf" } } }, @@ -8023,23 +9475,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Check database", + "summary": "Load redis conf", "tags": [ - "Database" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name", - "type" - ], - "formatEN": "check if database [name][type] is connectable", - "formatZH": "检测远程数据库 [name][type] 连接性", - "paramKeys": [] - } + "Database Redis" + ] } }, - "/databases/db/del": { + "/databases/redis/conf/update": { "post": { "consumes": [ "application/json" @@ -8051,7 +9493,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseDelete" + "$ref": "#/definitions/dto.RedisConfUpdate" } } ], @@ -8068,41 +9510,24 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete database", + "summary": "Update redis conf", "tags": [ - "Database" + "Database Redis" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "databases", - "input_column": "id", - "input_value": "ids", - "isList": true, - "output_column": "name", - "output_value": "names" - } - ], - "bodyKeys": [ - "ids" - ], - "formatEN": "delete database [names]", - "formatZH": "删除远程数据库 [names]", + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "update the redis database configuration information", + "formatZH": "更新 redis 数据库配置信息", "paramKeys": [] } } }, - "/databases/db/item/:type": { - "get": { + "/databases/redis/install/cli": { + "post": { "responses": { "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/dto.DatabaseItem" - }, - "type": "array" - } + "description": "OK" } }, "security": [ @@ -8113,24 +9538,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List databases", + "summary": "Install redis-cli", "tags": [ - "Database" + "Database Redis" ] } }, - "/databases/db/list/:type": { - "get": { - "responses": { - "200": { - "description": "OK", + "/databases/redis/password": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "items": { - "$ref": "#/definitions/dto.DatabaseOption" - }, - "type": "array" + "$ref": "#/definitions/dto.ChangeRedisPass" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -8140,13 +9573,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List databases", + "summary": "Change redis password", "tags": [ - "Database" - ] + "Database Redis" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "change the password of the redis database", + "formatZH": "修改 redis 数据库密码", + "paramKeys": [] + } } }, - "/databases/db/search": { + "/databases/redis/persistence/conf": { "post": { "consumes": [ "application/json" @@ -8158,7 +9598,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseSearch" + "$ref": "#/definitions/dto.LoadRedisStatus" } } ], @@ -8166,7 +9606,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "$ref": "#/definitions/dto.RedisPersistence" } } }, @@ -8178,13 +9618,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page databases", + "summary": "Load redis persistence conf", "tags": [ - "Database" + "Database Redis" ] } }, - "/databases/db/update": { + "/databases/redis/persistence/update": { "post": { "consumes": [ "application/json" @@ -8196,7 +9636,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseUpdate" + "$ref": "#/definitions/dto.RedisConfPersistenceUpdate" } } ], @@ -8213,22 +9653,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update database", + "summary": "Update redis persistence conf", "tags": [ - "Database" + "Database Redis" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "update database [name]", - "formatZH": "更新远程数据库 [name]", + "bodyKeys": [], + "formatEN": "redis database persistence configuration update", + "formatZH": "redis 数据库持久化配置更新", "paramKeys": [] } } }, - "/databases/del": { + "/databases/redis/status": { "post": { "consumes": [ "application/json" @@ -8240,13 +9678,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBDelete" + "$ref": "#/definitions/dto.LoadRedisStatus" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.RedisStatus" + } } }, "security": [ @@ -8257,31 +9698,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete mysql database", + "summary": "Load redis status info", "tags": [ - "Database Mysql" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_mysqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "delete mysql database [name]", - "formatZH": "删除 mysql 数据库 [name]", - "paramKeys": [] - } + "Database Redis" + ] } }, - "/databases/del/check": { + "/databases/remote": { "post": { "consumes": [ "application/json" @@ -8293,7 +9716,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBDeleteCheck" + "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], @@ -8301,10 +9724,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "type": "boolean" } } }, @@ -8316,13 +9736,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Check before delete mysql database", + "summary": "Load mysql remote access", "tags": [ "Database Mysql" ] } }, - "/databases/description/update": { + "/databases/search": { "post": { "consumes": [ "application/json" @@ -8334,49 +9754,33 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.UpdateDescription" + "$ref": "#/definitions/dto.MysqlDBSearch" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ { "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Update mysql database description", - "tags": [ - "Database Mysql" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_mysqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id", - "description" - ], - "formatEN": "The description of the mysql database [name] is modified =\u003e [description]", - "formatZH": "mysql 数据库 [name] 描述信息修改 [description]", - "paramKeys": [] - } + }, + { + "Timestamp": [] + } + ], + "summary": "Page mysql databases", + "tags": [ + "Database Mysql" + ] } }, - "/databases/load": { + "/databases/status": { "post": { "consumes": [ "application/json" @@ -8388,11 +9792,18 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlLoadDB" + "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], - "responses": {}, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.MysqlStatus" + } + } + }, "security": [ { "ApiKeyAuth": [] @@ -8401,14 +9812,14 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load mysql database from remote", + "summary": "Load mysql status info", "tags": [ "Database Mysql" ] } }, - "/databases/options": { - "get": { + "/databases/variables": { + "post": { "consumes": [ "application/json" ], @@ -8419,7 +9830,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], @@ -8427,10 +9838,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/dto.MysqlOption" - }, - "type": "array" + "$ref": "#/definitions/dto.MysqlVariables" } } }, @@ -8442,13 +9850,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List mysql database names", + "summary": "Load mysql variables info", "tags": [ "Database Mysql" ] } }, - "/databases/pg": { + "/databases/variables/update": { "post": { "consumes": [ "application/json" @@ -8460,7 +9868,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBCreate" + "$ref": "#/definitions/dto.MysqlVariablesUpdate" } } ], @@ -8477,22 +9885,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create postgresql database", + "summary": "Update mysql variables", "tags": [ - "Database PostgreSQL" + "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "create postgresql database [name]", - "formatZH": "创建 postgresql 数据库 [name]", + "bodyKeys": [], + "formatEN": "adjust mysql database performance parameters", + "formatZH": "调整 mysql 数据库性能参数", "paramKeys": [] } } }, - "/databases/pg/:database/load": { + "/db/remote/del/check": { "post": { "consumes": [ "application/json" @@ -8504,11 +9910,21 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlLoadDB" + "$ref": "#/definitions/dto.OperateByID" } } ], - "responses": {}, + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, "security": [ { "ApiKeyAuth": [] @@ -8517,31 +9933,63 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load postgresql database from remote", + "summary": "Check before delete remote database", "tags": [ - "Database PostgreSQL" + "Database" ] } }, - "/databases/pg/bind": { + "/disks": { + "get": { + "description": "Get information about all disks including partitioned and unpartitioned disks", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.CompleteDiskInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get complete disk information", + "tags": [ + "Disk Management" + ] + } + }, + "/disks/mount": { "post": { "consumes": [ "application/json" ], + "description": "Mount partition to specified mount point", "parameters": [ { - "description": "request", + "description": "mount request", "in": "body", "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlBindUser" + "$ref": "#/definitions/request.DiskMountRequest" } } ], "responses": { "200": { - "description": "OK" + "description": "Disk mounted successfully", + "schema": { + "type": "string" + } } }, "security": [ @@ -8552,41 +10000,45 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Bind postgresql user", + "summary": "Mount disk", "tags": [ - "Database PostgreSQL" + "Disk Management" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "name", - "username" + "device", + "mountPoint" ], - "formatEN": "bind postgresql database [name] user [username]", - "formatZH": "绑定 postgresql 数据库 [name] 用户 [username]", + "formatEN": "Mount disk [device] to [mountPoint]", + "formatZH": "挂载磁盘 [device] 到 [mountPoint]", "paramKeys": [] } } }, - "/databases/pg/del": { + "/disks/partition": { "post": { "consumes": [ "application/json" ], + "description": "Create partition and format disk with specified filesystem", "parameters": [ { - "description": "request", + "description": "partition request", "in": "body", "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBDelete" + "$ref": "#/definitions/request.DiskPartitionRequest" } } ], "responses": { "200": { - "description": "OK" + "description": "Partition created successfully", + "schema": { + "type": "string" + } } }, "security": [ @@ -8597,54 +10049,45 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete postgresql database", + "summary": "Partition disk", "tags": [ - "Database PostgreSQL" + "Disk Management" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_postgresqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "device", + "filesystem", + "mountPoint" ], - "formatEN": "delete postgresql database [name]", - "formatZH": "删除 postgresql 数据库 [name]", + "formatEN": "Partition disk [device] with filesystem [filesystem], mount point [mountPoint]", + "formatZH": "对磁盘 [device] 进行分区，文件系统 [filesystem]，挂载点 [mountPoint]", "paramKeys": [] } } }, - "/databases/pg/del/check": { + "/disks/unmount": { "post": { "consumes": [ "application/json" ], + "description": "Unmount partition from mount point", "parameters": [ { - "description": "request", + "description": "unmount request", "in": "body", "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBDeleteCheck" + "$ref": "#/definitions/request.DiskUnmountRequest" } } ], "responses": { "200": { - "description": "OK", + "description": "Disk unmounted successfully", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" } } }, @@ -8656,13 +10099,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Check before delete postgresql database", + "summary": "Unmount disk", "tags": [ - "Database PostgreSQL" - ] + "Disk Management" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "device", + "mountPoint" + ], + "formatEN": "Unmount disk [device] from [mountPoint]", + "formatZH": "卸载磁盘 [device] 从 [mountPoint]", + "paramKeys": [] + } } }, - "/databases/pg/description": { + "/files": { "post": { "consumes": [ "application/json" @@ -8674,7 +10127,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.UpdateDescription" + "$ref": "#/definitions/request.FileCreate" } } ], @@ -8691,32 +10144,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update postgresql database description", + "summary": "Create file", "tags": [ - "Database PostgreSQL" + "File" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_postgresqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id", - "description" + "path" ], - "formatEN": "The description of the postgresql database [name] is modified =\u003e [description]", - "formatZH": "postgresql 数据库 [name] 描述信息修改 [description]", + "formatEN": "Create dir or file [path]", + "formatZH": "创建文件/文件夹 [path]", "paramKeys": [] } } }, - "/databases/pg/password": { + "/files/batch/check": { "post": { "consumes": [ "application/json" @@ -8728,13 +10171,19 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/request.FilePathsCheck" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/response.ExistFileInfo" + }, + "type": "array" + } } }, "security": [ @@ -8745,31 +10194,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change postgresql password", + "summary": "Batch check file exist", "tags": [ - "Database PostgreSQL" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_postgresqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "Update database [name] password", - "formatZH": "更新数据库 [name] 密码", - "paramKeys": [] - } + "File" + ] } }, - "/databases/pg/privileges": { + "/files/batch/del": { "post": { "consumes": [ "application/json" @@ -8781,7 +10212,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/request.FileBatchDelete" } } ], @@ -8798,23 +10229,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change postgresql privileges", + "summary": "Batch delete file", "tags": [ - "Database PostgreSQL" + "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "database", - "username" + "paths" ], - "formatEN": "Update [user] privileges of database [database]", - "formatZH": "更新数据库 [database] 用户 [username] 权限", + "formatEN": "Batch delete dir or file [paths]", + "formatZH": "批量删除文件/文件夹 [paths]", "paramKeys": [] } } }, - "/databases/pg/search": { + "/files/batch/role": { "post": { "consumes": [ "application/json" @@ -8826,16 +10256,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBSearch" + "$ref": "#/definitions/request.FileRoleReq" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -8846,13 +10273,25 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page postgresql databases", + "summary": "Batch change file mode and owner", "tags": [ - "Database PostgreSQL" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "paths", + "mode", + "user", + "group" + ], + "formatEN": "Batch change file mode and owner [paths] =\u003e [mode]/[user]/[group]", + "formatZH": "批量修改文件权限和用户/组 [paths] =\u003e [mode]/[user]/[group]", + "paramKeys": [] + } } }, - "/databases/redis/conf": { + "/files/check": { "post": { "consumes": [ "application/json" @@ -8864,7 +10303,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithName" + "$ref": "#/definitions/request.FilePathCheck" } } ], @@ -8872,7 +10311,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.RedisConf" + "type": "boolean" } } }, @@ -8884,13 +10323,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load redis conf", + "summary": "Check file exist", "tags": [ - "Database Redis" + "File" ] } }, - "/databases/redis/conf/update": { + "/files/chunkdownload": { "post": { "consumes": [ "application/json" @@ -8902,7 +10341,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.RedisConfUpdate" + "$ref": "#/definitions/request.FileDownload" } } ], @@ -8919,21 +10358,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update redis conf", + "summary": "Chunk Download file", "tags": [ - "Database Redis" + "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "update the redis database configuration information", - "formatZH": "更新 redis 数据库配置信息", + "bodyKeys": [ + "name" + ], + "formatEN": "Download file [name]", + "formatZH": "下载文件 [name]", "paramKeys": [] } } }, - "/databases/redis/install/cli": { + "/files/chunkupload": { "post": { + "parameters": [ + { + "description": "request", + "in": "formData", + "name": "file", + "required": true, + "type": "file" + } + ], "responses": { "200": { "description": "OK" @@ -8947,13 +10397,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Install redis-cli", + "summary": "ChunkUpload file", "tags": [ - "Database Redis" + "File" ] } }, - "/databases/redis/password": { + "/files/compress": { "post": { "consumes": [ "application/json" @@ -8965,7 +10415,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeRedisPass" + "$ref": "#/definitions/request.FileCompress" } } ], @@ -8982,20 +10432,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change redis password", + "summary": "Compress file", "tags": [ - "Database Redis" + "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "change the password of the redis database", - "formatZH": "修改 redis 数据库密码", + "bodyKeys": [ + "name" + ], + "formatEN": "Compress file [name]", + "formatZH": "压缩文件 [name]", "paramKeys": [] } } }, - "/databases/redis/persistence/conf": { + "/files/content": { "post": { "consumes": [ "application/json" @@ -9007,7 +10459,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithName" + "$ref": "#/definitions/request.FileContentReq" } } ], @@ -9015,7 +10467,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.RedisPersistence" + "$ref": "#/definitions/response.FileInfo" } } }, @@ -9027,13 +10479,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load redis persistence conf", + "summary": "Load file content", "tags": [ - "Database Redis" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "Load file content [path]", + "formatZH": "获取文件内容 [path]", + "paramKeys": [] + } } }, - "/databases/redis/persistence/update": { + "/files/decompress": { "post": { "consumes": [ "application/json" @@ -9045,7 +10506,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.RedisConfPersistenceUpdate" + "$ref": "#/definitions/request.FileDeCompress" } } ], @@ -9062,20 +10523,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update redis persistence conf", + "summary": "Decompress file", "tags": [ - "Database Redis" + "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "redis database persistence configuration update", - "formatZH": "redis 数据库持久化配置更新", + "bodyKeys": [ + "path" + ], + "formatEN": "Decompress file [path]", + "formatZH": "解压 [path]", "paramKeys": [] } } }, - "/databases/redis/status": { + "/files/del": { "post": { "consumes": [ "application/json" @@ -9087,16 +10550,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithName" + "$ref": "#/definitions/request.FileDelete" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.RedisStatus" - } + "description": "OK" } }, "security": [ @@ -9107,51 +10567,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load redis status info", + "summary": "Delete file", "tags": [ - "Database Redis" - ] - } - }, - "/databases/remote": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "boolean" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } + "File" ], - "summary": "Load mysql remote access", - "tags": [ - "Database Mysql" - ] + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "Delete dir or file [path]", + "formatZH": "删除文件/文件夹 [path]", + "paramKeys": [] + } } }, - "/databases/search": { + "/files/depth/size": { "post": { "consumes": [ "application/json" @@ -9163,7 +10594,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBSearch" + "$ref": "#/definitions/request.DirSizeReq" } } ], @@ -9171,7 +10602,10 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "items": { + "$ref": "#/definitions/response.DepthDirSizeRes" + }, + "type": "array" } } }, @@ -9183,34 +10617,29 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page mysql databases", + "summary": "Multi file size", "tags": [ - "Database Mysql" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "Multi file size [path]", + "formatZH": "获取目录及其第一层子目录文件夹大小 [path]", + "paramKeys": [] + } } }, - "/databases/status": { - "post": { + "/files/download": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" - } - } - ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.MysqlStatus" - } + "description": "OK" } }, "security": [ @@ -9221,13 +10650,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load mysql status info", + "summary": "Download file", "tags": [ - "Database Mysql" + "File" ] } }, - "/databases/variables": { + "/files/favorite": { "post": { "consumes": [ "application/json" @@ -9239,7 +10668,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" + "$ref": "#/definitions/request.FavoriteCreate" } } ], @@ -9247,7 +10676,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.MysqlVariables" + "$ref": "#/definitions/model.Favorite" } } }, @@ -9259,13 +10688,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load mysql variables info", + "summary": "Create favorite", "tags": [ - "Database Mysql" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "收藏文件/文件夹 [path]", + "formatZH": "收藏文件/文件夹 [path]", + "paramKeys": [] + } } }, - "/databases/variables/update": { + "/files/favorite/del": { "post": { "consumes": [ "application/json" @@ -9277,7 +10715,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlVariablesUpdate" + "$ref": "#/definitions/request.FavoriteDelete" } } ], @@ -9294,20 +10732,31 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update mysql variables", + "summary": "Delete favorite", "tags": [ - "Database Mysql" + "File" ], "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "adjust mysql database performance parameters", - "formatZH": "调整 mysql 数据库性能参数", + "BeforeFunctions": [ + { + "db": "favorites", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "path", + "output_value": "path" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "delete avorite [path]", + "formatZH": "删除收藏 [path]", "paramKeys": [] } } }, - "/db/remote/del/check": { + "/files/favorite/search": { "post": { "consumes": [ "application/json" @@ -9319,7 +10768,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.PageInfo" } } ], @@ -9327,10 +10776,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -9342,13 +10788,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Check before delete remote database", + "summary": "List favorites", "tags": [ - "Database" + "File" ] } }, - "/files": { + "/files/mode": { "post": { "consumes": [ "application/json" @@ -9377,22 +10823,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create file", + "summary": "Change file mode", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "path", + "mode" ], - "formatEN": "Create dir or file [path]", - "formatZH": "创建文件/文件夹 [path]", + "formatEN": "Change mode [paths] =\u003e [mode]", + "formatZH": "修改权限 [paths] =\u003e [mode]", "paramKeys": [] } } }, - "/files/batch/del": { + "/files/move": { "post": { "consumes": [ "application/json" @@ -9404,7 +10851,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileBatchDelete" + "$ref": "#/definitions/request.FileMove" } } ], @@ -9421,22 +10868,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Batch delete file", + "summary": "Move file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "paths" + "oldPaths", + "newPath" ], - "formatEN": "Batch delete dir or file [paths]", - "formatZH": "批量删除文件/文件夹 [paths]", + "formatEN": "Move [oldPaths] =\u003e [newPath]", + "formatZH": "移动文件 [oldPaths] =\u003e [newPath]", "paramKeys": [] } } }, - "/files/batch/role": { + "/files/owner": { "post": { "consumes": [ "application/json" @@ -9448,7 +10896,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileRoleReq" + "$ref": "#/definitions/request.FileRoleUpdate" } } ], @@ -9465,29 +10913,25 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Batch change file mode and owner", + "summary": "Change file owner", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "paths", - "mode", + "path", "user", "group" ], - "formatEN": "Batch change file mode and owner [paths] =\u003e [mode]/[user]/[group]", - "formatZH": "批量修改文件权限和用户/组 [paths] =\u003e [mode]/[user]/[group]", + "formatEN": "Change owner [paths] =\u003e [user]/[group]", + "formatZH": "修改用户/组 [paths] =\u003e [user]/[group]", "paramKeys": [] } } }, - "/files/check": { + "/files/read": { "post": { - "consumes": [ - "application/json" - ], "parameters": [ { "description": "request", @@ -9495,7 +10939,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FilePathCheck" + "$ref": "#/definitions/request.FileReadByLineReq" } } ], @@ -9503,7 +10947,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "type": "boolean" + "$ref": "#/definitions/response.FileLineContent" } } }, @@ -9515,28 +10959,17 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Check file exist", + "summary": "Read file by Line", "tags": [ "File" ] } }, - "/files/chunkdownload": { + "/files/recycle/clear": { "post": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.FileDownload" - } - } - ], "responses": { "200": { "description": "OK" @@ -9550,30 +10983,33 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Chunk Download file", + "summary": "Clear RecycleBin files", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Download file [name]", - "formatZH": "下载文件 [name]", + "bodyKeys": [], + "formatEN": "清空回收站", + "formatZH": "清空回收站", "paramKeys": [] } } }, - "/files/chunkupload": { + "/files/recycle/reduce": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", - "in": "formData", - "name": "file", + "in": "body", + "name": "request", "required": true, - "type": "file" + "schema": { + "$ref": "#/definitions/request.RecycleBinReduce" + } } ], "responses": { @@ -9589,13 +11025,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "ChunkUpload file", + "summary": "Reduce RecycleBin files", "tags": [ "File" - ] + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name" + ], + "formatEN": "Reduce RecycleBin file [name]", + "formatZH": "还原回收站文件 [name]", + "paramKeys": [] + } } }, - "/files/compress": { + "/files/recycle/search": { "post": { "consumes": [ "application/json" @@ -9607,13 +11052,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileCompress" + "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -9624,42 +11072,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Compress file", + "summary": "List RecycleBin files", "tags": [ "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Compress file [name]", - "formatZH": "压缩文件 [name]", - "paramKeys": [] - } + ] } }, - "/files/content": { - "post": { + "/files/recycle/status": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.FileContentReq" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.FileInfo" + "type": "string" } } }, @@ -9671,22 +11099,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load file content", + "summary": "Get RecycleBin status", "tags": [ "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "path" - ], - "formatEN": "Load file content [path]", - "formatZH": "获取文件内容 [path]", - "paramKeys": [] - } + ] } }, - "/files/decompress": { + "/files/rename": { "post": { "consumes": [ "application/json" @@ -9698,7 +11117,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileDeCompress" + "$ref": "#/definitions/request.FileRename" } } ], @@ -9715,22 +11134,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Decompress file", + "summary": "Change file name", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "oldName", + "newName" ], - "formatEN": "Decompress file [path]", - "formatZH": "解压 [path]", + "formatEN": "Rename [oldName] =\u003e [newName]", + "formatZH": "重命名 [oldName] =\u003e [newName]", "paramKeys": [] } } }, - "/files/del": { + "/files/save": { "post": { "consumes": [ "application/json" @@ -9742,7 +11162,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileDelete" + "$ref": "#/definitions/request.FileEdit" } } ], @@ -9759,7 +11179,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete file", + "summary": "Update file content", "tags": [ "File" ], @@ -9768,20 +11188,34 @@ const docTemplate = `{ "bodyKeys": [ "path" ], - "formatEN": "Delete dir or file [path]", - "formatZH": "删除文件/文件夹 [path]", + "formatEN": "Update file content [path]", + "formatZH": "更新文件内容 [path]", "paramKeys": [] } } }, - "/files/download": { - "get": { + "/files/search": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.FileOption" + } + } + ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.FileInfo" + } } }, "security": [ @@ -9792,13 +11226,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Download file", + "summary": "List files", "tags": [ "File" ] } }, - "/files/favorite": { + "/files/size": { "post": { "consumes": [ "application/json" @@ -9810,7 +11244,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FavoriteCreate" + "$ref": "#/definitions/request.DirSizeReq" } } ], @@ -9818,7 +11252,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/model.Favorite" + "$ref": "#/definitions/response.DirSizeRes" } } }, @@ -9830,7 +11264,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create favorite", + "summary": "Load file size", "tags": [ "File" ], @@ -9839,13 +11273,13 @@ const docTemplate = `{ "bodyKeys": [ "path" ], - "formatEN": "收藏文件/文件夹 [path]", - "formatZH": "收藏文件/文件夹 [path]", + "formatEN": "Load file size [path]", + "formatZH": "获取文件夹大小 [path]", "paramKeys": [] } } }, - "/files/favorite/del": { + "/files/tree": { "post": { "consumes": [ "application/json" @@ -9857,13 +11291,19 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FavoriteDelete" + "$ref": "#/definitions/request.FileOption" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/response.FileTree" + }, + "type": "array" + } } }, "security": [ @@ -9874,31 +11314,53 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete favorite", + "summary": "Load files tree", "tags": [ "File" + ] + } + }, + "/files/upload": { + "post": { + "parameters": [ + { + "description": "request", + "in": "formData", + "name": "file", + "required": true, + "type": "file" + } ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "favorites", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "path", - "output_value": "path" - } - ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Upload file", + "tags": [ + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], "bodyKeys": [ - "id" + "path", + "file" ], - "formatEN": "delete avorite [path]", - "formatZH": "删除收藏 [path]", + "formatEN": "Upload file [path]/[file]", + "formatZH": "上传文件 [path]/[file]", "paramKeys": [] } } }, - "/files/favorite/search": { + "/files/upload/search": { "post": { "consumes": [ "application/json" @@ -9910,7 +11372,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/request.SearchUploadWithPage" } } ], @@ -9930,13 +11392,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List favorites", + "summary": "Page file", "tags": [ "File" ] } }, - "/files/mode": { + "/files/wget": { "post": { "consumes": [ "application/json" @@ -9948,13 +11410,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileCreate" + "$ref": "#/definitions/request.FileWget" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.FileWgetRes" + } } }, "security": [ @@ -9965,23 +11430,24 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change file mode", + "summary": "Wget file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ + "url", "path", - "mode" + "name" ], - "formatEN": "Change mode [paths] =\u003e [mode]", - "formatZH": "修改权限 [paths] =\u003e [mode]", + "formatEN": "Download url =\u003e [path]/[name]", + "formatZH": "下载 url =\u003e [path]/[name]", "paramKeys": [] } } }, - "/files/move": { + "/groups": { "post": { "consumes": [ "application/json" @@ -9993,7 +11459,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileMove" + "$ref": "#/definitions/dto.GroupCreate" } } ], @@ -10010,23 +11476,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Move file", + "summary": "Create group", "tags": [ - "File" + "System Group" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "oldPaths", - "newPath" + "name", + "type" ], - "formatEN": "Move [oldPaths] =\u003e [newPath]", - "formatZH": "移动文件 [oldPaths] =\u003e [newPath]", + "formatEN": "create group [name][type]", + "formatZH": "创建组 [name][type]", "paramKeys": [] } } }, - "/files/owner": { + "/groups/del": { "post": { "consumes": [ "application/json" @@ -10038,7 +11504,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileRoleUpdate" + "$ref": "#/definitions/dto.OperateByID" } } ], @@ -10055,25 +11521,43 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change file owner", + "summary": "Delete group", "tags": [ - "File" + "System Group" ], "x-panel-log": { - "BeforeFunctions": [], + "BeforeFunctions": [ + { + "db": "groups", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + }, + { + "db": "groups", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "type", + "output_value": "type" + } + ], "bodyKeys": [ - "path", - "user", - "group" + "id" ], - "formatEN": "Change owner [paths] =\u003e [user]/[group]", - "formatZH": "修改用户/组 [paths] =\u003e [user]/[group]", + "formatEN": "delete group [type][name]", + "formatZH": "删除组 [type][name]", "paramKeys": [] } } }, - "/files/read": { + "/groups/search": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", @@ -10081,7 +11565,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileReadByLineReq" + "$ref": "#/definitions/dto.GroupSearch" } } ], @@ -10089,7 +11573,10 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.FileLineContent" + "items": { + "$ref": "#/definitions/dto.OperateByType" + }, + "type": "array" } } }, @@ -10101,17 +11588,28 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Read file by Line", + "summary": "List groups", "tags": [ - "File" + "System Group" ] } }, - "/files/recycle/clear": { + "/groups/update": { "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.GroupUpdate" + } + } + ], "responses": { "200": { "description": "OK" @@ -10125,20 +11623,59 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Clear RecycleBin files", + "summary": "Update group", "tags": [ - "File" + "System Group" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "清空回收站", - "formatZH": "清空回收站", + "bodyKeys": [ + "name", + "type" + ], + "formatEN": "update group [name][type]", + "formatZH": "更新组 [name][type]", "paramKeys": [] } } }, - "/files/recycle/reduce": { + "/hosts/components/{name}": { + "get": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "Component name to check (e.g., rsync, docker)", + "in": "query", + "name": "name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.ComponentInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Check if a system component exists", + "tags": [ + "Host" + ] + } + }, + "/hosts/conffile/update": { "post": { "consumes": [ "application/json" @@ -10150,7 +11687,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.RecycleBinReduce" + "$ref": "#/definitions/dto.SSHConf" } } ], @@ -10167,22 +11704,44 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Reduce RecycleBin files", + "summary": "Update host SSH setting by file", "tags": [ - "File" + "SSH" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Reduce RecycleBin file [name]", - "formatZH": "还原回收站文件 [name]", + "bodyKeys": [], + "formatEN": "update SSH conf", + "formatZH": "修改 SSH 配置文件", "paramKeys": [] } } }, - "/files/recycle/search": { + "/hosts/firewall/base": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.FirewallBaseInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load firewall base info", + "tags": [ + "Firewall" + ] + } + }, + "/hosts/firewall/batch": { "post": { "consumes": [ "application/json" @@ -10194,16 +11753,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/dto.BatchRuleOperate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -10214,24 +11770,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List RecycleBin files", + "summary": "Create group", "tags": [ - "File" + "Firewall" ] } }, - "/files/recycle/status": { - "get": { + "/hosts/firewall/forward": { + "post": { "consumes": [ "application/json" ], - "responses": { - "200": { - "description": "OK", + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "type": "string" + "$ref": "#/definitions/dto.ForwardRuleOperate" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -10241,13 +11805,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get RecycleBin status", + "summary": "Create group", "tags": [ - "File" - ] + "Firewall" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "source_port" + ], + "formatEN": "update port forward rules [source_port]", + "formatZH": "更新端口转发规则 [source_port]", + "paramKeys": [] + } } }, - "/files/rename": { + "/hosts/firewall/ip": { "post": { "consumes": [ "application/json" @@ -10259,7 +11832,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileRename" + "$ref": "#/definitions/dto.AddrRuleOperate" } } ], @@ -10276,23 +11849,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Change file name", + "summary": "Create group", "tags": [ - "File" + "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "oldName", - "newName" + "strategy", + "address" ], - "formatEN": "Rename [oldName] =\u003e [newName]", - "formatZH": "重命名 [oldName] =\u003e [newName]", + "formatEN": "create address rules [strategy][address]", + "formatZH": "添加 ip 规则 [strategy] [address]", "paramKeys": [] } } }, - "/files/save": { + "/hosts/firewall/operate": { "post": { "consumes": [ "application/json" @@ -10304,7 +11877,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileEdit" + "$ref": "#/definitions/dto.FirewallOperation" } } ], @@ -10321,22 +11894,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update file content", + "summary": "Operate firewall", "tags": [ - "File" + "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "operation" ], - "formatEN": "Update file content [path]", - "formatZH": "更新文件内容 [path]", + "formatEN": "[operation] firewall", + "formatZH": "[operation] 防火墙", "paramKeys": [] } } }, - "/files/search": { + "/hosts/firewall/port": { "post": { "consumes": [ "application/json" @@ -10348,16 +11921,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileOption" + "$ref": "#/definitions/dto.PortRuleOperate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.FileInfo" - } + "description": "OK" } }, "security": [ @@ -10368,13 +11938,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List files", + "summary": "Create group", "tags": [ - "File" - ] + "Firewall" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "port", + "strategy" + ], + "formatEN": "create port rules [strategy][port]", + "formatZH": "添加端口规则 [strategy] [port]", + "paramKeys": [] + } } }, - "/files/size": { + "/hosts/firewall/search": { "post": { "consumes": [ "application/json" @@ -10386,7 +11966,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.DirSizeReq" + "$ref": "#/definitions/dto.RuleSearch" } } ], @@ -10394,7 +11974,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.DirSizeRes" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -10406,22 +11986,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load file size", + "summary": "Page firewall rules", "tags": [ - "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "path" - ], - "formatEN": "Load file size [path]", - "formatZH": "获取文件夹大小 [path]", - "paramKeys": [] - } + "Firewall" + ] } }, - "/files/tree": { + "/hosts/firewall/update/addr": { "post": { "consumes": [ "application/json" @@ -10433,19 +12004,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileOption" + "$ref": "#/definitions/dto.AddrRuleUpdate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/response.FileTree" - }, - "type": "array" - } + "description": "OK" } }, "security": [ @@ -10456,21 +12021,26 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load files tree", + "summary": "Create group", "tags": [ - "File" + "Firewall" ] } }, - "/files/upload": { + "/hosts/firewall/update/description": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", - "in": "formData", - "name": "file", + "in": "body", + "name": "request", "required": true, - "type": "file" + "schema": { + "$ref": "#/definitions/dto.UpdateFirewallDescription" + } } ], "responses": { @@ -10486,22 +12056,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Upload file", + "summary": "Update rule description", "tags": [ - "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "path" - ], - "formatEN": "Upload file [path]", - "formatZH": "上传文件 [path]", - "paramKeys": [] - } + "Firewall" + ] } }, - "/files/upload/search": { + "/hosts/firewall/update/port": { "post": { "consumes": [ "application/json" @@ -10513,16 +12074,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.SearchUploadWithPage" + "$ref": "#/definitions/dto.PortRuleUpdate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -10533,34 +12091,17 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page file", + "summary": "Create group", "tags": [ - "File" + "Firewall" ] } }, - "/files/wget": { + "/hosts/monitor/clean": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.FileWget" - } - } - ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.FileWgetRes" - } + "description": "OK" } }, "security": [ @@ -10571,28 +12112,21 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Wget file", + "summary": "Clean monitor data", "tags": [ - "File" + "Monitor" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "url", - "path", - "name" - ], - "formatEN": "Download url =\u003e [path]/[name]", - "formatZH": "下载 url =\u003e [path]/[name]", + "bodyKeys": [], + "formatEN": "clean monitor datas", + "formatZH": "清空监控数据", "paramKeys": [] } } }, - "/host/conffile/update": { + "/hosts/monitor/search": { "post": { - "consumes": [ - "application/json" - ], "parameters": [ { "description": "request", @@ -10600,13 +12134,19 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SSHConf" + "$ref": "#/definitions/dto.MonitorSearch" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.MonitorData" + }, + "type": "array" + } } }, "security": [ @@ -10617,26 +12157,19 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update host SSH setting by file", + "summary": "Load monitor data", "tags": [ - "SSH" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "update SSH conf", - "formatZH": "修改 SSH 配置文件", - "paramKeys": [] - } + "Monitor" + ] } }, - "/host/ssh/conf": { + "/hosts/monitor/setting": { "get": { "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/dto.MonitorSetting" } } }, @@ -10648,17 +12181,14 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load host SSH conf", + "summary": "Load monitor setting", "tags": [ - "SSH" + "Monitor" ] } }, - "/host/ssh/generate": { + "/hosts/monitor/setting/update": { "post": { - "consumes": [ - "application/json" - ], "parameters": [ { "description": "request", @@ -10666,7 +12196,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.GenerateSSH" + "$ref": "#/definitions/dto.MonitorSettingUpdate" } } ], @@ -10683,58 +12213,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Generate host SSH secret", + "summary": "Update monitor setting", "tags": [ - "SSH" + "Monitor" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "generate SSH secret", - "formatZH": "生成 SSH 密钥 ", + "bodyKeys": [ + "key", + "value" + ], + "formatEN": "update default monitor [name]-[value]", + "formatZH": "修改默认监控网卡 [name]-[value]", "paramKeys": [] } } }, - "/host/ssh/log": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SearchSSHLog" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.SSHLog" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load host SSH logs", - "tags": [ - "SSH" - ] - } - }, - "/host/ssh/operate": { + "/hosts/ssh/cert": { "post": { "consumes": [ "application/json" @@ -10746,7 +12241,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.Operate" + "$ref": "#/definitions/dto.CreateRootCert" } } ], @@ -10763,30 +12258,39 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Operate SSH", + "summary": "Generate host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "operation" - ], - "formatEN": "[operation] SSH", - "formatZH": "[operation] SSH ", + "bodyKeys": [], + "formatEN": "generate SSH secret", + "formatZH": "生成 SSH 密钥 ", "paramKeys": [] } } }, - "/host/ssh/search": { + "/hosts/ssh/cert/delete": { "post": { - "responses": { - "200": { - "description": "OK", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "$ref": "#/definitions/dto.SSHInfo" + "$ref": "#/definitions/dto.ForceDelete" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -10796,13 +12300,20 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load host SSH setting info", + "summary": "Delete host SSH secret", "tags": [ "SSH" - ] + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "delete SSH secret", + "formatZH": "删除 SSH 密钥 ", + "paramKeys": [] + } } }, - "/host/ssh/secret": { + "/hosts/ssh/cert/search": { "post": { "consumes": [ "application/json" @@ -10814,7 +12325,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.GenerateLoad" + "$ref": "#/definitions/dto.SearchWithPage" } } ], @@ -10822,7 +12333,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -10840,22 +12351,8 @@ const docTemplate = `{ ] } }, - "/host/ssh/update": { + "/hosts/ssh/cert/sync": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SSHUpdate" - } - } - ], "responses": { "200": { "description": "OK" @@ -10869,23 +12366,44 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update host SSH setting", + "summary": "Sycn host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "update SSH setting [key] =\u003e [value]", - "formatZH": "修改 SSH 配置 [key] =\u003e [value]", + "bodyKeys": [], + "formatEN": "sync SSH secret", + "formatZH": "同步 SSH 密钥 ", "paramKeys": [] } } }, - "/host/tool": { + "/hosts/ssh/conf": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load host SSH conf", + "tags": [ + "SSH" + ] + } + }, + "/hosts/ssh/log": { "post": { "consumes": [ "application/json" @@ -10897,7 +12415,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolReq" + "$ref": "#/definitions/dto.SearchSSHLog" } } ], @@ -10905,7 +12423,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.HostToolRes" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -10917,13 +12435,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get tool status", + "summary": "Load host SSH logs", "tags": [ - "Host tool" + "SSH" ] } }, - "/host/tool/config": { + "/hosts/ssh/log/export": { "post": { "consumes": [ "application/json" @@ -10935,7 +12453,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolConfig" + "$ref": "#/definitions/dto.SearchSSHLog" } } ], @@ -10943,7 +12461,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.HostToolConfig" + "type": "string" } } }, @@ -10955,22 +12473,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get tool config", + "summary": "Export host SSH logs", "tags": [ - "Host tool" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "operate" - ], - "formatEN": "[operate] tool config", - "formatZH": "[operate] 主机工具配置文件 ", - "paramKeys": [] - } + "SSH" + ] } }, - "/host/tool/create": { + "/hosts/ssh/operate": { "post": { "consumes": [ "application/json" @@ -10982,7 +12491,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolCreate" + "$ref": "#/definitions/dto.Operate" } } ], @@ -10999,42 +12508,28 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create Host tool Config", + "summary": "Operate SSH", "tags": [ - "Host tool" + "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "type" + "operation" ], - "formatEN": "create [type] config", - "formatZH": "创建 [type] 配置", + "formatEN": "[operation] SSH", + "formatZH": "[operation] SSH ", "paramKeys": [] } } }, - "/host/tool/log": { + "/hosts/ssh/search": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.HostToolLogReq" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/dto.SSHInfo" } } }, @@ -11046,13 +12541,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get tool logs", + "summary": "Load host SSH setting info", "tags": [ - "Host tool" + "SSH" ] } }, - "/host/tool/operate": { + "/hosts/ssh/update": { "post": { "consumes": [ "application/json" @@ -11064,7 +12559,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolReq" + "$ref": "#/definitions/dto.SSHUpdate" } } ], @@ -11081,32 +12576,43 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Operate tool", + "summary": "Update host SSH setting", "tags": [ - "Host tool" + "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "operate", - "type" + "key", + "value" ], - "formatEN": "[operate] [type]", - "formatZH": "[operate] [type] ", + "formatEN": "update SSH setting [key] =\u003e [value]", + "formatZH": "修改 SSH 配置 [key] =\u003e [value]", "paramKeys": [] } } }, - "/host/tool/supervisor/process": { - "get": { + "/hosts/tool": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.HostToolReq" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.SupervisorProcessConfig" + "$ref": "#/definitions/response.HostToolRes" } } }, @@ -11118,11 +12624,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get Supervisor process config", + "summary": "Get tool status", "tags": [ "Host tool" ] - }, + } + }, + "/hosts/tool/config": { "post": { "consumes": [ "application/json" @@ -11134,13 +12642,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.SupervisorProcessConfig" + "$ref": "#/definitions/request.HostToolConfig" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.HostToolConfig" + } } }, "security": [ @@ -11151,7 +12662,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create Supervisor process", + "summary": "Get tool config", "tags": [ "Host tool" ], @@ -11160,13 +12671,13 @@ const docTemplate = `{ "bodyKeys": [ "operate" ], - "formatEN": "[operate] process", - "formatZH": "[operate] 守护进程 ", + "formatEN": "[operate] tool config", + "formatZH": "[operate] 主机工具配置文件 ", "paramKeys": [] } } }, - "/host/tool/supervisor/process/file": { + "/hosts/tool/create": { "post": { "consumes": [ "application/json" @@ -11178,16 +12689,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.SupervisorProcessFileReq" + "$ref": "#/definitions/request.HostToolCreate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -11198,46 +12706,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get Supervisor process config file", + "summary": "Create Host tool Config", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "operate" + "type" ], - "formatEN": "[operate] Supervisor Process Config file", - "formatZH": "[operate] Supervisor 进程文件 ", + "formatEN": "create [type] config", + "formatZH": "创建 [type] 配置", "paramKeys": [] } } }, - "/hosts/firewall/base": { - "get": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.FirewallBaseInfo" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load firewall base info", - "tags": [ - "Firewall" - ] - } - }, - "/hosts/firewall/batch": { + "/hosts/tool/log": { "post": { "consumes": [ "application/json" @@ -11249,13 +12733,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.BatchRuleOperate" + "$ref": "#/definitions/request.HostToolLogReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "string" + } } }, "security": [ @@ -11266,13 +12753,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get tool logs", "tags": [ - "Firewall" + "Host tool" ] } }, - "/hosts/firewall/forward": { + "/hosts/tool/operate": { "post": { "consumes": [ "application/json" @@ -11284,7 +12771,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ForwardRuleOperate" + "$ref": "#/definitions/request.HostToolReq" } } ], @@ -11301,40 +12788,33 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Operate tool", "tags": [ - "Firewall" + "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "source_port" + "operate", + "type" ], - "formatEN": "update port forward rules [source_port]", - "formatZH": "更新端口转发规则 [source_port]", - "paramKeys": [] - } - } - }, - "/hosts/firewall/ip": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.AddrRuleOperate" - } - } + "formatEN": "[operate] [type]", + "formatZH": "[operate] [type] ", + "paramKeys": [] + } + } + }, + "/hosts/tool/supervisor/process": { + "get": { + "consumes": [ + "application/json" ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.SupervisorProcessConfig" + } } }, "security": [ @@ -11345,23 +12825,11 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get Supervisor process config", "tags": [ - "Firewall" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "strategy", - "address" - ], - "formatEN": "create address rules [strategy][address]", - "formatZH": "添加 ip 规则 [strategy] [address]", - "paramKeys": [] - } - } - }, - "/hosts/firewall/operate": { + "Host tool" + ] + }, "post": { "consumes": [ "application/json" @@ -11373,7 +12841,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.FirewallOperation" + "$ref": "#/definitions/request.SupervisorProcessConfig" } } ], @@ -11390,22 +12858,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Operate firewall", + "summary": "Create Supervisor process", "tags": [ - "Firewall" + "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "operation" + "operate" ], - "formatEN": "[operation] firewall", - "formatZH": "[operation] 防火墙", + "formatEN": "[operate] process", + "formatZH": "[operate] 守护进程 ", "paramKeys": [] } } }, - "/hosts/firewall/port": { + "/hosts/tool/supervisor/process/file": { "post": { "consumes": [ "application/json" @@ -11417,13 +12885,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PortRuleOperate" + "$ref": "#/definitions/request.SupervisorProcessFileReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "string" + } } }, "security": [ @@ -11434,43 +12905,34 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get Supervisor process config file", "tags": [ - "Firewall" + "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "port", - "strategy" + "operate" ], - "formatEN": "create port rules [strategy][port]", - "formatZH": "添加端口规则 [strategy] [port]", + "formatEN": "[operate] Supervisor Process Config file", + "formatZH": "[operate] Supervisor 进程文件 ", "paramKeys": [] } } }, - "/hosts/firewall/search": { - "post": { + "/installed/delete/check/:id": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.RuleSearch" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "items": { + "$ref": "#/definitions/dto.AppResource" + }, + "type": "array" } } }, @@ -11482,31 +12944,47 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page firewall rules", + "summary": "Delete runtime", "tags": [ - "Firewall" + "Website" ] } }, - "/hosts/firewall/update/addr": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, + "/logs/system/files": { + "get": { + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/dto.AddrRuleUpdate" + "items": { + "type": "string" + }, + "type": "array" } } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } ], + "summary": "Load system log files", + "tags": [ + "Logs" + ] + } + }, + "/logs/tasks/executing/count": { + "get": { "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "integer" + } } }, "security": [ @@ -11517,13 +12995,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get the number of executing tasks", "tags": [ - "Firewall" + "TaskLog" ] } }, - "/hosts/firewall/update/description": { + "/logs/tasks/search": { "post": { "consumes": [ "application/json" @@ -11535,13 +13013,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.UpdateFirewallDescription" + "$ref": "#/definitions/dto.SearchTaskLogReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -11552,13 +13033,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update rule description", + "summary": "Page task logs", "tags": [ - "Firewall" + "TaskLog" ] } }, - "/hosts/firewall/update/port": { + "/mcp/domain/bind": { "post": { "consumes": [ "application/json" @@ -11570,7 +13051,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PortRuleUpdate" + "$ref": "#/definitions/request.McpBindDomain" } } ], @@ -11587,17 +13068,23 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Bind Domain for mcp server", "tags": [ - "Firewall" + "McpServer" ] } }, - "/hosts/monitor/clean": { - "post": { + "/mcp/domain/get": { + "get": { + "consumes": [ + "application/json" + ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.McpBindDomainRes" + } } }, "security": [ @@ -11608,21 +13095,17 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Clean monitor data", + "summary": "Get bin Domain for mcp server", "tags": [ - "Monitor" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "clean monitor datas", - "formatZH": "清空监控数据", - "paramKeys": [] - } + "McpServer" + ] } }, - "/hosts/monitor/search": { + "/mcp/domain/update": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", @@ -11630,19 +13113,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MonitorSearch" + "$ref": "#/definitions/request.McpBindDomainUpdate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/dto.MonitorData" - }, - "type": "array" - } + "description": "OK" } }, "security": [ @@ -11653,19 +13130,33 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load monitor data", + "summary": "Update bind Domain for mcp server", "tags": [ - "Monitor" + "McpServer" ] } }, - "/hosts/monitor/setting": { - "get": { + "/mcp/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.McpServerSearch" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.MonitorSetting" + "$ref": "#/definitions/response.McpServersRes" } } }, @@ -11677,14 +13168,17 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load monitor setting", + "summary": "List mcp servers", "tags": [ - "Monitor" + "McpServer" ] } }, - "/hosts/monitor/setting/update": { + "/mcp/server": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", @@ -11692,7 +13186,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MonitorSettingUpdate" + "$ref": "#/definitions/request.McpServerCreate" } } ], @@ -11709,60 +13203,31 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update monitor setting", + "summary": "Create mcp server", "tags": [ - "Monitor" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "update default monitor [name]-[value]", - "formatZH": "修改默认监控网卡 [name]-[value]", - "paramKeys": [] - } + "McpServer" + ] } }, - "/installed/delete/check/:id": { - "get": { + "/mcp/server/del": { + "post": { "consumes": [ "application/json" ], - "responses": { - "200": { - "description": "OK", + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "items": { - "$ref": "#/definitions/dto.AppResource" - }, - "type": "array" + "$ref": "#/definitions/request.McpServerDelete" } } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } ], - "summary": "Delete runtime", - "tags": [ - "Website" - ] - } - }, - "/logs/system": { - "post": { "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -11773,24 +13238,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load system logs", + "summary": "Delete mcp server", "tags": [ - "Logs" + "McpServer" ] } }, - "/logs/system/files": { - "get": { - "responses": { - "200": { - "description": "OK", + "/mcp/server/op": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/definitions/request.McpServerOperate" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -11800,21 +13273,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Load system log files", + "summary": "Operate mcp server", "tags": [ - "Logs" + "McpServer" ] } }, - "/logs/tasks/executing/count": { - "get": { - "responses": { - "200": { - "description": "OK", + "/mcp/server/update": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "type": "integer" + "$ref": "#/definitions/request.McpServerUpdate" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -11824,33 +13308,22 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get the number of executing tasks", + "summary": "Update mcp server", "tags": [ - "TaskLog" + "McpServer" ] } }, - "/logs/tasks/search": { + "/mount": { "post": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SearchTaskLogReq" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "$ref": "#/definitions/dto.DiskInfo" } } }, @@ -11862,9 +13335,9 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page task logs", + "summary": "system mount", "tags": [ - "TaskLog" + "File" ] } }, @@ -11976,6 +13449,63 @@ const docTemplate = `{ } } }, + "/openresty/https": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.NginxConfigRes" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get default HTTPs status", + "tags": [ + "OpenResty" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.NginxOperateReq" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Operate default HTTPs", + "tags": [ + "OpenResty" + ] + } + }, "/openresty/module/update": { "post": { "consumes": [ @@ -12201,6 +13731,39 @@ const docTemplate = `{ } } }, + "/process/{pid}": { + "get": { + "parameters": [ + { + "description": "PID", + "in": "path", + "name": "pid", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/websocket.PsProcessData" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get Process Info By PID", + "tags": [ + "Process" + ] + } + }, "/record/del": { "post": { "consumes": [ @@ -12667,61 +14230,27 @@ const docTemplate = `{ ] } }, - "/runtimes/php/extensions": { - "post": { + "/runtimes/php/container/:id": { + "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "body", - "name": "request", + "in": "path", + "name": "id", "required": true, - "schema": { - "$ref": "#/definitions/request.PHPExtensionsCreate" - } + "type": "integer" } ], "responses": { "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Create Extensions", - "tags": [ - "PHP Extensions" - ] - } - }, - "/runtimes/php/extensions/del": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, + "description": "OK", "schema": { - "$ref": "#/definitions/request.PHPExtensionsDelete" + "$ref": "#/definitions/request.PHPContainerConfig" } } - ], - "responses": { - "200": { - "description": "OK" - } }, "security": [ { @@ -12731,13 +14260,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete Extensions", + "summary": "Get PHP container config", "tags": [ - "PHP Extensions" + "Runtime" ] } }, - "/runtimes/php/extensions/install": { + "/runtimes/php/container/update": { "post": { "consumes": [ "application/json" @@ -12749,7 +14278,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPExtensionInstallReq" + "$ref": "#/definitions/request.PHPContainerConfig" } } ], @@ -12766,13 +14295,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Install php extension", + "summary": "Update PHP container config", "tags": [ "Runtime" ] } }, - "/runtimes/php/extensions/search": { + "/runtimes/php/extensions": { "post": { "consumes": [ "application/json" @@ -12784,16 +14313,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPExtensionsSearch" + "$ref": "#/definitions/request.PHPExtensionsCreate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -12804,13 +14330,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page Extensions", + "summary": "Create Extensions", "tags": [ "PHP Extensions" ] } }, - "/runtimes/php/extensions/uninstall": { + "/runtimes/php/extensions/del": { "post": { "consumes": [ "application/json" @@ -12822,7 +14348,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPExtensionInstallReq" + "$ref": "#/definitions/request.PHPExtensionsDelete" } } ], @@ -12839,13 +14365,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "UnInstall php extension", + "summary": "Delete Extensions", "tags": [ - "Runtime" + "PHP Extensions" ] } }, - "/runtimes/php/extensions/update": { + "/runtimes/php/extensions/install": { "post": { "consumes": [ "application/json" @@ -12857,7 +14383,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPExtensionsUpdate" + "$ref": "#/definitions/request.PHPExtensionInstallReq" } } ], @@ -12874,13 +14400,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update Extensions", + "summary": "Install php extension", "tags": [ - "PHP Extensions" + "Runtime" ] } }, - "/runtimes/php/file": { + "/runtimes/php/extensions/search": { "post": { "consumes": [ "application/json" @@ -12892,7 +14418,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPFileReq" + "$ref": "#/definitions/request.PHPExtensionsSearch" } } ], @@ -12900,7 +14426,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.FileInfo" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -12912,13 +14438,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get php conf file", + "summary": "Page Extensions", "tags": [ - "Runtime" + "PHP Extensions" ] } }, - "/runtimes/php/fpm/config": { + "/runtimes/php/extensions/uninstall": { "post": { "consumes": [ "application/json" @@ -12930,7 +14456,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FPMConfig" + "$ref": "#/definitions/request.PHPExtensionInstallReq" } } ], @@ -12947,32 +14473,31 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update fpm config", + "summary": "UnInstall php extension", "tags": [ "Runtime" ] } }, - "/runtimes/php/fpm/config/:id": { - "get": { + "/runtimes/php/extensions/update": { + "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "id", + "in": "body", + "name": "request", "required": true, - "type": "integer" + "schema": { + "$ref": "#/definitions/request.PHPExtensionsUpdate" + } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/request.FPMConfig" - } + "description": "OK" } }, "security": [ @@ -12983,13 +14508,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get fpm config", + "summary": "Update Extensions", "tags": [ - "Runtime" + "PHP Extensions" ] } }, - "/runtimes/php/update": { + "/runtimes/php/file": { "post": { "consumes": [ "application/json" @@ -13001,13 +14526,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPFileUpdate" + "$ref": "#/definitions/request.PHPFileReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.FileInfo" + } } }, "security": [ @@ -13018,31 +14546,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update php conf file", + "summary": "Get php conf file", "tags": [ "Runtime" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "websites", - "input_column": "id", - "input_value": "websiteId", - "isList": false, - "output_column": "primary_domain", - "output_value": "domain" - } - ], - "bodyKeys": [ - "websiteId" - ], - "formatEN": "Nginx conf update [domain]", - "formatZH": "php 配置修改 [domain]", - "paramKeys": [] - } + ] } }, - "/runtimes/search": { + "/runtimes/php/fpm/config": { "post": { "consumes": [ "application/json" @@ -13054,16 +14564,13 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.RuntimeSearch" + "$ref": "#/definitions/request.FPMConfig" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -13074,13 +14581,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "List runtimes", + "summary": "Update fpm config", "tags": [ "Runtime" ] } }, - "/runtimes/supervisor/process/:id": { + "/runtimes/php/fpm/config/:id": { "get": { "consumes": [ "application/json" @@ -13098,10 +14605,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/response.SupervisorProcessConfig" - }, - "type": "array" + "$ref": "#/definitions/request.FPMConfig" } } }, @@ -13113,33 +14617,32 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Get supervisor process", + "summary": "Get fpm config", "tags": [ "Runtime" ] } }, - "/runtimes/supervisor/process/file/operate": { - "post": { + "/runtimes/php/fpm/status/:id": { + "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "body", - "name": "request", + "in": "path", + "name": "id", "required": true, - "schema": { - "$ref": "#/definitions/request.PHPSupervisorProcessFileReq" - } + "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "additionalProperties": true, + "type": "object" } } }, @@ -13151,13 +14654,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Operate supervisor process file", + "summary": "Get PHP runtime status", "tags": [ "Runtime" ] } }, - "/runtimes/supervisor/process/operate": { + "/runtimes/php/update": { "post": { "consumes": [ "application/json" @@ -13169,7 +14672,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPSupervisorProcessConfig" + "$ref": "#/definitions/request.PHPFileUpdate" } } ], @@ -13186,34 +14689,31 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Operate supervisor process", + "summary": "Update php conf file", "tags": [ "Runtime" - ] - } - }, - "/runtimes/sync": { - "post": { - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - } ], - "summary": "Sync runtime status", - "tags": [ - "Runtime" - ] + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "websites", + "input_column": "id", + "input_value": "websiteId", + "isList": false, + "output_column": "primary_domain", + "output_value": "domain" + } + ], + "bodyKeys": [ + "websiteId" + ], + "formatEN": "Nginx conf update [domain]", + "formatZH": "php 配置修改 [domain]", + "paramKeys": [] + } } }, - "/runtimes/update": { + "/runtimes/remark": { "post": { "consumes": [ "application/json" @@ -13225,7 +14725,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.RuntimeUpdate" + "$ref": "#/definitions/request.RuntimeRemark" } } ], @@ -13242,22 +14742,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update runtime", + "summary": "Update runtime remark", "tags": [ "Runtime" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Update runtime [name]", - "formatZH": "更新运行环境 [name]", - "paramKeys": [] - } + ] } }, - "/script": { + "/runtimes/search": { "post": { "consumes": [ "application/json" @@ -13269,13 +14760,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ScriptOperate" + "$ref": "#/definitions/request.RuntimeSearch" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -13286,40 +14780,35 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Add script", + "summary": "List runtimes", "tags": [ - "ScriptLibrary" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "add script [name]", - "formatZH": "添加脚本库脚本 [name]", - "paramKeys": [] - } + "Runtime" + ] } }, - "/script/del": { - "post": { + "/runtimes/supervisor/process/:id": { + "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "body", - "name": "request", + "in": "path", + "name": "id", "required": true, - "schema": { - "$ref": "#/definitions/dto.OperateByIDs" - } + "type": "integer" } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/response.SupervisorProcessConfig" + }, + "type": "array" + } } }, "security": [ @@ -13330,31 +14819,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete script", + "summary": "Get supervisor process", "tags": [ - "ScriptLibrary" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "script_librarys", - "input_column": "id", - "input_value": "ids", - "isList": true, - "output_column": "name", - "output_value": "names" - } - ], - "bodyKeys": [ - "ids" - ], - "formatEN": "delete script [names]", - "formatZH": "删除脚本库脚本 [names]", - "paramKeys": [] - } + "Runtime" + ] } }, - "/script/search": { + "/runtimes/supervisor/process/file/operate": { "post": { "consumes": [ "application/json" @@ -13366,7 +14837,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchPageWithGroup" + "$ref": "#/definitions/request.PHPSupervisorProcessFileReq" } } ], @@ -13374,7 +14845,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "type": "string" } } }, @@ -13386,13 +14857,13 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Page script", + "summary": "Operate supervisor process file", "tags": [ - "ScriptLibrary" + "Runtime" ] } }, - "/script/update": { + "/runtimes/supervisor/process/operate": { "post": { "consumes": [ "application/json" @@ -13404,7 +14875,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ScriptOperate" + "$ref": "#/definitions/request.PHPSupervisorProcessConfig" } } ], @@ -13421,65 +14892,34 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update script", + "summary": "Operate supervisor process", "tags": [ - "ScriptLibrary" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "update script [name]", - "formatZH": "更新脚本库脚本 [name]", - "paramKeys": [] - } + "Runtime" + ] } }, - "/settings/api/config/generate/key": { + "/runtimes/sync": { "post": { "consumes": [ "application/json" ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ { "ApiKeyAuth": [] - }, - { - "Timestamp": [] } ], - "summary": "generate api key", + "summary": "Sync runtime status", "tags": [ - "System Setting" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "generate api key", - "formatZH": "生成 API 接口密钥", - "paramKeys": [] - } + "Runtime" + ] } }, - "/settings/api/config/update": { + "/runtimes/update": { "post": { "consumes": [ "application/json" @@ -13491,7 +14931,7 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ApiInterfaceConfig" + "$ref": "#/definitions/request.RuntimeUpdate" } } ], @@ -13508,17 +14948,17 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Update api config", + "summary": "Update runtime", "tags": [ - "System Setting" + "Runtime" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "ipWhiteList" + "name" ], - "formatEN": "update api config =\u003e IP White List: [ipWhiteList]", - "formatZH": "更新 API 接口配置 =\u003e IP 白名单: [ipWhiteList]", + "formatEN": "Update runtime [name]", + "formatZH": "更新运行环境 [name]", "paramKeys": [] } } @@ -13547,6 +14987,39 @@ const docTemplate = `{ ] } }, + "/settings/get/{key}": { + "get": { + "parameters": [ + { + "description": "key", + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.SettingInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load system setting by key", + "tags": [ + "System Setting" + ] + } + }, "/settings/search": { "post": { "responses": { @@ -14010,6 +15483,75 @@ const docTemplate = `{ ] } }, + "/settings/ssh": { + "post": { + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Save local conn info", + "tags": [ + "System Setting" + ] + } + }, + "/settings/ssh/check/info": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "bool" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Check local conn info", + "tags": [ + "System Setting" + ] + } + }, + "/settings/ssh/conn": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.SSHConnData" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load local conn", + "tags": [ + "System Setting" + ] + } + }, "/settings/update": { "post": { "consumes": [ @@ -14403,44 +15945,6 @@ const docTemplate = `{ } } }, - "/toolbox/clam/record/log": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.ClamLogReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load clam record detail", - "tags": [ - "Clam" - ] - } - }, "/toolbox/clam/record/search": { "post": { "consumes": [ @@ -15599,6 +17103,33 @@ const docTemplate = `{ } } }, + "/user/group": { + "post": { + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.UserGroupResponse" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "system user and group", + "tags": [ + "File" + ] + } + }, "/websites": { "post": { "consumes": [ @@ -15852,7 +17383,98 @@ const docTemplate = `{ } } }, - "/websites/acme/del": { + "/websites/acme/del": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.WebsiteResourceReq" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Delete website acme account", + "tags": [ + "Website Acme" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "website_acme_accounts", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "email", + "output_value": "email" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "Delete website acme [email]", + "formatZH": "删除网站 acme [email]", + "paramKeys": [] + } + } + }, + "/websites/acme/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.PageInfo" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Page website acme accounts", + "tags": [ + "Website Acme" + ] + } + }, + "/websites/acme/update": { "post": { "consumes": [ "application/json" @@ -15864,13 +17486,16 @@ const docTemplate = `{ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.WebsiteResourceReq" + "$ref": "#/definitions/request.WebsiteAcmeAccountUpdate" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.WebsiteAcmeAccountDTO" + } } }, "security": [ @@ -15881,7 +17506,7 @@ const docTemplate = `{ "Timestamp": [] } ], - "summary": "Delete website acme account", + "summary": "Update website acme account", "tags": [ "Website Acme" ], @@ -15899,50 +17524,12 @@ const docTemplate = `{ "bodyKeys": [ "id" ], - "formatEN": "Delete website acme [email]", - "formatZH": "删除网站 acme [email]", + "formatEN": "Update acme [email]", + "formatZH": "更新 acme [email]", "paramKeys": [] } } }, - "/websites/acme/search": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.PageInfo" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Page website acme accounts", - "tags": [ - "Website Acme" - ] - } - }, "/websites/auths": { "post": { "consumes": [ @@ -16554,6 +18141,41 @@ const docTemplate = `{ } } }, + "/websites/crosssite": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.CrossSiteAccessOp" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Operate Cross Site Access", + "tags": [ + "Website" + ] + } + }, "/websites/databases": { "get": { "consumes": [ @@ -17307,6 +18929,41 @@ const docTemplate = `{ } } }, + "/websites/exec/composer": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.ExecComposerReq" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Exec Composer", + "tags": [ + "Website" + ] + } + }, "/websites/lbs": { "get": { "consumes": [ @@ -19184,6 +20841,9 @@ const docTemplate = `{ "crossVersionUpdate": { "type": "boolean" }, + "deprecated": { + "type": "number" + }, "description": { "$ref": "#/definitions/dto.Locale" }, @@ -19326,6 +20986,9 @@ const docTemplate = `{ "type": "string" }, "type": "array" + }, + "taskID": { + "type": "string" } }, "required": [ @@ -19410,7 +21073,11 @@ const docTemplate = `{ "enum": [ "mysql", "mariadb", - "postgresql" + "postgresql", + "redis", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" }, @@ -19426,6 +21093,21 @@ const docTemplate = `{ ], "type": "object" }, + "dto.ChangeGroup": { + "properties": { + "groupID": { + "type": "integer" + }, + "id": { + "type": "integer" + } + }, + "required": [ + "groupID", + "id" + ], + "type": "object" + }, "dto.ChangePasswd": { "properties": { "passwd": { @@ -19437,6 +21119,17 @@ const docTemplate = `{ }, "type": "object" }, + "dto.ChangeQuicks": { + "properties": { + "quicks": { + "items": { + "$ref": "#/definitions/dto.QuickJump" + }, + "type": "array" + } + }, + "type": "object" + }, "dto.ChangeRedisPass": { "properties": { "database": { @@ -19479,6 +21172,9 @@ const docTemplate = `{ "alertCount": { "type": "integer" }, + "alertMethod": { + "type": "string" + }, "alertTitle": { "type": "string" }, @@ -19516,9 +21212,6 @@ const docTemplate = `{ }, "removeInfected": { "type": "boolean" - }, - "removeRecord": { - "type": "boolean" } }, "required": [ @@ -19540,20 +21233,6 @@ const docTemplate = `{ ], "type": "object" }, - "dto.ClamLogReq": { - "properties": { - "clamName": { - "type": "string" - }, - "recordName": { - "type": "string" - }, - "tail": { - "type": "string" - } - }, - "type": "object" - }, "dto.ClamLogSearch": { "properties": { "clamID": { @@ -19570,6 +21249,9 @@ const docTemplate = `{ }, "startTime": { "type": "string" + }, + "status": { + "type": "string" } }, "required": [ @@ -19583,6 +21265,9 @@ const docTemplate = `{ "alertCount": { "type": "integer" }, + "alertMethod": { + "type": "string" + }, "alertTitle": { "type": "string" }, @@ -19704,6 +21389,9 @@ const docTemplate = `{ }, "dto.CommonBackup": { "properties": { + "description": { + "type": "string" + }, "detailName": { "type": "string" }, @@ -19726,7 +21414,10 @@ const docTemplate = `{ "mariadb", "redis", "website", - "postgresql" + "postgresql", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" } @@ -19766,7 +21457,10 @@ const docTemplate = `{ "mariadb", "redis", "website", - "postgresql" + "postgresql", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" } @@ -19816,6 +21510,9 @@ const docTemplate = `{ }, "dto.ComposeOperation": { "properties": { + "force": { + "type": "boolean" + }, "name": { "type": "string" }, @@ -19823,6 +21520,7 @@ const docTemplate = `{ "enum": [ "up", "start", + "restart", "stop", "down", "delete" @@ -19937,6 +21635,9 @@ const docTemplate = `{ }, "pause": { "type": "boolean" + }, + "taskID": { + "type": "string" } }, "required": [ @@ -20132,6 +21833,17 @@ const docTemplate = `{ ], "type": "object" }, + "dto.ContainerOptions": { + "properties": { + "name": { + "type": "string" + }, + "state": { + "type": "string" + } + }, + "type": "object" + }, "dto.ContainerPrune": { "properties": { "pruneType": { @@ -20144,6 +21856,9 @@ const docTemplate = `{ ], "type": "string" }, + "taskID": { + "type": "string" + }, "withTagAll": { "type": "boolean" } @@ -20153,17 +21868,6 @@ const docTemplate = `{ ], "type": "object" }, - "dto.ContainerPruneReport": { - "properties": { - "deletedNumber": { - "type": "integer" - }, - "spaceReclaimed": { - "type": "integer" - } - }, - "type": "object" - }, "dto.ContainerRename": { "properties": { "name": { @@ -20269,8 +21973,11 @@ const docTemplate = `{ "image": { "type": "string" }, - "name": { - "type": "string" + "names": { + "items": { + "type": "string" + }, + "type": "array" }, "taskID": { "type": "string" @@ -20278,7 +21985,42 @@ const docTemplate = `{ }, "required": [ "image", - "name" + "names" + ], + "type": "object" + }, + "dto.CreateRootCert": { + "properties": { + "description": { + "type": "string" + }, + "encryptionMode": { + "enum": [ + "rsa", + "ed25519", + "ecdsa", + "dsa" + ], + "type": "string" + }, + "mode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "passPhrase": { + "type": "string" + }, + "privateKey": { + "type": "string" + }, + "publicKey": { + "type": "string" + } + }, + "required": [ + "encryptionMode" ], "type": "object" }, @@ -20287,6 +22029,9 @@ const docTemplate = `{ "cleanData": { "type": "boolean" }, + "cleanRemoteData": { + "type": "boolean" + }, "ids": { "items": { "type": "integer" @@ -20304,6 +22049,9 @@ const docTemplate = `{ "cleanData": { "type": "boolean" }, + "cleanRemoteData": { + "type": "boolean" + }, "cronjobID": { "type": "integer" }, @@ -20316,11 +22064,25 @@ const docTemplate = `{ ], "type": "object" }, - "dto.CronjobCreate": { + "dto.CronjobImport": { + "properties": { + "cronjobs": { + "items": { + "$ref": "#/definitions/dto.CronjobTrans" + }, + "type": "array" + } + }, + "type": "object" + }, + "dto.CronjobOperate": { "properties": { "alertCount": { "type": "integer" }, + "alertMethod": { + "type": "string" + }, "alertTitle": { "type": "string" }, @@ -20348,6 +22110,15 @@ const docTemplate = `{ "executor": { "type": "string" }, + "groupID": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "ignoreErr": { + "type": "boolean" + }, "isDir": { "type": "boolean" }, @@ -20358,15 +22129,25 @@ const docTemplate = `{ "minimum": 1, "type": "integer" }, + "retryTimes": { + "minimum": 0, + "type": "integer" + }, "script": { "type": "string" }, + "scriptID": { + "type": "integer" + }, "scriptMode": { "type": "string" }, "secret": { "type": "string" }, + "snapshotRule": { + "$ref": "#/definitions/dto.SnapshotRule" + }, "sourceAccountIDs": { "type": "string" }, @@ -20379,6 +22160,10 @@ const docTemplate = `{ "specCustom": { "type": "boolean" }, + "timeout": { + "minimum": 1, + "type": "integer" + }, "type": { "type": "string" }, @@ -20399,21 +22184,6 @@ const docTemplate = `{ ], "type": "object" }, - "dto.CronjobDownload": { - "properties": { - "backupAccountID": { - "type": "integer" - }, - "recordID": { - "type": "integer" - } - }, - "required": [ - "backupAccountID", - "recordID" - ], - "type": "object" - }, "dto.CronjobSpec": { "properties": { "spec": { @@ -20425,17 +22195,23 @@ const docTemplate = `{ ], "type": "object" }, - "dto.CronjobUpdate": { + "dto.CronjobTrans": { "properties": { "alertCount": { "type": "integer" }, - "alertTitle": { + "alertMethod": { "type": "string" }, - "appID": { + "alertTitle": { "type": "string" }, + "apps": { + "items": { + "$ref": "#/definitions/dto.TransHelper" + }, + "type": "array" + }, "command": { "type": "string" }, @@ -20443,13 +22219,16 @@ const docTemplate = `{ "type": "string" }, "dbName": { - "type": "string" + "items": { + "$ref": "#/definitions/dto.TransHelper" + }, + "type": "array" }, "dbType": { "type": "string" }, - "downloadAccountID": { - "type": "integer" + "downloadAccount": { + "type": "string" }, "exclusionRules": { "type": "string" @@ -20457,9 +22236,12 @@ const docTemplate = `{ "executor": { "type": "string" }, - "id": { + "groupID": { "type": "integer" }, + "ignoreErr": { + "type": "boolean" + }, "isDir": { "type": "boolean" }, @@ -20467,7 +22249,9 @@ const docTemplate = `{ "type": "string" }, "retainCopies": { - "minimum": 1, + "type": "integer" + }, + "retryTimes": { "type": "integer" }, "script": { @@ -20476,12 +22260,21 @@ const docTemplate = `{ "scriptMode": { "type": "string" }, - "secret": { + "scriptName": { "type": "string" }, - "sourceAccountIDs": { + "secret": { "type": "string" }, + "snapshotRule": { + "$ref": "#/definitions/dto.SnapshotTransHelper" + }, + "sourceAccounts": { + "items": { + "type": "string" + }, + "type": "array" + }, "sourceDir": { "type": "string" }, @@ -20491,6 +22284,9 @@ const docTemplate = `{ "specCustom": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -20500,16 +22296,13 @@ const docTemplate = `{ "user": { "type": "string" }, - "website": { - "type": "string" + "websites": { + "items": { + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "name", - "spec", - "type" - ], "type": "object" }, "dto.CronjobUpdateStatus": { @@ -20554,7 +22347,10 @@ const docTemplate = `{ "mysql", "mariadb", "postgresql", - "redis" + "redis", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" } @@ -20591,12 +22387,6 @@ const docTemplate = `{ "ipv6": { "type": "boolean" }, - "isActive": { - "type": "boolean" - }, - "isExist": { - "type": "boolean" - }, "isSwarm": { "type": "boolean" }, @@ -20676,6 +22466,12 @@ const docTemplate = `{ "platformVersion": { "type": "string" }, + "quickJump": { + "items": { + "$ref": "#/definitions/dto.QuickJump" + }, + "type": "array" + }, "systemProxy": { "type": "string" }, @@ -20747,6 +22543,15 @@ const docTemplate = `{ "memoryAvailable": { "type": "integer" }, + "memoryCache": { + "type": "integer" + }, + "memoryFree": { + "type": "integer" + }, + "memoryShard": { + "type": "integer" + }, "memoryTotal": { "type": "integer" }, @@ -20873,6 +22678,9 @@ const docTemplate = `{ "ssl": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -20951,6 +22759,9 @@ const docTemplate = `{ "ssl": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -21073,6 +22884,9 @@ const docTemplate = `{ "ssl": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -21331,6 +23145,9 @@ const docTemplate = `{ "enablePing" ], "type": "string" + }, + "withDockerRestart": { + "type": "boolean" } }, "required": [ @@ -21542,43 +23359,6 @@ const docTemplate = `{ }, "type": "object" }, - "dto.GenerateLoad": { - "properties": { - "encryptionMode": { - "enum": [ - "rsa", - "ed25519", - "ecdsa", - "dsa" - ], - "type": "string" - } - }, - "required": [ - "encryptionMode" - ], - "type": "object" - }, - "dto.GenerateSSH": { - "properties": { - "encryptionMode": { - "enum": [ - "rsa", - "ed25519", - "ecdsa", - "dsa" - ], - "type": "string" - }, - "password": { - "type": "string" - } - }, - "required": [ - "encryptionMode" - ], - "type": "object" - }, "dto.GroupCreate": { "properties": { "id": { @@ -21679,7 +23459,7 @@ const docTemplate = `{ "type": "boolean" }, "size": { - "type": "string" + "type": "integer" }, "tags": { "items": { @@ -21780,14 +23560,12 @@ const docTemplate = `{ "type": "integer" }, "password": { - "maxLength": 256, "type": "string" }, "protocol": { "type": "string" }, "username": { - "maxLength": 256, "type": "string" } }, @@ -21842,6 +23620,21 @@ const docTemplate = `{ ], "type": "object" }, + "dto.LoadRedisStatus": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, "dto.Locale": { "properties": { "en": { @@ -21850,6 +23643,9 @@ const docTemplate = `{ "ja": { "type": "string" }, + "ko": { + "type": "string" + }, "ms": { "type": "string" }, @@ -21859,6 +23655,9 @@ const docTemplate = `{ "ru": { "type": "string" }, + "tr": { + "type": "string" + }, "zh": { "type": "string" }, @@ -22037,7 +23836,8 @@ const docTemplate = `{ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" } @@ -22060,7 +23860,8 @@ const docTemplate = `{ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" } @@ -22126,7 +23927,8 @@ const docTemplate = `{ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" } @@ -22335,7 +24137,8 @@ const docTemplate = `{ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" }, @@ -22652,6 +24455,17 @@ const docTemplate = `{ ], "type": "object" }, + "dto.OperateByIDs": { + "properties": { + "ids": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, "dto.OperateByType": { "properties": { "type": { @@ -22774,6 +24588,12 @@ const docTemplate = `{ }, "dto.PageCronjob": { "properties": { + "groupIDs": { + "items": { + "type": "integer" + }, + "type": "array" + }, "info": { "type": "string" }, @@ -22808,6 +24628,43 @@ const docTemplate = `{ ], "type": "object" }, + "dto.PageImage": { + "properties": { + "name": { + "type": "string" + }, + "order": { + "enum": [ + "null", + "ascending", + "descending" + ], + "type": "string" + }, + "orderBy": { + "enum": [ + "size", + "tags", + "createdAt", + "isUsed" + ], + "type": "string" + }, + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer" + } + }, + "required": [ + "order", + "orderBy", + "page", + "pageSize" + ], + "type": "object" + }, "dto.PageInfo": { "properties": { "page": { @@ -23019,7 +24876,8 @@ const docTemplate = `{ }, "type": { "enum": [ - "postgresql" + "postgresql", + "postgresql-cluster" ], "type": "string" } @@ -23041,7 +24899,8 @@ const docTemplate = `{ }, "type": { "enum": [ - "postgresql" + "postgresql", + "postgresql-cluster" ], "type": "string" } @@ -23106,7 +24965,8 @@ const docTemplate = `{ }, "type": { "enum": [ - "postgresql" + "postgresql", + "postgresql-cluster" ], "type": "string" } @@ -23118,6 +24978,32 @@ const docTemplate = `{ ], "type": "object" }, + "dto.QuickJump": { + "properties": { + "detail": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "isShow": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "recommend": { + "type": "integer" + }, + "router": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "dto.RecordFileSize": { "properties": { "id": { @@ -23219,6 +25105,13 @@ const docTemplate = `{ "database": { "type": "string" }, + "dbType": { + "enum": [ + "redis", + "redis-cluster" + ], + "type": "string" + }, "save": { "type": "string" }, @@ -23232,6 +25125,7 @@ const docTemplate = `{ }, "required": [ "database", + "dbType", "type" ], "type": "object" @@ -23241,6 +25135,13 @@ const docTemplate = `{ "database": { "type": "string" }, + "dbType": { + "enum": [ + "redis", + "redis-cluster" + ], + "type": "string" + }, "maxclients": { "type": "string" }, @@ -23252,7 +25153,8 @@ const docTemplate = `{ } }, "required": [ - "database" + "database", + "dbType" ], "type": "object" }, @@ -23373,36 +25275,41 @@ const docTemplate = `{ }, "type": "object" }, - "dto.SSHHistory": { + "dto.SSHConnData": { "properties": { - "address": { - "type": "string" - }, - "area": { + "addr": { "type": "string" }, "authMode": { + "enum": [ + "password", + "key" + ], "type": "string" }, - "date": { - "type": "string" - }, - "dateStr": { + "passPhrase": { "type": "string" }, - "message": { + "password": { "type": "string" }, "port": { - "type": "string" + "maximum": 65535, + "minimum": 1, + "type": "integer" }, - "status": { + "privateKey": { "type": "string" }, "user": { "type": "string" } }, + "required": [ + "addr", + "port", + "user" + ], "type": "object" }, "dto.SSHInfo": { @@ -23410,6 +25317,9 @@ const docTemplate = `{ "autoStart": { "type": "boolean" }, + "currentUser": { + "type": "string" + }, "isActive": { "type": "boolean" }, @@ -23440,26 +25350,6 @@ const docTemplate = `{ }, "type": "object" }, - "dto.SSHLog": { - "properties": { - "failedCount": { - "type": "integer" - }, - "logs": { - "items": { - "$ref": "#/definitions/dto.SSHHistory" - }, - "type": "array" - }, - "successfulCount": { - "type": "integer" - }, - "totalCount": { - "type": "integer" - } - }, - "type": "object" - }, "dto.SSHUpdate": { "properties": { "key": { @@ -23477,6 +25367,17 @@ const docTemplate = `{ ], "type": "object" }, + "dto.ScriptOptions": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "dto.SearchByFilter": { "properties": { "filter": { @@ -23716,7 +25617,7 @@ const docTemplate = `{ "ntpSite": { "type": "string" }, - "snapshotIgnore": { + "systemIP": { "type": "string" }, "systemVersion": { @@ -23783,6 +25684,12 @@ const docTemplate = `{ "id": { "type": "integer" }, + "ignoreFiles": { + "items": { + "type": "string" + }, + "type": "array" + }, "interruptStep": { "type": "string" }, @@ -23804,6 +25711,12 @@ const docTemplate = `{ "taskID": { "type": "string" }, + "timeout": { + "type": "integer" + }, + "withDockerConf": { + "type": "boolean" + }, "withLoginLog": { "type": "boolean" }, @@ -23840,12 +25753,21 @@ const docTemplate = `{ }, "type": "array" }, + "ignoreFiles": { + "items": { + "type": "string" + }, + "type": "array" + }, "panelData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, + "withDockerConf": { + "type": "boolean" + }, "withLoginLog": { "type": "boolean" }, @@ -23905,6 +25827,34 @@ const docTemplate = `{ ], "type": "object" }, + "dto.SnapshotRule": { + "properties": { + "ignoreAppIDs": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "withImage": { + "type": "boolean" + } + }, + "type": "object" + }, + "dto.SnapshotTransHelper": { + "properties": { + "ignoreApps": { + "items": { + "$ref": "#/definitions/dto.TransHelper" + }, + "type": "array" + }, + "withImage": { + "type": "boolean" + } + }, + "type": "object" + }, "dto.SwapHelper": { "properties": { "isNew": { @@ -23942,6 +25892,17 @@ const docTemplate = `{ }, "type": "object" }, + "dto.TransHelper": { + "properties": { + "detailName": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "dto.UpdateByFile": { "properties": { "file": { @@ -24006,6 +25967,17 @@ const docTemplate = `{ ], "type": "object" }, + "dto.UploadForRecover": { + "properties": { + "filePath": { + "type": "string" + }, + "targetDir": { + "type": "string" + } + }, + "type": "object" + }, "dto.VolumeCreate": { "properties": { "driver": { @@ -24236,6 +26208,29 @@ const docTemplate = `{ }, "type": "object" }, + "model.AppIgnoreUpgrade": { + "properties": { + "appDetailID": { + "type": "integer" + }, + "appID": { + "type": "integer" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "scope": { + "type": "string" + }, + "updatedAt": { + "type": "string" + } + }, + "type": "object" + }, "model.AppInstall": { "properties": { "app": { @@ -24262,6 +26257,9 @@ const docTemplate = `{ "env": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "httpPort": { "type": "integer" }, @@ -24365,6 +26363,9 @@ const docTemplate = `{ "port": { "type": "string" }, + "remark": { + "type": "string" + }, "resource": { "type": "string" }, @@ -24424,6 +26425,9 @@ const docTemplate = `{ "expireDate": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "ftpId": { "type": "integer" }, @@ -24489,6 +26493,9 @@ const docTemplate = `{ }, "model.WebsiteAcmeAccount": { "properties": { + "caDirURL": { + "type": "string" + }, "createdAt": { "type": "string" }, @@ -24515,6 +26522,9 @@ const docTemplate = `{ }, "url": { "type": "string" + }, + "useProxy": { + "type": "boolean" } }, "type": "object" @@ -24615,6 +26625,9 @@ const docTemplate = `{ "keyType": { "type": "string" }, + "masterSslId": { + "type": "integer" + }, "message": { "type": "string" }, @@ -24624,6 +26637,9 @@ const docTemplate = `{ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "organization": { "type": "string" }, @@ -24642,6 +26658,9 @@ const docTemplate = `{ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -24683,6 +26702,28 @@ const docTemplate = `{ ], "type": "object" }, + "request.AppIgnoreUpgradeReq": { + "properties": { + "appDetailID": { + "type": "integer" + }, + "appID": { + "type": "integer" + }, + "scope": { + "enum": [ + "all", + "version" + ], + "type": "string" + } + }, + "required": [ + "appID", + "scope" + ], + "type": "object" + }, "request.AppInstallCreate": { "properties": { "advanced": { @@ -24728,12 +26769,24 @@ const docTemplate = `{ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, "services": { "additionalProperties": { "type": "string" }, "type": "object" }, + "specifyIP": { + "type": "string" + }, "taskID": { "type": "string" }, @@ -24750,25 +26803,6 @@ const docTemplate = `{ ], "type": "object" }, - "request.AppInstalledIgnoreUpgrade": { - "properties": { - "detailID": { - "type": "integer" - }, - "operate": { - "enum": [ - "cancel", - "ignore" - ], - "type": "string" - } - }, - "required": [ - "detailID", - "operate" - ], - "type": "object" - }, "request.AppInstalledInfo": { "properties": { "key": { @@ -24806,6 +26840,9 @@ const docTemplate = `{ "dockerCompose": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "forceDelete": { "type": "boolean" }, @@ -24909,6 +26946,18 @@ const docTemplate = `{ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, + "specifyIP": { + "type": "string" + }, "type": { "type": "string" }, @@ -24958,20 +27007,30 @@ const docTemplate = `{ ], "type": "object" }, - "request.AppstoreUpdate": { + "request.ChangeDatabase": { "properties": { - "defaultDomain": { + "databaseID": { + "type": "integer" + }, + "databaseType": { "type": "string" + }, + "websiteID": { + "type": "integer" } }, + "required": [ + "websiteID" + ], "type": "object" }, - "request.ChangeDatabase": { + "request.CrossSiteAccessOp": { "properties": { - "databaseID": { - "type": "integer" - }, - "databaseType": { + "operation": { + "enum": [ + "Enable", + "Disable" + ], "type": "string" }, "websiteID": { @@ -24979,8 +27038,7 @@ const docTemplate = `{ } }, "required": [ - "databaseID", - "databaseType", + "operation", "websiteID" ], "type": "object" @@ -25017,15 +27075,115 @@ const docTemplate = `{ ], "type": "object" }, + "request.DiskMountRequest": { + "properties": { + "autoMount": { + "type": "boolean" + }, + "device": { + "type": "string" + }, + "filesystem": { + "enum": [ + "ext4", + "xfs" + ], + "type": "string" + }, + "mountPoint": { + "type": "string" + } + }, + "required": [ + "device", + "filesystem", + "mountPoint" + ], + "type": "object" + }, + "request.DiskPartitionRequest": { + "properties": { + "autoMount": { + "type": "boolean" + }, + "device": { + "type": "string" + }, + "filesystem": { + "enum": [ + "ext4", + "xfs" + ], + "type": "string" + }, + "label": { + "type": "string" + }, + "mountPoint": { + "type": "string" + } + }, + "required": [ + "device", + "filesystem", + "mountPoint" + ], + "type": "object" + }, + "request.DiskUnmountRequest": { + "properties": { + "mountPoint": { + "type": "string" + } + }, + "required": [ + "mountPoint" + ], + "type": "object" + }, "request.Environment": { "properties": { "key": { "type": "string" }, - "value": { + "value": { + "type": "string" + } + }, + "type": "object" + }, + "request.ExecComposerReq": { + "properties": { + "command": { + "type": "string" + }, + "dir": { + "type": "string" + }, + "extCommand": { + "type": "string" + }, + "mirror": { + "type": "string" + }, + "taskID": { + "type": "string" + }, + "user": { "type": "string" + }, + "websiteID": { + "type": "integer" } }, + "required": [ + "command", + "dir", + "mirror", + "taskID", + "user", + "websiteID" + ], "type": "object" }, "request.ExposedPort": { @@ -25258,6 +27416,12 @@ const docTemplate = `{ "cover": { "type": "boolean" }, + "coverPaths": { + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "type": "string" }, @@ -25323,6 +27487,9 @@ const docTemplate = `{ "properties": { "path": { "type": "string" + }, + "withInit": { + "type": "boolean" } }, "required": [ @@ -25330,6 +27497,20 @@ const docTemplate = `{ ], "type": "object" }, + "request.FilePathsCheck": { + "properties": { + "paths": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "paths" + ], + "type": "object" + }, "request.FileReadByLineReq": { "properties": { "ID": { @@ -25536,6 +27717,199 @@ const docTemplate = `{ ], "type": "object" }, + "request.McpBindDomain": { + "properties": { + "domain": { + "type": "string" + }, + "ipList": { + "type": "string" + }, + "sslID": { + "type": "integer" + } + }, + "required": [ + "domain" + ], + "type": "object" + }, + "request.McpBindDomainUpdate": { + "properties": { + "ipList": { + "type": "string" + }, + "sslID": { + "type": "integer" + }, + "websiteID": { + "type": "integer" + } + }, + "required": [ + "websiteID" + ], + "type": "object" + }, + "request.McpServerCreate": { + "properties": { + "baseUrl": { + "type": "string" + }, + "command": { + "type": "string" + }, + "containerName": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "hostIP": { + "type": "string" + }, + "name": { + "type": "string" + }, + "outputTransport": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "ssePath": { + "type": "string" + }, + "streamableHttpPath": { + "type": "string" + }, + "type": { + "type": "string" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" + }, + "type": "array" + } + }, + "required": [ + "command", + "name", + "outputTransport", + "port", + "type" + ], + "type": "object" + }, + "request.McpServerDelete": { + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "request.McpServerOperate": { + "properties": { + "id": { + "type": "integer" + }, + "operate": { + "type": "string" + } + }, + "required": [ + "id", + "operate" + ], + "type": "object" + }, + "request.McpServerSearch": { + "properties": { + "name": { + "type": "string" + }, + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer" + }, + "sync": { + "type": "boolean" + } + }, + "required": [ + "page", + "pageSize" + ], + "type": "object" + }, + "request.McpServerUpdate": { + "properties": { + "baseUrl": { + "type": "string" + }, + "command": { + "type": "string" + }, + "containerName": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "hostIP": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "outputTransport": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "ssePath": { + "type": "string" + }, + "streamableHttpPath": { + "type": "string" + }, + "type": { + "type": "string" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" + }, + "type": "array" + } + }, + "required": [ + "command", + "id", + "name", + "outputTransport", + "port", + "type" + ], + "type": "object" + }, "request.NewAppInstall": { "properties": { "advanced": { @@ -25581,6 +27955,18 @@ const docTemplate = `{ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, + "specifyIP": { + "type": "string" + }, "type": { "type": "string" }, @@ -25630,8 +28016,6 @@ const docTemplate = `{ } }, "required": [ - "extends", - "return", "websiteID" ], "type": "object" @@ -25766,6 +28150,21 @@ const docTemplate = `{ ], "type": "object" }, + "request.NginxOperateReq": { + "properties": { + "operate": { + "enum": [ + "enable", + "disable" + ], + "type": "string" + } + }, + "required": [ + "operate" + ], + "type": "object" + }, "request.NginxPathAuthUpdate": { "properties": { "name": { @@ -25991,29 +28390,61 @@ const docTemplate = `{ "properties": { "disableFunctions": { "items": { - "type": "string" + "type": "string" + }, + "type": "array" + }, + "id": { + "type": "integer" + }, + "params": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "scope": { + "type": "string" + }, + "uploadMaxSize": { + "type": "string" + } + }, + "required": [ + "id", + "scope" + ], + "type": "object" + }, + "request.PHPContainerConfig": { + "properties": { + "containerName": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "exposedPorts": { + "items": { + "$ref": "#/definitions/request.ExposedPort" }, "type": "array" }, "id": { "type": "integer" }, - "params": { - "additionalProperties": { - "type": "string" + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" }, - "type": "object" - }, - "scope": { - "type": "string" - }, - "uploadMaxSize": { - "type": "string" + "type": "array" } }, "required": [ - "id", - "scope" + "id" ], "type": "object" }, @@ -26130,6 +28561,12 @@ const docTemplate = `{ }, "request.PHPSupervisorProcessConfig": { "properties": { + "autoRestart": { + "type": "string" + }, + "autoStart": { + "type": "string" + }, "command": { "type": "string" }, @@ -26236,6 +28673,17 @@ const docTemplate = `{ ], "type": "object" }, + "request.ReqWithID": { + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, "request.RuntimeCreate": { "properties": { "appDetailId": { @@ -26272,6 +28720,9 @@ const docTemplate = `{ "additionalProperties": true, "type": "object" }, + "remark": { + "type": "string" + }, "resource": { "type": "string" }, @@ -26315,6 +28766,20 @@ const docTemplate = `{ }, "type": "object" }, + "request.RuntimeRemark": { + "properties": { + "id": { + "type": "integer" + }, + "remark": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, "request.RuntimeSearch": { "properties": { "name": { @@ -26378,6 +28843,9 @@ const docTemplate = `{ "rebuild": { "type": "boolean" }, + "remark": { + "type": "string" + }, "source": { "type": "string" }, @@ -26414,6 +28882,12 @@ const docTemplate = `{ }, "request.SupervisorProcessConfig": { "properties": { + "autoRestart": { + "type": "string" + }, + "autoStart": { + "type": "string" + }, "command": { "type": "string" }, @@ -26480,6 +28954,9 @@ const docTemplate = `{ }, "request.WebsiteAcmeAccountCreate": { "properties": { + "caDirURL": { + "type": "string" + }, "eabHmacKey": { "type": "string" }, @@ -26505,9 +28982,13 @@ const docTemplate = `{ "letsencrypt", "zerossl", "buypass", - "google" + "google", + "custom" ], "type": "string" + }, + "useProxy": { + "type": "boolean" } }, "required": [ @@ -26517,6 +28998,20 @@ const docTemplate = `{ ], "type": "object" }, + "request.WebsiteAcmeAccountUpdate": { + "properties": { + "id": { + "type": "integer" + }, + "useProxy": { + "type": "boolean" + } + }, + "required": [ + "id" + ], + "type": "object" + }, "request.WebsiteBatchDelReq": { "properties": { "ids": { @@ -26735,6 +29230,9 @@ const docTemplate = `{ "runtimeID": { "type": "integer" }, + "siteDir": { + "type": "string" + }, "taskID": { "type": "string" }, @@ -26760,16 +29258,13 @@ const docTemplate = `{ "acmeAccountId": { "type": "integer" }, - "domains": { - "items": { - "type": "string" - }, - "type": "array" + "websiteSSLId": { + "type": "integer" } }, "required": [ "acmeAccountId", - "domains" + "websiteSSLId" ], "type": "object" }, @@ -26933,8 +29428,8 @@ const docTemplate = `{ "type": "boolean" }, "hstsIncludeSubDomains": { - "type": "boolean" - }, + "type": "boolean" + }, "http3": { "type": "boolean" }, @@ -27207,6 +29702,12 @@ const docTemplate = `{ }, "type": "object" }, + "serverCacheTime": { + "type": "integer" + }, + "serverCacheUnit": { + "type": "string" + }, "sni": { "type": "boolean" } @@ -27327,6 +29828,9 @@ const docTemplate = `{ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "otherDomains": { "type": "string" }, @@ -27339,6 +29843,9 @@ const docTemplate = `{ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -27358,6 +29865,9 @@ const docTemplate = `{ "acmeAccountID": { "type": "string" }, + "domain": { + "type": "string" + }, "page": { "type": "integer" }, @@ -27409,6 +29919,9 @@ const docTemplate = `{ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "otherDomains": { "type": "string" }, @@ -27421,6 +29934,9 @@ const docTemplate = `{ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -27488,7 +30004,8 @@ const docTemplate = `{ "status", "createdAt", "expire_date", - "created_at" + "created_at", + "favorite" ], "type": "string" }, @@ -27498,6 +30015,9 @@ const docTemplate = `{ "pageSize": { "type": "integer" }, + "type": { + "type": "string" + }, "websiteGroupId": { "type": "integer" } @@ -27518,6 +30038,9 @@ const docTemplate = `{ "expireDate": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "id": { "type": "integer" }, @@ -27612,6 +30135,18 @@ const docTemplate = `{ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, + "specifyIP": { + "type": "string" + }, "type": { "type": "string" }, @@ -27748,9 +30283,6 @@ const docTemplate = `{ "id": { "type": "integer" }, - "ignoreUpgrade": { - "type": "boolean" - }, "image": { "type": "string" }, @@ -27816,6 +30348,9 @@ const docTemplate = `{ }, "version": { "type": "string" + }, + "websiteDir": { + "type": "string" } }, "type": "object" @@ -27887,6 +30422,9 @@ const docTemplate = `{ "key": { "type": "string" }, + "label": { + "$ref": "#/definitions/dto.Locale" + }, "labelEn": { "type": "string" }, @@ -27962,9 +30500,44 @@ const docTemplate = `{ }, "type": "object" }, - "response.AppstoreConfig": { + "response.CompleteDiskInfo": { + "properties": { + "disks": { + "items": { + "$ref": "#/definitions/response.DiskInfo" + }, + "type": "array" + }, + "systemDisk": { + "$ref": "#/definitions/response.DiskInfo" + }, + "totalCapacity": { + "type": "integer" + }, + "totalDisks": { + "type": "integer" + }, + "unpartitionedDisks": { + "items": { + "$ref": "#/definitions/response.DiskBasicInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "response.ComponentInfo": { "properties": { - "defaultDomain": { + "error": { + "type": "string" + }, + "exists": { + "type": "boolean" + }, + "path": { + "type": "string" + }, + "version": { "type": "string" } }, @@ -27972,6 +30545,12 @@ const docTemplate = `{ }, "response.Database": { "properties": { + "databaseName": { + "type": "string" + }, + "from": { + "type": "string" + }, "id": { "type": "integer" }, @@ -28007,15 +30586,140 @@ const docTemplate = `{ }, "type": "object" }, + "response.DepthDirSizeRes": { + "properties": { + "path": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "type": "object" + }, "response.DirSizeRes": { "properties": { "size": { "type": "integer" } }, - "required": [ - "size" - ], + "required": [ + "size" + ], + "type": "object" + }, + "response.DiskBasicInfo": { + "properties": { + "avail": { + "type": "string" + }, + "device": { + "type": "string" + }, + "diskType": { + "type": "string" + }, + "filesystem": { + "type": "string" + }, + "isMounted": { + "type": "boolean" + }, + "isRemovable": { + "type": "boolean" + }, + "isSystem": { + "type": "boolean" + }, + "model": { + "type": "string" + }, + "mountPoint": { + "type": "string" + }, + "serial": { + "type": "string" + }, + "size": { + "type": "string" + }, + "usePercent": { + "type": "integer" + }, + "used": { + "type": "string" + } + }, + "type": "object" + }, + "response.DiskInfo": { + "properties": { + "avail": { + "type": "string" + }, + "device": { + "type": "string" + }, + "diskType": { + "type": "string" + }, + "filesystem": { + "type": "string" + }, + "isMounted": { + "type": "boolean" + }, + "isRemovable": { + "type": "boolean" + }, + "isSystem": { + "type": "boolean" + }, + "model": { + "type": "string" + }, + "mountPoint": { + "type": "string" + }, + "partitions": { + "items": { + "$ref": "#/definitions/response.DiskBasicInfo" + }, + "type": "array" + }, + "serial": { + "type": "string" + }, + "size": { + "type": "string" + }, + "usePercent": { + "type": "integer" + }, + "used": { + "type": "string" + } + }, + "type": "object" + }, + "response.ExistFileInfo": { + "properties": { + "isDir": { + "type": "boolean" + }, + "modTime": { + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, "type": "object" }, "response.FileInfo": { @@ -28094,9 +30798,6 @@ const docTemplate = `{ }, "response.FileLineContent": { "properties": { - "content": { - "type": "string" - }, "end": { "type": "boolean" }, @@ -28109,8 +30810,17 @@ const docTemplate = `{ "path": { "type": "string" }, + "scope": { + "type": "string" + }, + "taskStatus": { + "type": "string" + }, "total": { "type": "integer" + }, + "totalLines": { + "type": "integer" } }, "type": "object" @@ -28166,19 +30876,116 @@ const docTemplate = `{ }, "type": "object" }, - "response.IgnoredApp": { + "response.McpBindDomainRes": { "properties": { - "detailID": { + "acmeAccountID": { "type": "integer" }, - "icon": { + "allowIPs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "connUrl": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "sslID": { + "type": "integer" + }, + "websiteID": { + "type": "integer" + } + }, + "type": "object" + }, + "response.McpServerDTO": { + "properties": { + "baseUrl": { + "type": "string" + }, + "command": { + "type": "string" + }, + "containerName": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "dir": { + "type": "string" + }, + "dockerCompose": { + "type": "string" + }, + "env": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "hostIP": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "message": { "type": "string" }, "name": { "type": "string" }, - "version": { + "outputTransport": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "ssePath": { + "type": "string" + }, + "status": { + "type": "string" + }, + "streamableHttpPath": { + "type": "string" + }, + "type": { + "type": "string" + }, + "updatedAt": { "type": "string" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" + }, + "type": "array" + }, + "websiteID": { + "type": "integer" + } + }, + "type": "object" + }, + "response.McpServersRes": { + "properties": { + "items": { + "items": { + "$ref": "#/definitions/response.McpServerDTO" + }, + "type": "array" + }, + "total": { + "type": "integer" } }, "type": "object" @@ -28249,6 +31056,14 @@ const docTemplate = `{ }, "type": "object" }, + "response.NginxConfigRes": { + "properties": { + "https": { + "type": "boolean" + } + }, + "type": "object" + }, "response.NginxFile": { "properties": { "content": { @@ -28529,6 +31344,9 @@ const docTemplate = `{ "codeDir": { "type": "string" }, + "container": { + "type": "string" + }, "containerStatus": { "type": "string" }, @@ -28569,6 +31387,9 @@ const docTemplate = `{ "port": { "type": "string" }, + "remark": { + "type": "string" + }, "resource": { "type": "string" }, @@ -28595,6 +31416,12 @@ const docTemplate = `{ }, "response.SupervisorProcessConfig": { "properties": { + "autoRestart": { + "type": "string" + }, + "autoStart": { + "type": "string" + }, "command": { "type": "string" }, @@ -28662,8 +31489,39 @@ const docTemplate = `{ }, "type": "object" }, + "response.UserGroupResponse": { + "properties": { + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "users": { + "items": { + "$ref": "#/definitions/response.UserInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "response.UserInfo": { + "properties": { + "group": { + "type": "string" + }, + "username": { + "type": "string" + } + }, + "type": "object" + }, "response.WebsiteAcmeAccountDTO": { "properties": { + "caDirURL": { + "type": "string" + }, "createdAt": { "type": "string" }, @@ -28690,6 +31548,9 @@ const docTemplate = `{ }, "url": { "type": "string" + }, + "useProxy": { + "type": "boolean" } }, "type": "object" @@ -28802,6 +31663,9 @@ const docTemplate = `{ "expireDate": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "ftpId": { "type": "integer" }, @@ -28814,6 +31678,9 @@ const docTemplate = `{ "id": { "type": "integer" }, + "openBaseDir": { + "type": "boolean" + }, "parentWebsiteID": { "type": "integer" }, @@ -28915,8 +31782,8 @@ const docTemplate = `{ "type": "boolean" }, "hstsIncludeSubDomains": { - "type": "boolean" - }, + "type": "boolean" + }, "http3": { "type": "boolean" }, @@ -29081,6 +31948,9 @@ const docTemplate = `{ "logPath": { "type": "string" }, + "masterSslId": { + "type": "integer" + }, "message": { "type": "string" }, @@ -29090,6 +31960,9 @@ const docTemplate = `{ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "organization": { "type": "string" }, @@ -29108,6 +31981,9 @@ const docTemplate = `{ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -29134,6 +32010,115 @@ const docTemplate = `{ } }, "type": "object" + }, + "websocket.ProcessConnect": { + "properties": { + "PID": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "localaddr": { + "type": "object" + }, + "remoteaddr": { + "type": "object" + } + }, + "type": "object" + }, + "websocket.PsProcessData": { + "properties": { + "PID": { + "type": "integer" + }, + "PPID": { + "type": "integer" + }, + "cmdLine": { + "type": "string" + }, + "connects": { + "items": { + "$ref": "#/definitions/websocket.ProcessConnect" + }, + "type": "array" + }, + "cpuPercent": { + "type": "string" + }, + "cpuValue": { + "type": "number" + }, + "data": { + "type": "string" + }, + "diskRead": { + "type": "string" + }, + "diskWrite": { + "type": "string" + }, + "envs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "hwm": { + "type": "string" + }, + "locked": { + "type": "string" + }, + "name": { + "type": "string" + }, + "numConnections": { + "type": "integer" + }, + "numThreads": { + "type": "integer" + }, + "rss": { + "type": "string" + }, + "rssValue": { + "type": "integer" + }, + "stack": { + "type": "string" + }, + "startTime": { + "type": "string" + }, + "status": { + "type": "string" + }, + "swap": { + "type": "string" + }, + "username": { + "type": "string" + }, + "vms": { + "type": "string" + }, + "openFiles": { + "items": { + "type": "object" + }, + "type": "array" + } + }, + "type": "object" } } }` @@ -29153,4 +32138,4 @@ var SwaggerInfo = &swag.Spec{ func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) -} \ No newline at end of file +} diff --git a/core/cmd/server/docs/swagger.json b/core/cmd/server/docs/swagger.json index ed649e530e55..4758af70fc35 100644 --- a/core/cmd/server/docs/swagger.json +++ b/core/cmd/server/docs/swagger.json @@ -14,198 +14,6 @@ "host": "localhost", "basePath": "/api/v2", "paths": { - "/agent/groups": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.GroupCreate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Create group", - "tags": [ - "System Group" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name", - "type" - ], - "formatEN": "create group [name][type]", - "formatZH": "创建组 [name][type]", - "paramKeys": [] - } - } - }, - "/agent/groups/del": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.OperateByID" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Delete group", - "tags": [ - "System Group" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "groups", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - }, - { - "db": "groups", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "type", - "output_value": "type" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "delete group [type][name]", - "formatZH": "删除组 [type][name]", - "paramKeys": [] - } - } - }, - "/agent/groups/search": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.GroupSearch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/dto.OperateByType" - }, - "type": "array" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "List groups", - "tags": [ - "System Group" - ] - } - }, - "/agent/groups/update": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.GroupUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Update group", - "tags": [ - "System Group" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name", - "type" - ], - "formatEN": "update group [name][type]", - "formatZH": "更新组 [name][type]", - "paramKeys": [] - } - } - }, "/ai/domain/bind": { "post": { "consumes": [ @@ -744,7 +552,49 @@ ] } }, - "/apps/ignored": { + "/apps/ignored/cancel": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.ReqWithID" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Cancel Ignore Upgrade App", + "tags": [ + "App" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "Cancel ignore application upgrade", + "formatZH": "取消忽略应用升级", + "paramKeys": [] + } + } + }, + "/apps/ignored/detail": { "get": { "consumes": [ "application/json" @@ -754,7 +604,7 @@ "description": "OK", "schema": { "items": { - "$ref": "#/definitions/response.IgnoredApp" + "$ref": "#/definitions/model.AppIgnoreUpgrade" }, "type": "array" } @@ -768,7 +618,7 @@ "Timestamp": [] } ], - "summary": "Get Ignore App", + "summary": "List Upgrade Ignored App", "tags": [ "App" ] @@ -1031,7 +881,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.AppInstalledIgnoreUpgrade" + "$ref": "#/definitions/request.AppIgnoreUpgradeReq" } } ], @@ -1048,34 +898,38 @@ "Timestamp": [] } ], - "summary": "ignore App Update", + "summary": "Ignore Upgrade App", "tags": [ "App" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "installId" - ], - "formatEN": "Application param update [installId]", - "formatZH": "忽略应用 [installId] 版本升级", + "bodyKeys": [], + "formatEN": "Ignore application upgrade", + "formatZH": "忽略应用升级", "paramKeys": [] } } }, - "/apps/installed/list": { + "/apps/installed/info/:appInstallId": { "get": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "App install id", + "in": "path", + "name": "appInstallId", + "required": true, + "type": "integer" + } + ], "responses": { "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/dto.AppInstallInfo" - }, - "type": "array" + "$ref": "#/definitions/dto.AppInstallInfo" } } }, @@ -1087,24 +941,54 @@ "Timestamp": [] } ], - "summary": "List app installed", + "summary": "Get app install info", "tags": [ "App" ] } }, - "/apps/installed/loadport": { - "post": { + "/apps/installed/list": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.AppInstallInfo" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List app installed", + "tags": [ + "App" + ] + } + }, + "/apps/installed/loadport": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { "$ref": "#/definitions/dto.OperationWithNameAndType" } } @@ -1509,46 +1393,8 @@ ] } }, - "/apps/store/config": { - "get": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.AppstoreConfig" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Get appstore config", - "tags": [ - "App" - ] - } - }, - "/apps/store/update": { + "/apps/sync/local": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.AppstoreUpdate" - } - } - ], "responses": { "200": { "description": "OK" @@ -1562,13 +1408,20 @@ "Timestamp": [] } ], - "summary": "Update appstore config", + "summary": "Sync local app list", "tags": [ "App" - ] + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "App store synchronization", + "formatZH": "应用商店同步", + "paramKeys": [] + } } }, - "/apps/sync/local": { + "/apps/sync/remote": { "post": { "responses": { "200": { @@ -1583,7 +1436,7 @@ "Timestamp": [] } ], - "summary": "Sync local app list", + "summary": "Sync remote app list", "tags": [ "App" ], @@ -1596,8 +1449,22 @@ } } }, - "/apps/sync/remote": { + "/backup/record/description/update": { "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.UpdateDescription" + } + } + ], "responses": { "200": { "description": "OK" @@ -1611,17 +1478,10 @@ "Timestamp": [] } ], - "summary": "Sync remote app list", + "summary": "Update backup record description", "tags": [ - "App" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "App store synchronization", - "formatZH": "应用商店同步", - "paramKeys": [] - } + "Backup Account" + ] } }, "/backup/record/download": { @@ -2235,6 +2095,50 @@ } } }, + "/backups/upload": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.UploadForRecover" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Upload file for recover", + "tags": [ + "Backup Account" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "filePath" + ], + "formatEN": "upload backup file [filePath]", + "formatZH": "上传备份文件 [filePath]", + "paramKeys": [] + } + } + }, "/buckets": { "post": { "consumes": [ @@ -3148,10 +3052,7 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.ContainerPruneReport" - } + "description": "OK" } }, "security": [ @@ -3235,7 +3136,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchWithPage" + "$ref": "#/definitions/dto.PageImage" } } ], @@ -3470,7 +3371,7 @@ "description": "OK", "schema": { "items": { - "type": "string" + "$ref": "#/definitions/dto.ContainerOptions" }, "type": "array" } @@ -3490,6 +3391,39 @@ ] } }, + "/containers/list/byimage": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.ContainerOptions" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List containers by image", + "tags": [ + "Container" + ] + } + }, "/containers/list/stats": { "get": { "responses": { @@ -3779,10 +3713,7 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.ContainerPruneReport" - } + "description": "OK" } }, "security": [ @@ -3940,7 +3871,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ImageRepoDelete" + "$ref": "#/definitions/dto.OperateByID" } } ], @@ -3969,17 +3900,17 @@ { "db": "image_repos", "input_column": "id", - "input_value": "ids", - "isList": true, + "input_value": "id", + "isList": false, "output_column": "name", - "output_value": "names" + "output_value": "name" } ], "bodyKeys": [ - "ids" + "id" ], - "formatEN": "delete image repo [names]", - "formatZH": "删除镜像仓库 [names]", + "formatEN": "delete image repo [name]", + "formatZH": "删除镜像仓库 [name]", "paramKeys": [] } } @@ -4211,7 +4142,7 @@ "in": "path", "name": "id", "required": true, - "type": "integer" + "type": "string" } ], "responses": { @@ -4575,6 +4506,50 @@ } } }, + "/containers/users": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperationWithName" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load container users", + "tags": [ + "Container" + ] + } + }, "/containers/volume": { "get": { "consumes": [ @@ -4735,51 +4710,6 @@ ] } }, - "/core/app/launcher/show": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SettingUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Update app Launcher", - "tags": [ - "App Launcher" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "app launcher [key] =\u003e show: [value]", - "formatZH": "首页应用 [key] =\u003e 显示：[value]", - "paramKeys": [] - } - } - }, "/core/auth/captcha": { "get": { "responses": { @@ -6106,7 +6036,7 @@ ] } }, - "/core/settings/bind/update": { + "/core/script": { "post": { "consumes": [ "application/json" @@ -6118,7 +6048,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.BindInfo" + "$ref": "#/definitions/dto.ScriptOperate" } } ], @@ -6135,23 +6065,22 @@ "Timestamp": [] } ], - "summary": "Update system bind info", + "summary": "Add script", "tags": [ - "System Setting" + "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "ipv6", - "bindAddress" + "name" ], - "formatEN": "update system bind info =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", - "formatZH": "修改系统监听信息 =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", + "formatEN": "add script [name]", + "formatZH": "添加脚本库脚本 [name]", "paramKeys": [] } } }, - "/core/settings/expired/handle": { + "/core/script/del": { "post": { "consumes": [ "application/json" @@ -6163,7 +6092,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PasswordUpdate" + "$ref": "#/definitions/dto.OperateByIDs" } } ], @@ -6180,32 +6109,51 @@ "Timestamp": [] } ], - "summary": "Reset system password expired", + "summary": "Delete script", "tags": [ - "System Setting" + "ScriptLibrary" ], "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "reset an expired Password", - "formatZH": "重置过期密码", + "BeforeFunctions": [ + { + "db": "script_librarys", + "input_column": "id", + "input_value": "ids", + "isList": true, + "output_column": "name", + "output_value": "names" + } + ], + "bodyKeys": [ + "ids" + ], + "formatEN": "delete script [names]", + "formatZH": "删除脚本库脚本 [names]", "paramKeys": [] } } }, - "/core/settings/interface": { - "get": { + "/core/script/search": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SearchPageWithGroup" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -6217,13 +6165,13 @@ "Timestamp": [] } ], - "summary": "Load system address", + "summary": "Page script", "tags": [ - "System Setting" + "ScriptLibrary" ] } }, - "/core/settings/menu/update": { + "/core/script/sync": { "post": { "consumes": [ "application/json" @@ -6235,7 +6183,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SettingUpdate" + "$ref": "#/definitions/dto.OperateByTaskID" } } ], @@ -6252,20 +6200,20 @@ "Timestamp": [] } ], - "summary": "Update system setting", + "summary": "Sync script from remote", "tags": [ - "System Setting" + "ScriptLibrary" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], - "formatEN": "Hide advanced feature menu.", - "formatZH": "隐藏高级功能菜单", + "formatEN": "sync scripts", + "formatZH": "同步脚本库脚本", "paramKeys": [] } } }, - "/core/settings/mfa": { + "/core/script/update": { "post": { "consumes": [ "application/json" @@ -6277,16 +6225,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MfaCredential" + "$ref": "#/definitions/dto.ScriptOperate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/mfa.Otp" - } + "description": "OK" } }, "security": [ @@ -6297,31 +6242,41 @@ "Timestamp": [] } ], - "summary": "Load mfa info", + "summary": "Update script", "tags": [ - "System Setting" - ] + "ScriptLibrary" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "update script [name]", + "formatZH": "更新脚本库脚本 [name]", + "paramKeys": [] + } } }, - "/core/settings/mfa/bind": { + "/core/settings/api/config/generate/key": { "post": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.MfaCredential" - } - } - ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "string" + } } }, "security": [ @@ -6332,20 +6287,20 @@ "Timestamp": [] } ], - "summary": "Bind mfa", + "summary": "generate api key", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], - "formatEN": "bind mfa", - "formatZH": "mfa 绑定", + "formatEN": "generate api key", + "formatZH": "生成 API 接口密钥", "paramKeys": [] } } }, - "/core/settings/password/update": { + "/core/settings/api/config/update": { "post": { "consumes": [ "application/json" @@ -6357,7 +6312,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PasswordUpdate" + "$ref": "#/definitions/dto.ApiInterfaceConfig" } } ], @@ -6374,20 +6329,46 @@ "Timestamp": [] } ], - "summary": "Update system password", + "summary": "Update api config", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "update system password", - "formatZH": "修改系统密码", + "bodyKeys": [ + "ipWhiteList" + ], + "formatEN": "update api config =\u003e IP White List: [ipWhiteList]", + "formatZH": "更新 API 接口配置 =\u003e IP 白名单: [ipWhiteList]", "paramKeys": [] } } }, - "/core/settings/port/update": { + "/core/settings/apps/store/config": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.AppstoreConfig" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get appstore config", + "tags": [ + "App" + ] + } + }, + "/core/settings/apps/store/update": { "post": { "consumes": [ "application/json" @@ -6399,7 +6380,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PortUpdate" + "$ref": "#/definitions/dto.AppstoreUpdate" } } ], @@ -6416,22 +6397,13 @@ "Timestamp": [] } ], - "summary": "Update system port", + "summary": "Update appstore config", "tags": [ - "System Setting" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "serverPort" - ], - "formatEN": "update system port =\u003e [serverPort]", - "formatZH": "修改系统端口 =\u003e [serverPort]", - "paramKeys": [] - } + "App" + ] } }, - "/core/settings/proxy/update": { + "/core/settings/bind/update": { "post": { "consumes": [ "application/json" @@ -6443,7 +6415,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ProxyUpdate" + "$ref": "#/definitions/dto.BindInfo" } } ], @@ -6460,23 +6432,23 @@ "Timestamp": [] } ], - "summary": "Update proxy setting", + "summary": "Update system bind info", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "proxyUrl", - "proxyPort" + "ipv6", + "bindAddress" ], - "formatEN": "set proxy [proxyPort]:[proxyPort].", - "formatZH": "服务器代理配置 [proxyPort]:[proxyPort]", + "formatEN": "update system bind info =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", + "formatZH": "修改系统监听信息 =\u003e ipv6: [ipv6], 监听 IP: [bindAddress]", "paramKeys": [] } } }, - "/core/settings/rollback": { + "/core/settings/expired/handle": { "post": { "consumes": [ "application/json" @@ -6488,7 +6460,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.PasswordUpdate" } } ], @@ -6505,103 +6477,32 @@ "Timestamp": [] } ], - "summary": "Upgrade", + "summary": "Reset system password expired", "tags": [ "System Setting" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "upgrade_logs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "old_version", - "output_value": "version" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "rollback system =\u003e [version]", - "formatZH": "回滚系统 =\u003e [version]", + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "reset an expired Password", + "formatZH": "重置过期密码", "paramKeys": [] } } }, - "/core/settings/search": { - "post": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.SettingInfo" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load system setting info", - "tags": [ - "System Setting" - ] - } - }, - "/core/settings/search/available": { + "/core/settings/interface": { "get": { - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load system available status", - "tags": [ - "System Setting" - ] - } - }, - "/core/settings/ssl/download": { - "post": { - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } + "consumes": [ + "application/json" ], - "summary": "Download system cert", - "tags": [ - "System Setting" - ] - } - }, - "/core/settings/ssl/info": { - "get": { "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.SSLInfo" + "items": { + "type": "string" + }, + "type": "array" } } }, @@ -6613,13 +6514,13 @@ "Timestamp": [] } ], - "summary": "Load system cert info", + "summary": "Load system address", "tags": [ "System Setting" ] } }, - "/core/settings/ssl/update": { + "/core/settings/menu/update": { "post": { "consumes": [ "application/json" @@ -6631,7 +6532,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SSLUpdate" + "$ref": "#/definitions/dto.SettingUpdate" } } ], @@ -6648,28 +6549,40 @@ "Timestamp": [] } ], - "summary": "Update system ssl", + "summary": "Update system setting", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "ssl" - ], - "formatEN": "update system ssl =\u003e [ssl]", - "formatZH": "修改系统 ssl =\u003e [ssl]", + "bodyKeys": [], + "formatEN": "Hide advanced feature menu.", + "formatZH": "隐藏高级功能菜单", "paramKeys": [] } } }, - "/core/settings/terminal/search": { + "/core/settings/mfa": { "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.MfaCredential" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.TerminalInfo" + "$ref": "#/definitions/mfa.Otp" } } }, @@ -6681,13 +6594,13 @@ "Timestamp": [] } ], - "summary": "Load system terminal setting info", + "summary": "Load mfa info", "tags": [ "System Setting" ] } }, - "/core/settings/terminal/update": { + "/core/settings/mfa/bind": { "post": { "consumes": [ "application/json" @@ -6699,7 +6612,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.TerminalInfo" + "$ref": "#/definitions/dto.MfaCredential" } } ], @@ -6716,20 +6629,20 @@ "Timestamp": [] } ], - "summary": "Update system terminal setting", + "summary": "Bind mfa", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [], - "formatEN": "update system terminal setting", - "formatZH": "修改系统终端配置", + "formatEN": "bind mfa", + "formatZH": "mfa 绑定", "paramKeys": [] } } }, - "/core/settings/update": { + "/core/settings/password/update": { "post": { "consumes": [ "application/json" @@ -6741,7 +6654,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SettingUpdate" + "$ref": "#/definitions/dto.PasswordUpdate" } } ], @@ -6758,59 +6671,20 @@ "Timestamp": [] } ], - "summary": "Update system setting", + "summary": "Update system password", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "update system setting [key] =\u003e [value]", - "formatZH": "修改系统配置 [key] =\u003e [value]", + "bodyKeys": [], + "formatEN": "update system password", + "formatZH": "修改系统密码", "paramKeys": [] } } }, - "/core/settings/upgrade": { - "get": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.Upgrade" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load release notes by version", - "tags": [ - "System Setting" - ] - }, + "/core/settings/port/update": { "post": { "consumes": [ "application/json" @@ -6822,7 +6696,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.Upgrade" + "$ref": "#/definitions/dto.PortUpdate" } } ], @@ -6839,22 +6713,22 @@ "Timestamp": [] } ], - "summary": "Upgrade", + "summary": "Update system port", "tags": [ "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "version" + "serverPort" ], - "formatEN": "upgrade system =\u003e [version]", - "formatZH": "更新系统 =\u003e [version]", + "formatEN": "update system port =\u003e [serverPort]", + "formatZH": "修改系统端口 =\u003e [serverPort]", "paramKeys": [] } } }, - "/cronjobs": { + "/core/settings/proxy/update": { "post": { "consumes": [ "application/json" @@ -6866,7 +6740,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobCreate" + "$ref": "#/definitions/dto.ProxyUpdate" } } ], @@ -6883,23 +6757,23 @@ "Timestamp": [] } ], - "summary": "Create cronjob", + "summary": "Update proxy setting", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "type", - "name" + "proxyUrl", + "proxyPort" ], - "formatEN": "create cronjob [type][name]", - "formatZH": "创建计划任务 [type][name]", + "formatEN": "set proxy [proxyPort]:[proxyPort].", + "formatZH": "服务器代理配置 [proxyPort]:[proxyPort]", "paramKeys": [] } } }, - "/cronjobs/del": { + "/core/settings/rollback": { "post": { "consumes": [ "application/json" @@ -6911,7 +6785,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobBatchDelete" + "$ref": "#/definitions/dto.OperateByID" } } ], @@ -6928,46 +6802,56 @@ "Timestamp": [] } ], - "summary": "Delete cronjob", + "summary": "Upgrade", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { "BeforeFunctions": [ { - "db": "cronjobs", + "db": "upgrade_logs", "input_column": "id", - "input_value": "ids", - "isList": true, - "output_column": "name", - "output_value": "names" + "input_value": "id", + "isList": false, + "output_column": "old_version", + "output_value": "version" } ], "bodyKeys": [ - "ids" + "id" ], - "formatEN": "delete cronjob [names]", - "formatZH": "删除计划任务 [names]", + "formatEN": "rollback system =\u003e [version]", + "formatZH": "回滚系统 =\u003e [version]", "paramKeys": [] } } }, - "/cronjobs/download": { + "/core/settings/search": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, + "responses": { + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/dto.CronjobDownload" + "$ref": "#/definitions/dto.SettingInfo" } } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } ], + "summary": "Load system setting info", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/search/available": { + "get": { "responses": { "200": { "description": "OK" @@ -6981,31 +6865,58 @@ "Timestamp": [] } ], - "summary": "Download cronjob records", + "summary": "Load system available status", "tags": [ - "Cronjob" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "job_records", - "input_column": "id", - "input_value": "recordID", - "isList": false, - "output_column": "file", - "output_value": "file" - } - ], - "bodyKeys": [ - "recordID" - ], - "formatEN": "download the cronjob record [file]", - "formatZH": "下载计划任务记录 [file]", - "paramKeys": [] - } + "System Setting" + ] } }, - "/cronjobs/handle": { + "/core/settings/ssl/download": { + "post": { + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Download system cert", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/ssl/info": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.SSLInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load system cert info", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/ssl/update": { "post": { "consumes": [ "application/json" @@ -7017,7 +6928,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.SSLUpdate" } } ], @@ -7034,31 +6945,46 @@ "Timestamp": [] } ], - "summary": "Handle cronjob once", + "summary": "Update system ssl", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "ssl" ], - "formatEN": "manually execute the cronjob [name]", - "formatZH": "手动执行计划任务 [name]", + "formatEN": "update system ssl =\u003e [ssl]", + "formatZH": "修改系统 ssl =\u003e [ssl]", "paramKeys": [] } } }, - "/cronjobs/next": { + "/core/settings/terminal/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.TerminalInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load system terminal setting info", + "tags": [ + "System Setting" + ] + } + }, + "/core/settings/terminal/update": { "post": { "consumes": [ "application/json" @@ -7070,7 +6996,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobSpec" + "$ref": "#/definitions/dto.TerminalInfo" } } ], @@ -7087,13 +7013,20 @@ "Timestamp": [] } ], - "summary": "Load cronjob spec time", + "summary": "Update system terminal setting", "tags": [ - "Cronjob" - ] + "System Setting" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "update system terminal setting", + "formatZH": "修改系统终端配置", + "paramKeys": [] + } } }, - "/cronjobs/records/clean": { + "/core/settings/update": { "post": { "consumes": [ "application/json" @@ -7105,7 +7038,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobClean" + "$ref": "#/definitions/dto.SettingUpdate" } } ], @@ -7122,31 +7055,45 @@ "Timestamp": [] } ], - "summary": "Clean job records", + "summary": "Update system setting", "tags": [ - "Cronjob" + "System Setting" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "key", + "value" ], - "formatEN": "clean cronjob [name] records", - "formatZH": "清空计划任务记录 [name]", + "formatEN": "update system setting [key] =\u003e [value]", + "formatZH": "修改系统配置 [key] =\u003e [value]", "paramKeys": [] } } }, - "/cronjobs/records/log": { + "/core/settings/upgrade": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.UpgradeInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load upgrade info", + "tags": [ + "System Setting" + ] + }, "post": { "consumes": [ "application/json" @@ -7158,16 +7105,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.Upgrade" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -7178,13 +7122,22 @@ "Timestamp": [] } ], - "summary": "Load Cronjob record log", + "summary": "Upgrade", "tags": [ - "Cronjob" - ] + "System Setting" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "version" + ], + "formatEN": "upgrade system =\u003e [version]", + "formatZH": "更新系统 =\u003e [version]", + "paramKeys": [] + } } }, - "/cronjobs/search": { + "/core/settings/upgrade/notes": { "post": { "consumes": [ "application/json" @@ -7196,7 +7149,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageCronjob" + "$ref": "#/definitions/dto.Upgrade" } } ], @@ -7204,7 +7157,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "type": "string" } } }, @@ -7216,33 +7169,22 @@ "Timestamp": [] } ], - "summary": "Page cronjobs", + "summary": "Load release notes by version", "tags": [ - "Cronjob" + "System Setting" ] } }, - "/cronjobs/search/records": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SearchRecord" - } - } - ], + "/core/settings/upgrade/releases": { + "get": { "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "items": { + "$ref": "#/definitions/dto.ReleasesNotes" + }, + "type": "array" } } }, @@ -7254,13 +7196,13 @@ "Timestamp": [] } ], - "summary": "Page job records", + "summary": "Load upgrade notes", "tags": [ - "Cronjob" + "System Setting" ] } }, - "/cronjobs/status": { + "/cronjobs": { "post": { "consumes": [ "application/json" @@ -7272,7 +7214,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobUpdateStatus" + "$ref": "#/definitions/dto.CronjobOperate" } } ], @@ -7289,32 +7231,23 @@ "Timestamp": [] } ], - "summary": "Update cronjob status", + "summary": "Create cronjob", "tags": [ "Cronjob" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id", - "status" + "type", + "name" ], - "formatEN": "change the status of cronjob [name] to [status].", - "formatZH": "修改计划任务 [name] 状态为 [status]", + "formatEN": "create cronjob [type][name]", + "formatZH": "创建计划任务 [type][name]", "paramKeys": [] } } }, - "/cronjobs/update": { + "/cronjobs/del": { "post": { "consumes": [ "application/json" @@ -7326,7 +7259,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.CronjobUpdate" + "$ref": "#/definitions/dto.CronjobBatchDelete" } } ], @@ -7343,7 +7276,7 @@ "Timestamp": [] } ], - "summary": "Update cronjob", + "summary": "Delete cronjob", "tags": [ "Cronjob" ], @@ -7352,31 +7285,1475 @@ { "db": "cronjobs", "input_column": "id", - "input_value": "id", - "isList": false, + "input_value": "ids", + "isList": true, "output_column": "name", - "output_value": "name" + "output_value": "names" } ], "bodyKeys": [ - "id" + "ids" + ], + "formatEN": "delete cronjob [names]", + "formatZH": "删除计划任务 [names]", + "paramKeys": [] + } + } + }, + "/cronjobs/export": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByIDs" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Export cronjob list", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/group/update": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeGroup" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update cronjob group", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "update cronjob group [name]", + "formatZH": "更新计划任务分组 [name]", + "paramKeys": [] + } + } + }, + "/cronjobs/handle": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByID" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Handle cronjob once", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "manually execute the cronjob [name]", + "formatZH": "手动执行计划任务 [name]", + "paramKeys": [] + } + } + }, + "/cronjobs/import": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobImport" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Import cronjob list", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/load/info": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByID" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load cronjob info", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/next": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobSpec" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load cronjob spec time", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/records/clean": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobClean" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Clean job records", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "clean cronjob [name] records", + "formatZH": "清空计划任务记录 [name]", + "paramKeys": [] + } + } + }, + "/cronjobs/records/log": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperateByID" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load Cronjob record log", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/script/options": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.ScriptOptions" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load script options", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.PageCronjob" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Page cronjobs", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/search/records": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SearchRecord" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Page job records", + "tags": [ + "Cronjob" + ] + } + }, + "/cronjobs/status": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobUpdateStatus" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update cronjob status", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id", + "status" + ], + "formatEN": "change the status of cronjob [name] to [status].", + "formatZH": "修改计划任务 [name] 状态为 [status]", + "paramKeys": [] + } + } + }, + "/cronjobs/update": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.CronjobOperate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update cronjob", + "tags": [ + "Cronjob" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "cronjobs", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "update cronjob [name]", + "formatZH": "更新计划任务 [name]", + "paramKeys": [] + } + } + }, + "/dashboard/app/launcher": { + "get": { + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "Array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load app launcher", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/app/launcher/option": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SearchByFilter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "Array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load app launcher options", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/app/launcher/show": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.SettingUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update app Launcher", + "tags": [ + "Dashboard" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "key", + "value" + ], + "formatEN": "app launcher [key] =\u003e show: [value]", + "formatZH": "首页应用 [key] =\u003e 显示：[value]", + "paramKeys": [] + } + } + }, + "/dashboard/base/:ioOption/:netOption": { + "get": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "ioOption", + "required": true, + "type": "string" + }, + { + "description": "request", + "in": "path", + "name": "netOption", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DashboardBase" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load dashboard base info", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/base/os": { + "get": { + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.OsInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load os info", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/current/:ioOption/:netOption": { + "get": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "ioOption", + "required": true, + "type": "string" + }, + { + "description": "request", + "in": "path", + "name": "netOption", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DashboardCurrent" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load dashboard current info", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/current/node": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.NodeCurrent" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load dashboard current info for node", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/quick/change": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeQuicks" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update quick jump", + "tags": [ + "Dashboard" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "change quick jump", + "formatZH": "切换快速跳转", + "paramKeys": [] + } + } + }, + "/dashboard/quick/option": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "Array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load quick jump options", + "tags": [ + "Dashboard" + ] + } + }, + "/dashboard/system/restart/:operation": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "operation", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "System restart", + "tags": [ + "Dashboard" + ] + } + }, + "/databases": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.MysqlDBCreate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Create mysql database", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name" + ], + "formatEN": "create mysql database [name]", + "formatZH": "创建 mysql 数据库 [name]", + "paramKeys": [] + } + } + }, + "/databases/bind": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.BindUser" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Bind user of mysql database", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "database", + "username" + ], + "formatEN": "bind mysql database [database] [username]", + "formatZH": "绑定 mysql 数据库名 [database] [username]", + "paramKeys": [] + } + } + }, + "/databases/change/access": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeDBInfo" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Change mysql access", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "Update database [name] access", + "formatZH": "更新数据库 [name] 访问权限", + "paramKeys": [] + } + } + }, + "/databases/change/password": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ChangeDBInfo" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Change mysql password", + "tags": [ + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "Update database [name] password", + "formatZH": "更新数据库 [name] 密码", + "paramKeys": [] + } + } + }, + "/databases/common/info": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperationWithNameAndType" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DBBaseInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load base info", + "tags": [ + "Database Common" + ] + } + }, + "/databases/common/load/file": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.OperationWithNameAndType" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load Database conf", + "tags": [ + "Database Common" + ] + } + }, + "/databases/common/update/conf": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DBConfUpdateByFile" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update conf by upload file", + "tags": [ + "Database Common" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "type", + "database" ], - "formatEN": "update cronjob [name]", - "formatZH": "更新计划任务 [name]", + "formatEN": "update the [type] [database] database configuration information", + "formatZH": "更新 [type] 数据库 [database] 配置信息", "paramKeys": [] } } }, - "/dashboard/app/launcher": { + "/databases/db": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseCreate" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Create database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name", + "type" + ], + "formatEN": "create database [name][type]", + "formatZH": "创建远程数据库 [name][type]", + "paramKeys": [] + } + } + }, + "/databases/db/:name": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.DatabaseInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get databases", + "tags": [ + "Database" + ] + } + }, + "/databases/db/check": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseCreate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Check database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name", + "type" + ], + "formatEN": "check if database [name][type] is connectable", + "formatZH": "检测远程数据库 [name][type] 连接性", + "paramKeys": [] + } + } + }, + "/databases/db/del": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseDelete" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Delete database", + "tags": [ + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "databases", + "input_column": "id", + "input_value": "ids", + "isList": true, + "output_column": "name", + "output_value": "names" + } + ], + "bodyKeys": [ + "ids" + ], + "formatEN": "delete database [names]", + "formatZH": "删除远程数据库 [names]", + "paramKeys": [] + } + } + }, + "/databases/db/item/:type": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.DatabaseItem" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List databases", + "tags": [ + "Database" + ] + } + }, + "/databases/db/list/:type": { "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.DatabaseOption" + }, + "type": "array" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "List databases", + "tags": [ + "Database" + ] + } + }, + "/databases/db/search": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.DatabaseSearch" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "type": "Array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -7388,13 +8765,13 @@ "Timestamp": [] } ], - "summary": "Load app launcher", + "summary": "Page databases", "tags": [ - "Dashboard" + "Database" ] } }, - "/dashboard/app/launcher/option": { + "/databases/db/update": { "post": { "consumes": [ "application/json" @@ -7406,16 +8783,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchByFilter" + "$ref": "#/definitions/dto.DatabaseUpdate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "Array" - } + "description": "OK" } }, "security": [ @@ -7426,39 +8800,40 @@ "Timestamp": [] } ], - "summary": "Load app launcher options", + "summary": "Update database", "tags": [ - "Dashboard" - ] + "Database" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name" + ], + "formatEN": "update database [name]", + "formatZH": "更新远程数据库 [name]", + "paramKeys": [] + } } }, - "/dashboard/base/:ioOption/:netOption": { - "get": { + "/databases/del": { + "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "ioOption", - "required": true, - "type": "string" - }, - { - "description": "request", - "in": "path", - "name": "netOption", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.MysqlDBDelete" + } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.DashboardBase" - } + "description": "OK" } }, "security": [ @@ -7469,22 +8844,54 @@ "Timestamp": [] } ], - "summary": "Load dashboard base info", + "summary": "Delete mysql database", "tags": [ - "Dashboard" - ] + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "delete mysql database [name]", + "formatZH": "删除 mysql 数据库 [name]", + "paramKeys": [] + } } }, - "/dashboard/base/os": { - "get": { + "/databases/del/check": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.MysqlDBDeleteCheck" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.OsInfo" + "items": { + "type": "string" + }, + "type": "array" } } }, @@ -7496,39 +8903,31 @@ "Timestamp": [] } ], - "summary": "Load os info", + "summary": "Check before delete mysql database", "tags": [ - "Dashboard" + "Database Mysql" ] } }, - "/dashboard/current/:ioOption/:netOption": { - "get": { + "/databases/description/update": { + "post": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "ioOption", - "required": true, - "type": "string" - }, - { - "description": "request", - "in": "path", - "name": "netOption", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.UpdateDescription" + } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.DashboardCurrent" - } + "description": "OK" } }, "security": [ @@ -7539,22 +8938,48 @@ "Timestamp": [] } ], - "summary": "Load dashboard current info", + "summary": "Update mysql database description", "tags": [ - "Dashboard" - ] + "Database Mysql" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_mysqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id", + "description" + ], + "formatEN": "The description of the mysql database [name] is modified =\u003e [description]", + "formatZH": "mysql 数据库 [name] 描述信息修改 [description]", + "paramKeys": [] + } } }, - "/dashboard/current/node": { - "get": { - "responses": { - "200": { - "description": "OK", + "/databases/load": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "$ref": "#/definitions/dto.NodeCurrent" + "$ref": "#/definitions/dto.MysqlLoadDB" } } - }, + ], + "responses": {}, "security": [ { "ApiKeyAuth": [] @@ -7563,29 +8988,37 @@ "Timestamp": [] } ], - "summary": "Load dashboard current info for node", + "summary": "Load mysql database from remote", "tags": [ - "Dashboard" + "Database Mysql" ] } }, - "/dashboard/system/restart/:operation": { - "post": { + "/databases/options": { + "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "path", - "name": "operation", + "in": "body", + "name": "request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/dto.PageInfo" + } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.MysqlOption" + }, + "type": "array" + } } }, "security": [ @@ -7596,13 +9029,13 @@ "Timestamp": [] } ], - "summary": "System restart", + "summary": "List mysql database names", "tags": [ - "Dashboard" + "Database Mysql" ] } }, - "/databases": { + "/databases/pg": { "post": { "consumes": [ "application/json" @@ -7614,7 +9047,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBCreate" + "$ref": "#/definitions/dto.PostgresqlDBCreate" } } ], @@ -7631,22 +9064,22 @@ "Timestamp": [] } ], - "summary": "Create mysql database", + "summary": "Create postgresql database", "tags": [ - "Database Mysql" + "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ "name" ], - "formatEN": "create mysql database [name]", - "formatZH": "创建 mysql 数据库 [name]", + "formatEN": "create postgresql database [name]", + "formatZH": "创建 postgresql 数据库 [name]", "paramKeys": [] } } }, - "/databases/bind": { + "/databases/pg/:database/load": { "post": { "consumes": [ "application/json" @@ -7658,15 +9091,11 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.BindUser" + "$ref": "#/definitions/dto.PostgresqlLoadDB" } } ], - "responses": { - "200": { - "description": "OK" - } - }, + "responses": {}, "security": [ { "ApiKeyAuth": [] @@ -7675,23 +9104,13 @@ "Timestamp": [] } ], - "summary": "Bind user of mysql database", + "summary": "Load postgresql database from remote", "tags": [ - "Database Mysql" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "database", - "username" - ], - "formatEN": "bind mysql database [database] [username]", - "formatZH": "绑定 mysql 数据库名 [database] [username]", - "paramKeys": [] - } + "Database PostgreSQL" + ] } }, - "/databases/change/access": { + "/databases/pg/bind": { "post": { "consumes": [ "application/json" @@ -7703,7 +9122,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/dto.PostgresqlBindUser" } } ], @@ -7720,31 +9139,23 @@ "Timestamp": [] } ], - "summary": "Change mysql access", + "summary": "Bind postgresql user", "tags": [ - "Database Mysql" + "Database PostgreSQL" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_mysqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "name", + "username" ], - "formatEN": "Update database [name] access", - "formatZH": "更新数据库 [name] 访问权限", + "formatEN": "bind postgresql database [name] user [username]", + "formatZH": "绑定 postgresql 数据库 [name] 用户 [username]", "paramKeys": [] } } }, - "/databases/change/password": { + "/databases/pg/del": { "post": { "consumes": [ "application/json" @@ -7756,7 +9167,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/dto.PostgresqlDBDelete" } } ], @@ -7773,14 +9184,14 @@ "Timestamp": [] } ], - "summary": "Change mysql password", + "summary": "Delete postgresql database", "tags": [ - "Database Mysql" + "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [ { - "db": "database_mysqls", + "db": "database_postgresqls", "input_column": "id", "input_value": "id", "isList": false, @@ -7791,13 +9202,13 @@ "bodyKeys": [ "id" ], - "formatEN": "Update database [name] password", - "formatZH": "更新数据库 [name] 密码", + "formatEN": "delete postgresql database [name]", + "formatZH": "删除 postgresql 数据库 [name]", "paramKeys": [] } } }, - "/databases/common/info": { + "/databases/pg/del/check": { "post": { "consumes": [ "application/json" @@ -7809,7 +9220,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" + "$ref": "#/definitions/dto.PostgresqlDBDeleteCheck" } } ], @@ -7817,7 +9228,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.DBBaseInfo" + "items": { + "type": "string" + }, + "type": "array" } } }, @@ -7829,13 +9243,13 @@ "Timestamp": [] } ], - "summary": "Load base info", + "summary": "Check before delete postgresql database", "tags": [ - "Database Common" + "Database PostgreSQL" ] } }, - "/databases/common/load/file": { + "/databases/pg/description": { "post": { "consumes": [ "application/json" @@ -7847,16 +9261,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" + "$ref": "#/definitions/dto.UpdateDescription" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -7867,13 +9278,32 @@ "Timestamp": [] } ], - "summary": "Load Database conf", + "summary": "Update postgresql database description", "tags": [ - "Database Common" - ] + "Database PostgreSQL" + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "database_postgresqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], + "bodyKeys": [ + "id", + "description" + ], + "formatEN": "The description of the postgresql database [name] is modified =\u003e [description]", + "formatZH": "postgresql 数据库 [name] 描述信息修改 [description]", + "paramKeys": [] + } } }, - "/databases/common/update/conf": { + "/databases/pg/password": { "post": { "consumes": [ "application/json" @@ -7885,7 +9315,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DBConfUpdateByFile" + "$ref": "#/definitions/dto.ChangeDBInfo" } } ], @@ -7902,23 +9332,31 @@ "Timestamp": [] } ], - "summary": "Update conf by upload file", + "summary": "Change postgresql password", "tags": [ - "Database Common" + "Database PostgreSQL" ], "x-panel-log": { - "BeforeFunctions": [], + "BeforeFunctions": [ + { + "db": "database_postgresqls", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + } + ], "bodyKeys": [ - "type", - "database" + "id" ], - "formatEN": "update the [type] [database] database configuration information", - "formatZH": "更新 [type] 数据库 [database] 配置信息", + "formatEN": "Update database [name] password", + "formatZH": "更新数据库 [name] 密码", "paramKeys": [] } } }, - "/databases/db": { + "/databases/pg/privileges": { "post": { "consumes": [ "application/json" @@ -7930,7 +9368,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseCreate" + "$ref": "#/definitions/dto.ChangeDBInfo" } } ], @@ -7947,29 +9385,43 @@ "Timestamp": [] } ], - "summary": "Create database", + "summary": "Change postgresql privileges", "tags": [ - "Database" + "Database PostgreSQL" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "name", - "type" + "database", + "username" ], - "formatEN": "create database [name][type]", - "formatZH": "创建远程数据库 [name][type]", + "formatEN": "Update [user] privileges of database [database]", + "formatZH": "更新数据库 [database] 用户 [username] 权限", "paramKeys": [] } } }, - "/databases/db/:name": { - "get": { + "/databases/pg/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.PostgresqlDBSearch" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.DatabaseInfo" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -7981,13 +9433,13 @@ "Timestamp": [] } ], - "summary": "Get databases", + "summary": "Page postgresql databases", "tags": [ - "Database" + "Database PostgreSQL" ] } }, - "/databases/db/check": { + "/databases/redis/conf": { "post": { "consumes": [ "application/json" @@ -7999,7 +9451,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseCreate" + "$ref": "#/definitions/dto.LoadRedisStatus" } } ], @@ -8007,7 +9459,7 @@ "200": { "description": "OK", "schema": { - "type": "boolean" + "$ref": "#/definitions/dto.RedisConf" } } }, @@ -8019,23 +9471,13 @@ "Timestamp": [] } ], - "summary": "Check database", + "summary": "Load redis conf", "tags": [ - "Database" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name", - "type" - ], - "formatEN": "check if database [name][type] is connectable", - "formatZH": "检测远程数据库 [name][type] 连接性", - "paramKeys": [] - } + "Database Redis" + ] } }, - "/databases/db/del": { + "/databases/redis/conf/update": { "post": { "consumes": [ "application/json" @@ -8047,7 +9489,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseDelete" + "$ref": "#/definitions/dto.RedisConfUpdate" } } ], @@ -8064,41 +9506,24 @@ "Timestamp": [] } ], - "summary": "Delete database", + "summary": "Update redis conf", "tags": [ - "Database" + "Database Redis" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "databases", - "input_column": "id", - "input_value": "ids", - "isList": true, - "output_column": "name", - "output_value": "names" - } - ], - "bodyKeys": [ - "ids" - ], - "formatEN": "delete database [names]", - "formatZH": "删除远程数据库 [names]", + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "update the redis database configuration information", + "formatZH": "更新 redis 数据库配置信息", "paramKeys": [] } } }, - "/databases/db/item/:type": { - "get": { + "/databases/redis/install/cli": { + "post": { "responses": { "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/dto.DatabaseItem" - }, - "type": "array" - } + "description": "OK" } }, "security": [ @@ -8109,24 +9534,32 @@ "Timestamp": [] } ], - "summary": "List databases", + "summary": "Install redis-cli", "tags": [ - "Database" + "Database Redis" ] } }, - "/databases/db/list/:type": { - "get": { - "responses": { - "200": { - "description": "OK", + "/databases/redis/password": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "items": { - "$ref": "#/definitions/dto.DatabaseOption" - }, - "type": "array" + "$ref": "#/definitions/dto.ChangeRedisPass" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -8136,13 +9569,20 @@ "Timestamp": [] } ], - "summary": "List databases", + "summary": "Change redis password", "tags": [ - "Database" - ] + "Database Redis" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "change the password of the redis database", + "formatZH": "修改 redis 数据库密码", + "paramKeys": [] + } } }, - "/databases/db/search": { + "/databases/redis/persistence/conf": { "post": { "consumes": [ "application/json" @@ -8154,7 +9594,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseSearch" + "$ref": "#/definitions/dto.LoadRedisStatus" } } ], @@ -8162,7 +9602,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "$ref": "#/definitions/dto.RedisPersistence" } } }, @@ -8174,13 +9614,13 @@ "Timestamp": [] } ], - "summary": "Page databases", + "summary": "Load redis persistence conf", "tags": [ - "Database" + "Database Redis" ] } }, - "/databases/db/update": { + "/databases/redis/persistence/update": { "post": { "consumes": [ "application/json" @@ -8192,7 +9632,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.DatabaseUpdate" + "$ref": "#/definitions/dto.RedisConfPersistenceUpdate" } } ], @@ -8209,22 +9649,20 @@ "Timestamp": [] } ], - "summary": "Update database", + "summary": "Update redis persistence conf", "tags": [ - "Database" + "Database Redis" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "update database [name]", - "formatZH": "更新远程数据库 [name]", + "bodyKeys": [], + "formatEN": "redis database persistence configuration update", + "formatZH": "redis 数据库持久化配置更新", "paramKeys": [] } } }, - "/databases/del": { + "/databases/redis/status": { "post": { "consumes": [ "application/json" @@ -8236,13 +9674,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBDelete" + "$ref": "#/definitions/dto.LoadRedisStatus" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.RedisStatus" + } } }, "security": [ @@ -8253,31 +9694,13 @@ "Timestamp": [] } ], - "summary": "Delete mysql database", + "summary": "Load redis status info", "tags": [ - "Database Mysql" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_mysqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "delete mysql database [name]", - "formatZH": "删除 mysql 数据库 [name]", - "paramKeys": [] - } + "Database Redis" + ] } }, - "/databases/del/check": { + "/databases/remote": { "post": { "consumes": [ "application/json" @@ -8289,7 +9712,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBDeleteCheck" + "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], @@ -8297,10 +9720,7 @@ "200": { "description": "OK", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "type": "boolean" } } }, @@ -8312,13 +9732,13 @@ "Timestamp": [] } ], - "summary": "Check before delete mysql database", + "summary": "Load mysql remote access", "tags": [ "Database Mysql" ] } }, - "/databases/description/update": { + "/databases/search": { "post": { "consumes": [ "application/json" @@ -8330,13 +9750,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.UpdateDescription" + "$ref": "#/definitions/dto.MysqlDBSearch" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -8347,32 +9770,13 @@ "Timestamp": [] } ], - "summary": "Update mysql database description", + "summary": "Page mysql databases", "tags": [ "Database Mysql" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_mysqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id", - "description" - ], - "formatEN": "The description of the mysql database [name] is modified =\u003e [description]", - "formatZH": "mysql 数据库 [name] 描述信息修改 [description]", - "paramKeys": [] - } + ] } }, - "/databases/load": { + "/databases/status": { "post": { "consumes": [ "application/json" @@ -8384,11 +9788,18 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlLoadDB" + "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], - "responses": {}, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.MysqlStatus" + } + } + }, "security": [ { "ApiKeyAuth": [] @@ -8397,14 +9808,14 @@ "Timestamp": [] } ], - "summary": "Load mysql database from remote", + "summary": "Load mysql status info", "tags": [ "Database Mysql" ] } }, - "/databases/options": { - "get": { + "/databases/variables": { + "post": { "consumes": [ "application/json" ], @@ -8415,7 +9826,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/dto.OperationWithNameAndType" } } ], @@ -8423,10 +9834,7 @@ "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/dto.MysqlOption" - }, - "type": "array" + "$ref": "#/definitions/dto.MysqlVariables" } } }, @@ -8438,13 +9846,13 @@ "Timestamp": [] } ], - "summary": "List mysql database names", + "summary": "Load mysql variables info", "tags": [ "Database Mysql" ] } }, - "/databases/pg": { + "/databases/variables/update": { "post": { "consumes": [ "application/json" @@ -8456,7 +9864,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBCreate" + "$ref": "#/definitions/dto.MysqlVariablesUpdate" } } ], @@ -8473,22 +9881,20 @@ "Timestamp": [] } ], - "summary": "Create postgresql database", + "summary": "Update mysql variables", "tags": [ - "Database PostgreSQL" + "Database Mysql" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "create postgresql database [name]", - "formatZH": "创建 postgresql 数据库 [name]", + "bodyKeys": [], + "formatEN": "adjust mysql database performance parameters", + "formatZH": "调整 mysql 数据库性能参数", "paramKeys": [] } } }, - "/databases/pg/:database/load": { + "/db/remote/del/check": { "post": { "consumes": [ "application/json" @@ -8500,11 +9906,21 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlLoadDB" + "$ref": "#/definitions/dto.OperateByID" } } ], - "responses": {}, + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, "security": [ { "ApiKeyAuth": [] @@ -8513,31 +9929,63 @@ "Timestamp": [] } ], - "summary": "Load postgresql database from remote", + "summary": "Check before delete remote database", "tags": [ - "Database PostgreSQL" + "Database" ] } }, - "/databases/pg/bind": { + "/disks": { + "get": { + "description": "Get information about all disks including partitioned and unpartitioned disks", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.CompleteDiskInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get complete disk information", + "tags": [ + "Disk Management" + ] + } + }, + "/disks/mount": { "post": { "consumes": [ "application/json" ], + "description": "Mount partition to specified mount point", "parameters": [ { - "description": "request", + "description": "mount request", "in": "body", "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlBindUser" + "$ref": "#/definitions/request.DiskMountRequest" } } ], "responses": { "200": { - "description": "OK" + "description": "Disk mounted successfully", + "schema": { + "type": "string" + } } }, "security": [ @@ -8548,41 +9996,45 @@ "Timestamp": [] } ], - "summary": "Bind postgresql user", + "summary": "Mount disk", "tags": [ - "Database PostgreSQL" + "Disk Management" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "name", - "username" + "device", + "mountPoint" ], - "formatEN": "bind postgresql database [name] user [username]", - "formatZH": "绑定 postgresql 数据库 [name] 用户 [username]", + "formatEN": "Mount disk [device] to [mountPoint]", + "formatZH": "挂载磁盘 [device] 到 [mountPoint]", "paramKeys": [] } } }, - "/databases/pg/del": { + "/disks/partition": { "post": { "consumes": [ "application/json" ], + "description": "Create partition and format disk with specified filesystem", "parameters": [ { - "description": "request", + "description": "partition request", "in": "body", "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBDelete" + "$ref": "#/definitions/request.DiskPartitionRequest" } } ], "responses": { "200": { - "description": "OK" + "description": "Partition created successfully", + "schema": { + "type": "string" + } } }, "security": [ @@ -8593,54 +10045,45 @@ "Timestamp": [] } ], - "summary": "Delete postgresql database", + "summary": "Partition disk", "tags": [ - "Database PostgreSQL" + "Disk Management" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_postgresqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "device", + "filesystem", + "mountPoint" ], - "formatEN": "delete postgresql database [name]", - "formatZH": "删除 postgresql 数据库 [name]", + "formatEN": "Partition disk [device] with filesystem [filesystem], mount point [mountPoint]", + "formatZH": "对磁盘 [device] 进行分区，文件系统 [filesystem]，挂载点 [mountPoint]", "paramKeys": [] } } }, - "/databases/pg/del/check": { + "/disks/unmount": { "post": { "consumes": [ "application/json" ], + "description": "Unmount partition from mount point", "parameters": [ { - "description": "request", + "description": "unmount request", "in": "body", "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBDeleteCheck" + "$ref": "#/definitions/request.DiskUnmountRequest" } } ], "responses": { "200": { - "description": "OK", + "description": "Disk unmounted successfully", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" } } }, @@ -8652,13 +10095,23 @@ "Timestamp": [] } ], - "summary": "Check before delete postgresql database", + "summary": "Unmount disk", "tags": [ - "Database PostgreSQL" - ] + "Disk Management" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "device", + "mountPoint" + ], + "formatEN": "Unmount disk [device] from [mountPoint]", + "formatZH": "卸载磁盘 [device] 从 [mountPoint]", + "paramKeys": [] + } } }, - "/databases/pg/description": { + "/files": { "post": { "consumes": [ "application/json" @@ -8670,7 +10123,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.UpdateDescription" + "$ref": "#/definitions/request.FileCreate" } } ], @@ -8686,33 +10139,23 @@ { "Timestamp": [] } - ], - "summary": "Update postgresql database description", - "tags": [ - "Database PostgreSQL" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_postgresqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], + ], + "summary": "Create file", + "tags": [ + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], "bodyKeys": [ - "id", - "description" + "path" ], - "formatEN": "The description of the postgresql database [name] is modified =\u003e [description]", - "formatZH": "postgresql 数据库 [name] 描述信息修改 [description]", + "formatEN": "Create dir or file [path]", + "formatZH": "创建文件/文件夹 [path]", "paramKeys": [] } } }, - "/databases/pg/password": { + "/files/batch/check": { "post": { "consumes": [ "application/json" @@ -8724,13 +10167,19 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/request.FilePathsCheck" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/response.ExistFileInfo" + }, + "type": "array" + } } }, "security": [ @@ -8741,31 +10190,13 @@ "Timestamp": [] } ], - "summary": "Change postgresql password", + "summary": "Batch check file exist", "tags": [ - "Database PostgreSQL" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "database_postgresqls", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "Update database [name] password", - "formatZH": "更新数据库 [name] 密码", - "paramKeys": [] - } + "File" + ] } }, - "/databases/pg/privileges": { + "/files/batch/del": { "post": { "consumes": [ "application/json" @@ -8777,7 +10208,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeDBInfo" + "$ref": "#/definitions/request.FileBatchDelete" } } ], @@ -8794,23 +10225,22 @@ "Timestamp": [] } ], - "summary": "Change postgresql privileges", + "summary": "Batch delete file", "tags": [ - "Database PostgreSQL" + "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "database", - "username" + "paths" ], - "formatEN": "Update [user] privileges of database [database]", - "formatZH": "更新数据库 [database] 用户 [username] 权限", + "formatEN": "Batch delete dir or file [paths]", + "formatZH": "批量删除文件/文件夹 [paths]", "paramKeys": [] } } }, - "/databases/pg/search": { + "/files/batch/role": { "post": { "consumes": [ "application/json" @@ -8822,16 +10252,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PostgresqlDBSearch" + "$ref": "#/definitions/request.FileRoleReq" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -8842,13 +10269,25 @@ "Timestamp": [] } ], - "summary": "Page postgresql databases", + "summary": "Batch change file mode and owner", "tags": [ - "Database PostgreSQL" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "paths", + "mode", + "user", + "group" + ], + "formatEN": "Batch change file mode and owner [paths] =\u003e [mode]/[user]/[group]", + "formatZH": "批量修改文件权限和用户/组 [paths] =\u003e [mode]/[user]/[group]", + "paramKeys": [] + } } }, - "/databases/redis/conf": { + "/files/check": { "post": { "consumes": [ "application/json" @@ -8860,7 +10299,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithName" + "$ref": "#/definitions/request.FilePathCheck" } } ], @@ -8868,7 +10307,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.RedisConf" + "type": "boolean" } } }, @@ -8880,13 +10319,13 @@ "Timestamp": [] } ], - "summary": "Load redis conf", + "summary": "Check file exist", "tags": [ - "Database Redis" + "File" ] } }, - "/databases/redis/conf/update": { + "/files/chunkdownload": { "post": { "consumes": [ "application/json" @@ -8898,7 +10337,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.RedisConfUpdate" + "$ref": "#/definitions/request.FileDownload" } } ], @@ -8915,21 +10354,32 @@ "Timestamp": [] } ], - "summary": "Update redis conf", + "summary": "Chunk Download file", "tags": [ - "Database Redis" + "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "update the redis database configuration information", - "formatZH": "更新 redis 数据库配置信息", + "bodyKeys": [ + "name" + ], + "formatEN": "Download file [name]", + "formatZH": "下载文件 [name]", "paramKeys": [] } } }, - "/databases/redis/install/cli": { + "/files/chunkupload": { "post": { + "parameters": [ + { + "description": "request", + "in": "formData", + "name": "file", + "required": true, + "type": "file" + } + ], "responses": { "200": { "description": "OK" @@ -8943,13 +10393,13 @@ "Timestamp": [] } ], - "summary": "Install redis-cli", + "summary": "ChunkUpload file", "tags": [ - "Database Redis" + "File" ] } }, - "/databases/redis/password": { + "/files/compress": { "post": { "consumes": [ "application/json" @@ -8961,7 +10411,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ChangeRedisPass" + "$ref": "#/definitions/request.FileCompress" } } ], @@ -8978,20 +10428,22 @@ "Timestamp": [] } ], - "summary": "Change redis password", + "summary": "Compress file", "tags": [ - "Database Redis" + "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "change the password of the redis database", - "formatZH": "修改 redis 数据库密码", + "bodyKeys": [ + "name" + ], + "formatEN": "Compress file [name]", + "formatZH": "压缩文件 [name]", "paramKeys": [] } } }, - "/databases/redis/persistence/conf": { + "/files/content": { "post": { "consumes": [ "application/json" @@ -9003,7 +10455,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithName" + "$ref": "#/definitions/request.FileContentReq" } } ], @@ -9011,7 +10463,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.RedisPersistence" + "$ref": "#/definitions/response.FileInfo" } } }, @@ -9023,13 +10475,22 @@ "Timestamp": [] } ], - "summary": "Load redis persistence conf", + "summary": "Load file content", "tags": [ - "Database Redis" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "Load file content [path]", + "formatZH": "获取文件内容 [path]", + "paramKeys": [] + } } }, - "/databases/redis/persistence/update": { + "/files/decompress": { "post": { "consumes": [ "application/json" @@ -9041,7 +10502,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.RedisConfPersistenceUpdate" + "$ref": "#/definitions/request.FileDeCompress" } } ], @@ -9058,20 +10519,22 @@ "Timestamp": [] } ], - "summary": "Update redis persistence conf", + "summary": "Decompress file", "tags": [ - "Database Redis" + "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "redis database persistence configuration update", - "formatZH": "redis 数据库持久化配置更新", + "bodyKeys": [ + "path" + ], + "formatEN": "Decompress file [path]", + "formatZH": "解压 [path]", "paramKeys": [] } } }, - "/databases/redis/status": { + "/files/del": { "post": { "consumes": [ "application/json" @@ -9083,16 +10546,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithName" + "$ref": "#/definitions/request.FileDelete" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.RedisStatus" - } + "description": "OK" } }, "security": [ @@ -9103,51 +10563,22 @@ "Timestamp": [] } ], - "summary": "Load redis status info", + "summary": "Delete file", "tags": [ - "Database Redis" - ] - } - }, - "/databases/remote": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "boolean" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } + "File" ], - "summary": "Load mysql remote access", - "tags": [ - "Database Mysql" - ] + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "Delete dir or file [path]", + "formatZH": "删除文件/文件夹 [path]", + "paramKeys": [] + } } }, - "/databases/search": { + "/files/depth/size": { "post": { "consumes": [ "application/json" @@ -9159,7 +10590,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlDBSearch" + "$ref": "#/definitions/request.DirSizeReq" } } ], @@ -9167,7 +10598,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "items": { + "$ref": "#/definitions/response.DepthDirSizeRes" + }, + "type": "array" } } }, @@ -9179,34 +10613,29 @@ "Timestamp": [] } ], - "summary": "Page mysql databases", + "summary": "Multi file size", "tags": [ - "Database Mysql" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "Multi file size [path]", + "formatZH": "获取目录及其第一层子目录文件夹大小 [path]", + "paramKeys": [] + } } }, - "/databases/status": { - "post": { + "/files/download": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" - } - } - ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.MysqlStatus" - } + "description": "OK" } }, "security": [ @@ -9217,13 +10646,13 @@ "Timestamp": [] } ], - "summary": "Load mysql status info", + "summary": "Download file", "tags": [ - "Database Mysql" + "File" ] } }, - "/databases/variables": { + "/files/favorite": { "post": { "consumes": [ "application/json" @@ -9235,7 +10664,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperationWithNameAndType" + "$ref": "#/definitions/request.FavoriteCreate" } } ], @@ -9243,7 +10672,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.MysqlVariables" + "$ref": "#/definitions/model.Favorite" } } }, @@ -9255,13 +10684,22 @@ "Timestamp": [] } ], - "summary": "Load mysql variables info", + "summary": "Create favorite", "tags": [ - "Database Mysql" - ] + "File" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "path" + ], + "formatEN": "收藏文件/文件夹 [path]", + "formatZH": "收藏文件/文件夹 [path]", + "paramKeys": [] + } } }, - "/databases/variables/update": { + "/files/favorite/del": { "post": { "consumes": [ "application/json" @@ -9273,7 +10711,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MysqlVariablesUpdate" + "$ref": "#/definitions/request.FavoriteDelete" } } ], @@ -9290,20 +10728,31 @@ "Timestamp": [] } ], - "summary": "Update mysql variables", + "summary": "Delete favorite", "tags": [ - "Database Mysql" + "File" ], "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "adjust mysql database performance parameters", - "formatZH": "调整 mysql 数据库性能参数", + "BeforeFunctions": [ + { + "db": "favorites", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "path", + "output_value": "path" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "delete avorite [path]", + "formatZH": "删除收藏 [path]", "paramKeys": [] } } }, - "/db/remote/del/check": { + "/files/favorite/search": { "post": { "consumes": [ "application/json" @@ -9315,7 +10764,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.OperateByID" + "$ref": "#/definitions/dto.PageInfo" } } ], @@ -9323,10 +10772,7 @@ "200": { "description": "OK", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -9338,13 +10784,13 @@ "Timestamp": [] } ], - "summary": "Check before delete remote database", + "summary": "List favorites", "tags": [ - "Database" + "File" ] } }, - "/files": { + "/files/mode": { "post": { "consumes": [ "application/json" @@ -9373,22 +10819,23 @@ "Timestamp": [] } ], - "summary": "Create file", + "summary": "Change file mode", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "path", + "mode" ], - "formatEN": "Create dir or file [path]", - "formatZH": "创建文件/文件夹 [path]", + "formatEN": "Change mode [paths] =\u003e [mode]", + "formatZH": "修改权限 [paths] =\u003e [mode]", "paramKeys": [] } } }, - "/files/batch/del": { + "/files/move": { "post": { "consumes": [ "application/json" @@ -9400,7 +10847,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileBatchDelete" + "$ref": "#/definitions/request.FileMove" } } ], @@ -9417,22 +10864,23 @@ "Timestamp": [] } ], - "summary": "Batch delete file", + "summary": "Move file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "paths" + "oldPaths", + "newPath" ], - "formatEN": "Batch delete dir or file [paths]", - "formatZH": "批量删除文件/文件夹 [paths]", + "formatEN": "Move [oldPaths] =\u003e [newPath]", + "formatZH": "移动文件 [oldPaths] =\u003e [newPath]", "paramKeys": [] } } }, - "/files/batch/role": { + "/files/owner": { "post": { "consumes": [ "application/json" @@ -9444,7 +10892,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileRoleReq" + "$ref": "#/definitions/request.FileRoleUpdate" } } ], @@ -9461,29 +10909,25 @@ "Timestamp": [] } ], - "summary": "Batch change file mode and owner", + "summary": "Change file owner", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "paths", - "mode", + "path", "user", "group" ], - "formatEN": "Batch change file mode and owner [paths] =\u003e [mode]/[user]/[group]", - "formatZH": "批量修改文件权限和用户/组 [paths] =\u003e [mode]/[user]/[group]", + "formatEN": "Change owner [paths] =\u003e [user]/[group]", + "formatZH": "修改用户/组 [paths] =\u003e [user]/[group]", "paramKeys": [] } } }, - "/files/check": { + "/files/read": { "post": { - "consumes": [ - "application/json" - ], "parameters": [ { "description": "request", @@ -9491,7 +10935,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FilePathCheck" + "$ref": "#/definitions/request.FileReadByLineReq" } } ], @@ -9499,7 +10943,7 @@ "200": { "description": "OK", "schema": { - "type": "boolean" + "$ref": "#/definitions/response.FileLineContent" } } }, @@ -9511,28 +10955,17 @@ "Timestamp": [] } ], - "summary": "Check file exist", + "summary": "Read file by Line", "tags": [ "File" ] } }, - "/files/chunkdownload": { + "/files/recycle/clear": { "post": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.FileDownload" - } - } - ], "responses": { "200": { "description": "OK" @@ -9546,30 +10979,33 @@ "Timestamp": [] } ], - "summary": "Chunk Download file", + "summary": "Clear RecycleBin files", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Download file [name]", - "formatZH": "下载文件 [name]", + "bodyKeys": [], + "formatEN": "清空回收站", + "formatZH": "清空回收站", "paramKeys": [] } } }, - "/files/chunkupload": { + "/files/recycle/reduce": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", - "in": "formData", - "name": "file", + "in": "body", + "name": "request", "required": true, - "type": "file" + "schema": { + "$ref": "#/definitions/request.RecycleBinReduce" + } } ], "responses": { @@ -9585,13 +11021,22 @@ "Timestamp": [] } ], - "summary": "ChunkUpload file", + "summary": "Reduce RecycleBin files", "tags": [ "File" - ] + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "name" + ], + "formatEN": "Reduce RecycleBin file [name]", + "formatZH": "还原回收站文件 [name]", + "paramKeys": [] + } } }, - "/files/compress": { + "/files/recycle/search": { "post": { "consumes": [ "application/json" @@ -9603,13 +11048,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileCompress" + "$ref": "#/definitions/dto.PageInfo" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -9620,42 +11068,22 @@ "Timestamp": [] } ], - "summary": "Compress file", + "summary": "List RecycleBin files", "tags": [ "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Compress file [name]", - "formatZH": "压缩文件 [name]", - "paramKeys": [] - } + ] } }, - "/files/content": { - "post": { + "/files/recycle/status": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.FileContentReq" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.FileInfo" + "type": "string" } } }, @@ -9667,22 +11095,13 @@ "Timestamp": [] } ], - "summary": "Load file content", + "summary": "Get RecycleBin status", "tags": [ "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "path" - ], - "formatEN": "Load file content [path]", - "formatZH": "获取文件内容 [path]", - "paramKeys": [] - } + ] } }, - "/files/decompress": { + "/files/rename": { "post": { "consumes": [ "application/json" @@ -9694,7 +11113,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileDeCompress" + "$ref": "#/definitions/request.FileRename" } } ], @@ -9711,22 +11130,23 @@ "Timestamp": [] } ], - "summary": "Decompress file", + "summary": "Change file name", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "oldName", + "newName" ], - "formatEN": "Decompress file [path]", - "formatZH": "解压 [path]", + "formatEN": "Rename [oldName] =\u003e [newName]", + "formatZH": "重命名 [oldName] =\u003e [newName]", "paramKeys": [] } } }, - "/files/del": { + "/files/save": { "post": { "consumes": [ "application/json" @@ -9738,7 +11158,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileDelete" + "$ref": "#/definitions/request.FileEdit" } } ], @@ -9755,7 +11175,7 @@ "Timestamp": [] } ], - "summary": "Delete file", + "summary": "Update file content", "tags": [ "File" ], @@ -9764,20 +11184,34 @@ "bodyKeys": [ "path" ], - "formatEN": "Delete dir or file [path]", - "formatZH": "删除文件/文件夹 [path]", + "formatEN": "Update file content [path]", + "formatZH": "更新文件内容 [path]", "paramKeys": [] } } }, - "/files/download": { - "get": { + "/files/search": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.FileOption" + } + } + ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.FileInfo" + } } }, "security": [ @@ -9788,13 +11222,13 @@ "Timestamp": [] } ], - "summary": "Download file", + "summary": "List files", "tags": [ "File" ] } }, - "/files/favorite": { + "/files/size": { "post": { "consumes": [ "application/json" @@ -9806,7 +11240,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FavoriteCreate" + "$ref": "#/definitions/request.DirSizeReq" } } ], @@ -9814,7 +11248,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/model.Favorite" + "$ref": "#/definitions/response.DirSizeRes" } } }, @@ -9826,7 +11260,7 @@ "Timestamp": [] } ], - "summary": "Create favorite", + "summary": "Load file size", "tags": [ "File" ], @@ -9835,13 +11269,13 @@ "bodyKeys": [ "path" ], - "formatEN": "收藏文件/文件夹 [path]", - "formatZH": "收藏文件/文件夹 [path]", + "formatEN": "Load file size [path]", + "formatZH": "获取文件夹大小 [path]", "paramKeys": [] } } }, - "/files/favorite/del": { + "/files/tree": { "post": { "consumes": [ "application/json" @@ -9853,9 +11287,45 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FavoriteDelete" + "$ref": "#/definitions/request.FileOption" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/response.FileTree" + }, + "type": "array" } } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load files tree", + "tags": [ + "File" + ] + } + }, + "/files/upload": { + "post": { + "parameters": [ + { + "description": "request", + "in": "formData", + "name": "file", + "required": true, + "type": "file" + } ], "responses": { "200": { @@ -9870,31 +11340,23 @@ "Timestamp": [] } ], - "summary": "Delete favorite", + "summary": "Upload file", "tags": [ "File" ], "x-panel-log": { - "BeforeFunctions": [ - { - "db": "favorites", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "path", - "output_value": "path" - } - ], + "BeforeFunctions": [], "bodyKeys": [ - "id" + "path", + "file" ], - "formatEN": "delete avorite [path]", - "formatZH": "删除收藏 [path]", + "formatEN": "Upload file [path]/[file]", + "formatZH": "上传文件 [path]/[file]", "paramKeys": [] } } }, - "/files/favorite/search": { + "/files/upload/search": { "post": { "consumes": [ "application/json" @@ -9906,7 +11368,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/request.SearchUploadWithPage" } } ], @@ -9926,13 +11388,13 @@ "Timestamp": [] } ], - "summary": "List favorites", + "summary": "Page file", "tags": [ "File" ] } }, - "/files/mode": { + "/files/wget": { "post": { "consumes": [ "application/json" @@ -9944,13 +11406,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileCreate" + "$ref": "#/definitions/request.FileWget" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.FileWgetRes" + } } }, "security": [ @@ -9961,23 +11426,24 @@ "Timestamp": [] } ], - "summary": "Change file mode", + "summary": "Wget file", "tags": [ "File" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ + "url", "path", - "mode" + "name" ], - "formatEN": "Change mode [paths] =\u003e [mode]", - "formatZH": "修改权限 [paths] =\u003e [mode]", + "formatEN": "Download url =\u003e [path]/[name]", + "formatZH": "下载 url =\u003e [path]/[name]", "paramKeys": [] } } }, - "/files/move": { + "/groups": { "post": { "consumes": [ "application/json" @@ -9989,7 +11455,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileMove" + "$ref": "#/definitions/dto.GroupCreate" } } ], @@ -10006,23 +11472,23 @@ "Timestamp": [] } ], - "summary": "Move file", + "summary": "Create group", "tags": [ - "File" + "System Group" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "oldPaths", - "newPath" + "name", + "type" ], - "formatEN": "Move [oldPaths] =\u003e [newPath]", - "formatZH": "移动文件 [oldPaths] =\u003e [newPath]", + "formatEN": "create group [name][type]", + "formatZH": "创建组 [name][type]", "paramKeys": [] } } }, - "/files/owner": { + "/groups/del": { "post": { "consumes": [ "application/json" @@ -10034,7 +11500,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileRoleUpdate" + "$ref": "#/definitions/dto.OperateByID" } } ], @@ -10051,25 +11517,43 @@ "Timestamp": [] } ], - "summary": "Change file owner", + "summary": "Delete group", "tags": [ - "File" + "System Group" ], "x-panel-log": { - "BeforeFunctions": [], + "BeforeFunctions": [ + { + "db": "groups", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "name", + "output_value": "name" + }, + { + "db": "groups", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "type", + "output_value": "type" + } + ], "bodyKeys": [ - "path", - "user", - "group" + "id" ], - "formatEN": "Change owner [paths] =\u003e [user]/[group]", - "formatZH": "修改用户/组 [paths] =\u003e [user]/[group]", + "formatEN": "delete group [type][name]", + "formatZH": "删除组 [type][name]", "paramKeys": [] } } }, - "/files/read": { + "/groups/search": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", @@ -10077,7 +11561,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileReadByLineReq" + "$ref": "#/definitions/dto.GroupSearch" } } ], @@ -10085,7 +11569,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.FileLineContent" + "items": { + "$ref": "#/definitions/dto.OperateByType" + }, + "type": "array" } } }, @@ -10097,17 +11584,28 @@ "Timestamp": [] } ], - "summary": "Read file by Line", + "summary": "List groups", "tags": [ - "File" + "System Group" ] } }, - "/files/recycle/clear": { + "/groups/update": { "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.GroupUpdate" + } + } + ], "responses": { "200": { "description": "OK" @@ -10121,38 +11619,42 @@ "Timestamp": [] } ], - "summary": "Clear RecycleBin files", + "summary": "Update group", "tags": [ - "File" + "System Group" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "清空回收站", - "formatZH": "清空回收站", + "bodyKeys": [ + "name", + "type" + ], + "formatEN": "update group [name][type]", + "formatZH": "更新组 [name][type]", "paramKeys": [] } } }, - "/files/recycle/reduce": { - "post": { + "/hosts/components/{name}": { + "get": { "consumes": [ "application/json" ], "parameters": [ { - "description": "request", - "in": "body", - "name": "request", + "description": "Component name to check (e.g., rsync, docker)", + "in": "query", + "name": "name", "required": true, - "schema": { - "$ref": "#/definitions/request.RecycleBinReduce" - } + "type": "string" } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.ComponentInfo" + } } }, "security": [ @@ -10163,22 +11665,13 @@ "Timestamp": [] } ], - "summary": "Reduce RecycleBin files", + "summary": "Check if a system component exists", "tags": [ - "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Reduce RecycleBin file [name]", - "formatZH": "还原回收站文件 [name]", - "paramKeys": [] - } + "Host" + ] } }, - "/files/recycle/search": { + "/hosts/conffile/update": { "post": { "consumes": [ "application/json" @@ -10190,15 +11683,43 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/dto.SSHConf" } } ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update host SSH setting by file", + "tags": [ + "SSH" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "update SSH conf", + "formatZH": "修改 SSH 配置文件", + "paramKeys": [] + } + } + }, + "/hosts/firewall/base": { + "get": { "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "$ref": "#/definitions/dto.FirewallBaseInfo" } } }, @@ -10210,24 +11731,32 @@ "Timestamp": [] } ], - "summary": "List RecycleBin files", + "summary": "Load firewall base info", "tags": [ - "File" + "Firewall" ] } }, - "/files/recycle/status": { - "get": { + "/hosts/firewall/batch": { + "post": { "consumes": [ "application/json" ], - "responses": { - "200": { - "description": "OK", + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "type": "string" + "$ref": "#/definitions/dto.BatchRuleOperate" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -10237,13 +11766,13 @@ "Timestamp": [] } ], - "summary": "Get RecycleBin status", + "summary": "Create group", "tags": [ - "File" + "Firewall" ] } }, - "/files/rename": { + "/hosts/firewall/forward": { "post": { "consumes": [ "application/json" @@ -10255,7 +11784,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileRename" + "$ref": "#/definitions/dto.ForwardRuleOperate" } } ], @@ -10272,23 +11801,22 @@ "Timestamp": [] } ], - "summary": "Change file name", + "summary": "Create group", "tags": [ - "File" + "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "oldName", - "newName" + "source_port" ], - "formatEN": "Rename [oldName] =\u003e [newName]", - "formatZH": "重命名 [oldName] =\u003e [newName]", + "formatEN": "update port forward rules [source_port]", + "formatZH": "更新端口转发规则 [source_port]", "paramKeys": [] } } }, - "/files/save": { + "/hosts/firewall/ip": { "post": { "consumes": [ "application/json" @@ -10300,7 +11828,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileEdit" + "$ref": "#/definitions/dto.AddrRuleOperate" } } ], @@ -10317,22 +11845,23 @@ "Timestamp": [] } ], - "summary": "Update file content", + "summary": "Create group", "tags": [ - "File" + "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "strategy", + "address" ], - "formatEN": "Update file content [path]", - "formatZH": "更新文件内容 [path]", + "formatEN": "create address rules [strategy][address]", + "formatZH": "添加 ip 规则 [strategy] [address]", "paramKeys": [] } } }, - "/files/search": { + "/hosts/firewall/operate": { "post": { "consumes": [ "application/json" @@ -10344,16 +11873,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileOption" + "$ref": "#/definitions/dto.FirewallOperation" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.FileInfo" - } + "description": "OK" } }, "security": [ @@ -10364,13 +11890,22 @@ "Timestamp": [] } ], - "summary": "List files", + "summary": "Operate firewall", "tags": [ - "File" - ] + "Firewall" + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [ + "operation" + ], + "formatEN": "[operation] firewall", + "formatZH": "[operation] 防火墙", + "paramKeys": [] + } } }, - "/files/size": { + "/hosts/firewall/port": { "post": { "consumes": [ "application/json" @@ -10382,16 +11917,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.DirSizeReq" + "$ref": "#/definitions/dto.PortRuleOperate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.DirSizeRes" - } + "description": "OK" } }, "security": [ @@ -10402,22 +11934,23 @@ "Timestamp": [] } ], - "summary": "Load file size", + "summary": "Create group", "tags": [ - "File" + "Firewall" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "path" + "port", + "strategy" ], - "formatEN": "Load file size [path]", - "formatZH": "获取文件夹大小 [path]", + "formatEN": "create port rules [strategy][port]", + "formatZH": "添加端口规则 [strategy] [port]", "paramKeys": [] } } }, - "/files/tree": { + "/hosts/firewall/search": { "post": { "consumes": [ "application/json" @@ -10429,7 +11962,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileOption" + "$ref": "#/definitions/dto.RuleSearch" } } ], @@ -10437,10 +11970,7 @@ "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/response.FileTree" - }, - "type": "array" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -10452,21 +11982,26 @@ "Timestamp": [] } ], - "summary": "Load files tree", + "summary": "Page firewall rules", "tags": [ - "File" + "Firewall" ] } }, - "/files/upload": { + "/hosts/firewall/update/addr": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", - "in": "formData", - "name": "file", + "in": "body", + "name": "request", "required": true, - "type": "file" + "schema": { + "$ref": "#/definitions/dto.AddrRuleUpdate" + } } ], "responses": { @@ -10482,22 +12017,13 @@ "Timestamp": [] } ], - "summary": "Upload file", + "summary": "Create group", "tags": [ - "File" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "path" - ], - "formatEN": "Upload file [path]", - "formatZH": "上传文件 [path]", - "paramKeys": [] - } + "Firewall" + ] } }, - "/files/upload/search": { + "/hosts/firewall/update/description": { "post": { "consumes": [ "application/json" @@ -10509,16 +12035,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.SearchUploadWithPage" + "$ref": "#/definitions/dto.UpdateFirewallDescription" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } + "description": "OK" } }, "security": [ @@ -10529,13 +12052,13 @@ "Timestamp": [] } ], - "summary": "Page file", + "summary": "Update rule description", "tags": [ - "File" + "Firewall" ] } }, - "/files/wget": { + "/hosts/firewall/update/port": { "post": { "consumes": [ "application/json" @@ -10547,16 +12070,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.FileWget" + "$ref": "#/definitions/dto.PortRuleUpdate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/response.FileWgetRes" - } + "description": "OK" } }, "security": [ @@ -10567,28 +12087,42 @@ "Timestamp": [] } ], - "summary": "Wget file", + "summary": "Create group", "tags": [ - "File" + "Firewall" + ] + } + }, + "/hosts/monitor/clean": { + "post": { + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Clean monitor data", + "tags": [ + "Monitor" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "url", - "path", - "name" - ], - "formatEN": "Download url =\u003e [path]/[name]", - "formatZH": "下载 url =\u003e [path]/[name]", + "bodyKeys": [], + "formatEN": "clean monitor datas", + "formatZH": "清空监控数据", "paramKeys": [] } } }, - "/host/conffile/update": { + "/hosts/monitor/search": { "post": { - "consumes": [ - "application/json" - ], "parameters": [ { "description": "request", @@ -10596,13 +12130,19 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SSHConf" + "$ref": "#/definitions/dto.MonitorSearch" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "$ref": "#/definitions/dto.MonitorData" + }, + "type": "array" + } } }, "security": [ @@ -10613,26 +12153,19 @@ "Timestamp": [] } ], - "summary": "Update host SSH setting by file", + "summary": "Load monitor data", "tags": [ - "SSH" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "update SSH conf", - "formatZH": "修改 SSH 配置文件", - "paramKeys": [] - } + "Monitor" + ] } }, - "/host/ssh/conf": { + "/hosts/monitor/setting": { "get": { "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/dto.MonitorSetting" } } }, @@ -10644,17 +12177,14 @@ "Timestamp": [] } ], - "summary": "Load host SSH conf", + "summary": "Load monitor setting", "tags": [ - "SSH" + "Monitor" ] } }, - "/host/ssh/generate": { + "/hosts/monitor/setting/update": { "post": { - "consumes": [ - "application/json" - ], "parameters": [ { "description": "request", @@ -10662,7 +12192,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.GenerateSSH" + "$ref": "#/definitions/dto.MonitorSettingUpdate" } } ], @@ -10679,20 +12209,23 @@ "Timestamp": [] } ], - "summary": "Generate host SSH secret", + "summary": "Update monitor setting", "tags": [ - "SSH" + "Monitor" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "generate SSH secret", - "formatZH": "生成 SSH 密钥 ", + "bodyKeys": [ + "key", + "value" + ], + "formatEN": "update default monitor [name]-[value]", + "formatZH": "修改默认监控网卡 [name]-[value]", "paramKeys": [] } } }, - "/host/ssh/log": { + "/hosts/ssh/cert": { "post": { "consumes": [ "application/json" @@ -10704,16 +12237,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchSSHLog" + "$ref": "#/definitions/dto.CreateRootCert" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.SSHLog" - } + "description": "OK" } }, "security": [ @@ -10724,13 +12254,20 @@ "Timestamp": [] } ], - "summary": "Load host SSH logs", + "summary": "Generate host SSH secret", "tags": [ "SSH" - ] + ], + "x-panel-log": { + "BeforeFunctions": [], + "bodyKeys": [], + "formatEN": "generate SSH secret", + "formatZH": "生成 SSH 密钥 ", + "paramKeys": [] + } } }, - "/host/ssh/operate": { + "/hosts/ssh/cert/delete": { "post": { "consumes": [ "application/json" @@ -10742,7 +12279,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.Operate" + "$ref": "#/definitions/dto.ForceDelete" } } ], @@ -10759,46 +12296,20 @@ "Timestamp": [] } ], - "summary": "Operate SSH", + "summary": "Delete host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "operation" - ], - "formatEN": "[operation] SSH", - "formatZH": "[operation] SSH ", + "bodyKeys": [], + "formatEN": "delete SSH secret", + "formatZH": "删除 SSH 密钥 ", "paramKeys": [] } } }, - "/host/ssh/search": { - "post": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.SSHInfo" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load host SSH setting info", - "tags": [ - "SSH" - ] - } - }, - "/host/ssh/secret": { + "/hosts/ssh/cert/search": { "post": { "consumes": [ "application/json" @@ -10810,7 +12321,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.GenerateLoad" + "$ref": "#/definitions/dto.SearchWithPage" } } ], @@ -10818,7 +12329,7 @@ "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -10836,22 +12347,8 @@ ] } }, - "/host/ssh/update": { + "/hosts/ssh/cert/sync": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.SSHUpdate" - } - } - ], "responses": { "200": { "description": "OK" @@ -10865,23 +12362,44 @@ "Timestamp": [] } ], - "summary": "Update host SSH setting", + "summary": "Sycn host SSH secret", "tags": [ "SSH" ], "x-panel-log": { "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "update SSH setting [key] =\u003e [value]", - "formatZH": "修改 SSH 配置 [key] =\u003e [value]", + "bodyKeys": [], + "formatEN": "sync SSH secret", + "formatZH": "同步 SSH 密钥 ", "paramKeys": [] } } }, - "/host/tool": { + "/hosts/ssh/conf": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load host SSH conf", + "tags": [ + "SSH" + ] + } + }, + "/hosts/ssh/log": { "post": { "consumes": [ "application/json" @@ -10893,7 +12411,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolReq" + "$ref": "#/definitions/dto.SearchSSHLog" } } ], @@ -10901,7 +12419,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.HostToolRes" + "$ref": "#/definitions/dto.PageResult" } } }, @@ -10913,13 +12431,13 @@ "Timestamp": [] } ], - "summary": "Get tool status", + "summary": "Load host SSH logs", "tags": [ - "Host tool" + "SSH" ] } }, - "/host/tool/config": { + "/hosts/ssh/log/export": { "post": { "consumes": [ "application/json" @@ -10931,7 +12449,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolConfig" + "$ref": "#/definitions/dto.SearchSSHLog" } } ], @@ -10939,7 +12457,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.HostToolConfig" + "type": "string" } } }, @@ -10951,22 +12469,13 @@ "Timestamp": [] } ], - "summary": "Get tool config", + "summary": "Export host SSH logs", "tags": [ - "Host tool" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "operate" - ], - "formatEN": "[operate] tool config", - "formatZH": "[operate] 主机工具配置文件 ", - "paramKeys": [] - } + "SSH" + ] } }, - "/host/tool/create": { + "/hosts/ssh/operate": { "post": { "consumes": [ "application/json" @@ -10978,7 +12487,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolCreate" + "$ref": "#/definitions/dto.Operate" } } ], @@ -10995,42 +12504,28 @@ "Timestamp": [] } ], - "summary": "Create Host tool Config", + "summary": "Operate SSH", "tags": [ - "Host tool" + "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "type" + "operation" ], - "formatEN": "create [type] config", - "formatZH": "创建 [type] 配置", + "formatEN": "[operation] SSH", + "formatZH": "[operation] SSH ", "paramKeys": [] } } }, - "/host/tool/log": { + "/hosts/ssh/search": { "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.HostToolLogReq" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "$ref": "#/definitions/dto.SSHInfo" } } }, @@ -11042,13 +12537,13 @@ "Timestamp": [] } ], - "summary": "Get tool logs", + "summary": "Load host SSH setting info", "tags": [ - "Host tool" + "SSH" ] } }, - "/host/tool/operate": { + "/hosts/ssh/update": { "post": { "consumes": [ "application/json" @@ -11060,7 +12555,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.HostToolReq" + "$ref": "#/definitions/dto.SSHUpdate" } } ], @@ -11077,32 +12572,43 @@ "Timestamp": [] } ], - "summary": "Operate tool", + "summary": "Update host SSH setting", "tags": [ - "Host tool" + "SSH" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "operate", - "type" + "key", + "value" ], - "formatEN": "[operate] [type]", - "formatZH": "[operate] [type] ", + "formatEN": "update SSH setting [key] =\u003e [value]", + "formatZH": "修改 SSH 配置 [key] =\u003e [value]", "paramKeys": [] } } }, - "/host/tool/supervisor/process": { - "get": { + "/hosts/tool": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.HostToolReq" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/response.SupervisorProcessConfig" + "$ref": "#/definitions/response.HostToolRes" } } }, @@ -11114,11 +12620,13 @@ "Timestamp": [] } ], - "summary": "Get Supervisor process config", + "summary": "Get tool status", "tags": [ "Host tool" ] - }, + } + }, + "/hosts/tool/config": { "post": { "consumes": [ "application/json" @@ -11130,13 +12638,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.SupervisorProcessConfig" + "$ref": "#/definitions/request.HostToolConfig" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.HostToolConfig" + } } }, "security": [ @@ -11147,7 +12658,7 @@ "Timestamp": [] } ], - "summary": "Create Supervisor process", + "summary": "Get tool config", "tags": [ "Host tool" ], @@ -11156,13 +12667,13 @@ "bodyKeys": [ "operate" ], - "formatEN": "[operate] process", - "formatZH": "[operate] 守护进程 ", + "formatEN": "[operate] tool config", + "formatZH": "[operate] 主机工具配置文件 ", "paramKeys": [] } } }, - "/host/tool/supervisor/process/file": { + "/hosts/tool/create": { "post": { "consumes": [ "application/json" @@ -11174,16 +12685,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.SupervisorProcessFileReq" + "$ref": "#/definitions/request.HostToolCreate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -11194,46 +12702,22 @@ "Timestamp": [] } ], - "summary": "Get Supervisor process config file", + "summary": "Create Host tool Config", "tags": [ "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "operate" + "type" ], - "formatEN": "[operate] Supervisor Process Config file", - "formatZH": "[operate] Supervisor 进程文件 ", + "formatEN": "create [type] config", + "formatZH": "创建 [type] 配置", "paramKeys": [] } } }, - "/hosts/firewall/base": { - "get": { - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.FirewallBaseInfo" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load firewall base info", - "tags": [ - "Firewall" - ] - } - }, - "/hosts/firewall/batch": { + "/hosts/tool/log": { "post": { "consumes": [ "application/json" @@ -11245,13 +12729,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.BatchRuleOperate" + "$ref": "#/definitions/request.HostToolLogReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "string" + } } }, "security": [ @@ -11262,13 +12749,13 @@ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get tool logs", "tags": [ - "Firewall" + "Host tool" ] } }, - "/hosts/firewall/forward": { + "/hosts/tool/operate": { "post": { "consumes": [ "application/json" @@ -11280,7 +12767,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ForwardRuleOperate" + "$ref": "#/definitions/request.HostToolReq" } } ], @@ -11297,40 +12784,33 @@ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Operate tool", "tags": [ - "Firewall" + "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "source_port" + "operate", + "type" ], - "formatEN": "update port forward rules [source_port]", - "formatZH": "更新端口转发规则 [source_port]", + "formatEN": "[operate] [type]", + "formatZH": "[operate] [type] ", "paramKeys": [] } } }, - "/hosts/firewall/ip": { - "post": { + "/hosts/tool/supervisor/process": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.AddrRuleOperate" - } - } - ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/response.SupervisorProcessConfig" + } } }, "security": [ @@ -11341,23 +12821,11 @@ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get Supervisor process config", "tags": [ - "Firewall" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "strategy", - "address" - ], - "formatEN": "create address rules [strategy][address]", - "formatZH": "添加 ip 规则 [strategy] [address]", - "paramKeys": [] - } - } - }, - "/hosts/firewall/operate": { + "Host tool" + ] + }, "post": { "consumes": [ "application/json" @@ -11369,7 +12837,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.FirewallOperation" + "$ref": "#/definitions/request.SupervisorProcessConfig" } } ], @@ -11386,22 +12854,22 @@ "Timestamp": [] } ], - "summary": "Operate firewall", + "summary": "Create Supervisor process", "tags": [ - "Firewall" + "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "operation" + "operate" ], - "formatEN": "[operation] firewall", - "formatZH": "[operation] 防火墙", + "formatEN": "[operate] process", + "formatZH": "[operate] 守护进程 ", "paramKeys": [] } } }, - "/hosts/firewall/port": { + "/hosts/tool/supervisor/process/file": { "post": { "consumes": [ "application/json" @@ -11413,13 +12881,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PortRuleOperate" + "$ref": "#/definitions/request.SupervisorProcessFileReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "string" + } } }, "security": [ @@ -11430,43 +12901,34 @@ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Get Supervisor process config file", "tags": [ - "Firewall" + "Host tool" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "port", - "strategy" + "operate" ], - "formatEN": "create port rules [strategy][port]", - "formatZH": "添加端口规则 [strategy] [port]", + "formatEN": "[operate] Supervisor Process Config file", + "formatZH": "[operate] Supervisor 进程文件 ", "paramKeys": [] } } }, - "/hosts/firewall/search": { - "post": { + "/installed/delete/check/:id": { + "get": { "consumes": [ "application/json" ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.RuleSearch" - } - } - ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "items": { + "$ref": "#/definitions/dto.AppResource" + }, + "type": "array" } } }, @@ -11478,31 +12940,23 @@ "Timestamp": [] } ], - "summary": "Page firewall rules", + "summary": "Delete runtime", "tags": [ - "Firewall" + "Website" ] } }, - "/hosts/firewall/update/addr": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.AddrRuleUpdate" - } - } - ], + "/logs/system/files": { + "get": { "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } } }, "security": [ @@ -11513,31 +12967,20 @@ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Load system log files", "tags": [ - "Firewall" + "Logs" ] } }, - "/hosts/firewall/update/description": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.UpdateFirewallDescription" - } - } - ], + "/logs/tasks/executing/count": { + "get": { "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "type": "integer" + } } }, "security": [ @@ -11548,13 +12991,13 @@ "Timestamp": [] } ], - "summary": "Update rule description", + "summary": "Get the number of executing tasks", "tags": [ - "Firewall" + "TaskLog" ] } }, - "/hosts/firewall/update/port": { + "/logs/tasks/search": { "post": { "consumes": [ "application/json" @@ -11566,13 +13009,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PortRuleUpdate" + "$ref": "#/definitions/dto.SearchTaskLogReq" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -11583,42 +13029,17 @@ "Timestamp": [] } ], - "summary": "Create group", + "summary": "Page task logs", "tags": [ - "Firewall" + "TaskLog" ] } }, - "/hosts/monitor/clean": { + "/mcp/domain/bind": { "post": { - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Clean monitor data", - "tags": [ - "Monitor" + "consumes": [ + "application/json" ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "clean monitor datas", - "formatZH": "清空监控数据", - "paramKeys": [] - } - } - }, - "/hosts/monitor/search": { - "post": { "parameters": [ { "description": "request", @@ -11626,19 +13047,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MonitorSearch" + "$ref": "#/definitions/request.McpBindDomain" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "items": { - "$ref": "#/definitions/dto.MonitorData" - }, - "type": "array" - } + "description": "OK" } }, "security": [ @@ -11649,19 +13064,22 @@ "Timestamp": [] } ], - "summary": "Load monitor data", + "summary": "Bind Domain for mcp server", "tags": [ - "Monitor" + "McpServer" ] } }, - "/hosts/monitor/setting": { + "/mcp/domain/get": { "get": { + "consumes": [ + "application/json" + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.MonitorSetting" + "$ref": "#/definitions/response.McpBindDomainRes" } } }, @@ -11673,14 +13091,17 @@ "Timestamp": [] } ], - "summary": "Load monitor setting", + "summary": "Get bin Domain for mcp server", "tags": [ - "Monitor" + "McpServer" ] } }, - "/hosts/monitor/setting/update": { + "/mcp/domain/update": { "post": { + "consumes": [ + "application/json" + ], "parameters": [ { "description": "request", @@ -11688,7 +13109,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.MonitorSettingUpdate" + "$ref": "#/definitions/request.McpBindDomainUpdate" } } ], @@ -11705,35 +13126,33 @@ "Timestamp": [] } ], - "summary": "Update monitor setting", + "summary": "Update bind Domain for mcp server", "tags": [ - "Monitor" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "key", - "value" - ], - "formatEN": "update default monitor [name]-[value]", - "formatZH": "修改默认监控网卡 [name]-[value]", - "paramKeys": [] - } + "McpServer" + ] } }, - "/installed/delete/check/:id": { - "get": { + "/mcp/search": { + "post": { "consumes": [ "application/json" ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.McpServerSearch" + } + } + ], "responses": { "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/dto.AppResource" - }, - "type": "array" + "$ref": "#/definitions/response.McpServersRes" } } }, @@ -11745,21 +13164,32 @@ "Timestamp": [] } ], - "summary": "Delete runtime", + "summary": "List mcp servers", "tags": [ - "Website" + "McpServer" ] } }, - "/logs/system": { + "/mcp/server": { "post": { - "responses": { - "200": { - "description": "OK", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "type": "string" + "$ref": "#/definitions/request.McpServerCreate" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -11769,24 +13199,32 @@ "Timestamp": [] } ], - "summary": "Load system logs", + "summary": "Create mcp server", "tags": [ - "Logs" + "McpServer" ] } }, - "/logs/system/files": { - "get": { - "responses": { - "200": { - "description": "OK", + "/mcp/server/del": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/definitions/request.McpServerDelete" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -11796,21 +13234,32 @@ "Timestamp": [] } ], - "summary": "Load system log files", + "summary": "Delete mcp server", "tags": [ - "Logs" + "McpServer" ] } }, - "/logs/tasks/executing/count": { - "get": { - "responses": { - "200": { - "description": "OK", + "/mcp/server/op": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, "schema": { - "type": "integer" + "$ref": "#/definitions/request.McpServerOperate" } } + ], + "responses": { + "200": { + "description": "OK" + } }, "security": [ { @@ -11820,13 +13269,13 @@ "Timestamp": [] } ], - "summary": "Get the number of executing tasks", + "summary": "Operate mcp server", "tags": [ - "TaskLog" + "McpServer" ] } }, - "/logs/tasks/search": { + "/mcp/server/update": { "post": { "consumes": [ "application/json" @@ -11838,15 +13287,39 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchTaskLogReq" + "$ref": "#/definitions/request.McpServerUpdate" } } ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update mcp server", + "tags": [ + "McpServer" + ] + } + }, + "/mount": { + "post": { + "consumes": [ + "application/json" + ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "$ref": "#/definitions/dto.DiskInfo" } } }, @@ -11858,9 +13331,9 @@ "Timestamp": [] } ], - "summary": "Page task logs", + "summary": "system mount", "tags": [ - "TaskLog" + "File" ] } }, @@ -11972,6 +13445,63 @@ } } }, + "/openresty/https": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.NginxConfigRes" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get default HTTPs status", + "tags": [ + "OpenResty" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.NginxOperateReq" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Operate default HTTPs", + "tags": [ + "OpenResty" + ] + } + }, "/openresty/module/update": { "post": { "consumes": [ @@ -12197,6 +13727,39 @@ } } }, + "/process/{pid}": { + "get": { + "parameters": [ + { + "description": "PID", + "in": "path", + "name": "pid", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/websocket.PsProcessData" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get Process Info By PID", + "tags": [ + "Process" + ] + } + }, "/record/del": { "post": { "consumes": [ @@ -12657,7 +14220,78 @@ "Timestamp": [] } ], - "summary": "Load php runtime conf", + "summary": "Load php runtime conf", + "tags": [ + "Runtime" + ] + } + }, + "/runtimes/php/container/:id": { + "get": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "path", + "name": "id", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/request.PHPContainerConfig" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Get PHP container config", + "tags": [ + "Runtime" + ] + } + }, + "/runtimes/php/container/update": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.PHPContainerConfig" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Update PHP container config", "tags": [ "Runtime" ] @@ -12985,98 +14619,7 @@ ] } }, - "/runtimes/php/update": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.PHPFileUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Update php conf file", - "tags": [ - "Runtime" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "websites", - "input_column": "id", - "input_value": "websiteId", - "isList": false, - "output_column": "primary_domain", - "output_value": "domain" - } - ], - "bodyKeys": [ - "websiteId" - ], - "formatEN": "Nginx conf update [domain]", - "formatZH": "php 配置修改 [domain]", - "paramKeys": [] - } - } - }, - "/runtimes/search": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/request.RuntimeSearch" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/dto.PageResult" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "List runtimes", - "tags": [ - "Runtime" - ] - } - }, - "/runtimes/supervisor/process/:id": { + "/runtimes/php/fpm/status/:id": { "get": { "consumes": [ "application/json" @@ -13094,10 +14637,8 @@ "200": { "description": "OK", "schema": { - "items": { - "$ref": "#/definitions/response.SupervisorProcessConfig" - }, - "type": "array" + "additionalProperties": true, + "type": "object" } } }, @@ -13109,13 +14650,13 @@ "Timestamp": [] } ], - "summary": "Get supervisor process", + "summary": "Get PHP runtime status", "tags": [ "Runtime" ] } }, - "/runtimes/supervisor/process/file/operate": { + "/runtimes/php/update": { "post": { "consumes": [ "application/json" @@ -13127,16 +14668,13 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPSupervisorProcessFileReq" + "$ref": "#/definitions/request.PHPFileUpdate" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ @@ -13147,13 +14685,31 @@ "Timestamp": [] } ], - "summary": "Operate supervisor process file", + "summary": "Update php conf file", "tags": [ "Runtime" - ] + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "websites", + "input_column": "id", + "input_value": "websiteId", + "isList": false, + "output_column": "primary_domain", + "output_value": "domain" + } + ], + "bodyKeys": [ + "websiteId" + ], + "formatEN": "Nginx conf update [domain]", + "formatZH": "php 配置修改 [domain]", + "paramKeys": [] + } } }, - "/runtimes/supervisor/process/operate": { + "/runtimes/remark": { "post": { "consumes": [ "application/json" @@ -13165,7 +14721,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.PHPSupervisorProcessConfig" + "$ref": "#/definitions/request.RuntimeRemark" } } ], @@ -13182,34 +14738,13 @@ "Timestamp": [] } ], - "summary": "Operate supervisor process", - "tags": [ - "Runtime" - ] - } - }, - "/runtimes/sync": { - "post": { - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - } - ], - "summary": "Sync runtime status", + "summary": "Update runtime remark", "tags": [ "Runtime" ] } }, - "/runtimes/update": { + "/runtimes/search": { "post": { "consumes": [ "application/json" @@ -13221,13 +14756,16 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/request.RuntimeUpdate" + "$ref": "#/definitions/request.RuntimeSearch" } } ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } } }, "security": [ @@ -13238,85 +14776,36 @@ "Timestamp": [] } ], - "summary": "Update runtime", + "summary": "List runtimes", "tags": [ "Runtime" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "Update runtime [name]", - "formatZH": "更新运行环境 [name]", - "paramKeys": [] - } + ] } }, - "/script": { - "post": { + "/runtimes/supervisor/process/:id": { + "get": { "consumes": [ "application/json" ], "parameters": [ { "description": "request", - "in": "body", - "name": "request", + "in": "path", + "name": "id", "required": true, - "schema": { - "$ref": "#/definitions/dto.ScriptOperate" - } + "type": "integer" } ], "responses": { "200": { - "description": "OK" - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Add script", - "tags": [ - "ScriptLibrary" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [ - "name" - ], - "formatEN": "add script [name]", - "formatZH": "添加脚本库脚本 [name]", - "paramKeys": [] - } - } - }, - "/script/del": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, + "description": "OK", "schema": { - "$ref": "#/definitions/dto.OperateByIDs" + "items": { + "$ref": "#/definitions/response.SupervisorProcessConfig" + }, + "type": "array" } } - ], - "responses": { - "200": { - "description": "OK" - } }, "security": [ { @@ -13326,31 +14815,13 @@ "Timestamp": [] } ], - "summary": "Delete script", + "summary": "Get supervisor process", "tags": [ - "ScriptLibrary" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "script_librarys", - "input_column": "id", - "input_value": "ids", - "isList": true, - "output_column": "name", - "output_value": "names" - } - ], - "bodyKeys": [ - "ids" - ], - "formatEN": "delete script [names]", - "formatZH": "删除脚本库脚本 [names]", - "paramKeys": [] - } + "Runtime" + ] } }, - "/script/search": { + "/runtimes/supervisor/process/file/operate": { "post": { "consumes": [ "application/json" @@ -13362,7 +14833,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.SearchPageWithGroup" + "$ref": "#/definitions/request.PHPSupervisorProcessFileReq" } } ], @@ -13370,7 +14841,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "type": "string" } } }, @@ -13382,13 +14853,13 @@ "Timestamp": [] } ], - "summary": "Page script", + "summary": "Operate supervisor process file", "tags": [ - "ScriptLibrary" + "Runtime" ] } }, - "/script/update": { + "/runtimes/supervisor/process/operate": { "post": { "consumes": [ "application/json" @@ -13400,7 +14871,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ScriptOperate" + "$ref": "#/definitions/request.PHPSupervisorProcessConfig" } } ], @@ -13417,65 +14888,34 @@ "Timestamp": [] } ], - "summary": "Update script", + "summary": "Operate supervisor process", "tags": [ - "ScriptLibrary" - ], - "x-panel-log": { - "BeforeFunctions": [ - { - "db": "cronjobs", - "input_column": "id", - "input_value": "id", - "isList": false, - "output_column": "name", - "output_value": "name" - } - ], - "bodyKeys": [ - "id" - ], - "formatEN": "update script [name]", - "formatZH": "更新脚本库脚本 [name]", - "paramKeys": [] - } + "Runtime" + ] } }, - "/settings/api/config/generate/key": { + "/runtimes/sync": { "post": { "consumes": [ "application/json" ], "responses": { "200": { - "description": "OK", - "schema": { - "type": "string" - } + "description": "OK" } }, "security": [ { "ApiKeyAuth": [] - }, - { - "Timestamp": [] } ], - "summary": "generate api key", + "summary": "Sync runtime status", "tags": [ - "System Setting" - ], - "x-panel-log": { - "BeforeFunctions": [], - "bodyKeys": [], - "formatEN": "generate api key", - "formatZH": "生成 API 接口密钥", - "paramKeys": [] - } + "Runtime" + ] } }, - "/settings/api/config/update": { + "/runtimes/update": { "post": { "consumes": [ "application/json" @@ -13487,7 +14927,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.ApiInterfaceConfig" + "$ref": "#/definitions/request.RuntimeUpdate" } } ], @@ -13504,17 +14944,17 @@ "Timestamp": [] } ], - "summary": "Update api config", + "summary": "Update runtime", "tags": [ - "System Setting" + "Runtime" ], "x-panel-log": { "BeforeFunctions": [], "bodyKeys": [ - "ipWhiteList" + "name" ], - "formatEN": "update api config =\u003e IP White List: [ipWhiteList]", - "formatZH": "更新 API 接口配置 =\u003e IP 白名单: [ipWhiteList]", + "formatEN": "Update runtime [name]", + "formatZH": "更新运行环境 [name]", "paramKeys": [] } } @@ -13543,6 +14983,39 @@ ] } }, + "/settings/get/{key}": { + "get": { + "parameters": [ + { + "description": "key", + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.SettingInfo" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load system setting by key", + "tags": [ + "System Setting" + ] + } + }, "/settings/search": { "post": { "responses": { @@ -14006,6 +15479,75 @@ ] } }, + "/settings/ssh": { + "post": { + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Save local conn info", + "tags": [ + "System Setting" + ] + } + }, + "/settings/ssh/check/info": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "bool" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Check local conn info", + "tags": [ + "System Setting" + ] + } + }, + "/settings/ssh/conn": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.SSHConnData" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Load local conn", + "tags": [ + "System Setting" + ] + } + }, "/settings/update": { "post": { "consumes": [ @@ -14399,44 +15941,6 @@ } } }, - "/toolbox/clam/record/log": { - "post": { - "consumes": [ - "application/json" - ], - "parameters": [ - { - "description": "request", - "in": "body", - "name": "request", - "required": true, - "schema": { - "$ref": "#/definitions/dto.ClamLogReq" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] - }, - { - "Timestamp": [] - } - ], - "summary": "Load clam record detail", - "tags": [ - "Clam" - ] - } - }, "/toolbox/clam/record/search": { "post": { "consumes": [ @@ -15595,6 +17099,33 @@ } } }, + "/user/group": { + "post": { + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/response.UserGroupResponse" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "system user and group", + "tags": [ + "File" + ] + } + }, "/websites": { "post": { "consumes": [ @@ -15901,7 +17432,45 @@ } } }, - "/websites/acme/search": { + "/websites/acme/search": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/dto.PageInfo" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/dto.PageResult" + } + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Page website acme accounts", + "tags": [ + "Website Acme" + ] + } + }, + "/websites/acme/update": { "post": { "consumes": [ "application/json" @@ -15913,7 +17482,7 @@ "name": "request", "required": true, "schema": { - "$ref": "#/definitions/dto.PageInfo" + "$ref": "#/definitions/request.WebsiteAcmeAccountUpdate" } } ], @@ -15921,7 +17490,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/dto.PageResult" + "$ref": "#/definitions/response.WebsiteAcmeAccountDTO" } } }, @@ -15933,10 +17502,28 @@ "Timestamp": [] } ], - "summary": "Page website acme accounts", + "summary": "Update website acme account", "tags": [ "Website Acme" - ] + ], + "x-panel-log": { + "BeforeFunctions": [ + { + "db": "website_acme_accounts", + "input_column": "id", + "input_value": "id", + "isList": false, + "output_column": "email", + "output_value": "email" + } + ], + "bodyKeys": [ + "id" + ], + "formatEN": "Update acme [email]", + "formatZH": "更新 acme [email]", + "paramKeys": [] + } } }, "/websites/auths": { @@ -16550,6 +18137,41 @@ } } }, + "/websites/crosssite": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.CrossSiteAccessOp" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Operate Cross Site Access", + "tags": [ + "Website" + ] + } + }, "/websites/databases": { "get": { "consumes": [ @@ -17303,6 +18925,41 @@ } } }, + "/websites/exec/composer": { + "post": { + "consumes": [ + "application/json" + ], + "parameters": [ + { + "description": "request", + "in": "body", + "name": "request", + "required": true, + "schema": { + "$ref": "#/definitions/request.ExecComposerReq" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "Timestamp": [] + } + ], + "summary": "Exec Composer", + "tags": [ + "Website" + ] + } + }, "/websites/lbs": { "get": { "consumes": [ @@ -19180,6 +20837,9 @@ "crossVersionUpdate": { "type": "boolean" }, + "deprecated": { + "type": "number" + }, "description": { "$ref": "#/definitions/dto.Locale" }, @@ -19322,6 +20982,9 @@ "type": "string" }, "type": "array" + }, + "taskID": { + "type": "string" } }, "required": [ @@ -19406,7 +21069,11 @@ "enum": [ "mysql", "mariadb", - "postgresql" + "postgresql", + "redis", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" }, @@ -19422,6 +21089,21 @@ ], "type": "object" }, + "dto.ChangeGroup": { + "properties": { + "groupID": { + "type": "integer" + }, + "id": { + "type": "integer" + } + }, + "required": [ + "groupID", + "id" + ], + "type": "object" + }, "dto.ChangePasswd": { "properties": { "passwd": { @@ -19433,6 +21115,17 @@ }, "type": "object" }, + "dto.ChangeQuicks": { + "properties": { + "quicks": { + "items": { + "$ref": "#/definitions/dto.QuickJump" + }, + "type": "array" + } + }, + "type": "object" + }, "dto.ChangeRedisPass": { "properties": { "database": { @@ -19475,6 +21168,9 @@ "alertCount": { "type": "integer" }, + "alertMethod": { + "type": "string" + }, "alertTitle": { "type": "string" }, @@ -19512,9 +21208,6 @@ }, "removeInfected": { "type": "boolean" - }, - "removeRecord": { - "type": "boolean" } }, "required": [ @@ -19536,20 +21229,6 @@ ], "type": "object" }, - "dto.ClamLogReq": { - "properties": { - "clamName": { - "type": "string" - }, - "recordName": { - "type": "string" - }, - "tail": { - "type": "string" - } - }, - "type": "object" - }, "dto.ClamLogSearch": { "properties": { "clamID": { @@ -19566,6 +21245,9 @@ }, "startTime": { "type": "string" + }, + "status": { + "type": "string" } }, "required": [ @@ -19579,6 +21261,9 @@ "alertCount": { "type": "integer" }, + "alertMethod": { + "type": "string" + }, "alertTitle": { "type": "string" }, @@ -19700,6 +21385,9 @@ }, "dto.CommonBackup": { "properties": { + "description": { + "type": "string" + }, "detailName": { "type": "string" }, @@ -19722,7 +21410,10 @@ "mariadb", "redis", "website", - "postgresql" + "postgresql", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" } @@ -19762,7 +21453,10 @@ "mariadb", "redis", "website", - "postgresql" + "postgresql", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" } @@ -19812,6 +21506,9 @@ }, "dto.ComposeOperation": { "properties": { + "force": { + "type": "boolean" + }, "name": { "type": "string" }, @@ -19819,6 +21516,7 @@ "enum": [ "up", "start", + "restart", "stop", "down", "delete" @@ -19933,6 +21631,9 @@ }, "pause": { "type": "boolean" + }, + "taskID": { + "type": "string" } }, "required": [ @@ -20128,6 +21829,17 @@ ], "type": "object" }, + "dto.ContainerOptions": { + "properties": { + "name": { + "type": "string" + }, + "state": { + "type": "string" + } + }, + "type": "object" + }, "dto.ContainerPrune": { "properties": { "pruneType": { @@ -20140,6 +21852,9 @@ ], "type": "string" }, + "taskID": { + "type": "string" + }, "withTagAll": { "type": "boolean" } @@ -20149,17 +21864,6 @@ ], "type": "object" }, - "dto.ContainerPruneReport": { - "properties": { - "deletedNumber": { - "type": "integer" - }, - "spaceReclaimed": { - "type": "integer" - } - }, - "type": "object" - }, "dto.ContainerRename": { "properties": { "name": { @@ -20265,8 +21969,11 @@ "image": { "type": "string" }, - "name": { - "type": "string" + "names": { + "items": { + "type": "string" + }, + "type": "array" }, "taskID": { "type": "string" @@ -20274,7 +21981,42 @@ }, "required": [ "image", - "name" + "names" + ], + "type": "object" + }, + "dto.CreateRootCert": { + "properties": { + "description": { + "type": "string" + }, + "encryptionMode": { + "enum": [ + "rsa", + "ed25519", + "ecdsa", + "dsa" + ], + "type": "string" + }, + "mode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "passPhrase": { + "type": "string" + }, + "privateKey": { + "type": "string" + }, + "publicKey": { + "type": "string" + } + }, + "required": [ + "encryptionMode" ], "type": "object" }, @@ -20283,6 +22025,9 @@ "cleanData": { "type": "boolean" }, + "cleanRemoteData": { + "type": "boolean" + }, "ids": { "items": { "type": "integer" @@ -20300,6 +22045,9 @@ "cleanData": { "type": "boolean" }, + "cleanRemoteData": { + "type": "boolean" + }, "cronjobID": { "type": "integer" }, @@ -20312,11 +22060,25 @@ ], "type": "object" }, - "dto.CronjobCreate": { + "dto.CronjobImport": { + "properties": { + "cronjobs": { + "items": { + "$ref": "#/definitions/dto.CronjobTrans" + }, + "type": "array" + } + }, + "type": "object" + }, + "dto.CronjobOperate": { "properties": { "alertCount": { "type": "integer" }, + "alertMethod": { + "type": "string" + }, "alertTitle": { "type": "string" }, @@ -20344,6 +22106,15 @@ "executor": { "type": "string" }, + "groupID": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "ignoreErr": { + "type": "boolean" + }, "isDir": { "type": "boolean" }, @@ -20354,15 +22125,25 @@ "minimum": 1, "type": "integer" }, + "retryTimes": { + "minimum": 0, + "type": "integer" + }, "script": { "type": "string" }, + "scriptID": { + "type": "integer" + }, "scriptMode": { "type": "string" }, "secret": { "type": "string" }, + "snapshotRule": { + "$ref": "#/definitions/dto.SnapshotRule" + }, "sourceAccountIDs": { "type": "string" }, @@ -20375,6 +22156,10 @@ "specCustom": { "type": "boolean" }, + "timeout": { + "minimum": 1, + "type": "integer" + }, "type": { "type": "string" }, @@ -20395,21 +22180,6 @@ ], "type": "object" }, - "dto.CronjobDownload": { - "properties": { - "backupAccountID": { - "type": "integer" - }, - "recordID": { - "type": "integer" - } - }, - "required": [ - "backupAccountID", - "recordID" - ], - "type": "object" - }, "dto.CronjobSpec": { "properties": { "spec": { @@ -20421,17 +22191,23 @@ ], "type": "object" }, - "dto.CronjobUpdate": { + "dto.CronjobTrans": { "properties": { "alertCount": { "type": "integer" }, - "alertTitle": { + "alertMethod": { "type": "string" }, - "appID": { + "alertTitle": { "type": "string" }, + "apps": { + "items": { + "$ref": "#/definitions/dto.TransHelper" + }, + "type": "array" + }, "command": { "type": "string" }, @@ -20439,13 +22215,16 @@ "type": "string" }, "dbName": { - "type": "string" + "items": { + "$ref": "#/definitions/dto.TransHelper" + }, + "type": "array" }, "dbType": { "type": "string" }, - "downloadAccountID": { - "type": "integer" + "downloadAccount": { + "type": "string" }, "exclusionRules": { "type": "string" @@ -20453,9 +22232,12 @@ "executor": { "type": "string" }, - "id": { + "groupID": { "type": "integer" }, + "ignoreErr": { + "type": "boolean" + }, "isDir": { "type": "boolean" }, @@ -20463,7 +22245,9 @@ "type": "string" }, "retainCopies": { - "minimum": 1, + "type": "integer" + }, + "retryTimes": { "type": "integer" }, "script": { @@ -20472,12 +22256,21 @@ "scriptMode": { "type": "string" }, - "secret": { + "scriptName": { "type": "string" }, - "sourceAccountIDs": { + "secret": { "type": "string" }, + "snapshotRule": { + "$ref": "#/definitions/dto.SnapshotTransHelper" + }, + "sourceAccounts": { + "items": { + "type": "string" + }, + "type": "array" + }, "sourceDir": { "type": "string" }, @@ -20487,6 +22280,9 @@ "specCustom": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -20496,16 +22292,13 @@ "user": { "type": "string" }, - "website": { - "type": "string" + "websites": { + "items": { + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "name", - "spec", - "type" - ], "type": "object" }, "dto.CronjobUpdateStatus": { @@ -20550,7 +22343,10 @@ "mysql", "mariadb", "postgresql", - "redis" + "redis", + "mysql-cluster", + "postgresql-cluster", + "redis-cluster" ], "type": "string" } @@ -20587,12 +22383,6 @@ "ipv6": { "type": "boolean" }, - "isActive": { - "type": "boolean" - }, - "isExist": { - "type": "boolean" - }, "isSwarm": { "type": "boolean" }, @@ -20672,6 +22462,12 @@ "platformVersion": { "type": "string" }, + "quickJump": { + "items": { + "$ref": "#/definitions/dto.QuickJump" + }, + "type": "array" + }, "systemProxy": { "type": "string" }, @@ -20743,6 +22539,15 @@ "memoryAvailable": { "type": "integer" }, + "memoryCache": { + "type": "integer" + }, + "memoryFree": { + "type": "integer" + }, + "memoryShard": { + "type": "integer" + }, "memoryTotal": { "type": "integer" }, @@ -20869,6 +22674,9 @@ "ssl": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -20947,6 +22755,9 @@ "ssl": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -21069,6 +22880,9 @@ "ssl": { "type": "boolean" }, + "timeout": { + "type": "integer" + }, "type": { "type": "string" }, @@ -21327,6 +23141,9 @@ "enablePing" ], "type": "string" + }, + "withDockerRestart": { + "type": "boolean" } }, "required": [ @@ -21538,43 +23355,6 @@ }, "type": "object" }, - "dto.GenerateLoad": { - "properties": { - "encryptionMode": { - "enum": [ - "rsa", - "ed25519", - "ecdsa", - "dsa" - ], - "type": "string" - } - }, - "required": [ - "encryptionMode" - ], - "type": "object" - }, - "dto.GenerateSSH": { - "properties": { - "encryptionMode": { - "enum": [ - "rsa", - "ed25519", - "ecdsa", - "dsa" - ], - "type": "string" - }, - "password": { - "type": "string" - } - }, - "required": [ - "encryptionMode" - ], - "type": "object" - }, "dto.GroupCreate": { "properties": { "id": { @@ -21675,7 +23455,7 @@ "type": "boolean" }, "size": { - "type": "string" + "type": "integer" }, "tags": { "items": { @@ -21776,14 +23556,12 @@ "type": "integer" }, "password": { - "maxLength": 256, "type": "string" }, "protocol": { "type": "string" }, "username": { - "maxLength": 256, "type": "string" } }, @@ -21838,6 +23616,21 @@ ], "type": "object" }, + "dto.LoadRedisStatus": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, "dto.Locale": { "properties": { "en": { @@ -21846,6 +23639,9 @@ "ja": { "type": "string" }, + "ko": { + "type": "string" + }, "ms": { "type": "string" }, @@ -21855,6 +23651,9 @@ "ru": { "type": "string" }, + "tr": { + "type": "string" + }, "zh": { "type": "string" }, @@ -22033,7 +23832,8 @@ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" } @@ -22056,7 +23856,8 @@ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" } @@ -22122,7 +23923,8 @@ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" } @@ -22331,7 +24133,8 @@ "type": { "enum": [ "mysql", - "mariadb" + "mariadb", + "mysql-cluster" ], "type": "string" }, @@ -22648,6 +24451,17 @@ ], "type": "object" }, + "dto.OperateByIDs": { + "properties": { + "ids": { + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, "dto.OperateByType": { "properties": { "type": { @@ -22770,6 +24584,12 @@ }, "dto.PageCronjob": { "properties": { + "groupIDs": { + "items": { + "type": "integer" + }, + "type": "array" + }, "info": { "type": "string" }, @@ -22804,6 +24624,43 @@ ], "type": "object" }, + "dto.PageImage": { + "properties": { + "name": { + "type": "string" + }, + "order": { + "enum": [ + "null", + "ascending", + "descending" + ], + "type": "string" + }, + "orderBy": { + "enum": [ + "size", + "tags", + "createdAt", + "isUsed" + ], + "type": "string" + }, + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer" + } + }, + "required": [ + "order", + "orderBy", + "page", + "pageSize" + ], + "type": "object" + }, "dto.PageInfo": { "properties": { "page": { @@ -23015,7 +24872,8 @@ }, "type": { "enum": [ - "postgresql" + "postgresql", + "postgresql-cluster" ], "type": "string" } @@ -23037,7 +24895,8 @@ }, "type": { "enum": [ - "postgresql" + "postgresql", + "postgresql-cluster" ], "type": "string" } @@ -23102,7 +24961,8 @@ }, "type": { "enum": [ - "postgresql" + "postgresql", + "postgresql-cluster" ], "type": "string" } @@ -23114,6 +24974,32 @@ ], "type": "object" }, + "dto.QuickJump": { + "properties": { + "detail": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "isShow": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "recommend": { + "type": "integer" + }, + "router": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, "dto.RecordFileSize": { "properties": { "id": { @@ -23215,6 +25101,13 @@ "database": { "type": "string" }, + "dbType": { + "enum": [ + "redis", + "redis-cluster" + ], + "type": "string" + }, "save": { "type": "string" }, @@ -23228,6 +25121,7 @@ }, "required": [ "database", + "dbType", "type" ], "type": "object" @@ -23237,6 +25131,13 @@ "database": { "type": "string" }, + "dbType": { + "enum": [ + "redis", + "redis-cluster" + ], + "type": "string" + }, "maxclients": { "type": "string" }, @@ -23248,7 +25149,8 @@ } }, "required": [ - "database" + "database", + "dbType" ], "type": "object" }, @@ -23369,36 +25271,41 @@ }, "type": "object" }, - "dto.SSHHistory": { + "dto.SSHConnData": { "properties": { - "address": { - "type": "string" - }, - "area": { + "addr": { "type": "string" }, "authMode": { + "enum": [ + "password", + "key" + ], "type": "string" }, - "date": { - "type": "string" - }, - "dateStr": { + "passPhrase": { "type": "string" }, - "message": { + "password": { "type": "string" }, "port": { - "type": "string" + "maximum": 65535, + "minimum": 1, + "type": "integer" }, - "status": { + "privateKey": { "type": "string" }, "user": { "type": "string" } }, + "required": [ + "addr", + "port", + "user" + ], "type": "object" }, "dto.SSHInfo": { @@ -23406,6 +25313,9 @@ "autoStart": { "type": "boolean" }, + "currentUser": { + "type": "string" + }, "isActive": { "type": "boolean" }, @@ -23422,36 +25332,16 @@ "type": "string" }, "permitRootLogin": { - "type": "string" - }, - "port": { - "type": "string" - }, - "pubkeyAuthentication": { - "type": "string" - }, - "useDNS": { - "type": "string" - } - }, - "type": "object" - }, - "dto.SSHLog": { - "properties": { - "failedCount": { - "type": "integer" + "type": "string" }, - "logs": { - "items": { - "$ref": "#/definitions/dto.SSHHistory" - }, - "type": "array" + "port": { + "type": "string" }, - "successfulCount": { - "type": "integer" + "pubkeyAuthentication": { + "type": "string" }, - "totalCount": { - "type": "integer" + "useDNS": { + "type": "string" } }, "type": "object" @@ -23473,6 +25363,17 @@ ], "type": "object" }, + "dto.ScriptOptions": { + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "dto.SearchByFilter": { "properties": { "filter": { @@ -23712,7 +25613,7 @@ "ntpSite": { "type": "string" }, - "snapshotIgnore": { + "systemIP": { "type": "string" }, "systemVersion": { @@ -23779,6 +25680,12 @@ "id": { "type": "integer" }, + "ignoreFiles": { + "items": { + "type": "string" + }, + "type": "array" + }, "interruptStep": { "type": "string" }, @@ -23800,6 +25707,12 @@ "taskID": { "type": "string" }, + "timeout": { + "type": "integer" + }, + "withDockerConf": { + "type": "boolean" + }, "withLoginLog": { "type": "boolean" }, @@ -23836,12 +25749,21 @@ }, "type": "array" }, + "ignoreFiles": { + "items": { + "type": "string" + }, + "type": "array" + }, "panelData": { "items": { "$ref": "#/definitions/dto.DataTree" }, "type": "array" }, + "withDockerConf": { + "type": "boolean" + }, "withLoginLog": { "type": "boolean" }, @@ -23901,6 +25823,34 @@ ], "type": "object" }, + "dto.SnapshotRule": { + "properties": { + "ignoreAppIDs": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "withImage": { + "type": "boolean" + } + }, + "type": "object" + }, + "dto.SnapshotTransHelper": { + "properties": { + "ignoreApps": { + "items": { + "$ref": "#/definitions/dto.TransHelper" + }, + "type": "array" + }, + "withImage": { + "type": "boolean" + } + }, + "type": "object" + }, "dto.SwapHelper": { "properties": { "isNew": { @@ -23938,6 +25888,17 @@ }, "type": "object" }, + "dto.TransHelper": { + "properties": { + "detailName": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, "dto.UpdateByFile": { "properties": { "file": { @@ -24002,6 +25963,17 @@ ], "type": "object" }, + "dto.UploadForRecover": { + "properties": { + "filePath": { + "type": "string" + }, + "targetDir": { + "type": "string" + } + }, + "type": "object" + }, "dto.VolumeCreate": { "properties": { "driver": { @@ -24232,6 +26204,29 @@ }, "type": "object" }, + "model.AppIgnoreUpgrade": { + "properties": { + "appDetailID": { + "type": "integer" + }, + "appID": { + "type": "integer" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "scope": { + "type": "string" + }, + "updatedAt": { + "type": "string" + } + }, + "type": "object" + }, "model.AppInstall": { "properties": { "app": { @@ -24258,6 +26253,9 @@ "env": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "httpPort": { "type": "integer" }, @@ -24361,6 +26359,9 @@ "port": { "type": "string" }, + "remark": { + "type": "string" + }, "resource": { "type": "string" }, @@ -24420,6 +26421,9 @@ "expireDate": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "ftpId": { "type": "integer" }, @@ -24485,6 +26489,9 @@ }, "model.WebsiteAcmeAccount": { "properties": { + "caDirURL": { + "type": "string" + }, "createdAt": { "type": "string" }, @@ -24511,6 +26518,9 @@ }, "url": { "type": "string" + }, + "useProxy": { + "type": "boolean" } }, "type": "object" @@ -24611,6 +26621,9 @@ "keyType": { "type": "string" }, + "masterSslId": { + "type": "integer" + }, "message": { "type": "string" }, @@ -24620,6 +26633,9 @@ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "organization": { "type": "string" }, @@ -24638,6 +26654,9 @@ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -24679,6 +26698,28 @@ ], "type": "object" }, + "request.AppIgnoreUpgradeReq": { + "properties": { + "appDetailID": { + "type": "integer" + }, + "appID": { + "type": "integer" + }, + "scope": { + "enum": [ + "all", + "version" + ], + "type": "string" + } + }, + "required": [ + "appID", + "scope" + ], + "type": "object" + }, "request.AppInstallCreate": { "properties": { "advanced": { @@ -24724,12 +26765,24 @@ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, "services": { "additionalProperties": { "type": "string" }, "type": "object" }, + "specifyIP": { + "type": "string" + }, "taskID": { "type": "string" }, @@ -24746,25 +26799,6 @@ ], "type": "object" }, - "request.AppInstalledIgnoreUpgrade": { - "properties": { - "detailID": { - "type": "integer" - }, - "operate": { - "enum": [ - "cancel", - "ignore" - ], - "type": "string" - } - }, - "required": [ - "detailID", - "operate" - ], - "type": "object" - }, "request.AppInstalledInfo": { "properties": { "key": { @@ -24802,6 +26836,9 @@ "dockerCompose": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "forceDelete": { "type": "boolean" }, @@ -24905,6 +26942,18 @@ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, + "specifyIP": { + "type": "string" + }, "type": { "type": "string" }, @@ -24954,20 +27003,30 @@ ], "type": "object" }, - "request.AppstoreUpdate": { + "request.ChangeDatabase": { "properties": { - "defaultDomain": { + "databaseID": { + "type": "integer" + }, + "databaseType": { "type": "string" + }, + "websiteID": { + "type": "integer" } }, + "required": [ + "websiteID" + ], "type": "object" }, - "request.ChangeDatabase": { + "request.CrossSiteAccessOp": { "properties": { - "databaseID": { - "type": "integer" - }, - "databaseType": { + "operation": { + "enum": [ + "Enable", + "Disable" + ], "type": "string" }, "websiteID": { @@ -24975,8 +27034,7 @@ } }, "required": [ - "databaseID", - "databaseType", + "operation", "websiteID" ], "type": "object" @@ -25013,6 +27071,72 @@ ], "type": "object" }, + "request.DiskMountRequest": { + "properties": { + "autoMount": { + "type": "boolean" + }, + "device": { + "type": "string" + }, + "filesystem": { + "enum": [ + "ext4", + "xfs" + ], + "type": "string" + }, + "mountPoint": { + "type": "string" + } + }, + "required": [ + "device", + "filesystem", + "mountPoint" + ], + "type": "object" + }, + "request.DiskPartitionRequest": { + "properties": { + "autoMount": { + "type": "boolean" + }, + "device": { + "type": "string" + }, + "filesystem": { + "enum": [ + "ext4", + "xfs" + ], + "type": "string" + }, + "label": { + "type": "string" + }, + "mountPoint": { + "type": "string" + } + }, + "required": [ + "device", + "filesystem", + "mountPoint" + ], + "type": "object" + }, + "request.DiskUnmountRequest": { + "properties": { + "mountPoint": { + "type": "string" + } + }, + "required": [ + "mountPoint" + ], + "type": "object" + }, "request.Environment": { "properties": { "key": { @@ -25024,6 +27148,40 @@ }, "type": "object" }, + "request.ExecComposerReq": { + "properties": { + "command": { + "type": "string" + }, + "dir": { + "type": "string" + }, + "extCommand": { + "type": "string" + }, + "mirror": { + "type": "string" + }, + "taskID": { + "type": "string" + }, + "user": { + "type": "string" + }, + "websiteID": { + "type": "integer" + } + }, + "required": [ + "command", + "dir", + "mirror", + "taskID", + "user", + "websiteID" + ], + "type": "object" + }, "request.ExposedPort": { "properties": { "containerPort": { @@ -25254,6 +27412,12 @@ "cover": { "type": "boolean" }, + "coverPaths": { + "items": { + "type": "string" + }, + "type": "array" + }, "name": { "type": "string" }, @@ -25319,6 +27483,9 @@ "properties": { "path": { "type": "string" + }, + "withInit": { + "type": "boolean" } }, "required": [ @@ -25326,6 +27493,20 @@ ], "type": "object" }, + "request.FilePathsCheck": { + "properties": { + "paths": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "paths" + ], + "type": "object" + }, "request.FileReadByLineReq": { "properties": { "ID": { @@ -25532,6 +27713,199 @@ ], "type": "object" }, + "request.McpBindDomain": { + "properties": { + "domain": { + "type": "string" + }, + "ipList": { + "type": "string" + }, + "sslID": { + "type": "integer" + } + }, + "required": [ + "domain" + ], + "type": "object" + }, + "request.McpBindDomainUpdate": { + "properties": { + "ipList": { + "type": "string" + }, + "sslID": { + "type": "integer" + }, + "websiteID": { + "type": "integer" + } + }, + "required": [ + "websiteID" + ], + "type": "object" + }, + "request.McpServerCreate": { + "properties": { + "baseUrl": { + "type": "string" + }, + "command": { + "type": "string" + }, + "containerName": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "hostIP": { + "type": "string" + }, + "name": { + "type": "string" + }, + "outputTransport": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "ssePath": { + "type": "string" + }, + "streamableHttpPath": { + "type": "string" + }, + "type": { + "type": "string" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" + }, + "type": "array" + } + }, + "required": [ + "command", + "name", + "outputTransport", + "port", + "type" + ], + "type": "object" + }, + "request.McpServerDelete": { + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "request.McpServerOperate": { + "properties": { + "id": { + "type": "integer" + }, + "operate": { + "type": "string" + } + }, + "required": [ + "id", + "operate" + ], + "type": "object" + }, + "request.McpServerSearch": { + "properties": { + "name": { + "type": "string" + }, + "page": { + "type": "integer" + }, + "pageSize": { + "type": "integer" + }, + "sync": { + "type": "boolean" + } + }, + "required": [ + "page", + "pageSize" + ], + "type": "object" + }, + "request.McpServerUpdate": { + "properties": { + "baseUrl": { + "type": "string" + }, + "command": { + "type": "string" + }, + "containerName": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "hostIP": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "outputTransport": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "ssePath": { + "type": "string" + }, + "streamableHttpPath": { + "type": "string" + }, + "type": { + "type": "string" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" + }, + "type": "array" + } + }, + "required": [ + "command", + "id", + "name", + "outputTransport", + "port", + "type" + ], + "type": "object" + }, "request.NewAppInstall": { "properties": { "advanced": { @@ -25577,6 +27951,18 @@ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, + "specifyIP": { + "type": "string" + }, "type": { "type": "string" }, @@ -25626,8 +28012,6 @@ } }, "required": [ - "extends", - "return", "websiteID" ], "type": "object" @@ -25762,6 +28146,21 @@ ], "type": "object" }, + "request.NginxOperateReq": { + "properties": { + "operate": { + "enum": [ + "enable", + "disable" + ], + "type": "string" + } + }, + "required": [ + "operate" + ], + "type": "object" + }, "request.NginxPathAuthUpdate": { "properties": { "name": { @@ -25994,22 +28393,54 @@ "id": { "type": "integer" }, - "params": { - "additionalProperties": { - "type": "string" + "params": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "scope": { + "type": "string" + }, + "uploadMaxSize": { + "type": "string" + } + }, + "required": [ + "id", + "scope" + ], + "type": "object" + }, + "request.PHPContainerConfig": { + "properties": { + "containerName": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "exposedPorts": { + "items": { + "$ref": "#/definitions/request.ExposedPort" + }, + "type": "array" + }, + "id": { + "type": "integer" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" }, - "type": "object" - }, - "scope": { - "type": "string" - }, - "uploadMaxSize": { - "type": "string" + "type": "array" } }, "required": [ - "id", - "scope" + "id" ], "type": "object" }, @@ -26126,6 +28557,12 @@ }, "request.PHPSupervisorProcessConfig": { "properties": { + "autoRestart": { + "type": "string" + }, + "autoStart": { + "type": "string" + }, "command": { "type": "string" }, @@ -26232,6 +28669,17 @@ ], "type": "object" }, + "request.ReqWithID": { + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, "request.RuntimeCreate": { "properties": { "appDetailId": { @@ -26268,6 +28716,9 @@ "additionalProperties": true, "type": "object" }, + "remark": { + "type": "string" + }, "resource": { "type": "string" }, @@ -26311,6 +28762,20 @@ }, "type": "object" }, + "request.RuntimeRemark": { + "properties": { + "id": { + "type": "integer" + }, + "remark": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, "request.RuntimeSearch": { "properties": { "name": { @@ -26374,6 +28839,9 @@ "rebuild": { "type": "boolean" }, + "remark": { + "type": "string" + }, "source": { "type": "string" }, @@ -26410,6 +28878,12 @@ }, "request.SupervisorProcessConfig": { "properties": { + "autoRestart": { + "type": "string" + }, + "autoStart": { + "type": "string" + }, "command": { "type": "string" }, @@ -26476,6 +28950,9 @@ }, "request.WebsiteAcmeAccountCreate": { "properties": { + "caDirURL": { + "type": "string" + }, "eabHmacKey": { "type": "string" }, @@ -26501,9 +28978,13 @@ "letsencrypt", "zerossl", "buypass", - "google" + "google", + "custom" ], "type": "string" + }, + "useProxy": { + "type": "boolean" } }, "required": [ @@ -26513,6 +28994,20 @@ ], "type": "object" }, + "request.WebsiteAcmeAccountUpdate": { + "properties": { + "id": { + "type": "integer" + }, + "useProxy": { + "type": "boolean" + } + }, + "required": [ + "id" + ], + "type": "object" + }, "request.WebsiteBatchDelReq": { "properties": { "ids": { @@ -26731,6 +29226,9 @@ "runtimeID": { "type": "integer" }, + "siteDir": { + "type": "string" + }, "taskID": { "type": "string" }, @@ -26756,16 +29254,13 @@ "acmeAccountId": { "type": "integer" }, - "domains": { - "items": { - "type": "string" - }, - "type": "array" + "websiteSSLId": { + "type": "integer" } }, "required": [ "acmeAccountId", - "domains" + "websiteSSLId" ], "type": "object" }, @@ -26929,8 +29424,8 @@ "type": "boolean" }, "hstsIncludeSubDomains": { - "type": "boolean" - }, + "type": "boolean" + }, "http3": { "type": "boolean" }, @@ -27203,6 +29698,12 @@ }, "type": "object" }, + "serverCacheTime": { + "type": "integer" + }, + "serverCacheUnit": { + "type": "string" + }, "sni": { "type": "boolean" } @@ -27323,6 +29824,9 @@ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "otherDomains": { "type": "string" }, @@ -27335,6 +29839,9 @@ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -27354,6 +29861,9 @@ "acmeAccountID": { "type": "string" }, + "domain": { + "type": "string" + }, "page": { "type": "integer" }, @@ -27405,6 +29915,9 @@ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "otherDomains": { "type": "string" }, @@ -27417,6 +29930,9 @@ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -27484,7 +30000,8 @@ "status", "createdAt", "expire_date", - "created_at" + "created_at", + "favorite" ], "type": "string" }, @@ -27494,6 +30011,9 @@ "pageSize": { "type": "integer" }, + "type": { + "type": "string" + }, "websiteGroupId": { "type": "integer" } @@ -27514,6 +30034,9 @@ "expireDate": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "id": { "type": "integer" }, @@ -27608,6 +30131,18 @@ "pullImage": { "type": "boolean" }, + "restartPolicy": { + "enum": [ + "always", + "unless-stopped", + "no", + "on-failure" + ], + "type": "string" + }, + "specifyIP": { + "type": "string" + }, "type": { "type": "string" }, @@ -27744,9 +30279,6 @@ "id": { "type": "integer" }, - "ignoreUpgrade": { - "type": "boolean" - }, "image": { "type": "string" }, @@ -27812,6 +30344,9 @@ }, "version": { "type": "string" + }, + "websiteDir": { + "type": "string" } }, "type": "object" @@ -27883,6 +30418,9 @@ "key": { "type": "string" }, + "label": { + "$ref": "#/definitions/dto.Locale" + }, "labelEn": { "type": "string" }, @@ -27958,9 +30496,44 @@ }, "type": "object" }, - "response.AppstoreConfig": { + "response.CompleteDiskInfo": { + "properties": { + "disks": { + "items": { + "$ref": "#/definitions/response.DiskInfo" + }, + "type": "array" + }, + "systemDisk": { + "$ref": "#/definitions/response.DiskInfo" + }, + "totalCapacity": { + "type": "integer" + }, + "totalDisks": { + "type": "integer" + }, + "unpartitionedDisks": { + "items": { + "$ref": "#/definitions/response.DiskBasicInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "response.ComponentInfo": { "properties": { - "defaultDomain": { + "error": { + "type": "string" + }, + "exists": { + "type": "boolean" + }, + "path": { + "type": "string" + }, + "version": { "type": "string" } }, @@ -27968,6 +30541,12 @@ }, "response.Database": { "properties": { + "databaseName": { + "type": "string" + }, + "from": { + "type": "string" + }, "id": { "type": "integer" }, @@ -27999,19 +30578,144 @@ }, "username": { "type": "string" - } - }, - "type": "object" - }, - "response.DirSizeRes": { - "properties": { + } + }, + "type": "object" + }, + "response.DepthDirSizeRes": { + "properties": { + "path": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "type": "object" + }, + "response.DirSizeRes": { + "properties": { + "size": { + "type": "integer" + } + }, + "required": [ + "size" + ], + "type": "object" + }, + "response.DiskBasicInfo": { + "properties": { + "avail": { + "type": "string" + }, + "device": { + "type": "string" + }, + "diskType": { + "type": "string" + }, + "filesystem": { + "type": "string" + }, + "isMounted": { + "type": "boolean" + }, + "isRemovable": { + "type": "boolean" + }, + "isSystem": { + "type": "boolean" + }, + "model": { + "type": "string" + }, + "mountPoint": { + "type": "string" + }, + "serial": { + "type": "string" + }, + "size": { + "type": "string" + }, + "usePercent": { + "type": "integer" + }, + "used": { + "type": "string" + } + }, + "type": "object" + }, + "response.DiskInfo": { + "properties": { + "avail": { + "type": "string" + }, + "device": { + "type": "string" + }, + "diskType": { + "type": "string" + }, + "filesystem": { + "type": "string" + }, + "isMounted": { + "type": "boolean" + }, + "isRemovable": { + "type": "boolean" + }, + "isSystem": { + "type": "boolean" + }, + "model": { + "type": "string" + }, + "mountPoint": { + "type": "string" + }, + "partitions": { + "items": { + "$ref": "#/definitions/response.DiskBasicInfo" + }, + "type": "array" + }, + "serial": { + "type": "string" + }, + "size": { + "type": "string" + }, + "usePercent": { + "type": "integer" + }, + "used": { + "type": "string" + } + }, + "type": "object" + }, + "response.ExistFileInfo": { + "properties": { + "isDir": { + "type": "boolean" + }, + "modTime": { + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, "size": { "type": "integer" } }, - "required": [ - "size" - ], "type": "object" }, "response.FileInfo": { @@ -28090,9 +30794,6 @@ }, "response.FileLineContent": { "properties": { - "content": { - "type": "string" - }, "end": { "type": "boolean" }, @@ -28105,8 +30806,17 @@ "path": { "type": "string" }, + "scope": { + "type": "string" + }, + "taskStatus": { + "type": "string" + }, "total": { "type": "integer" + }, + "totalLines": { + "type": "integer" } }, "type": "object" @@ -28162,19 +30872,116 @@ }, "type": "object" }, - "response.IgnoredApp": { + "response.McpBindDomainRes": { "properties": { - "detailID": { + "acmeAccountID": { "type": "integer" }, - "icon": { + "allowIPs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "connUrl": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "sslID": { + "type": "integer" + }, + "websiteID": { + "type": "integer" + } + }, + "type": "object" + }, + "response.McpServerDTO": { + "properties": { + "baseUrl": { + "type": "string" + }, + "command": { + "type": "string" + }, + "containerName": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "dir": { + "type": "string" + }, + "dockerCompose": { + "type": "string" + }, + "env": { + "type": "string" + }, + "environments": { + "items": { + "$ref": "#/definitions/request.Environment" + }, + "type": "array" + }, + "hostIP": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "message": { "type": "string" }, "name": { "type": "string" }, - "version": { + "outputTransport": { + "type": "string" + }, + "port": { + "type": "integer" + }, + "ssePath": { + "type": "string" + }, + "status": { + "type": "string" + }, + "streamableHttpPath": { "type": "string" + }, + "type": { + "type": "string" + }, + "updatedAt": { + "type": "string" + }, + "volumes": { + "items": { + "$ref": "#/definitions/request.Volume" + }, + "type": "array" + }, + "websiteID": { + "type": "integer" + } + }, + "type": "object" + }, + "response.McpServersRes": { + "properties": { + "items": { + "items": { + "$ref": "#/definitions/response.McpServerDTO" + }, + "type": "array" + }, + "total": { + "type": "integer" } }, "type": "object" @@ -28245,6 +31052,14 @@ }, "type": "object" }, + "response.NginxConfigRes": { + "properties": { + "https": { + "type": "boolean" + } + }, + "type": "object" + }, "response.NginxFile": { "properties": { "content": { @@ -28525,6 +31340,9 @@ "codeDir": { "type": "string" }, + "container": { + "type": "string" + }, "containerStatus": { "type": "string" }, @@ -28565,6 +31383,9 @@ "port": { "type": "string" }, + "remark": { + "type": "string" + }, "resource": { "type": "string" }, @@ -28591,6 +31412,12 @@ }, "response.SupervisorProcessConfig": { "properties": { + "autoRestart": { + "type": "string" + }, + "autoStart": { + "type": "string" + }, "command": { "type": "string" }, @@ -28658,8 +31485,39 @@ }, "type": "object" }, + "response.UserGroupResponse": { + "properties": { + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "users": { + "items": { + "$ref": "#/definitions/response.UserInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "response.UserInfo": { + "properties": { + "group": { + "type": "string" + }, + "username": { + "type": "string" + } + }, + "type": "object" + }, "response.WebsiteAcmeAccountDTO": { "properties": { + "caDirURL": { + "type": "string" + }, "createdAt": { "type": "string" }, @@ -28686,6 +31544,9 @@ }, "url": { "type": "string" + }, + "useProxy": { + "type": "boolean" } }, "type": "object" @@ -28798,6 +31659,9 @@ "expireDate": { "type": "string" }, + "favorite": { + "type": "boolean" + }, "ftpId": { "type": "integer" }, @@ -28810,6 +31674,9 @@ "id": { "type": "integer" }, + "openBaseDir": { + "type": "boolean" + }, "parentWebsiteID": { "type": "integer" }, @@ -28911,8 +31778,8 @@ "type": "boolean" }, "hstsIncludeSubDomains": { - "type": "boolean" - }, + "type": "boolean" + }, "http3": { "type": "boolean" }, @@ -29077,6 +31944,9 @@ "logPath": { "type": "string" }, + "masterSslId": { + "type": "integer" + }, "message": { "type": "string" }, @@ -29086,6 +31956,9 @@ "nameserver2": { "type": "string" }, + "nodes": { + "type": "string" + }, "organization": { "type": "string" }, @@ -29104,6 +31977,9 @@ "pushDir": { "type": "boolean" }, + "pushNode": { + "type": "boolean" + }, "shell": { "type": "string" }, @@ -29130,6 +32006,115 @@ } }, "type": "object" + }, + "websocket.ProcessConnect": { + "properties": { + "PID": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "localaddr": { + "type": "object" + }, + "remoteaddr": { + "type": "object" + } + }, + "type": "object" + }, + "websocket.PsProcessData": { + "properties": { + "PID": { + "type": "integer" + }, + "PPID": { + "type": "integer" + }, + "cmdLine": { + "type": "string" + }, + "connects": { + "items": { + "$ref": "#/definitions/websocket.ProcessConnect" + }, + "type": "array" + }, + "cpuPercent": { + "type": "string" + }, + "cpuValue": { + "type": "number" + }, + "data": { + "type": "string" + }, + "diskRead": { + "type": "string" + }, + "diskWrite": { + "type": "string" + }, + "envs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "hwm": { + "type": "string" + }, + "locked": { + "type": "string" + }, + "name": { + "type": "string" + }, + "numConnections": { + "type": "integer" + }, + "numThreads": { + "type": "integer" + }, + "rss": { + "type": "string" + }, + "rssValue": { + "type": "integer" + }, + "stack": { + "type": "string" + }, + "startTime": { + "type": "string" + }, + "status": { + "type": "string" + }, + "swap": { + "type": "string" + }, + "username": { + "type": "string" + }, + "vms": { + "type": "string" + }, + "openFiles": { + "items": { + "type": "object" + }, + "type": "array" + } + }, + "type": "object" } } } \ No newline at end of file