diff --git a/backend/app/api/v1/app.go b/backend/app/api/v1/app.go index 2518fe2b3..1f70d13fd 100644 --- a/backend/app/api/v1/app.go +++ b/backend/app/api/v1/app.go @@ -11,7 +11,6 @@ import ( // @Tags App // @Summary List apps -// @Description 获取应用列表 // @Accept json // @Param request body request.AppSearch true "request" // @Success 200 @@ -32,7 +31,6 @@ func (b *BaseApi) SearchApp(c *gin.Context) { // @Tags App // @Summary Sync app list -// @Description 同步应用列表 // @Success 200 // @Security ApiKeyAuth // @Router /apps/sync [post] @@ -63,7 +61,6 @@ func (b *BaseApi) SyncApp(c *gin.Context) { // @Tags App // @Summary Search app by key -// @Description 通过 key 获取应用信息 // @Accept json // @Param key path string true "app key" // @Success 200 {object} response.AppDTO @@ -85,11 +82,10 @@ func (b *BaseApi) GetApp(c *gin.Context) { // @Tags App // @Summary Search app detail by appid -// @Description 通过 appid 获取应用详情 // @Accept json // @Param appId path integer true "app id" -// @Param version path string true "app 版本" -// @Param version path string true "app 类型" +// @Param version path string true "app version" +// @Param version path string true "app type" // @Success 200 {object} response.AppDetailDTO // @Security ApiKeyAuth // @Router /apps/detail/:appId/:version/:type [get] @@ -111,7 +107,6 @@ func (b *BaseApi) GetAppDetail(c *gin.Context) { // @Tags App // @Summary Get app detail by id -// @Description 通过 id 获取应用详情 // @Accept json // @Param appId path integer true "id" // @Success 200 {object} response.AppDetailDTO @@ -133,7 +128,6 @@ func (b *BaseApi) GetAppDetailByID(c *gin.Context) { // @Tags App // @Summary Get Ignore App -// @Description 获取忽略的应用版本 // @Accept json // @Success 200 {object} response.IgnoredApp // @Security ApiKeyAuth @@ -149,7 +143,6 @@ func (b *BaseApi) GetIgnoredApp(c *gin.Context) { // @Tags App // @Summary Install app -// @Description 安装应用 // @Accept json // @Param request body request.AppInstallCreate true "request" // @Success 200 {object} model.AppInstall @@ -183,7 +176,6 @@ func (b *BaseApi) GetAppTags(c *gin.Context) { // @Tags App // @Summary Get app list update -// @Description 获取应用更新版本 // @Success 200 // @Security ApiKeyAuth // @Router /apps/checkupdate [get] diff --git a/backend/app/api/v1/app_install.go b/backend/app/api/v1/app_install.go index f0b63ab6c..319e73fbf 100644 --- a/backend/app/api/v1/app_install.go +++ b/backend/app/api/v1/app_install.go @@ -11,7 +11,6 @@ import ( // @Tags App // @Summary Page app installed -// @Description 分页获取已安装应用列表 // @Accept json // @Param request body request.AppInstalledSearch true "request" // @Success 200 @@ -44,7 +43,6 @@ func (b *BaseApi) SearchAppInstalled(c *gin.Context) { // @Tags App // @Summary List app installed -// @Description 获取已安装应用列表 // @Accept json // @Success 200 array dto.AppInstallInfo // @Security ApiKeyAuth @@ -60,7 +58,6 @@ func (b *BaseApi) ListAppInstalled(c *gin.Context) { // @Tags App // @Summary Check app installed -// @Description 检查应用安装情况 // @Accept json // @Param request body request.AppInstalledInfo true "request" // @Success 200 {object} response.AppInstalledCheck @@ -81,7 +78,6 @@ func (b *BaseApi) CheckAppInstalled(c *gin.Context) { // @Tags App // @Summary Search app port by key -// @Description 获取应用端口 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {integer} port @@ -102,7 +98,6 @@ func (b *BaseApi) LoadPort(c *gin.Context) { // @Tags App // @Summary Search app password by key -// @Description 获取应用连接信息 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {string} response.DatabaseConn @@ -123,7 +118,6 @@ func (b *BaseApi) LoadConnInfo(c *gin.Context) { // @Tags App // @Summary Check before delete -// @Description 删除前检查 // @Accept json // @Param appInstallId path integer true "App install id" // @Success 200 {array} dto.AppResource @@ -146,7 +140,6 @@ func (b *BaseApi) DeleteCheck(c *gin.Context) { // Sync app installed // @Tags App // @Summary Sync app installed -// @Description 同步已安装应用列表 // @Success 200 // @Security ApiKeyAuth // @Router /apps/installed/sync [post] @@ -161,7 +154,6 @@ func (b *BaseApi) SyncInstalled(c *gin.Context) { // @Tags App // @Summary Operate installed app -// @Description 操作已安装应用 // @Accept json // @Param request body request.AppInstalledOperate true "request" // @Success 200 @@ -182,7 +174,6 @@ func (b *BaseApi) OperateInstalled(c *gin.Context) { // @Tags App // @Summary Search app service by key -// @Description 通过 key 获取应用 service // @Accept json // @Param key path string true "request" // @Success 200 {array} response.AppService @@ -200,7 +191,6 @@ func (b *BaseApi) GetServices(c *gin.Context) { // @Tags App // @Summary Search app update version by install id -// @Description 通过 install id 获取应用更新版本 // @Accept json // @Param appInstallId path integer true "request" // @Success 200 {array} dto.AppVersion @@ -221,7 +211,6 @@ func (b *BaseApi) GetUpdateVersions(c *gin.Context) { // @Tags App // @Summary Change app port -// @Description 修改应用端口 // @Accept json // @Param request body request.PortUpdate true "request" // @Success 200 @@ -242,7 +231,6 @@ func (b *BaseApi) ChangeAppPort(c *gin.Context) { // @Tags App // @Summary Search default config by key -// @Description 通过 key 获取应用默认配置 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {string} content @@ -264,7 +252,6 @@ func (b *BaseApi) GetDefaultConfig(c *gin.Context) { // @Tags App // @Summary Search params by appInstallId -// @Description 通过 install id 获取应用参数 // @Accept json // @Param appInstallId path string true "request" // @Success 200 {object} response.AppParam @@ -286,7 +273,6 @@ func (b *BaseApi) GetParams(c *gin.Context) { // @Tags App // @Summary Change app params -// @Description 修改应用参数 // @Accept json // @Param request body request.AppInstalledUpdate true "request" // @Success 200 @@ -307,7 +293,6 @@ func (b *BaseApi) UpdateInstalled(c *gin.Context) { // @Tags App // @Summary ignore App Update -// @Description 忽略应用升级版本 // @Accept json // @Param request body request.AppInstalledIgnoreUpgrade true "request" // @Success 200 diff --git a/backend/app/api/v1/auth.go b/backend/app/api/v1/auth.go index 461effa2c..5556b0d3e 100644 --- a/backend/app/api/v1/auth.go +++ b/backend/app/api/v1/auth.go @@ -17,9 +17,8 @@ type BaseApi struct{} // @Tags Auth // @Summary User login -// @Description 用户登录 // @Accept json -// @Param EntranceCode header string true "安全入口 base64 加密串" +// @Param EntranceCode header string true "Secure entrance base64 encrypted string" // @Param request body dto.Login true "request" // @Success 200 {object} dto.UserLoginInfo // @Router /auth/login [post] @@ -59,12 +58,11 @@ func (b *BaseApi) Login(c *gin.Context) { // @Tags Auth // @Summary User login with mfa -// @Description 用户 mfa 登录 // @Accept json // @Param request body dto.MFALogin true "request" // @Success 200 {object} dto.UserLoginInfo // @Router /auth/mfalogin [post] -// @Header 200 {string} EntranceCode "安全入口" +// @Header 200 {string} EntranceCode func (b *BaseApi) MFALogin(c *gin.Context) { var req dto.MFALogin if err := helper.CheckBindAndValidate(&req, c); err != nil { @@ -87,7 +85,6 @@ func (b *BaseApi) MFALogin(c *gin.Context) { // @Tags Auth // @Summary User logout -// @Description 用户登出 // @Success 200 // @Security ApiKeyAuth // @Router /auth/logout [post] @@ -101,7 +98,6 @@ func (b *BaseApi) LogOut(c *gin.Context) { // @Tags Auth // @Summary Load captcha -// @Description 加载验证码 // @Success 200 {object} dto.CaptchaResponse // @Router /auth/captcha [get] func (b *BaseApi) Captcha(c *gin.Context) { @@ -124,7 +120,6 @@ func (b *BaseApi) GetResponsePage(c *gin.Context) { // @Tags Auth // @Summary Check System isDemo -// @Description 判断是否为demo环境 // @Success 200 // @Router /auth/demo [get] func (b *BaseApi) CheckIsDemo(c *gin.Context) { @@ -132,8 +127,7 @@ func (b *BaseApi) CheckIsDemo(c *gin.Context) { } // @Tags Auth -// @Summary Check System isDemo -// @Description 判断是否为国际版 +// @Summary Check System isIntl // @Success 200 // @Router /auth/intl [get] func (b *BaseApi) CheckIsIntl(c *gin.Context) { @@ -142,7 +136,6 @@ func (b *BaseApi) CheckIsIntl(c *gin.Context) { // @Tags Auth // @Summary Load System Language -// @Description 获取系统语言设置 // @Success 200 // @Router /auth/language [get] func (b *BaseApi) GetLanguage(c *gin.Context) { diff --git a/backend/app/api/v1/backup.go b/backend/app/api/v1/backup.go index 1849ba568..d52f75d76 100644 --- a/backend/app/api/v1/backup.go +++ b/backend/app/api/v1/backup.go @@ -13,7 +13,6 @@ import ( // @Tags Backup Account // @Summary Create backup account -// @Description 创建备份账号 // @Accept json // @Param request body dto.BackupOperate true "request" // @Success 200 @@ -51,7 +50,6 @@ func (b *BaseApi) CreateBackup(c *gin.Context) { // @Tags Backup Account // @Summary Refresh OneDrive token -// @Description 刷新 OneDrive token // @Success 200 // @Security ApiKeyAuth // @Router /settings/backup/refresh/onedrive [post] @@ -62,7 +60,6 @@ func (b *BaseApi) RefreshOneDriveToken(c *gin.Context) { // @Tags Backup Account // @Summary List buckets -// @Description 获取 bucket 列表 // @Accept json // @Param request body dto.ForBuckets true "request" // @Success 200 {array} string @@ -100,7 +97,6 @@ func (b *BaseApi) ListBuckets(c *gin.Context) { // @Tags Backup Account // @Summary Load OneDrive info -// @Description 获取 OneDrive 信息 // @Accept json // @Success 200 {object} dto.OneDriveInfo // @Security ApiKeyAuth @@ -116,7 +112,6 @@ func (b *BaseApi) LoadOneDriveInfo(c *gin.Context) { // @Tags Backup Account // @Summary Delete backup account -// @Description 删除备份账号 // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 @@ -138,7 +133,6 @@ func (b *BaseApi) DeleteBackup(c *gin.Context) { // @Tags Backup Account // @Summary Page backup records -// @Description 获取备份记录列表分页 // @Accept json // @Param request body dto.RecordSearch true "request" // @Success 200 @@ -164,7 +158,6 @@ func (b *BaseApi) SearchBackupRecords(c *gin.Context) { // @Tags Backup Account // @Summary Page backup records by cronjob -// @Description 通过计划任务获取备份记录列表分页 // @Accept json // @Param request body dto.RecordSearchByCronjob true "request" // @Success 200 @@ -190,7 +183,6 @@ func (b *BaseApi) SearchBackupRecordsByCronjob(c *gin.Context) { // @Tags Backup Account // @Summary Download backup record -// @Description 下载备份记录 // @Accept json // @Param request body dto.DownloadRecord true "request" // @Success 200 @@ -213,7 +205,6 @@ func (b *BaseApi) DownloadRecord(c *gin.Context) { // @Tags Backup Account // @Summary Delete backup record -// @Description 删除备份记录 // @Accept json // @Param request body dto.BatchDeleteReq true "request" // @Success 200 @@ -235,7 +226,6 @@ func (b *BaseApi) DeleteBackupRecord(c *gin.Context) { // @Tags Backup Account // @Summary Update backup account -// @Description 更新备份账号信息 // @Accept json // @Param request body dto.BackupOperate true "request" // @Success 200 @@ -274,7 +264,6 @@ func (b *BaseApi) UpdateBackup(c *gin.Context) { // @Tags Backup Account // @Summary List backup accounts -// @Description 获取备份账号列表 // @Success 200 {array} dto.BackupInfo // @Security ApiKeyAuth // @Router /settings/backup/search [get] @@ -290,7 +279,6 @@ func (b *BaseApi) ListBackup(c *gin.Context) { // @Tags Backup Account // @Summary List files from backup accounts -// @Description 获取备份账号内文件列表 // @Accept json // @Param request body dto.BackupSearchFile true "request" // @Success 200 {array} string @@ -308,7 +296,6 @@ func (b *BaseApi) LoadFilesFromBackup(c *gin.Context) { // @Tags Backup Account // @Summary Backup system data -// @Description 备份系统数据 // @Accept json // @Param request body dto.CommonBackup true "request" // @Success 200 @@ -353,7 +340,6 @@ func (b *BaseApi) Backup(c *gin.Context) { // @Tags Backup Account // @Summary Recover system data -// @Description 恢复系统数据 // @Accept json // @Param request body dto.CommonRecover true "request" // @Success 200 @@ -404,7 +390,6 @@ func (b *BaseApi) Recover(c *gin.Context) { // @Tags Backup Account // @Summary Recover system data by upload -// @Description 从上传恢复系统数据 // @Accept json // @Param request body dto.CommonRecover true "request" // @Success 200 diff --git a/backend/app/api/v1/clam.go b/backend/app/api/v1/clam.go index 0e4e7cf47..d6cd9a381 100644 --- a/backend/app/api/v1/clam.go +++ b/backend/app/api/v1/clam.go @@ -9,7 +9,6 @@ import ( // @Tags Clam // @Summary Create clam -// @Description 创建扫描规则 // @Accept json // @Param request body dto.ClamCreate true "request" // @Success 200 @@ -31,7 +30,6 @@ func (b *BaseApi) CreateClam(c *gin.Context) { // @Tags Clam // @Summary Update clam -// @Description 修改扫描规则 // @Accept json // @Param request body dto.ClamUpdate true "request" // @Success 200 @@ -53,7 +51,6 @@ func (b *BaseApi) UpdateClam(c *gin.Context) { // @Tags Clam // @Summary Update clam status -// @Description 修改扫描规则状态 // @Accept json // @Param request body dto.ClamUpdateStatus true "request" // @Success 200 @@ -75,7 +72,6 @@ func (b *BaseApi) UpdateClamStatus(c *gin.Context) { // @Tags Clam // @Summary Page clam -// @Description 获取扫描规则列表分页 // @Accept json // @Param request body dto.SearchClamWithPage true "request" // @Success 200 {object} dto.PageResult @@ -101,7 +97,6 @@ func (b *BaseApi) SearchClam(c *gin.Context) { // @Tags Clam // @Summary Load clam base info -// @Description 获取 Clam 基础信息 // @Accept json // @Success 200 {object} dto.ClamBaseInfo // @Security ApiKeyAuth @@ -118,7 +113,6 @@ func (b *BaseApi) LoadClamBaseInfo(c *gin.Context) { // @Tags Clam // @Summary Operate Clam -// @Description 修改 Clam 状态 // @Accept json // @Param request body dto.Operate true "request" // @Security ApiKeyAuth @@ -140,7 +134,6 @@ func (b *BaseApi) OperateClam(c *gin.Context) { // @Tags Clam // @Summary Clean clam record -// @Description 清空扫描报告 // @Accept json // @Param request body dto.OperateByID true "request" // @Security ApiKeyAuth @@ -161,7 +154,6 @@ func (b *BaseApi) CleanClamRecord(c *gin.Context) { // @Tags Clam // @Summary Page clam record -// @Description 获取扫描结果列表分页 // @Accept json // @Param request body dto.ClamLogSearch true "request" // @Success 200 {object} dto.PageResult @@ -187,7 +179,6 @@ func (b *BaseApi) SearchClamRecord(c *gin.Context) { // @Tags Clam // @Summary Load clam record detail -// @Description 获取扫描结果详情 // @Accept json // @Param request body dto.ClamLogReq true "request" // @Success 200 @@ -210,7 +201,6 @@ func (b *BaseApi) LoadClamRecordLog(c *gin.Context) { // @Tags Clam // @Summary Load clam file -// @Description 获取扫描文件 // @Accept json // @Param request body dto.ClamFileReq true "request" // @Success 200 {object} dto.PageResult @@ -233,7 +223,6 @@ func (b *BaseApi) SearchClamFile(c *gin.Context) { // @Tags Clam // @Summary Update clam file -// @Description 更新病毒扫描配置文件 // @Accept json // @Param request body dto.UpdateByNameAndFile true "request" // @Success 200 @@ -253,7 +242,6 @@ func (b *BaseApi) UpdateFile(c *gin.Context) { // @Tags Clam // @Summary Delete clam -// @Description 删除扫描规则 // @Accept json // @Param request body dto.ClamDelete true "request" // @Success 200 @@ -275,7 +263,6 @@ func (b *BaseApi) DeleteClam(c *gin.Context) { // @Tags Clam // @Summary Handle clam scan -// @Description 执行病毒扫描 // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 diff --git a/backend/app/api/v1/command.go b/backend/app/api/v1/command.go index 3c9926111..45152bb0c 100644 --- a/backend/app/api/v1/command.go +++ b/backend/app/api/v1/command.go @@ -9,7 +9,6 @@ import ( // @Tags Command // @Summary Create command -// @Description 创建快速命令 // @Accept json // @Param request body dto.CommandOperate true "request" // @Success 200 @@ -31,7 +30,6 @@ func (b *BaseApi) CreateCommand(c *gin.Context) { // @Tags Redis Command // @Summary Save redis command -// @Description 保存 Redis 快速命令 // @Accept json // @Param request body dto.RedisCommand true "request" // @Success 200 @@ -53,7 +51,6 @@ func (b *BaseApi) SaveRedisCommand(c *gin.Context) { // @Tags Command // @Summary Page commands -// @Description 获取快速命令列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Success 200 {object} dto.PageResult @@ -79,7 +76,6 @@ func (b *BaseApi) SearchCommand(c *gin.Context) { // @Tags Redis Command // @Summary Page redis commands -// @Description 获取 redis 快速命令列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Success 200 {object} dto.PageResult @@ -105,7 +101,6 @@ func (b *BaseApi) SearchRedisCommand(c *gin.Context) { // @Tags Command // @Summary Tree commands -// @Description 获取快速命令树 // @Accept json // @Success 200 {Array} dto.CommandTree // @Security ApiKeyAuth @@ -122,7 +117,6 @@ func (b *BaseApi) SearchCommandTree(c *gin.Context) { // @Tags Redis Command // @Summary List redis commands -// @Description 获取 redis 快速命令列表 // @Success 200 {Array} dto.RedisCommand // @Security ApiKeyAuth // @Router /hosts/command/redis [get] @@ -138,7 +132,6 @@ func (b *BaseApi) ListRedisCommand(c *gin.Context) { // @Tags Command // @Summary List commands -// @Description 获取快速命令列表 // @Success 200 {object} dto.CommandInfo // @Security ApiKeyAuth // @Router /hosts/command [get] @@ -154,7 +147,6 @@ func (b *BaseApi) ListCommand(c *gin.Context) { // @Tags Command // @Summary Delete command -// @Description 删除快速命令 // @Accept json // @Param request body dto.BatchDeleteReq true "request" // @Success 200 @@ -176,7 +168,6 @@ func (b *BaseApi) DeleteCommand(c *gin.Context) { // @Tags Redis Command // @Summary Delete redis command -// @Description 删除 redis 快速命令 // @Accept json // @Param request body dto.BatchDeleteReq true "request" // @Success 200 @@ -198,7 +189,6 @@ func (b *BaseApi) DeleteRedisCommand(c *gin.Context) { // @Tags Command // @Summary Update command -// @Description 更新快速命令 // @Accept json // @Param request body dto.CommandOperate true "request" // @Success 200 diff --git a/backend/app/api/v1/compose_template.go b/backend/app/api/v1/compose_template.go index 5fcba846d..6ee99f073 100644 --- a/backend/app/api/v1/compose_template.go +++ b/backend/app/api/v1/compose_template.go @@ -9,7 +9,6 @@ import ( // @Tags Container Compose-template // @Summary Create compose template -// @Description 创建容器编排模版 // @Accept json // @Param request body dto.ComposeTemplateCreate true "request" // @Success 200 @@ -31,7 +30,6 @@ func (b *BaseApi) CreateComposeTemplate(c *gin.Context) { // @Tags Container Compose-template // @Summary Page compose templates -// @Description 获取容器编排模版列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Produce json @@ -58,7 +56,6 @@ func (b *BaseApi) SearchComposeTemplate(c *gin.Context) { // @Tags Container Compose-template // @Summary List compose templates -// @Description 获取容器编排模版列表 // @Produce json // @Success 200 {array} dto.ComposeTemplateInfo // @Security ApiKeyAuth @@ -75,7 +72,6 @@ func (b *BaseApi) ListComposeTemplate(c *gin.Context) { // @Tags Container Compose-template // @Summary Delete compose template -// @Description 删除容器编排模版 // @Accept json // @Param request body dto.BatchDelete true "request" // @Success 200 @@ -97,7 +93,6 @@ func (b *BaseApi) DeleteComposeTemplate(c *gin.Context) { // @Tags Container Compose-template // @Summary Update compose template -// @Description 更新容器编排模版 // @Accept json // @Param request body dto.ComposeTemplateUpdate true "request" // @Success 200 diff --git a/backend/app/api/v1/container.go b/backend/app/api/v1/container.go index 5c8213662..93179445e 100644 --- a/backend/app/api/v1/container.go +++ b/backend/app/api/v1/container.go @@ -12,7 +12,6 @@ import ( // @Tags Container // @Summary Page containers -// @Description 获取容器列表分页 // @Accept json // @Param request body dto.PageContainer true "request" // @Produce json @@ -38,7 +37,6 @@ func (b *BaseApi) SearchContainer(c *gin.Context) { // @Tags Container // @Summary List containers -// @Description 获取容器名称 // @Accept json // @Produce json // @Success 200 @@ -55,7 +53,6 @@ func (b *BaseApi) ListContainer(c *gin.Context) { // @Tags Container Compose // @Summary Page composes -// @Description 获取编排列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Success 200 {object} dto.PageResult @@ -80,7 +77,6 @@ func (b *BaseApi) SearchCompose(c *gin.Context) { // @Tags Container Compose // @Summary Test compose -// @Description 测试 compose 是否可用 // @Accept json // @Param request body dto.ComposeCreate true "request" // @Success 200 @@ -103,7 +99,6 @@ func (b *BaseApi) TestCompose(c *gin.Context) { // @Tags Container Compose // @Summary Create compose -// @Description 创建容器编排 // @Accept json // @Param request body dto.ComposeCreate true "request" // @Success 200 @@ -126,7 +121,6 @@ func (b *BaseApi) CreateCompose(c *gin.Context) { // @Tags Container Compose // @Summary Operate compose -// @Description 容器编排操作 // @Accept json // @Param request body dto.ComposeOperation true "request" // @Success 200 @@ -148,7 +142,6 @@ func (b *BaseApi) OperatorCompose(c *gin.Context) { // @Tags Container // @Summary Update container -// @Description 更新容器 // @Accept json // @Param request body dto.ContainerOperate true "request" // @Success 200 @@ -170,7 +163,6 @@ func (b *BaseApi) ContainerUpdate(c *gin.Context) { // @Tags Container // @Summary Load container info -// @Description 获取容器表单信息 // @Accept json // @Param request body dto.OperationWithName true "request" // @Success 200 {object} dto.ContainerOperate @@ -191,7 +183,6 @@ func (b *BaseApi) ContainerInfo(c *gin.Context) { } // @Summary Load container limits -// @Description 获取容器限制 // @Success 200 {object} dto.ResourceLimit // @Security ApiKeyAuth // @Router /containers/limit [get] @@ -205,7 +196,6 @@ func (b *BaseApi) LoadResourceLimit(c *gin.Context) { } // @Summary Load container stats -// @Description 获取容器列表资源占用 // @Success 200 {array} dto.ContainerListStats // @Security ApiKeyAuth // @Router /containers/list/stats [get] @@ -220,7 +210,6 @@ func (b *BaseApi) ContainerListStats(c *gin.Context) { // @Tags Container // @Summary Create container -// @Description 创建容器 // @Accept json // @Param request body dto.ContainerOperate true "request" // @Success 200 @@ -242,7 +231,6 @@ func (b *BaseApi) ContainerCreate(c *gin.Context) { // @Tags Container // @Summary Upgrade container -// @Description 更新容器镜像 // @Accept json // @Param request body dto.ContainerUpgrade true "request" // @Success 200 @@ -264,7 +252,6 @@ func (b *BaseApi) ContainerUpgrade(c *gin.Context) { // @Tags Container // @Summary Clean container -// @Description 容器清理 // @Accept json // @Param request body dto.ContainerPrune true "request" // @Success 200 {object} dto.ContainerPruneReport @@ -287,7 +274,6 @@ func (b *BaseApi) ContainerPrune(c *gin.Context) { // @Tags Container // @Summary Clean container log -// @Description 清理容器日志 // @Accept json // @Param request body dto.OperationWithName true "request" // @Success 200 @@ -309,7 +295,6 @@ func (b *BaseApi) CleanContainerLog(c *gin.Context) { // @Tags Container // @Summary Load container log -// @Description 获取容器操作日志 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 @@ -327,7 +312,6 @@ func (b *BaseApi) LoadContainerLog(c *gin.Context) { // @Tags Container // @Summary Rename Container -// @Description 容器重命名 // @Accept json // @Param request body dto.ContainerRename true "request" // @Success 200 @@ -349,7 +333,6 @@ func (b *BaseApi) ContainerRename(c *gin.Context) { // @Tags Container // @Summary Commit Container -// @Description 容器提交生成新镜像 // @Accept json // @Param request body dto.ContainerCommit true "request" // @Success 200 @@ -369,7 +352,6 @@ func (b *BaseApi) ContainerCommit(c *gin.Context) { // @Tags Container // @Summary Operate Container -// @Description 容器操作 // @Accept json // @Param request body dto.ContainerOperation true "request" // @Success 200 @@ -391,8 +373,7 @@ func (b *BaseApi) ContainerOperation(c *gin.Context) { // @Tags Container // @Summary Container stats -// @Description 容器监控信息 -// @Param id path integer true "容器id" +// @Param id path integer true "container id" // @Success 200 {object} dto.ContainerStats // @Security ApiKeyAuth // @Router /containers/stats/:id [get] @@ -413,7 +394,6 @@ func (b *BaseApi) ContainerStats(c *gin.Context) { // @Tags Container // @Summary Container inspect -// @Description 容器详情 // @Accept json // @Param request body dto.InspectReq true "request" // @Success 200 {string} result @@ -435,11 +415,10 @@ func (b *BaseApi) Inspect(c *gin.Context) { // @Tags Container // @Summary Container logs -// @Description 容器日志 -// @Param container query string false "容器名称" -// @Param since query string false "时间筛选" -// @Param follow query string false "是否追踪" -// @Param tail query string false "显示行号" +// @Param container query string false "container name" +// @Param since query string false "since" +// @Param follow query string false "follow" +// @Param tail query string false "tail" // @Security ApiKeyAuth // @Router /containers/search/log [post] func (b *BaseApi) ContainerLogs(c *gin.Context) { @@ -461,7 +440,11 @@ func (b *BaseApi) ContainerLogs(c *gin.Context) { } } -// @Description 下载容器日志 +// @Tags Container +// @Summary Download Container logs +// @Accept json +// @Param request body dto.ContainerLog true "request" +// @Security ApiKeyAuth // @Router /containers/download/log [post] func (b *BaseApi) DownloadContainerLogs(c *gin.Context) { var req dto.ContainerLog @@ -476,7 +459,6 @@ func (b *BaseApi) DownloadContainerLogs(c *gin.Context) { // @Tags Container Network // @Summary Page networks -// @Description 获取容器网络列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Produce json @@ -502,7 +484,6 @@ func (b *BaseApi) SearchNetwork(c *gin.Context) { // @Tags Container Network // @Summary List networks -// @Description 获取容器网络列表 // @Accept json // @Produce json // @Success 200 {array} dto.Options @@ -519,7 +500,6 @@ func (b *BaseApi) ListNetwork(c *gin.Context) { // @Tags Container Network // @Summary Delete network -// @Description 删除容器网络 // @Accept json // @Param request body dto.BatchDelete true "request" // @Success 200 @@ -541,7 +521,6 @@ func (b *BaseApi) DeleteNetwork(c *gin.Context) { // @Tags Container Network // @Summary Create network -// @Description 创建容器网络 // @Accept json // @Param request body dto.NetworkCreate true "request" // @Success 200 @@ -562,8 +541,7 @@ func (b *BaseApi) CreateNetwork(c *gin.Context) { } // @Tags Container Volume -// @Summary Page volumes -// @Description 获取容器存储卷分页 +// @Summary Page Container Volumes // @Accept json // @Param request body dto.SearchWithPage true "request" // @Produce json @@ -588,8 +566,7 @@ func (b *BaseApi) SearchVolume(c *gin.Context) { } // @Tags Container Volume -// @Summary List volumes -// @Description 获取容器存储卷列表 +// @Summary List Container Volumes // @Accept json // @Produce json // @Success 200 {array} dto.Options @@ -605,8 +582,7 @@ func (b *BaseApi) ListVolume(c *gin.Context) { } // @Tags Container Volume -// @Summary Delete volume -// @Description 删除容器存储卷 +// @Summary Delete Container Volume // @Accept json // @Param request body dto.BatchDelete true "request" // @Success 200 @@ -627,8 +603,7 @@ func (b *BaseApi) DeleteVolume(c *gin.Context) { } // @Tags Container Volume -// @Summary Create volume -// @Description 创建容器存储卷 +// @Summary Create Container Volume // @Accept json // @Param request body dto.VolumeCreate true "request" // @Success 200 @@ -649,8 +624,7 @@ func (b *BaseApi) CreateVolume(c *gin.Context) { } // @Tags Container Compose -// @Summary Update compose -// @Description 更新容器编排 +// @Summary Update Container Compose // @Accept json // @Param request body dto.ComposeUpdate true "request" // @Success 200 @@ -672,11 +646,10 @@ func (b *BaseApi) ComposeUpdate(c *gin.Context) { // @Tags Container Compose // @Summary Container Compose logs -// @Description docker-compose 日志 -// @Param compose query string false "compose 文件地址" -// @Param since query string false "时间筛选" -// @Param follow query string false "是否追踪" -// @Param tail query string false "显示行号" +// @Param compose query string false "compose file address" +// @Param since query string false "date" +// @Param follow query string false "follow" +// @Param tail query string false "tail" // @Security ApiKeyAuth // @Router /containers/compose/search/log [get] func (b *BaseApi) ComposeLogs(c *gin.Context) { diff --git a/backend/app/api/v1/cronjob.go b/backend/app/api/v1/cronjob.go index 2e54c3794..6e8cf513d 100644 --- a/backend/app/api/v1/cronjob.go +++ b/backend/app/api/v1/cronjob.go @@ -12,7 +12,6 @@ import ( // @Tags Cronjob // @Summary Create cronjob -// @Description 创建计划任务 // @Accept json // @Param request body dto.CronjobCreate true "request" // @Success 200 @@ -34,7 +33,6 @@ func (b *BaseApi) CreateCronjob(c *gin.Context) { // @Tags Cronjob // @Summary Page cronjobs -// @Description 获取计划任务分页 // @Accept json // @Param request body dto.PageCronjob true "request" // @Success 200 {object} dto.PageResult @@ -60,7 +58,6 @@ func (b *BaseApi) SearchCronjob(c *gin.Context) { // @Tags Cronjob // @Summary Page job records -// @Description 获取计划任务记录 // @Accept json // @Param request body dto.SearchRecord true "request" // @Success 200 {object} dto.PageResult @@ -90,7 +87,6 @@ func (b *BaseApi) SearchJobRecords(c *gin.Context) { // @Tags Cronjob // @Summary Load Cronjob record log -// @Description 获取计划任务记录日志 // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 @@ -107,7 +103,6 @@ func (b *BaseApi) LoadRecordLog(c *gin.Context) { // @Tags Cronjob // @Summary Clean job records -// @Description 清空计划任务记录 // @Accept json // @Param request body dto.CronjobClean true "request" // @Success 200 @@ -130,7 +125,6 @@ func (b *BaseApi) CleanRecord(c *gin.Context) { // @Tags Cronjob // @Summary Delete cronjob -// @Description 删除计划任务 // @Accept json // @Param request body dto.CronjobBatchDelete true "request" // @Success 200 @@ -152,7 +146,6 @@ func (b *BaseApi) DeleteCronjob(c *gin.Context) { // @Tags Cronjob // @Summary Update cronjob -// @Description 更新计划任务 // @Accept json // @Param request body dto.CronjobUpdate true "request" // @Success 200 @@ -174,7 +167,6 @@ func (b *BaseApi) UpdateCronjob(c *gin.Context) { // @Tags Cronjob // @Summary Update cronjob status -// @Description 更新计划任务状态 // @Accept json // @Param request body dto.CronjobUpdateStatus true "request" // @Success 200 @@ -196,7 +188,6 @@ func (b *BaseApi) UpdateCronjobStatus(c *gin.Context) { // @Tags Cronjob // @Summary Download cronjob records -// @Description 下载计划任务记录 // @Accept json // @Param request body dto.CronjobDownload true "request" // @Success 200 @@ -220,7 +211,6 @@ func (b *BaseApi) TargetDownload(c *gin.Context) { // @Tags Cronjob // @Summary Handle cronjob once -// @Description 手动执行计划任务 // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 diff --git a/backend/app/api/v1/dashboard.go b/backend/app/api/v1/dashboard.go index d15e4e345..1e873e65d 100644 --- a/backend/app/api/v1/dashboard.go +++ b/backend/app/api/v1/dashboard.go @@ -12,7 +12,6 @@ import ( // @Tags Dashboard // @Summary Load os info -// @Description 获取服务器基础数据 // @Accept json // @Success 200 {object} dto.OsInfo // @Security ApiKeyAuth @@ -28,7 +27,6 @@ func (b *BaseApi) LoadDashboardOsInfo(c *gin.Context) { // @Tags Dashboard // @Summary Load dashboard base info -// @Description 获取首页基础数据 // @Accept json // @Param ioOption path string true "request" // @Param netOption path string true "request" @@ -56,7 +54,6 @@ func (b *BaseApi) LoadDashboardBaseInfo(c *gin.Context) { // @Tags Dashboard // @Summary Load dashboard current info -// @Description 获取首页实时数据 // @Accept json // @Param request body dto.DashboardReq true "request" // @Success 200 {object} dto.DashboardCurrent @@ -72,8 +69,7 @@ func (b *BaseApi) LoadDashboardCurrentInfo(c *gin.Context) { } // @Tags Dashboard -// @Summary System restart -// @Description 重启服务器/面板 +// @Summary System restart panel // @Accept json // @Param operation path string true "request" // @Success 200 diff --git a/backend/app/api/v1/database.go b/backend/app/api/v1/database.go index 5a198f7c1..ac976100f 100644 --- a/backend/app/api/v1/database.go +++ b/backend/app/api/v1/database.go @@ -11,7 +11,6 @@ import ( // @Tags Database // @Summary Create database -// @Description 创建远程数据库 // @Accept json // @Param request body dto.DatabaseCreate true "request" // @Success 200 @@ -41,7 +40,6 @@ func (b *BaseApi) CreateDatabase(c *gin.Context) { // @Tags Database // @Summary Check database -// @Description 检测远程数据库连接性 // @Accept json // @Param request body dto.DatabaseCreate true "request" // @Success 200 @@ -67,7 +65,6 @@ func (b *BaseApi) CheckDatabase(c *gin.Context) { // @Tags Database // @Summary Page databases -// @Description 获取远程数据库列表分页 // @Accept json // @Param request body dto.DatabaseSearch true "request" // @Success 200 {object} dto.PageResult @@ -93,7 +90,6 @@ func (b *BaseApi) SearchDatabase(c *gin.Context) { // @Tags Database // @Summary List databases -// @Description 获取远程数据库列表 // @Success 200 {array} dto.DatabaseOption // @Security ApiKeyAuth // @Router /databases/db/list/:type [get] @@ -113,8 +109,7 @@ func (b *BaseApi) ListDatabase(c *gin.Context) { } // @Tags Database -// @Summary List databases -// @Description 获取数据库列表 +// @Summary Retrieve database list based on type // @Success 200 {array} dto.DatabaseItem // @Security ApiKeyAuth // @Router /databases/db/item/:type [get] @@ -135,7 +130,6 @@ func (b *BaseApi) LoadDatabaseItems(c *gin.Context) { // @Tags Database // @Summary Get databases -// @Description 获取远程数据库 // @Success 200 {object} dto.DatabaseInfo // @Security ApiKeyAuth // @Router /databases/db/:name [get] @@ -156,7 +150,6 @@ func (b *BaseApi) GetDatabase(c *gin.Context) { // @Tags Database // @Summary Check before delete remote database -// @Description Mysql 远程数据库删除前检查 // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 {array} string @@ -178,7 +171,6 @@ func (b *BaseApi) DeleteCheckDatabase(c *gin.Context) { // @Tags Database // @Summary Delete database -// @Description 删除远程数据库 // @Accept json // @Param request body dto.DatabaseDelete true "request" // @Success 200 @@ -200,7 +192,6 @@ func (b *BaseApi) DeleteDatabase(c *gin.Context) { // @Tags Database // @Summary Update database -// @Description 更新远程数据库 // @Accept json // @Param request body dto.DatabaseUpdate true "request" // @Success 200 diff --git a/backend/app/api/v1/database_common.go b/backend/app/api/v1/database_common.go index 5ff57736e..9ef71d068 100644 --- a/backend/app/api/v1/database_common.go +++ b/backend/app/api/v1/database_common.go @@ -9,7 +9,6 @@ import ( // @Tags Database Common // @Summary Load base info -// @Description 获取数据库基础信息 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {object} dto.DBBaseInfo @@ -32,7 +31,6 @@ func (b *BaseApi) LoadDBBaseInfo(c *gin.Context) { // @Tags Database Common // @Summary Load Database conf -// @Description 获取数据库配置文件 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 @@ -53,7 +51,6 @@ func (b *BaseApi) LoadDBFile(c *gin.Context) { // @Tags Database Common // @Summary Update conf by upload file -// @Description 上传替换配置文件 // @Accept json // @Param request body dto.DBConfUpdateByFile true "request" // @Success 200 diff --git a/backend/app/api/v1/database_mysql.go b/backend/app/api/v1/database_mysql.go index 1168dad49..73b73a5e4 100644 --- a/backend/app/api/v1/database_mysql.go +++ b/backend/app/api/v1/database_mysql.go @@ -12,7 +12,6 @@ import ( // @Tags Database Mysql // @Summary Create mysql database -// @Description 创建 mysql 数据库 // @Accept json // @Param request body dto.MysqlDBCreate true "request" // @Success 200 @@ -43,7 +42,6 @@ func (b *BaseApi) CreateMysql(c *gin.Context) { // @Tags Database Mysql // @Summary Bind user of mysql database -// @Description 绑定 mysql 数据库用户 // @Accept json // @Param request body dto.BindUser true "request" // @Success 200 @@ -74,7 +72,6 @@ func (b *BaseApi) BindUser(c *gin.Context) { // @Tags Database Mysql // @Summary Update mysql database description -// @Description 更新 mysql 数据库库描述信息 // @Accept json // @Param request body dto.UpdateDescription true "request" // @Success 200 @@ -96,7 +93,6 @@ func (b *BaseApi) UpdateMysqlDescription(c *gin.Context) { // @Tags Database Mysql // @Summary Change mysql password -// @Description 修改 mysql 密码 // @Accept json // @Param request body dto.ChangeDBInfo true "request" // @Success 200 @@ -127,7 +123,6 @@ func (b *BaseApi) ChangeMysqlPassword(c *gin.Context) { // @Tags Database Mysql // @Summary Change mysql access -// @Description 修改 mysql 访问权限 // @Accept json // @Param request body dto.ChangeDBInfo true "request" // @Success 200 @@ -149,7 +144,6 @@ func (b *BaseApi) ChangeMysqlAccess(c *gin.Context) { // @Tags Database Mysql // @Summary Update mysql variables -// @Description mysql 性能调优 // @Accept json // @Param request body dto.MysqlVariablesUpdate true "request" // @Success 200 @@ -171,7 +165,6 @@ func (b *BaseApi) UpdateMysqlVariables(c *gin.Context) { // @Tags Database Mysql // @Summary Page mysql databases -// @Description 获取 mysql 数据库列表分页 // @Accept json // @Param request body dto.MysqlDBSearch true "request" // @Success 200 {object} dto.PageResult @@ -197,7 +190,6 @@ func (b *BaseApi) SearchMysql(c *gin.Context) { // @Tags Database Mysql // @Summary List mysql database names -// @Description 获取 mysql 数据库列表 // @Accept json // @Param request body dto.PageInfo true "request" // @Success 200 {array} dto.MysqlOption @@ -215,7 +207,6 @@ func (b *BaseApi) ListDBName(c *gin.Context) { // @Tags Database Mysql // @Summary Load mysql database from remote -// @Description 从服务器获取 // @Accept json // @Param request body dto.MysqlLoadDB true "request" // @Security ApiKeyAuth @@ -236,7 +227,6 @@ func (b *BaseApi) LoadDBFromRemote(c *gin.Context) { // @Tags Database Mysql // @Summary Check before delete mysql database -// @Description Mysql 数据库删除前检查 // @Accept json // @Param request body dto.MysqlDBDeleteCheck true "request" // @Success 200 {array} string @@ -258,7 +248,6 @@ func (b *BaseApi) DeleteCheckMysql(c *gin.Context) { // @Tags Database Mysql // @Summary Delete mysql database -// @Description 删除 mysql 数据库 // @Accept json // @Param request body dto.MysqlDBDelete true "request" // @Success 200 @@ -283,7 +272,6 @@ func (b *BaseApi) DeleteMysql(c *gin.Context) { // @Tags Database Mysql // @Summary Load mysql remote access -// @Description 获取 mysql 远程访问权限 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {boolean} isRemote @@ -305,7 +293,6 @@ func (b *BaseApi) LoadRemoteAccess(c *gin.Context) { // @Tags Database Mysql // @Summary Load mysql status info -// @Description 获取 mysql 状态信息 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {object} dto.MysqlStatus @@ -328,7 +315,6 @@ func (b *BaseApi) LoadStatus(c *gin.Context) { // @Tags Database Mysql // @Summary Load mysql variables info -// @Description 获取 mysql 性能参数信息 // @Accept json // @Param request body dto.OperationWithNameAndType true "request" // @Success 200 {object} dto.MysqlVariables diff --git a/backend/app/api/v1/database_postgresql.go b/backend/app/api/v1/database_postgresql.go index 5bd5f093a..56dc53b8d 100644 --- a/backend/app/api/v1/database_postgresql.go +++ b/backend/app/api/v1/database_postgresql.go @@ -12,7 +12,6 @@ import ( // @Tags Database Postgresql // @Summary Create postgresql database -// @Description 创建 postgresql 数据库 // @Accept json // @Param request body dto.PostgresqlDBCreate true "request" // @Success 200 @@ -43,7 +42,6 @@ func (b *BaseApi) CreatePostgresql(c *gin.Context) { // @Tags Database Postgresql // @Summary Bind postgresql user -// @Description 绑定 postgresql 数据库用户 // @Accept json // @Param request body dto.PostgresqlBindUser true "request" // @Success 200 @@ -65,7 +63,6 @@ func (b *BaseApi) BindPostgresqlUser(c *gin.Context) { // @Tags Database Postgresql // @Summary Update postgresql database description -// @Description 更新 postgresql 数据库库描述信息 // @Accept json // @Param request body dto.UpdateDescription true "request" // @Success 200 @@ -87,7 +84,6 @@ func (b *BaseApi) UpdatePostgresqlDescription(c *gin.Context) { // @Tags Database Postgresql // @Summary Change postgresql privileges -// @Description 修改 postgresql 用户权限 // @Accept json // @Param request body dto.ChangeDBInfo true "request" // @Success 200 @@ -109,7 +105,6 @@ func (b *BaseApi) ChangePostgresqlPrivileges(c *gin.Context) { // @Tags Database Postgresql // @Summary Change postgresql password -// @Description 修改 postgresql 密码 // @Accept json // @Param request body dto.ChangeDBInfo true "request" // @Success 200 @@ -140,7 +135,6 @@ func (b *BaseApi) ChangePostgresqlPassword(c *gin.Context) { // @Tags Database Postgresql // @Summary Page postgresql databases -// @Description 获取 postgresql 数据库列表分页 // @Accept json // @Param request body dto.PostgresqlDBSearch true "request" // @Success 200 {object} dto.PageResult @@ -166,7 +160,6 @@ func (b *BaseApi) SearchPostgresql(c *gin.Context) { // @Tags Database Postgresql // @Summary Load postgresql database from remote -// @Description 从服务器获取 // @Accept json // @Param request body dto.PostgresqlLoadDB true "request" // @Security ApiKeyAuth @@ -188,7 +181,6 @@ func (b *BaseApi) LoadPostgresqlDBFromRemote(c *gin.Context) { // @Tags Database Postgresql // @Summary Check before delete postgresql database -// @Description Postgresql 数据库删除前检查 // @Accept json // @Param request body dto.PostgresqlDBDeleteCheck true "request" // @Success 200 {array} string @@ -210,7 +202,6 @@ func (b *BaseApi) DeleteCheckPostgresql(c *gin.Context) { // @Tags Database Postgresql // @Summary Delete postgresql database -// @Description 删除 postgresql 数据库 // @Accept json // @Param request body dto.PostgresqlDBDelete true "request" // @Success 200 diff --git a/backend/app/api/v1/database_redis.go b/backend/app/api/v1/database_redis.go index 60b086280..bef94da82 100644 --- a/backend/app/api/v1/database_redis.go +++ b/backend/app/api/v1/database_redis.go @@ -11,7 +11,6 @@ import ( // @Tags Database Redis // @Summary Load redis status info -// @Description 获取 redis 状态信息 // @Accept json // @Param request body dto.OperationWithName true "request" // @Success 200 {object} dto.RedisStatus @@ -33,7 +32,6 @@ func (b *BaseApi) LoadRedisStatus(c *gin.Context) { // @Tags Database Redis // @Summary Load redis conf -// @Description 获取 redis 配置信息 // @Accept json // @Param request body dto.OperationWithName true "request" // @Success 200 {object} dto.RedisConf @@ -55,7 +53,6 @@ func (b *BaseApi) LoadRedisConf(c *gin.Context) { // @Tags Database Redis // @Summary Load redis persistence conf -// @Description 获取 redis 持久化配置 // @Accept json // @Param request body dto.OperationWithName true "request" // @Success 200 {object} dto.RedisPersistence @@ -81,7 +78,6 @@ func (b *BaseApi) CheckHasCli(c *gin.Context) { // @Tags Database Redis // @Summary Install redis-cli -// @Description 安装 redis cli // @Success 200 // @Security ApiKeyAuth // @Router /databases/redis/install/cli [post] @@ -96,7 +92,6 @@ func (b *BaseApi) InstallCli(c *gin.Context) { // @Tags Database Redis // @Summary Update redis conf -// @Description 更新 redis 配置信息 // @Accept json // @Param request body dto.RedisConfUpdate true "request" // @Success 200 @@ -118,7 +113,6 @@ func (b *BaseApi) UpdateRedisConf(c *gin.Context) { // @Tags Database Redis // @Summary Change redis password -// @Description 更新 redis 密码 // @Accept json // @Param request body dto.ChangeRedisPass true "request" // @Success 200 @@ -149,7 +143,6 @@ func (b *BaseApi) ChangeRedisPassword(c *gin.Context) { // @Tags Database Redis // @Summary Update redis persistence conf -// @Description 更新 redis 持久化配置 // @Accept json // @Param request body dto.RedisConfPersistenceUpdate true "request" // @Success 200 diff --git a/backend/app/api/v1/device.go b/backend/app/api/v1/device.go index 4b04e3f5d..5c709a27b 100644 --- a/backend/app/api/v1/device.go +++ b/backend/app/api/v1/device.go @@ -11,7 +11,6 @@ import ( // @Tags Device // @Summary Load device base info -// @Description 获取设备基础信息 // @Success 200 {object} dto.DeviceBaseInfo // @Security ApiKeyAuth // @Router /toolbox/device/base [post] @@ -27,7 +26,6 @@ func (b *BaseApi) LoadDeviceBaseInfo(c *gin.Context) { // @Tags Device // @Summary list time zone options -// @Description 获取系统可用时区选项 // @Accept json // @Success 200 {Array} string // @Security ApiKeyAuth @@ -44,7 +42,6 @@ func (b *BaseApi) LoadTimeOption(c *gin.Context) { // @Tags Device // @Summary load conf -// @Description 获取系统配置文件 // @Accept json // @Param request body dto.OperationWithName true "request" // @Success 200 @@ -67,7 +64,6 @@ func (b *BaseApi) LoadDeviceConf(c *gin.Context) { // @Tags Device // @Summary Update device conf by file -// @Description 通过文件修改配置 // @Accept json // @Param request body dto.UpdateByNameAndFile true "request" // @Success 200 @@ -88,7 +84,6 @@ func (b *BaseApi) UpdateDeviceByFile(c *gin.Context) { // @Tags Device // @Summary Update device -// @Description 修改系统参数 // @Accept json // @Param request body dto.SettingUpdate true "request" // @Success 200 @@ -111,7 +106,6 @@ func (b *BaseApi) UpdateDeviceConf(c *gin.Context) { // @Tags Device // @Summary Update device hosts -// @Description 修改系统 hosts // @Success 200 // @Security ApiKeyAuth // @Router /toolbox/device/update/host [post] @@ -132,7 +126,6 @@ func (b *BaseApi) UpdateDeviceHost(c *gin.Context) { // @Tags Device // @Summary Update device passwd -// @Description 修改系统密码 // @Accept json // @Param request body dto.ChangePasswd true "request" // @Success 200 @@ -161,7 +154,6 @@ func (b *BaseApi) UpdateDevicePasswd(c *gin.Context) { // @Tags Device // @Summary Update device swap -// @Description 修改系统 Swap // @Accept json // @Param request body dto.SwapHelper true "request" // @Success 200 @@ -183,7 +175,6 @@ func (b *BaseApi) UpdateDeviceSwap(c *gin.Context) { // @Tags Device // @Summary Check device DNS conf -// @Description 检查系统 DNS 配置可用性 // @Accept json // @Param request body dto.SettingUpdate true "request" // @Success 200 @@ -206,7 +197,6 @@ func (b *BaseApi) CheckDNS(c *gin.Context) { // @Tags Device // @Summary Scan system -// @Description 扫描系统垃圾文件 // @Success 200 // @Security ApiKeyAuth // @Router /toolbox/scan [post] @@ -217,7 +207,6 @@ func (b *BaseApi) ScanSystem(c *gin.Context) { // @Tags Device // @Summary Clean system -// @Description 清理系统垃圾文件 // @Accept json // @Param request body []dto.Clean true "request" // @Success 200 diff --git a/backend/app/api/v1/docker.go b/backend/app/api/v1/docker.go index 79a2e232f..90d3f1ca8 100644 --- a/backend/app/api/v1/docker.go +++ b/backend/app/api/v1/docker.go @@ -11,7 +11,6 @@ import ( // @Tags Container Docker // @Summary Load docker status -// @Description 获取 docker 服务状态 // @Produce json // @Success 200 {string} status // @Security ApiKeyAuth @@ -23,7 +22,6 @@ func (b *BaseApi) LoadDockerStatus(c *gin.Context) { // @Tags Container Docker // @Summary Load docker daemon.json -// @Description 获取 docker 配置信息(表单) // @Produce json // @Success 200 {object} string // @Security ApiKeyAuth @@ -43,7 +41,6 @@ func (b *BaseApi) LoadDaemonJsonFile(c *gin.Context) { // @Tags Container Docker // @Summary Load docker daemon.json -// @Description 获取 docker 配置信息 // @Produce json // @Success 200 {object} dto.DaemonJsonConf // @Security ApiKeyAuth @@ -55,7 +52,6 @@ func (b *BaseApi) LoadDaemonJson(c *gin.Context) { // @Tags Container Docker // @Summary Update docker daemon.json -// @Description 修改 docker 配置信息 // @Accept json // @Param request body dto.SettingUpdate true "request" // @Success 200 @@ -78,7 +74,6 @@ func (b *BaseApi) UpdateDaemonJson(c *gin.Context) { // @Tags Container Docker // @Summary Update docker daemon.json log option -// @Description 修改 docker 日志配置 // @Accept json // @Param request body dto.LogOption true "request" // @Success 200 @@ -101,7 +96,6 @@ func (b *BaseApi) UpdateLogOption(c *gin.Context) { // @Tags Container Docker // @Summary Update docker daemon.json ipv6 option -// @Description 修改 docker ipv6 配置 // @Accept json // @Param request body dto.LogOption true "request" // @Success 200 @@ -124,7 +118,6 @@ func (b *BaseApi) UpdateIpv6Option(c *gin.Context) { // @Tags Container Docker // @Summary Update docker daemon.json by upload file -// @Description 上传替换 docker 配置文件 // @Accept json // @Param request body dto.DaemonJsonUpdateByFile true "request" // @Success 200 @@ -147,7 +140,6 @@ func (b *BaseApi) UpdateDaemonJsonByFile(c *gin.Context) { // @Tags Container Docker // @Summary Operate docker -// @Description Docker 操作 // @Accept json // @Param request body dto.DockerOperation true "request" // @Success 200 diff --git a/backend/app/api/v1/fail2ban.go b/backend/app/api/v1/fail2ban.go index 5ffd2c3dc..86d8023ec 100644 --- a/backend/app/api/v1/fail2ban.go +++ b/backend/app/api/v1/fail2ban.go @@ -11,7 +11,6 @@ import ( // @Tags Fail2ban // @Summary Load fail2ban base info -// @Description 获取 Fail2ban 基础信息 // @Success 200 {object} dto.Fail2BanBaseInfo // @Security ApiKeyAuth // @Router /toolbox/fail2ban/base [get] @@ -27,7 +26,6 @@ func (b *BaseApi) LoadFail2BanBaseInfo(c *gin.Context) { // @Tags Fail2ban // @Summary Page fail2ban ip list -// @Description 获取 Fail2ban ip // @Accept json // @Param request body dto.Fail2BanSearch true "request" // @Success 200 {Array} string @@ -50,7 +48,6 @@ func (b *BaseApi) SearchFail2Ban(c *gin.Context) { // @Tags Fail2ban // @Summary Operate fail2ban -// @Description 修改 Fail2ban 状态 // @Accept json // @Param request body dto.Operate true "request" // @Security ApiKeyAuth @@ -72,7 +69,6 @@ func (b *BaseApi) OperateFail2Ban(c *gin.Context) { // @Tags Fail2ban // @Summary Operate sshd of fail2ban -// @Description 配置 sshd // @Accept json // @Param request body dto.Operate true "request" // @Security ApiKeyAuth @@ -93,7 +89,6 @@ func (b *BaseApi) OperateSSHD(c *gin.Context) { // @Tags Fail2ban // @Summary Update fail2ban conf -// @Description 修改 Fail2ban 配置 // @Accept json // @Param request body dto.Fail2BanUpdate true "request" // @Success 200 @@ -115,7 +110,6 @@ func (b *BaseApi) UpdateFail2BanConf(c *gin.Context) { // @Tags Fail2ban // @Summary Load fail2ban conf -// @Description 获取 fail2ban 配置文件 // @Accept json // @Success 200 // @Security ApiKeyAuth @@ -133,7 +127,6 @@ func (b *BaseApi) LoadFail2BanConf(c *gin.Context) { // @Tags Fail2ban // @Summary Update fail2ban conf by file -// @Description 通过文件修改 fail2ban 配置 // @Accept json // @Param request body dto.UpdateByFile true "request" // @Success 200 diff --git a/backend/app/api/v1/favorite.go b/backend/app/api/v1/favorite.go index 5cd1d57fe..c16297234 100644 --- a/backend/app/api/v1/favorite.go +++ b/backend/app/api/v1/favorite.go @@ -10,7 +10,6 @@ import ( // @Tags File // @Summary List favorites -// @Description 获取收藏列表 // @Accept json // @Param request body dto.PageInfo true "request" // @Success 200 @@ -34,7 +33,6 @@ func (b *BaseApi) SearchFavorite(c *gin.Context) { // @Tags File // @Summary Create favorite -// @Description 创建收藏 // @Accept json // @Param request body request.FavoriteCreate true "request" // @Success 200 @@ -56,7 +54,6 @@ func (b *BaseApi) CreateFavorite(c *gin.Context) { // @Tags File // @Summary Delete favorite -// @Description 删除收藏 // @Accept json // @Param request body request.FavoriteDelete true "request" // @Success 200 diff --git a/backend/app/api/v1/file.go b/backend/app/api/v1/file.go index 59abb1d41..2efd4b3d0 100644 --- a/backend/app/api/v1/file.go +++ b/backend/app/api/v1/file.go @@ -28,7 +28,6 @@ import ( // @Tags File // @Summary List files -// @Description 获取文件列表 // @Accept json // @Param request body request.FileOption true "request" // @Success 200 {object} response.FileInfo @@ -49,7 +48,6 @@ func (b *BaseApi) ListFiles(c *gin.Context) { // @Tags File // @Summary Page file -// @Description 分页获取上传文件 // @Accept json // @Param request body request.SearchUploadWithPage true "request" // @Success 200 {array} response.FileInfo @@ -73,7 +71,6 @@ func (b *BaseApi) SearchUploadWithPage(c *gin.Context) { // @Tags File // @Summary Load files tree -// @Description 加载文件树 // @Accept json // @Param request body request.FileOption true "request" // @Success 200 {array} response.FileTree @@ -94,7 +91,6 @@ func (b *BaseApi) GetFileTree(c *gin.Context) { // @Tags File // @Summary Create file -// @Description 创建文件/文件夹 // @Accept json // @Param request body request.FileCreate true "request" // @Success 200 @@ -116,7 +112,6 @@ func (b *BaseApi) CreateFile(c *gin.Context) { // @Tags File // @Summary Delete file -// @Description 删除文件/文件夹 // @Accept json // @Param request body request.FileDelete true "request" // @Success 200 @@ -138,7 +133,6 @@ func (b *BaseApi) DeleteFile(c *gin.Context) { // @Tags File // @Summary Batch delete file -// @Description 批量删除文件/文件夹 // @Accept json // @Param request body request.FileBatchDelete true "request" // @Success 200 @@ -160,7 +154,6 @@ func (b *BaseApi) BatchDeleteFile(c *gin.Context) { // @Tags File // @Summary Change file mode -// @Description 修改文件权限 // @Accept json // @Param request body request.FileCreate true "request" // @Success 200 @@ -182,7 +175,6 @@ func (b *BaseApi) ChangeFileMode(c *gin.Context) { // @Tags File // @Summary Change file owner -// @Description 修改文件用户/组 // @Accept json // @Param request body request.FileRoleUpdate true "request" // @Success 200 @@ -203,7 +195,6 @@ func (b *BaseApi) ChangeFileOwner(c *gin.Context) { // @Tags File // @Summary Compress file -// @Description 压缩文件 // @Accept json // @Param request body request.FileCompress true "request" // @Success 200 @@ -225,7 +216,6 @@ func (b *BaseApi) CompressFile(c *gin.Context) { // @Tags File // @Summary Decompress file -// @Description 解压文件 // @Accept json // @Param request body request.FileDeCompress true "request" // @Success 200 @@ -247,7 +237,6 @@ func (b *BaseApi) DeCompressFile(c *gin.Context) { // @Tags File // @Summary Load file content -// @Description 获取文件内容 // @Accept json // @Param request body request.FileContentReq true "request" // @Success 200 {object} response.FileInfo @@ -269,7 +258,6 @@ func (b *BaseApi) GetContent(c *gin.Context) { // @Tags File // @Summary Update file content -// @Description 更新文件内容 // @Accept json // @Param request body request.FileEdit true "request" // @Success 200 @@ -290,7 +278,6 @@ func (b *BaseApi) SaveContent(c *gin.Context) { // @Tags File // @Summary Upload file -// @Description 上传文件 // @Param file formData file true "request" // @Success 200 // @Security ApiKeyAuth @@ -398,7 +385,6 @@ func (b *BaseApi) UploadFiles(c *gin.Context) { // @Tags File // @Summary Check file exist -// @Description 检测文件是否存在 // @Accept json // @Param request body request.FilePathCheck true "request" // @Success 200 @@ -418,7 +404,6 @@ func (b *BaseApi) CheckFile(c *gin.Context) { // @Tags File // @Summary Change file name -// @Description 修改文件名称 // @Accept json // @Param request body request.FileRename true "request" // @Success 200 @@ -439,7 +424,6 @@ func (b *BaseApi) ChangeFileName(c *gin.Context) { // @Tags File // @Summary Wget file -// @Description 下载远端文件 // @Accept json // @Param request body request.FileWget true "request" // @Success 200 @@ -463,7 +447,6 @@ func (b *BaseApi) WgetFile(c *gin.Context) { // @Tags File // @Summary Move file -// @Description 移动文件 // @Accept json // @Param request body request.FileMove true "request" // @Success 200 @@ -484,7 +467,6 @@ func (b *BaseApi) MoveFile(c *gin.Context) { // @Tags File // @Summary Download file -// @Description 下载文件 // @Accept json // @Success 200 // @Security ApiKeyAuth @@ -504,7 +486,6 @@ func (b *BaseApi) Download(c *gin.Context) { // @Tags File // @Summary Chunk Download file -// @Description 分片下载下载文件 // @Accept json // @Param request body request.FileDownload true "request" // @Success 200 @@ -581,7 +562,6 @@ func (b *BaseApi) DownloadChunkFiles(c *gin.Context) { // @Tags File // @Summary Load file size -// @Description 获取文件夹大小 // @Accept json // @Param request body request.DirSizeReq true "request" // @Success 200 @@ -661,8 +641,7 @@ func mergeChunks(fileName string, fileDir string, dstDir string, chunkCount int, } // @Tags File -// @Summary ChunkUpload file -// @Description 分片上传文件 +// @Summary Chunk upload file // @Param file formData file true "request" // @Success 200 // @Security ApiKeyAuth @@ -783,7 +762,6 @@ func (b *BaseApi) Keys(c *gin.Context) { // @Tags File // @Summary Read file by Line -// @Description 按行读取日志文件 // @Param request body request.FileReadByLineReq true "request" // @Success 200 // @Security ApiKeyAuth @@ -803,7 +781,6 @@ func (b *BaseApi) ReadFileByLine(c *gin.Context) { // @Tags File // @Summary Batch change file mode and owner -// @Description 批量修改文件权限和用户/组 // @Accept json // @Param request body request.FileRoleReq true "request" // @Success 200 diff --git a/backend/app/api/v1/firewall.go b/backend/app/api/v1/firewall.go index b509e7064..68e190751 100644 --- a/backend/app/api/v1/firewall.go +++ b/backend/app/api/v1/firewall.go @@ -9,7 +9,6 @@ import ( // @Tags Firewall // @Summary Load firewall base info -// @Description 获取防火墙基础信息 // @Success 200 {object} dto.FirewallBaseInfo // @Security ApiKeyAuth // @Router /hosts/firewall/base [get] @@ -25,7 +24,6 @@ func (b *BaseApi) LoadFirewallBaseInfo(c *gin.Context) { // @Tags Firewall // @Summary Page firewall rules -// @Description 获取防火墙规则列表分页 // @Accept json // @Param request body dto.RuleSearch true "request" // @Success 200 {object} dto.PageResult @@ -51,7 +49,6 @@ func (b *BaseApi) SearchFirewallRule(c *gin.Context) { // @Tags Firewall // @Summary Page firewall status -// @Description 修改防火墙状态 // @Accept json // @Param request body dto.FirewallOperation true "request" // @Success 200 {object} dto.PageResult @@ -73,8 +70,7 @@ func (b *BaseApi) OperateFirewall(c *gin.Context) { } // @Tags Firewall -// @Summary Create group -// @Description 创建防火墙端口规则 +// @Summary Create firewall port group // @Accept json // @Param request body dto.PortRuleOperate true "request" // @Success 200 @@ -96,8 +92,7 @@ func (b *BaseApi) OperatePortRule(c *gin.Context) { // OperateForwardRule // @Tags Firewall -// @Summary Create group -// @Description 更新防火墙端口转发规则 +// @Summary Update firewall port group // @Accept json // @Param request body dto.ForwardRuleOperate true "request" // @Success 200 @@ -118,8 +113,7 @@ func (b *BaseApi) OperateForwardRule(c *gin.Context) { } // @Tags Firewall -// @Summary Create group -// @Description 创建防火墙 IP 规则 +// @Summary Create firewall group // @Accept json // @Param request body dto.AddrRuleOperate true "request" // @Success 200 @@ -140,8 +134,7 @@ func (b *BaseApi) OperateIPRule(c *gin.Context) { } // @Tags Firewall -// @Summary Create group -// @Description 批量删除防火墙规则 +// @Summary Batch create group // @Accept json // @Param request body dto.BatchRuleOperate true "request" // @Success 200 @@ -162,7 +155,6 @@ func (b *BaseApi) BatchOperateRule(c *gin.Context) { // @Tags Firewall // @Summary Update rule description -// @Description 更新防火墙描述 // @Accept json // @Param request body dto.UpdateFirewallDescription true "request" // @Success 200 @@ -182,8 +174,7 @@ func (b *BaseApi) UpdateFirewallDescription(c *gin.Context) { } // @Tags Firewall -// @Summary Create group -// @Description 更新端口防火墙规则 +// @Summary Update firewall group // @Accept json // @Param request body dto.PortRuleUpdate true "request" // @Success 200 @@ -203,8 +194,7 @@ func (b *BaseApi) UpdatePortRule(c *gin.Context) { } // @Tags Firewall -// @Summary Create group -// @Description 更新 ip 防火墙规则 +// @Summary Uodate address group // @Accept json // @Param request body dto.AddrRuleUpdate true "request" // @Success 200 diff --git a/backend/app/api/v1/ftp.go b/backend/app/api/v1/ftp.go index 4241013af..b837f27f6 100644 --- a/backend/app/api/v1/ftp.go +++ b/backend/app/api/v1/ftp.go @@ -11,7 +11,6 @@ import ( // @Tags FTP // @Summary Load FTP base info -// @Description 获取 FTP 基础信息 // @Success 200 {object} dto.FtpBaseInfo // @Security ApiKeyAuth // @Router /toolbox/ftp/base [get] @@ -27,7 +26,6 @@ func (b *BaseApi) LoadFtpBaseInfo(c *gin.Context) { // @Tags FTP // @Summary Load FTP operation log -// @Description 获取 FTP 操作日志 // @Accept json // @Param request body dto.FtpLogSearch true "request" // @Success 200 {object} dto.PageResult @@ -53,7 +51,6 @@ func (b *BaseApi) LoadFtpLogInfo(c *gin.Context) { // @Tags FTP // @Summary Operate FTP -// @Description 修改 FTP 状态 // @Accept json // @Param request body dto.Operate true "request" // @Security ApiKeyAuth @@ -75,7 +72,6 @@ func (b *BaseApi) OperateFtp(c *gin.Context) { // @Tags FTP // @Summary Page FTP user -// @Description 获取 FTP 账户列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Success 200 {object} dto.PageResult @@ -101,7 +97,6 @@ func (b *BaseApi) SearchFtp(c *gin.Context) { // @Tags FTP // @Summary Create FTP user -// @Description 创建 FTP 账户 // @Accept json // @Param request body dto.FtpCreate true "request" // @Success 200 @@ -131,7 +126,6 @@ func (b *BaseApi) CreateFtp(c *gin.Context) { // @Tags FTP // @Summary Delete FTP user -// @Description 删除 FTP 账户 // @Accept json // @Param request body dto.BatchDeleteReq true "request" // @Success 200 @@ -153,7 +147,6 @@ func (b *BaseApi) DeleteFtp(c *gin.Context) { // @Tags FTP // @Summary Sync FTP user -// @Description 同步 FTP 账户 // @Accept json // @Param request body dto.BatchDeleteReq true "request" // @Success 200 @@ -170,7 +163,6 @@ func (b *BaseApi) SyncFtp(c *gin.Context) { // @Tags FTP // @Summary Update FTP user -// @Description 修改 FTP 账户 // @Accept json // @Param request body dto.FtpUpdate true "request" // @Success 200 diff --git a/backend/app/api/v1/group.go b/backend/app/api/v1/group.go index 95ce11deb..43a903cba 100644 --- a/backend/app/api/v1/group.go +++ b/backend/app/api/v1/group.go @@ -8,8 +8,7 @@ import ( ) // @Tags System Group -// @Summary Create group -// @Description 创建系统组 +// @Summary Create system group // @Accept json // @Param request body dto.GroupCreate true "request" // @Success 200 @@ -30,8 +29,7 @@ func (b *BaseApi) CreateGroup(c *gin.Context) { } // @Tags System Group -// @Summary Delete group -// @Description 删除系统组 +// @Summary Delete system group // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 @@ -52,8 +50,7 @@ func (b *BaseApi) DeleteGroup(c *gin.Context) { } // @Tags System Group -// @Summary Update group -// @Description 更新系统组 +// @Summary Update system group // @Accept json // @Param request body dto.GroupUpdate true "request" // @Success 200 @@ -74,8 +71,7 @@ func (b *BaseApi) UpdateGroup(c *gin.Context) { } // @Tags System Group -// @Summary List groups -// @Description 查询系统组 +// @Summary List system groups // @Accept json // @Param request body dto.GroupSearch true "request" // @Success 200 {array} dto.GroupInfo diff --git a/backend/app/api/v1/host.go b/backend/app/api/v1/host.go index 1789b028f..569c70502 100644 --- a/backend/app/api/v1/host.go +++ b/backend/app/api/v1/host.go @@ -10,7 +10,6 @@ import ( // @Tags Host // @Summary Create host -// @Description 创建主机 // @Accept json // @Param request body dto.HostOperate true "request" // @Success 200 @@ -33,7 +32,6 @@ func (b *BaseApi) CreateHost(c *gin.Context) { // @Tags Host // @Summary Test host conn by info -// @Description 测试主机连接 // @Accept json // @Param request body dto.HostConnTest true "request" // @Success 200 @@ -51,7 +49,6 @@ func (b *BaseApi) TestByInfo(c *gin.Context) { // @Tags Host // @Summary Test host conn by host id -// @Description 测试主机连接 // @Accept json // @Param id path integer true "request" // @Success 200 {boolean} connStatus @@ -70,7 +67,6 @@ func (b *BaseApi) TestByID(c *gin.Context) { // @Tags Host // @Summary Load host tree -// @Description 加载主机树 // @Accept json // @Param request body dto.SearchForTree true "request" // @Success 200 {array} dto.HostTree @@ -93,7 +89,6 @@ func (b *BaseApi) HostTree(c *gin.Context) { // @Tags Host // @Summary Page host -// @Description 获取主机列表分页 // @Accept json // @Param request body dto.SearchHostWithPage true "request" // @Success 200 {array} dto.HostTree @@ -119,7 +114,6 @@ func (b *BaseApi) SearchHost(c *gin.Context) { // @Tags Host // @Summary Delete host -// @Description 删除主机 // @Accept json // @Param request body dto.BatchDeleteReq true "request" // @Success 200 @@ -141,7 +135,6 @@ func (b *BaseApi) DeleteHost(c *gin.Context) { // @Tags Host // @Summary Update host -// @Description 更新主机 // @Accept json // @Param request body dto.HostOperate true "request" // @Success 200 @@ -207,7 +200,6 @@ func (b *BaseApi) UpdateHost(c *gin.Context) { // @Tags Host // @Summary Update host group -// @Description 切换分组 // @Accept json // @Param request body dto.ChangeHostGroup true "request" // @Success 200 diff --git a/backend/app/api/v1/host_tool.go b/backend/app/api/v1/host_tool.go index c55fb9bd8..eb2d7f243 100644 --- a/backend/app/api/v1/host_tool.go +++ b/backend/app/api/v1/host_tool.go @@ -8,8 +8,7 @@ import ( ) // @Tags Host tool -// @Summary Get tool -// @Description 获取主机工具状态 +// @Summary Get tool status // @Accept json // @Param request body request.HostToolReq true "request" // @Success 200 @@ -31,7 +30,6 @@ func (b *BaseApi) GetToolStatus(c *gin.Context) { // @Tags Host tool // @Summary Create Host tool Config -// @Description 创建主机工具配置 // @Accept json // @Param request body request.HostToolCreate true "request" // @Success 200 @@ -53,7 +51,6 @@ func (b *BaseApi) InitToolConfig(c *gin.Context) { // @Tags Host tool // @Summary Operate tool -// @Description 操作主机工具 // @Accept json // @Param request body request.HostToolReq true "request" // @Success 200 @@ -75,7 +72,6 @@ func (b *BaseApi) OperateTool(c *gin.Context) { // @Tags Host tool // @Summary Get tool config -// @Description 操作主机工具配置文件 // @Accept json // @Param request body request.HostToolConfig true "request" // @Success 200 @@ -97,8 +93,7 @@ func (b *BaseApi) OperateToolConfig(c *gin.Context) { } // @Tags Host tool -// @Summary Get tool -// @Description 获取主机工具日志 +// @Summary Get tool logs // @Accept json // @Param request body request.HostToolLogReq true "request" // @Success 200 @@ -120,7 +115,6 @@ func (b *BaseApi) GetToolLog(c *gin.Context) { // @Tags Host tool // @Summary Create Supervisor process -// @Description 操作守护进程 // @Accept json // @Param request body request.SupervisorProcessConfig true "request" // @Success 200 @@ -143,7 +137,6 @@ func (b *BaseApi) OperateProcess(c *gin.Context) { // @Tags Host tool // @Summary Get Supervisor process config -// @Description 获取 Supervisor 进程配置 // @Accept json // @Success 200 // @Security ApiKeyAuth @@ -159,7 +152,6 @@ func (b *BaseApi) GetProcess(c *gin.Context) { // @Tags Host tool // @Summary Get Supervisor process config -// @Description 操作 Supervisor 进程文件 // @Accept json // @Param request body request.SupervisorProcessFileReq true "request" // @Success 200 diff --git a/backend/app/api/v1/image.go b/backend/app/api/v1/image.go index 6f3743eb3..d897f1ae9 100644 --- a/backend/app/api/v1/image.go +++ b/backend/app/api/v1/image.go @@ -9,7 +9,6 @@ import ( // @Tags Container Image // @Summary Page images -// @Description 获取镜像列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Produce json @@ -36,7 +35,6 @@ func (b *BaseApi) SearchImage(c *gin.Context) { // @Tags Container Image // @Summary List all images -// @Description 获取所有镜像列表 // @Produce json // @Success 200 {array} dto.ImageInfo // @Security ApiKeyAuth @@ -52,7 +50,6 @@ func (b *BaseApi) ListAllImage(c *gin.Context) { // @Tags Container Image // @Summary load images options -// @Description 获取镜像名称列表 // @Produce json // @Success 200 {array} dto.Options // @Security ApiKeyAuth @@ -68,7 +65,6 @@ func (b *BaseApi) ListImage(c *gin.Context) { // @Tags Container Image // @Summary Build image -// @Description 构建镜像 // @Accept json // @Param request body dto.ImageBuild true "request" // @Success 200 {string} log @@ -92,7 +88,6 @@ func (b *BaseApi) ImageBuild(c *gin.Context) { // @Tags Container Image // @Summary Pull image -// @Description 拉取镜像 // @Accept json // @Param request body dto.ImagePull true "request" // @Success 200 {string} log @@ -116,7 +111,6 @@ func (b *BaseApi) ImagePull(c *gin.Context) { // @Tags Container Image // @Summary Push image -// @Description 推送镜像 // @Accept json // @Param request body dto.ImagePush true "request" // @Success 200 {string} log @@ -140,7 +134,6 @@ func (b *BaseApi) ImagePush(c *gin.Context) { // @Tags Container Image // @Summary Delete image -// @Description 删除镜像 // @Accept json // @Param request body dto.BatchDelete true "request" // @Success 200 @@ -163,7 +156,6 @@ func (b *BaseApi) ImageRemove(c *gin.Context) { // @Tags Container Image // @Summary Save image -// @Description 导出镜像 // @Accept json // @Param request body dto.ImageSave true "request" // @Success 200 @@ -186,7 +178,6 @@ func (b *BaseApi) ImageSave(c *gin.Context) { // @Tags Container Image // @Summary Tag image -// @Description Tag 镜像 // @Accept json // @Param request body dto.ImageTag true "request" // @Success 200 @@ -209,7 +200,6 @@ func (b *BaseApi) ImageTag(c *gin.Context) { // @Tags Container Image // @Summary Load image -// @Description 导入镜像 // @Accept json // @Param request body dto.ImageLoad true "request" // @Success 200 diff --git a/backend/app/api/v1/image_repo.go b/backend/app/api/v1/image_repo.go index b6e1c5c42..3cf1061b2 100644 --- a/backend/app/api/v1/image_repo.go +++ b/backend/app/api/v1/image_repo.go @@ -9,7 +9,6 @@ import ( // @Tags Container Image-repo // @Summary Page image repos -// @Description 获取镜像仓库列表分页 // @Accept json // @Param request body dto.SearchWithPage true "request" // @Produce json @@ -36,7 +35,6 @@ func (b *BaseApi) SearchRepo(c *gin.Context) { // @Tags Container Image-repo // @Summary List image repos -// @Description 获取镜像仓库列表 // @Produce json // @Success 200 {array} dto.ImageRepoOption // @Security ApiKeyAuth @@ -53,7 +51,6 @@ func (b *BaseApi) ListRepo(c *gin.Context) { // @Tags Container Image-repo // @Summary Load repo status -// @Description 获取 docker 仓库状态 // @Accept json // @Param request body dto.OperateByID true "request" // @Produce json @@ -75,7 +72,6 @@ func (b *BaseApi) CheckRepoStatus(c *gin.Context) { // @Tags Container Image-repo // @Summary Create image repo -// @Description 创建镜像仓库 // @Accept json // @Param request body dto.ImageRepoDelete true "request" // @Produce json @@ -98,7 +94,6 @@ func (b *BaseApi) CreateRepo(c *gin.Context) { // @Tags Container Image-repo // @Summary Delete image repo -// @Description 删除镜像仓库 // @Accept json // @Param request body dto.ImageRepoDelete true "request" // @Produce json @@ -121,7 +116,6 @@ func (b *BaseApi) DeleteRepo(c *gin.Context) { // @Tags Container Image-repo // @Summary Update image repo -// @Description 更新镜像仓库 // @Accept json // @Param request body dto.ImageRepoUpdate true "request" // @Produce json diff --git a/backend/app/api/v1/logs.go b/backend/app/api/v1/logs.go index 72563328d..4e34f54cd 100644 --- a/backend/app/api/v1/logs.go +++ b/backend/app/api/v1/logs.go @@ -9,7 +9,6 @@ import ( // @Tags Logs // @Summary Page login logs -// @Description 获取系统登录日志列表分页 // @Accept json // @Param request body dto.SearchLgLogWithPage true "request" // @Success 200 {object} dto.PageResult @@ -35,7 +34,6 @@ func (b *BaseApi) GetLoginLogs(c *gin.Context) { // @Tags Logs // @Summary Page operation logs -// @Description 获取系统操作日志列表分页 // @Accept json // @Param request body dto.SearchOpLogWithPage true "request" // @Success 200 {object} dto.PageResult @@ -61,7 +59,6 @@ func (b *BaseApi) GetOperationLogs(c *gin.Context) { // @Tags Logs // @Summary Clean operation logs -// @Description 清空操作日志 // @Accept json // @Param request body dto.CleanLog true "request" // @Success 200 {object} dto.PageResult @@ -84,7 +81,6 @@ func (b *BaseApi) CleanLogs(c *gin.Context) { // @Tags Logs // @Summary Load system log files -// @Description 获取系统日志文件列表 // @Success 200 // @Security ApiKeyAuth // @Router /logs/system/files [get] @@ -100,7 +96,6 @@ func (b *BaseApi) GetSystemFiles(c *gin.Context) { // @Tags Logs // @Summary Load system logs -// @Description 获取系统日志 // @Success 200 // @Security ApiKeyAuth // @Router /logs/system [post] diff --git a/backend/app/api/v1/monitor.go b/backend/app/api/v1/monitor.go index cfb7fe743..709a8f4d8 100644 --- a/backend/app/api/v1/monitor.go +++ b/backend/app/api/v1/monitor.go @@ -17,7 +17,6 @@ import ( // @Tags Monitor // @Summary Load monitor datas -// @Description 获取监控数据 // @Param request body dto.MonitorSearch true "request" // @Success 200 // @Security ApiKeyAuth @@ -89,7 +88,6 @@ func (b *BaseApi) LoadMonitor(c *gin.Context) { // @Tags Monitor // @Summary Clean monitor datas -// @Description 清空监控数据 // @Success 200 // @Security ApiKeyAuth // @Router /hosts/monitor/clean [post] diff --git a/backend/app/api/v1/nginx.go b/backend/app/api/v1/nginx.go index 8249f19dc..69591aced 100644 --- a/backend/app/api/v1/nginx.go +++ b/backend/app/api/v1/nginx.go @@ -9,7 +9,6 @@ import ( // @Tags OpenResty // @Summary Load OpenResty conf -// @Description 获取 OpenResty 配置信息 // @Success 200 {object} response.FileInfo // @Security ApiKeyAuth // @Router /openresty [get] @@ -24,7 +23,6 @@ func (b *BaseApi) GetNginx(c *gin.Context) { // @Tags OpenResty // @Summary Load partial OpenResty conf -// @Description 获取部分 OpenResty 配置信息 // @Accept json // @Param request body request.NginxScopeReq true "request" // @Success 200 {array} response.NginxParam @@ -46,7 +44,6 @@ func (b *BaseApi) GetNginxConfigByScope(c *gin.Context) { // @Tags OpenResty // @Summary Update OpenResty conf -// @Description 更新 OpenResty 配置信息 // @Accept json // @Param request body request.NginxConfigUpdate true "request" // @Success 200 @@ -67,7 +64,6 @@ func (b *BaseApi) UpdateNginxConfigByScope(c *gin.Context) { // @Tags OpenResty // @Summary Load OpenResty status info -// @Description 获取 OpenResty 状态信息 // @Success 200 {object} response.NginxStatus // @Security ApiKeyAuth // @Router /openresty/status [get] @@ -82,7 +78,6 @@ func (b *BaseApi) GetNginxStatus(c *gin.Context) { // @Tags OpenResty // @Summary Update OpenResty conf by upload file -// @Description 上传更新 OpenResty 配置文件 // @Accept json // @Param request body request.NginxConfigFileUpdate true "request" // @Success 200 @@ -104,7 +99,6 @@ func (b *BaseApi) UpdateNginxFile(c *gin.Context) { // @Tags OpenResty // @Summary Clear OpenResty proxy cache -// @Description 清理 OpenResty 代理缓存 // @Success 200 // @Security ApiKeyAuth // @Router /openresty/clear [post] diff --git a/backend/app/api/v1/php_extensions.go b/backend/app/api/v1/php_extensions.go index 9af31f4f1..6dbd4041c 100644 --- a/backend/app/api/v1/php_extensions.go +++ b/backend/app/api/v1/php_extensions.go @@ -10,7 +10,6 @@ import ( // @Tags PHP Extensions // @Summary Page Extensions -// @Description Page Extensions // @Accept json // @Param request body request.PHPExtensionsSearch true "request" // @Success 200 {array} response.PHPExtensionsDTO @@ -44,7 +43,6 @@ func (b *BaseApi) PagePHPExtensions(c *gin.Context) { // @Tags PHP Extensions // @Summary Create Extensions -// @Description Create Extensions // @Accept json // @Param request body request.PHPExtensionsCreate true "request" // @Success 200 @@ -64,7 +62,6 @@ func (b *BaseApi) CreatePHPExtensions(c *gin.Context) { // @Tags PHP Extensions // @Summary Update Extensions -// @Description Update Extensions // @Accept json // @Param request body request.PHPExtensionsUpdate true "request" // @Success 200 @@ -84,7 +81,6 @@ func (b *BaseApi) UpdatePHPExtensions(c *gin.Context) { // @Tags PHP Extensions // @Summary Delete Extensions -// @Description Delete Extensions // @Accept json // @Param request body request.PHPExtensionsDelete true "request" // @Success 200 diff --git a/backend/app/api/v1/process.go b/backend/app/api/v1/process.go index 70666ac09..5c1017bd7 100644 --- a/backend/app/api/v1/process.go +++ b/backend/app/api/v1/process.go @@ -20,7 +20,6 @@ func (b *BaseApi) ProcessWs(c *gin.Context) { // @Tags Process // @Summary Stop Process -// @Description 停止进程 // @Param request body request.ProcessReq true "request" // @Success 200 // @Security ApiKeyAuth diff --git a/backend/app/api/v1/recycle_bin.go b/backend/app/api/v1/recycle_bin.go index 0c7794e01..6aaf7af9a 100644 --- a/backend/app/api/v1/recycle_bin.go +++ b/backend/app/api/v1/recycle_bin.go @@ -9,8 +9,7 @@ import ( ) // @Tags File -// @Summary List RecycleBin files -// @Description 获取回收站文件列表 +// @Summary List Recycle Bin files // @Accept json // @Param request body dto.PageInfo true "request" // @Success 200 @@ -33,8 +32,7 @@ func (b *BaseApi) SearchRecycleBinFile(c *gin.Context) { } // @Tags File -// @Summary Reduce RecycleBin files -// @Description 还原回收站文件 +// @Summary Reduce Recycle Bin files // @Accept json // @Param request body request.RecycleBinReduce true "request" // @Success 200 @@ -54,8 +52,7 @@ func (b *BaseApi) ReduceRecycleBinFile(c *gin.Context) { } // @Tags File -// @Summary Clear RecycleBin files -// @Description 清空回收站文件 +// @Summary Clear Recycle Bin files // @Accept json // @Success 200 // @Security ApiKeyAuth @@ -70,8 +67,7 @@ func (b *BaseApi) ClearRecycleBinFile(c *gin.Context) { } // @Tags File -// @Summary Get RecycleBin status -// @Description 获取回收站状态 +// @Summary Get Recycle Bin status // @Accept json // @Success 200 // @Security ApiKeyAuth diff --git a/backend/app/api/v1/runtime.go b/backend/app/api/v1/runtime.go index b6e5c608b..74f6354f2 100644 --- a/backend/app/api/v1/runtime.go +++ b/backend/app/api/v1/runtime.go @@ -10,7 +10,6 @@ import ( // @Tags Runtime // @Summary List runtimes -// @Description 获取运行环境列表 // @Accept json // @Param request body request.RuntimeSearch true "request" // @Success 200 @@ -34,7 +33,6 @@ func (b *BaseApi) SearchRuntimes(c *gin.Context) { // @Tags Runtime // @Summary Create runtime -// @Description 创建运行环境 // @Accept json // @Param request body request.RuntimeCreate true "request" // @Success 200 @@ -56,7 +54,6 @@ func (b *BaseApi) CreateRuntime(c *gin.Context) { // @Tags Website // @Summary Delete runtime -// @Description 删除运行环境 // @Accept json // @Param request body request.RuntimeDelete true "request" // @Success 200 @@ -92,7 +89,6 @@ func (b *BaseApi) DeleteRuntimeCheck(c *gin.Context) { // @Tags Runtime // @Summary Update runtime -// @Description 更新运行环境 // @Accept json // @Param request body request.RuntimeUpdate true "request" // @Success 200 @@ -113,7 +109,6 @@ func (b *BaseApi) UpdateRuntime(c *gin.Context) { // @Tags Runtime // @Summary Get runtime -// @Description 获取运行环境 // @Accept json // @Param id path string true "request" // @Success 200 @@ -135,7 +130,6 @@ func (b *BaseApi) GetRuntime(c *gin.Context) { // @Tags Runtime // @Summary Get Node package scripts -// @Description 获取 Node 项目的 scripts // @Accept json // @Param request body request.NodePackageReq true "request" // @Success 200 @@ -156,7 +150,6 @@ func (b *BaseApi) GetNodePackageRunScript(c *gin.Context) { // @Tags Runtime // @Summary Operate runtime -// @Description 操作运行环境 // @Accept json // @Param request body request.RuntimeOperate true "request" // @Success 200 @@ -178,7 +171,6 @@ func (b *BaseApi) OperateRuntime(c *gin.Context) { // @Tags Runtime // @Summary Get Node modules -// @Description 获取 Node 项目的 modules // @Accept json // @Param request body request.NodeModuleReq true "request" // @Success 200 @@ -199,7 +191,6 @@ func (b *BaseApi) GetNodeModules(c *gin.Context) { // @Tags Runtime // @Summary Operate Node modules -// @Description 操作 Node 项目 modules // @Accept json // @Param request body request.NodeModuleReq true "request" // @Success 200 @@ -220,7 +211,6 @@ func (b *BaseApi) OperateNodeModules(c *gin.Context) { // @Tags Runtime // @Summary Sync runtime status -// @Description 同步运行环境状态 // @Accept json // @Success 200 // @Security ApiKeyAuth diff --git a/backend/app/api/v1/setting.go b/backend/app/api/v1/setting.go index dc48e181c..4ba8152cb 100644 --- a/backend/app/api/v1/setting.go +++ b/backend/app/api/v1/setting.go @@ -16,7 +16,6 @@ import ( // @Tags System Setting // @Summary Load system setting info -// @Description 加载系统配置信息 // @Success 200 {object} dto.SettingInfo // @Security ApiKeyAuth // @Router /settings/search [post] @@ -31,7 +30,6 @@ func (b *BaseApi) GetSettingInfo(c *gin.Context) { // @Tags System Setting // @Summary Load system available status -// @Description 获取系统可用状态 // @Success 200 // @Security ApiKeyAuth // @Router /settings/search/available [get] @@ -41,7 +39,6 @@ func (b *BaseApi) GetSystemAvailable(c *gin.Context) { // @Tags System Setting // @Summary Update system setting -// @Description 更新系统配置 // @Accept json // @Param request body dto.SettingUpdate true "request" // @Success 200 @@ -63,7 +60,6 @@ func (b *BaseApi) UpdateSetting(c *gin.Context) { // @Tags System Setting // @Summary Update proxy setting -// @Description 服务器代理配置 // @Accept json // @Param request body dto.ProxyUpdate true "request" // @Success 200 @@ -94,7 +90,6 @@ func (b *BaseApi) UpdateProxy(c *gin.Context) { // @Tags System Setting // @Summary Update system setting -// @Description 隐藏高级功能菜单 // @Accept json // @Param request body dto.SettingUpdate true "request" // @Success 200 @@ -116,7 +111,6 @@ func (b *BaseApi) UpdateMenu(c *gin.Context) { // @Tags System Setting // @Summary Update system password -// @Description 更新系统登录密码 // @Accept json // @Param request body dto.PasswordUpdate true "request" // @Success 200 @@ -138,7 +132,6 @@ func (b *BaseApi) UpdatePassword(c *gin.Context) { // @Tags System Setting // @Summary Update system ssl -// @Description 修改系统 ssl 登录 // @Accept json // @Param request body dto.SSLUpdate true "request" // @Success 200 @@ -160,7 +153,6 @@ func (b *BaseApi) UpdateSSL(c *gin.Context) { // @Tags System Setting // @Summary Load system cert info -// @Description 获取证书信息 // @Success 200 {object} dto.SettingInfo // @Security ApiKeyAuth // @Router /settings/ssl/info [get] @@ -175,7 +167,6 @@ func (b *BaseApi) LoadFromCert(c *gin.Context) { // @Tags System Setting // @Summary Download system cert -// @Description 下载证书 // @Success 200 // @Security ApiKeyAuth // @Router /settings/ssl/download [post] @@ -191,7 +182,6 @@ func (b *BaseApi) DownloadSSL(c *gin.Context) { // @Tags System Setting // @Summary Load system address -// @Description 获取系统地址信息 // @Accept json // @Success 200 // @Security ApiKeyAuth @@ -207,7 +197,6 @@ func (b *BaseApi) LoadInterfaceAddr(c *gin.Context) { // @Tags System Setting // @Summary Update system bind info -// @Description 更新系统监听信息 // @Accept json // @Param request body dto.BindInfo true "request" // @Success 200 @@ -229,7 +218,6 @@ func (b *BaseApi) UpdateBindInfo(c *gin.Context) { // @Tags System Setting // @Summary Update system port -// @Description 更新系统端口 // @Accept json // @Param request body dto.PortUpdate true "request" // @Success 200 @@ -251,7 +239,6 @@ func (b *BaseApi) UpdatePort(c *gin.Context) { // @Tags System Setting // @Summary Reset system password expired -// @Description 重置过期系统登录密码 // @Accept json // @Param request body dto.PasswordUpdate true "request" // @Success 200 @@ -272,8 +259,7 @@ func (b *BaseApi) HandlePasswordExpired(c *gin.Context) { } // @Tags System Setting -// @Summary Load local backup dir -// @Description 获取安装根目录 +// @Summary Load local base dir // @Success 200 {string} path // @Security ApiKeyAuth // @Router /settings/basedir [get] @@ -283,7 +269,6 @@ func (b *BaseApi) LoadBaseDir(c *gin.Context) { // @Tags System Setting // @Summary Load mfa info -// @Description 获取 mfa 信息 // @Accept json // @Param request body dto.MfaCredential true "request" // @Success 200 {object} mfa.Otp @@ -306,7 +291,6 @@ func (b *BaseApi) LoadMFA(c *gin.Context) { // @Tags System Setting // @Summary Bind mfa -// @Description Mfa 绑定 // @Accept json // @Param request body dto.MfaCredential true "request" // @Success 200 @@ -344,8 +328,7 @@ func (b *BaseApi) MFABind(c *gin.Context) { } // @Tags System Setting -// @Summary generate api key -// @Description 生成 API 接口密钥 +// @Summary Generate api key // @Accept json // @Success 200 // @Security ApiKeyAuth @@ -367,7 +350,6 @@ func (b *BaseApi) GenerateApiKey(c *gin.Context) { // @Tags System Setting // @Summary Update api config -// @Description 更新 API 接口配置 // @Accept json // @Param request body dto.ApiInterfaceConfig true "request" // @Success 200 diff --git a/backend/app/api/v1/snapshot.go b/backend/app/api/v1/snapshot.go index a98b95f30..cf2b85566 100644 --- a/backend/app/api/v1/snapshot.go +++ b/backend/app/api/v1/snapshot.go @@ -9,7 +9,6 @@ import ( // @Tags System Setting // @Summary Create system snapshot -// @Description 创建系统快照 // @Accept json // @Param request body dto.SnapshotCreate true "request" // @Success 200 @@ -31,7 +30,6 @@ func (b *BaseApi) CreateSnapshot(c *gin.Context) { // @Tags System Setting // @Summary Import system snapshot -// @Description 导入已有快照 // @Accept json // @Param request body dto.SnapshotImport true "request" // @Success 200 @@ -53,7 +51,6 @@ func (b *BaseApi) ImportSnapshot(c *gin.Context) { // @Tags System Setting // @Summary Load Snapshot status -// @Description 获取快照状态 // @Accept json // @Param request body dto.OperateByID true "request" // @Success 200 @@ -75,7 +72,6 @@ func (b *BaseApi) LoadSnapShotStatus(c *gin.Context) { // @Tags System Setting // @Summary Update snapshot description -// @Description 更新快照描述信息 // @Accept json // @Param request body dto.UpdateDescription true "request" // @Success 200 @@ -97,7 +93,6 @@ func (b *BaseApi) UpdateSnapDescription(c *gin.Context) { // @Tags System Setting // @Summary Page system snapshot -// @Description 获取系统快照列表分页 // @Accept json // @Param request body dto.PageSnapshot true "request" // @Success 200 {object} dto.PageResult @@ -122,7 +117,6 @@ func (b *BaseApi) SearchSnapshot(c *gin.Context) { // @Tags System Setting // @Summary Load system snapshot size -// @Description 获取系统快照大小 // @Accept json // @Param request body dto.PageSnapshot true "request" // @Success 200 @@ -144,7 +138,6 @@ func (b *BaseApi) LoadSnapshotSize(c *gin.Context) { // @Tags System Setting // @Summary Recover system backup -// @Description 从系统快照恢复 // @Accept json // @Param request body dto.SnapshotRecover true "request" // @Success 200 @@ -166,7 +159,6 @@ func (b *BaseApi) RecoverSnapshot(c *gin.Context) { // @Tags System Setting // @Summary Rollback system backup -// @Description 从系统快照回滚 // @Accept json // @Param request body dto.SnapshotRecover true "request" // @Success 200 @@ -188,7 +180,6 @@ func (b *BaseApi) RollbackSnapshot(c *gin.Context) { // @Tags System Setting // @Summary Delete system backup -// @Description 删除系统快照 // @Accept json // @Param request body dto.SnapshotBatchDelete true "request" // @Success 200 diff --git a/backend/app/api/v1/ssh.go b/backend/app/api/v1/ssh.go index 42fa9979e..75e8e95bb 100644 --- a/backend/app/api/v1/ssh.go +++ b/backend/app/api/v1/ssh.go @@ -9,7 +9,6 @@ import ( // @Tags SSH // @Summary Load host SSH setting info -// @Description 加载 SSH 配置信息 // @Success 200 {object} dto.SSHInfo // @Security ApiKeyAuth // @Router /host/ssh/search [post] @@ -24,7 +23,6 @@ func (b *BaseApi) GetSSHInfo(c *gin.Context) { // @Tags SSH // @Summary Operate SSH -// @Description 修改 SSH 服务状态 // @Accept json // @Param request body dto.Operate true "request" // @Security ApiKeyAuth @@ -45,7 +43,6 @@ func (b *BaseApi) OperateSSH(c *gin.Context) { // @Tags SSH // @Summary Update host SSH setting -// @Description 更新 SSH 配置 // @Accept json // @Param request body dto.SSHUpdate true "request" // @Success 200 @@ -67,7 +64,6 @@ func (b *BaseApi) UpdateSSH(c *gin.Context) { // @Tags SSH // @Summary Update host SSH setting by file -// @Description 上传文件更新 SSH 配置 // @Accept json // @Param request body dto.SSHConf true "request" // @Success 200 @@ -89,7 +85,6 @@ func (b *BaseApi) UpdateSSHByfile(c *gin.Context) { // @Tags SSH // @Summary Generate host SSH secret -// @Description 生成 SSH 密钥 // @Accept json // @Param request body dto.GenerateSSH true "request" // @Success 200 @@ -111,7 +106,6 @@ func (b *BaseApi) GenerateSSH(c *gin.Context) { // @Tags SSH // @Summary Load host SSH secret -// @Description 获取 SSH 密钥 // @Accept json // @Param request body dto.GenerateLoad true "request" // @Success 200 @@ -133,7 +127,6 @@ func (b *BaseApi) LoadSSHSecret(c *gin.Context) { // @Tags SSH // @Summary Load host SSH logs -// @Description 获取 SSH 登录日志 // @Accept json // @Param request body dto.SearchSSHLog true "request" // @Success 200 {object} dto.SSHLog @@ -155,7 +148,6 @@ func (b *BaseApi) LoadSSHLogs(c *gin.Context) { // @Tags SSH // @Summary Load host SSH conf -// @Description 获取 SSH 配置文件 // @Success 200 // @Security ApiKeyAuth // @Router /host/ssh/conf [get] diff --git a/backend/app/api/v1/upgrade.go b/backend/app/api/v1/upgrade.go index 3853e616a..33d8355e8 100644 --- a/backend/app/api/v1/upgrade.go +++ b/backend/app/api/v1/upgrade.go @@ -9,7 +9,6 @@ import ( // @Tags System Setting // @Summary Load upgrade info -// @Description 系统更新信息 // @Success 200 {object} dto.UpgradeInfo // @Security ApiKeyAuth // @Router /settings/upgrade [get] @@ -24,7 +23,6 @@ func (b *BaseApi) GetUpgradeInfo(c *gin.Context) { // @Tags System Setting // @Summary Load release notes by version -// @Description 获取版本 release notes // @Accept json // @Param request body dto.Upgrade true "request" // @Success 200 @@ -46,7 +44,6 @@ func (b *BaseApi) GetNotesByVersion(c *gin.Context) { // @Tags System Setting // @Summary Upgrade -// @Description 系统更新 // @Accept json // @Param request body dto.Upgrade true "request" // @Success 200 diff --git a/backend/app/api/v1/website.go b/backend/app/api/v1/website.go index caef8f261..73a358e6d 100644 --- a/backend/app/api/v1/website.go +++ b/backend/app/api/v1/website.go @@ -12,7 +12,6 @@ import ( // @Tags Website // @Summary Page websites -// @Description 获取网站列表分页 // @Accept json // @Param request body request.WebsiteSearch true "request" // @Success 200 {object} dto.PageResult @@ -36,7 +35,6 @@ func (b *BaseApi) PageWebsite(c *gin.Context) { // @Tags Website // @Summary List websites -// @Description 获取网站列表 // @Success 200 {array} response.WebsiteDTO // @Security ApiKeyAuth // @Router /websites/list [get] @@ -51,7 +49,6 @@ func (b *BaseApi) GetWebsites(c *gin.Context) { // @Tags Website // @Summary List website names -// @Description 获取网站列表 // @Success 200 {array} string // @Security ApiKeyAuth // @Router /websites/options [get] @@ -66,7 +63,6 @@ func (b *BaseApi) GetWebsiteOptions(c *gin.Context) { // @Tags Website // @Summary Create website -// @Description 创建网站 // @Accept json // @Param request body request.WebsiteCreate true "request" // @Success 200 @@ -96,7 +92,6 @@ func (b *BaseApi) CreateWebsite(c *gin.Context) { // @Tags Website // @Summary Operate website -// @Description 操作网站 // @Accept json // @Param request body request.WebsiteOp true "request" // @Success 200 @@ -118,7 +113,6 @@ func (b *BaseApi) OpWebsite(c *gin.Context) { // @Tags Website // @Summary Delete website -// @Description 删除网站 // @Accept json // @Param request body request.WebsiteDelete true "request" // @Success 200 @@ -140,7 +134,6 @@ func (b *BaseApi) DeleteWebsite(c *gin.Context) { // @Tags Website // @Summary Update website -// @Description 更新网站 // @Accept json // @Param request body request.WebsiteUpdate true "request" // @Success 200 @@ -161,7 +154,6 @@ func (b *BaseApi) UpdateWebsite(c *gin.Context) { // @Tags Website // @Summary Search website by id -// @Description 通过 id 查询网站 // @Accept json // @Param id path integer true "request" // @Success 200 {object} response.WebsiteDTO @@ -183,7 +175,6 @@ func (b *BaseApi) GetWebsite(c *gin.Context) { // @Tags Website Nginx // @Summary Search website nginx by id -// @Description 通过 id 查询网站 nginx // @Accept json // @Param id path integer true "request" // @Success 200 {object} response.FileInfo @@ -207,7 +198,6 @@ func (b *BaseApi) GetWebsiteNginx(c *gin.Context) { // @Tags Website Nginx // @Summary Load nginx conf -// @Description 获取 nginx 配置 // @Accept json // @Param request body request.NginxScopeReq true "request" // @Success 200 {object} response.WebsiteNginxConfig @@ -228,7 +218,6 @@ func (b *BaseApi) GetNginxConfig(c *gin.Context) { // @Tags Website Nginx // @Summary Update nginx conf -// @Description 更新 nginx 配置 // @Accept json // @Param request body request.NginxConfigUpdate true "request" // @Success 200 @@ -249,7 +238,6 @@ func (b *BaseApi) UpdateNginxConfig(c *gin.Context) { // @Tags Website HTTPS // @Summary Load https conf -// @Description 获取 https 配置 // @Accept json // @Param id path integer true "request" // @Success 200 {object} response.WebsiteHTTPS @@ -271,7 +259,6 @@ func (b *BaseApi) GetHTTPSConfig(c *gin.Context) { // @Tags Website HTTPS // @Summary Update https conf -// @Description 更新 https 配置 // @Accept json // @Param request body request.WebsiteHTTPSOp true "request" // @Success 200 {object} response.WebsiteHTTPS @@ -296,7 +283,6 @@ func (b *BaseApi) UpdateHTTPSConfig(c *gin.Context) { // @Tags Website // @Summary Check before create website -// @Description 网站创建前检查 // @Accept json // @Param request body request.WebsiteInstallCheckReq true "request" // @Success 200 {array} response.WebsitePreInstallCheck @@ -317,7 +303,6 @@ func (b *BaseApi) CreateWebsiteCheck(c *gin.Context) { // @Tags Website Nginx // @Summary Update website nginx conf -// @Description 更新 网站 nginx 配置 // @Accept json // @Param request body request.WebsiteNginxUpdate true "request" // @Success 200 @@ -338,7 +323,6 @@ func (b *BaseApi) UpdateWebsiteNginxConfig(c *gin.Context) { // @Tags Website // @Summary Operate website log -// @Description 操作网站日志 // @Accept json // @Param request body request.WebsiteLogReq true "request" // @Success 200 {object} response.WebsiteLog @@ -360,7 +344,6 @@ func (b *BaseApi) OpWebsiteLog(c *gin.Context) { // @Tags Website // @Summary Change default server -// @Description 操作网站日志 // @Accept json // @Param request body request.WebsiteDefaultUpdate true "request" // @Success 200 @@ -381,7 +364,6 @@ func (b *BaseApi) ChangeDefaultServer(c *gin.Context) { // @Tags Website // @Summary Load website php conf -// @Description 获取网站 php 配置 // @Accept json // @Param id path integer true "request" // @Success 200 {object} response.PHPConfig @@ -403,7 +385,6 @@ func (b *BaseApi) GetWebsitePHPConfig(c *gin.Context) { // @Tags Website PHP // @Summary Update website php conf -// @Description 更新 网站 PHP 配置 // @Accept json // @Param request body request.WebsitePHPConfigUpdate true "request" // @Success 200 @@ -424,7 +405,6 @@ func (b *BaseApi) UpdateWebsitePHPConfig(c *gin.Context) { // @Tags Website PHP // @Summary Update php conf -// @Description 更新 php 配置文件 // @Accept json // @Param request body request.WebsitePHPFileUpdate true "request" // @Success 200 @@ -445,7 +425,6 @@ func (b *BaseApi) UpdatePHPFile(c *gin.Context) { // @Tags Website PHP // @Summary Update php version -// @Description 变更 php 版本 // @Accept json // @Param request body request.WebsitePHPVersionReq true "request" // @Success 200 @@ -466,7 +445,6 @@ func (b *BaseApi) ChangePHPVersion(c *gin.Context) { // @Tags Website // @Summary Get rewrite conf -// @Description 获取伪静态配置 // @Accept json // @Param request body request.NginxRewriteReq true "request" // @Success 200 @@ -487,7 +465,6 @@ func (b *BaseApi) GetRewriteConfig(c *gin.Context) { // @Tags Website // @Summary Update rewrite conf -// @Description 更新伪静态配置 // @Accept json // @Param request body request.NginxRewriteUpdate true "request" // @Success 200 @@ -508,7 +485,6 @@ func (b *BaseApi) UpdateRewriteConfig(c *gin.Context) { // @Tags Website // @Summary Update Site Dir -// @Description 更新网站目录 // @Accept json // @Param request body request.WebsiteUpdateDir true "request" // @Success 200 @@ -529,7 +505,6 @@ func (b *BaseApi) UpdateSiteDir(c *gin.Context) { // @Tags Website // @Summary Update Site Dir permission -// @Description 更新网站目录权限 // @Accept json // @Param request body request.WebsiteUpdateDirPermission true "request" // @Success 200 @@ -550,7 +525,6 @@ func (b *BaseApi) UpdateSiteDirPermission(c *gin.Context) { // @Tags Website // @Summary Get proxy conf -// @Description 获取反向代理配置 // @Accept json // @Param request body request.WebsiteProxyReq true "request" // @Success 200 @@ -571,7 +545,6 @@ func (b *BaseApi) GetProxyConfig(c *gin.Context) { // @Tags Website // @Summary Update proxy conf -// @Description 修改反向代理配置 // @Accept json // @Param request body request.WebsiteProxyConfig true "request" // @Success 200 @@ -593,7 +566,6 @@ func (b *BaseApi) UpdateProxyConfig(c *gin.Context) { // @Tags Website // @Summary Update proxy file -// @Description 更新反向代理文件 // @Accept json // @Param request body request.NginxProxyUpdate true "request" // @Success 200 @@ -614,7 +586,6 @@ func (b *BaseApi) UpdateProxyConfigFile(c *gin.Context) { // @Tags Website // @Summary Get AuthBasic conf -// @Description 获取密码访问配置 // @Accept json // @Param request body request.NginxAuthReq true "request" // @Success 200 @@ -635,7 +606,6 @@ func (b *BaseApi) GetAuthConfig(c *gin.Context) { // @Tags Website // @Summary Get AuthBasic conf -// @Description 更新密码访问配置 // @Accept json // @Param request body request.NginxAuthUpdate true "request" // @Success 200 @@ -655,7 +625,6 @@ func (b *BaseApi) UpdateAuthConfig(c *gin.Context) { // @Tags Website // @Summary Get AntiLeech conf -// @Description 获取防盗链配置 // @Accept json // @Param request body request.NginxCommonReq true "request" // @Success 200 @@ -675,8 +644,7 @@ func (b *BaseApi) GetAntiLeech(c *gin.Context) { } // @Tags Website -// @Summary Update AntiLeech -// @Description 更新防盗链配置 +// @Summary Update AntiLeech conf // @Accept json // @Param request body request.NginxAntiLeechUpdate true "request" // @Success 200 @@ -696,7 +664,6 @@ func (b *BaseApi) UpdateAntiLeech(c *gin.Context) { // @Tags Website // @Summary Update redirect conf -// @Description 修改重定向配置 // @Accept json // @Param request body request.NginxRedirectReq true "request" // @Success 200 @@ -718,7 +685,6 @@ func (b *BaseApi) UpdateRedirectConfig(c *gin.Context) { // @Tags Website // @Summary Get redirect conf -// @Description 获取重定向配置 // @Accept json // @Param request body request.WebsiteProxyReq true "request" // @Success 200 @@ -739,7 +705,6 @@ func (b *BaseApi) GetRedirectConfig(c *gin.Context) { // @Tags Website // @Summary Update redirect file -// @Description 更新重定向文件 // @Accept json // @Param request body request.NginxRedirectUpdate true "request" // @Success 200 @@ -760,7 +725,6 @@ func (b *BaseApi) UpdateRedirectConfigFile(c *gin.Context) { // @Tags Website // @Summary Get website dir -// @Description 获取网站目录配置 // @Accept json // @Param request body request.WebsiteCommonReq true "request" // @Success 200 @@ -781,7 +745,6 @@ func (b *BaseApi) GetDirConfig(c *gin.Context) { // @Tags Website // @Summary Get default html -// @Description 获取默认 html // @Accept json // @Success 200 {object} response.FileInfo // @Security ApiKeyAuth @@ -802,7 +765,6 @@ func (b *BaseApi) GetDefaultHtml(c *gin.Context) { // @Tags Website // @Summary Update default html -// @Description 更新默认 html // @Accept json // @Param request body request.WebsiteHtmlUpdate true "request" // @Success 200 diff --git a/backend/app/api/v1/website_acme_account.go b/backend/app/api/v1/website_acme_account.go index 8360edb52..b7a219089 100644 --- a/backend/app/api/v1/website_acme_account.go +++ b/backend/app/api/v1/website_acme_account.go @@ -10,7 +10,6 @@ import ( // @Tags Website Acme // @Summary Page website acme accounts -// @Description 获取网站 acme 列表分页 // @Accept json // @Param request body dto.PageInfo true "request" // @Success 200 {object} dto.PageResult @@ -34,7 +33,6 @@ func (b *BaseApi) PageWebsiteAcmeAccount(c *gin.Context) { // @Tags Website Acme // @Summary Create website acme account -// @Description 创建网站 acme // @Accept json // @Param request body request.WebsiteAcmeAccountCreate true "request" // @Success 200 {object} response.WebsiteAcmeAccountDTO @@ -56,7 +54,6 @@ func (b *BaseApi) CreateWebsiteAcmeAccount(c *gin.Context) { // @Tags Website Acme // @Summary Delete website acme account -// @Description 删除网站 acme // @Accept json // @Param request body request.WebsiteResourceReq true "request" // @Success 200 diff --git a/backend/app/api/v1/website_ca.go b/backend/app/api/v1/website_ca.go index 986b6fa9f..236c97262 100644 --- a/backend/app/api/v1/website_ca.go +++ b/backend/app/api/v1/website_ca.go @@ -13,7 +13,6 @@ import ( // @Tags Website CA // @Summary Page website ca -// @Description 获取网站 ca 列表分页 // @Accept json // @Param request body request.WebsiteCASearch true "request" // @Success 200 {object} dto.PageResult @@ -37,7 +36,6 @@ func (b *BaseApi) PageWebsiteCA(c *gin.Context) { // @Tags Website CA // @Summary Create website ca -// @Description 创建网站 ca // @Accept json // @Param request body request.WebsiteCACreate true "request" // @Success 200 {object} request.WebsiteCACreate @@ -59,7 +57,6 @@ func (b *BaseApi) CreateWebsiteCA(c *gin.Context) { // @Tags Website CA // @Summary Get website ca -// @Description 获取网站 ca // @Accept json // @Param id path int true "id" // @Success 200 {object} response.WebsiteCADTO @@ -80,7 +77,6 @@ func (b *BaseApi) GetWebsiteCA(c *gin.Context) { // @Tags Website CA // @Summary Delete website ca -// @Description 删除网站 ca // @Accept json // @Param request body request.WebsiteCommonReq true "request" // @Success 200 @@ -101,7 +97,6 @@ func (b *BaseApi) DeleteWebsiteCA(c *gin.Context) { // @Tags Website CA // @Summary Obtain SSL -// @Description 自签 SSL 证书 // @Accept json // @Param request body request.WebsiteCAObtain true "request" // @Success 200 @@ -121,8 +116,7 @@ func (b *BaseApi) ObtainWebsiteCA(c *gin.Context) { } // @Tags Website CA -// @Summary Obtain SSL -// @Description 续签 SSL 证书 +// @Summary Renew Obtain SSL // @Accept json // @Param request body request.WebsiteCAObtain true "request" // @Success 200 @@ -148,7 +142,6 @@ func (b *BaseApi) RenewWebsiteCA(c *gin.Context) { // @Tags Website CA // @Summary Download CA file -// @Description 下载 CA 证书文件 // @Accept json // @Param request body request.WebsiteResourceReq true "request" // @Success 200 diff --git a/backend/app/api/v1/website_dns_account.go b/backend/app/api/v1/website_dns_account.go index 09ecdb7da..ba8e53007 100644 --- a/backend/app/api/v1/website_dns_account.go +++ b/backend/app/api/v1/website_dns_account.go @@ -10,7 +10,6 @@ import ( // @Tags Website DNS // @Summary Page website dns accounts -// @Description 获取网站 dns 列表分页 // @Accept json // @Param request body dto.PageInfo true "request" // @Success 200 {object} dto.PageResult @@ -34,7 +33,6 @@ func (b *BaseApi) PageWebsiteDnsAccount(c *gin.Context) { // @Tags Website DNS // @Summary Create website dns account -// @Description 创建网站 dns // @Accept json // @Param request body request.WebsiteDnsAccountCreate true "request" // @Success 200 @@ -55,7 +53,6 @@ func (b *BaseApi) CreateWebsiteDnsAccount(c *gin.Context) { // @Tags Website DNS // @Summary Update website dns account -// @Description 更新网站 dns // @Accept json // @Param request body request.WebsiteDnsAccountUpdate true "request" // @Success 200 @@ -76,7 +73,6 @@ func (b *BaseApi) UpdateWebsiteDnsAccount(c *gin.Context) { // @Tags Website DNS // @Summary Delete website dns account -// @Description 删除网站 dns // @Accept json // @Param request body request.WebsiteResourceReq true "request" // @Success 200 diff --git a/backend/app/api/v1/website_domain.go b/backend/app/api/v1/website_domain.go index d50433435..0ed158fb3 100644 --- a/backend/app/api/v1/website_domain.go +++ b/backend/app/api/v1/website_domain.go @@ -9,7 +9,6 @@ import ( // @Tags Website Domain // @Summary Delete website domain -// @Description 删除网站域名 // @Accept json // @Param request body request.WebsiteDomainDelete true "request" // @Success 200 @@ -30,7 +29,6 @@ func (b *BaseApi) DeleteWebDomain(c *gin.Context) { // @Tags Website Domain // @Summary Create website domain -// @Description 创建网站域名 // @Accept json // @Param request body request.WebsiteDomainCreate true "request" // @Success 200 {object} model.WebsiteDomain @@ -52,7 +50,6 @@ func (b *BaseApi) CreateWebDomain(c *gin.Context) { // @Tags Website Domain // @Summary Search website domains by websiteId -// @Description 通过网站 id 查询域名 // @Accept json // @Param websiteId path integer true "request" // @Success 200 {array} model.WebsiteDomain diff --git a/backend/app/api/v1/website_ssl.go b/backend/app/api/v1/website_ssl.go index d0420087d..10a2497a2 100644 --- a/backend/app/api/v1/website_ssl.go +++ b/backend/app/api/v1/website_ssl.go @@ -15,7 +15,6 @@ import ( // @Tags Website SSL // @Summary Page website ssl -// @Description 获取网站 ssl 列表分页 // @Accept json // @Param request body request.WebsiteSSLSearch true "request" // @Success 200 @@ -48,7 +47,6 @@ func (b *BaseApi) PageWebsiteSSL(c *gin.Context) { // @Tags Website SSL // @Summary Create website ssl -// @Description 创建网站 ssl // @Accept json // @Param request body request.WebsiteSSLCreate true "request" // @Success 200 {object} request.WebsiteSSLCreate @@ -70,7 +68,6 @@ func (b *BaseApi) CreateWebsiteSSL(c *gin.Context) { // @Tags Website SSL // @Summary Apply ssl -// @Description 申请证书 // @Accept json // @Param request body request.WebsiteSSLApply true "request" // @Success 200 @@ -91,7 +88,6 @@ func (b *BaseApi) ApplyWebsiteSSL(c *gin.Context) { // @Tags Website SSL // @Summary Resolve website ssl -// @Description 解析网站 ssl // @Accept json // @Param request body request.WebsiteDNSReq true "request" // @Success 200 {array} response.WebsiteDNSRes @@ -112,7 +108,6 @@ func (b *BaseApi) GetDNSResolve(c *gin.Context) { // @Tags Website SSL // @Summary Delete website ssl -// @Description 删除网站 ssl // @Accept json // @Param request body request.WebsiteBatchDelReq true "request" // @Success 200 @@ -133,7 +128,6 @@ func (b *BaseApi) DeleteWebsiteSSL(c *gin.Context) { // @Tags Website SSL // @Summary Search website ssl by website id -// @Description 通过网站 id 查询 ssl // @Accept json // @Param websiteId path integer true "request" // @Success 200 @@ -155,7 +149,6 @@ func (b *BaseApi) GetWebsiteSSLByWebsiteId(c *gin.Context) { // @Tags Website SSL // @Summary Search website ssl by id -// @Description 通过 id 查询 ssl // @Accept json // @Param id path integer true "request" // @Success 200 @@ -176,8 +169,7 @@ func (b *BaseApi) GetWebsiteSSLById(c *gin.Context) { } // @Tags Website SSL -// @Summary Update ssl -// @Description 更新 ssl +// @Summary Update Website ssl // @Accept json // @Param request body request.WebsiteSSLUpdate true "request" // @Success 200 @@ -197,8 +189,7 @@ func (b *BaseApi) UpdateWebsiteSSL(c *gin.Context) { } // @Tags Website SSL -// @Summary Upload ssl -// @Description 上传 ssl +// @Summary Upload Website ssl // @Accept json // @Param request body request.WebsiteSSLUpload true "request" // @Success 200 @@ -218,8 +209,7 @@ func (b *BaseApi) UploadWebsiteSSL(c *gin.Context) { } // @Tags Website SSL -// @Summary Download SSL file -// @Description 下载证书文件 +// @Summary Download SSL file // @Accept json // @Param request body request.WebsiteResourceReq true "request" // @Success 200 diff --git a/cmd/server/docs/docs.go b/cmd/server/docs/docs.go index b2257bb4a..848dbfd35 100644 --- a/cmd/server/docs/docs.go +++ b/cmd/server/docs/docs.go @@ -27,7 +27,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 key 获取应用信息", "consumes": [ "application/json" ], @@ -61,7 +60,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取应用更新版本", "tags": [ "App" ], @@ -80,7 +78,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 appid 获取应用详情", "consumes": [ "application/json" ], @@ -98,14 +95,14 @@ const docTemplate = `{ }, { "type": "string", - "description": "app 版本", + "description": "app version", "name": "version", "in": "path", "required": true }, { "type": "string", - "description": "app 类型", + "description": "app type", "name": "version", "in": "path", "required": true @@ -128,7 +125,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 id 获取应用详情", "consumes": [ "application/json" ], @@ -162,7 +158,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取忽略的应用版本", "consumes": [ "application/json" ], @@ -187,7 +182,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "安装应用", "consumes": [ "application/json" ], @@ -232,7 +226,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "检查应用安装情况", "consumes": [ "application/json" ], @@ -268,7 +261,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 key 获取应用默认配置", "consumes": [ "application/json" ], @@ -304,7 +296,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取应用连接信息", "consumes": [ "application/json" ], @@ -340,7 +331,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除前检查", "consumes": [ "application/json" ], @@ -377,7 +367,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "忽略应用升级版本", "consumes": [ "application/json" ], @@ -419,7 +408,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取已安装应用列表", "consumes": [ "application/json" ], @@ -447,7 +435,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取应用端口", "consumes": [ "application/json" ], @@ -483,7 +470,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作已安装应用", "consumes": [ "application/json" ], @@ -551,7 +537,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 install id 获取应用参数", "consumes": [ "application/json" ], @@ -585,7 +570,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改应用参数", "consumes": [ "application/json" ], @@ -627,7 +611,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改应用端口", "consumes": [ "application/json" ], @@ -671,7 +654,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "分页获取已安装应用列表", "consumes": [ "application/json" ], @@ -704,7 +686,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "同步已安装应用列表", "tags": [ "App" ], @@ -730,7 +711,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 install id 获取应用更新版本", "consumes": [ "application/json" ], @@ -767,7 +747,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取应用列表", "consumes": [ "application/json" ], @@ -800,7 +779,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 key 获取应用 service", "consumes": [ "application/json" ], @@ -837,7 +815,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "同步应用列表", "tags": [ "App" ], @@ -858,7 +835,6 @@ const docTemplate = `{ }, "/auth/captcha": { "get": { - "description": "加载验证码", "tags": [ "Auth" ], @@ -875,7 +851,6 @@ const docTemplate = `{ }, "/auth/demo": { "get": { - "description": "判断是否为demo环境", "tags": [ "Auth" ], @@ -887,9 +862,21 @@ const docTemplate = `{ } } }, + "/auth/intl": { + "get": { + "tags": [ + "Auth" + ], + "summary": "Check System isIntl", + "responses": { + "200": { + "description": "OK" + } + } + } + }, "/auth/language": { "get": { - "description": "获取系统语言设置", "tags": [ "Auth" ], @@ -903,7 +890,6 @@ const docTemplate = `{ }, "/auth/login": { "post": { - "description": "用户登录", "consumes": [ "application/json" ], @@ -914,7 +900,7 @@ const docTemplate = `{ "parameters": [ { "type": "string", - "description": "安全入口 base64 加密串", + "description": "Secure entrance base64 encrypted string", "name": "EntranceCode", "in": "header", "required": true @@ -946,7 +932,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "用户登出", "tags": [ "Auth" ], @@ -960,7 +945,6 @@ const docTemplate = `{ }, "/auth/mfalogin": { "post": { - "description": "用户 mfa 登录", "consumes": [ "application/json" ], @@ -987,8 +971,7 @@ const docTemplate = `{ }, "headers": { "EntranceCode": { - "type": "string", - "description": "安全入口" + "type": "string" } } } @@ -1002,7 +985,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建容器", "consumes": [ "application/json" ], @@ -1045,7 +1027,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清理容器日志", "consumes": [ "application/json" ], @@ -1082,7 +1063,6 @@ const docTemplate = `{ }, "/containers/commit": { "post": { - "description": "容器提交生成新镜像", "consumes": [ "application/json" ], @@ -1115,7 +1095,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建容器编排", "consumes": [ "application/json" ], @@ -1157,7 +1136,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器编排操作", "consumes": [ "application/json" ], @@ -1200,7 +1178,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取编排列表分页", "consumes": [ "application/json" ], @@ -1236,7 +1213,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "docker-compose 日志", "tags": [ "Container Compose" ], @@ -1244,25 +1220,25 @@ const docTemplate = `{ "parameters": [ { "type": "string", - "description": "compose 文件地址", + "description": "compose file address", "name": "compose", "in": "query" }, { "type": "string", - "description": "时间筛选", + "description": "date", "name": "since", "in": "query" }, { "type": "string", - "description": "是否追踪", + "description": "follow", "name": "follow", "in": "query" }, { "type": "string", - "description": "显示行号", + "description": "tail", "name": "tail", "in": "query" } @@ -1277,7 +1253,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "测试 compose 是否可用", "consumes": [ "application/json" ], @@ -1319,14 +1294,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新容器编排", "consumes": [ "application/json" ], "tags": [ "Container Compose" ], - "summary": "Update compose", + "summary": "Update Container Compose", "parameters": [ { "description": "request", @@ -1361,7 +1335,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 docker 配置信息", "produces": [ "application/json" ], @@ -1386,7 +1359,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 docker 配置信息(表单)", "produces": [ "application/json" ], @@ -1411,7 +1383,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 docker 配置信息", "consumes": [ "application/json" ], @@ -1454,7 +1425,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "上传替换 docker 配置文件", "consumes": [ "application/json" ], @@ -1494,7 +1464,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Docker 操作", "consumes": [ "application/json" ], @@ -1536,7 +1505,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 docker 服务状态", "produces": [ "application/json" ], @@ -1556,7 +1524,29 @@ const docTemplate = `{ }, "/containers/download/log": { "post": { - "description": "下载容器日志", + "security": [ + { + "ApiKeyAuth": [] + } + ], + "consumes": [ + "application/json" + ], + "tags": [ + "Container" + ], + "summary": "Download Container logs", + "parameters": [ + { + "description": "request", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ContainerLog" + } + } + ], "responses": {} } }, @@ -1567,7 +1557,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取镜像名称列表", "produces": [ "application/json" ], @@ -1595,7 +1584,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取所有镜像列表", "produces": [ "application/json" ], @@ -1623,7 +1611,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "构建镜像", "consumes": [ "application/json" ], @@ -1668,7 +1655,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "导入镜像", "consumes": [ "application/json" ], @@ -1710,7 +1696,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "拉取镜像", "consumes": [ "application/json" ], @@ -1765,7 +1750,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "推送镜像", "consumes": [ "application/json" ], @@ -1821,7 +1805,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除镜像", "consumes": [ "application/json" ], @@ -1863,7 +1846,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "导出镜像", "consumes": [ "application/json" ], @@ -1907,7 +1889,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取镜像列表分页", "consumes": [ "application/json" ], @@ -1946,7 +1927,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Tag 镜像", "consumes": [ "application/json" ], @@ -1998,7 +1978,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器表单信息", "consumes": [ "application/json" ], @@ -2034,7 +2013,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器详情", "consumes": [ "application/json" ], @@ -2070,7 +2048,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 docker ipv6 配置", "consumes": [ "application/json" ], @@ -2110,7 +2087,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器限制", "summary": "Load container limits", "responses": { "200": { @@ -2129,7 +2105,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器名称", "consumes": [ "application/json" ], @@ -2154,7 +2129,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器列表资源占用", "summary": "Load container stats", "responses": { "200": { @@ -2176,7 +2150,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器操作日志", "consumes": [ "application/json" ], @@ -2209,7 +2182,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 docker 日志配置", "consumes": [ "application/json" ], @@ -2249,7 +2221,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器网络列表", "consumes": [ "application/json" ], @@ -2278,7 +2249,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建容器网络", "consumes": [ "application/json" ], @@ -2320,7 +2290,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除容器网络", "consumes": [ "application/json" ], @@ -2362,7 +2331,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器网络列表分页", "consumes": [ "application/json" ], @@ -2401,7 +2369,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器操作", "consumes": [ "application/json" ], @@ -2444,7 +2411,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器清理", "consumes": [ "application/json" ], @@ -2489,7 +2455,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器重命名", "consumes": [ "application/json" ], @@ -2532,7 +2497,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取镜像仓库列表", "produces": [ "application/json" ], @@ -2558,7 +2522,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建镜像仓库", "consumes": [ "application/json" ], @@ -2603,7 +2566,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除镜像仓库", "consumes": [ "application/json" ], @@ -2657,7 +2619,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取镜像仓库列表分页", "consumes": [ "application/json" ], @@ -2696,7 +2657,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 docker 仓库状态", "consumes": [ "application/json" ], @@ -2732,7 +2692,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新镜像仓库", "consumes": [ "application/json" ], @@ -2786,7 +2745,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器列表分页", "consumes": [ "application/json" ], @@ -2825,7 +2783,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器日志", "tags": [ "Container" ], @@ -2833,25 +2790,25 @@ const docTemplate = `{ "parameters": [ { "type": "string", - "description": "容器名称", + "description": "container name", "name": "container", "in": "query" }, { "type": "string", - "description": "时间筛选", + "description": "since", "name": "since", "in": "query" }, { "type": "string", - "description": "是否追踪", + "description": "follow", "name": "follow", "in": "query" }, { "type": "string", - "description": "显示行号", + "description": "tail", "name": "tail", "in": "query" } @@ -2866,7 +2823,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "容器监控信息", "tags": [ "Container" ], @@ -2874,7 +2830,7 @@ const docTemplate = `{ "parameters": [ { "type": "integer", - "description": "容器id", + "description": "container id", "name": "id", "in": "path", "required": true @@ -2897,7 +2853,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器编排模版列表", "produces": [ "application/json" ], @@ -2923,7 +2878,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建容器编排模版", "consumes": [ "application/json" ], @@ -2965,7 +2919,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除容器编排模版", "consumes": [ "application/json" ], @@ -3016,7 +2969,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器编排模版列表分页", "consumes": [ "application/json" ], @@ -3055,7 +3007,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新容器编排模版", "consumes": [ "application/json" ], @@ -3106,7 +3057,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新容器", "consumes": [ "application/json" ], @@ -3149,7 +3099,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新容器镜像", "consumes": [ "application/json" ], @@ -3192,7 +3141,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器存储卷列表", "consumes": [ "application/json" ], @@ -3202,7 +3150,7 @@ const docTemplate = `{ "tags": [ "Container Volume" ], - "summary": "List volumes", + "summary": "List Container Volumes", "responses": { "200": { "description": "OK", @@ -3221,14 +3169,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建容器存储卷", "consumes": [ "application/json" ], "tags": [ "Container Volume" ], - "summary": "Create volume", + "summary": "Create Container Volume", "parameters": [ { "description": "request", @@ -3263,14 +3210,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除容器存储卷", "consumes": [ "application/json" ], "tags": [ "Container Volume" ], - "summary": "Delete volume", + "summary": "Delete Container Volume", "parameters": [ { "description": "request", @@ -3305,7 +3251,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取容器存储卷分页", "consumes": [ "application/json" ], @@ -3315,7 +3260,7 @@ const docTemplate = `{ "tags": [ "Container Volume" ], - "summary": "Page volumes", + "summary": "Page Container Volumes", "parameters": [ { "description": "request", @@ -3344,7 +3289,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建计划任务", "consumes": [ "application/json" ], @@ -3387,7 +3331,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除计划任务", "consumes": [ "application/json" ], @@ -3438,7 +3381,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载计划任务记录", "consumes": [ "application/json" ], @@ -3489,7 +3431,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "手动执行计划任务", "consumes": [ "application/json" ], @@ -3540,7 +3481,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清空计划任务记录", "consumes": [ "application/json" ], @@ -3591,7 +3531,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取计划任务记录日志", "consumes": [ "application/json" ], @@ -3624,7 +3563,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取计划任务分页", "consumes": [ "application/json" ], @@ -3660,7 +3598,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取计划任务记录", "consumes": [ "application/json" ], @@ -3696,7 +3633,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新计划任务状态", "consumes": [ "application/json" ], @@ -3748,7 +3684,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新计划任务", "consumes": [ "application/json" ], @@ -3799,7 +3734,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取首页基础数据", "consumes": [ "application/json" ], @@ -3840,7 +3774,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取服务器基础数据", "consumes": [ "application/json" ], @@ -3865,7 +3798,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取首页实时数据", "consumes": [ "application/json" ], @@ -3901,14 +3833,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "重启服务器/面板", "consumes": [ "application/json" ], "tags": [ "Dashboard" ], - "summary": "System restart", + "summary": "System restart panel", "parameters": [ { "type": "string", @@ -3932,7 +3863,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建 mysql 数据库", "consumes": [ "application/json" ], @@ -3974,7 +3904,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "绑定 mysql 数据库用户", "consumes": [ "application/json" ], @@ -4017,7 +3946,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 mysql 访问权限", "consumes": [ "application/json" ], @@ -4068,7 +3996,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 mysql 密码", "consumes": [ "application/json" ], @@ -4119,7 +4046,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取数据库基础信息", "consumes": [ "application/json" ], @@ -4155,7 +4081,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取数据库配置文件", "consumes": [ "application/json" ], @@ -4188,7 +4113,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "上传替换配置文件", "consumes": [ "application/json" ], @@ -4231,7 +4155,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建远程数据库", "consumes": [ "application/json" ], @@ -4274,7 +4197,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取远程数据库", "tags": [ "Database" ], @@ -4296,7 +4218,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "检测远程数据库连接性", "consumes": [ "application/json" ], @@ -4339,7 +4260,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除远程数据库", "consumes": [ "application/json" ], @@ -4390,11 +4310,10 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取数据库列表", "tags": [ "Database" ], - "summary": "List databases", + "summary": "Retrieve database list based on type", "responses": { "200": { "description": "OK", @@ -4415,7 +4334,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取远程数据库列表", "tags": [ "Database" ], @@ -4440,7 +4358,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取远程数据库列表分页", "consumes": [ "application/json" ], @@ -4476,7 +4393,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新远程数据库", "consumes": [ "application/json" ], @@ -4518,7 +4434,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除 mysql 数据库", "consumes": [ "application/json" ], @@ -4569,7 +4484,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Mysql 数据库删除前检查", "consumes": [ "application/json" ], @@ -4608,7 +4522,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 mysql 数据库库描述信息", "consumes": [ "application/json" ], @@ -4660,7 +4573,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "从服务器获取", "consumes": [ "application/json" ], @@ -4689,7 +4601,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 mysql 数据库列表", "consumes": [ "application/json" ], @@ -4728,7 +4639,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建 postgresql 数据库", "consumes": [ "application/json" ], @@ -4770,7 +4680,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "从服务器获取", "consumes": [ "application/json" ], @@ -4799,7 +4708,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "绑定 postgresql 数据库用户", "consumes": [ "application/json" ], @@ -4842,7 +4750,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除 postgresql 数据库", "consumes": [ "application/json" ], @@ -4893,7 +4800,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Postgresql 数据库删除前检查", "consumes": [ "application/json" ], @@ -4932,7 +4838,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 postgresql 数据库库描述信息", "consumes": [ "application/json" ], @@ -4984,7 +4889,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 postgresql 密码", "consumes": [ "application/json" ], @@ -5035,7 +4939,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 postgresql 用户权限", "consumes": [ "application/json" ], @@ -5078,7 +4981,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 postgresql 数据库列表分页", "consumes": [ "application/json" ], @@ -5114,7 +5016,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 redis 配置信息", "consumes": [ "application/json" ], @@ -5150,7 +5051,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 redis 配置信息", "consumes": [ "application/json" ], @@ -5190,7 +5090,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "安装 redis cli", "tags": [ "Database Redis" ], @@ -5209,7 +5108,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 redis 密码", "consumes": [ "application/json" ], @@ -5249,7 +5147,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 redis 持久化配置", "consumes": [ "application/json" ], @@ -5285,7 +5182,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 redis 持久化配置", "consumes": [ "application/json" ], @@ -5325,7 +5221,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 redis 状态信息", "consumes": [ "application/json" ], @@ -5361,7 +5256,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 mysql 远程访问权限", "consumes": [ "application/json" ], @@ -5397,7 +5291,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 mysql 数据库列表分页", "consumes": [ "application/json" ], @@ -5433,7 +5326,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 mysql 状态信息", "consumes": [ "application/json" ], @@ -5469,7 +5361,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 mysql 性能参数信息", "consumes": [ "application/json" ], @@ -5505,7 +5396,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "mysql 性能调优", "consumes": [ "application/json" ], @@ -5545,7 +5435,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Mysql 远程数据库删除前检查", "consumes": [ "application/json" ], @@ -5584,7 +5473,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建文件/文件夹", "consumes": [ "application/json" ], @@ -5626,7 +5514,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "批量删除文件/文件夹", "consumes": [ "application/json" ], @@ -5668,7 +5555,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "批量修改文件权限和用户/组", "consumes": [ "application/json" ], @@ -5713,7 +5599,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "检测文件是否存在", "consumes": [ "application/json" ], @@ -5746,7 +5631,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "分片下载下载文件", "consumes": [ "application/json" ], @@ -5788,11 +5672,10 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "分片上传文件", "tags": [ "File" ], - "summary": "ChunkUpload file", + "summary": "Chunk upload file", "parameters": [ { "type": "file", @@ -5816,7 +5699,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "压缩文件", "consumes": [ "application/json" ], @@ -5858,7 +5740,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取文件内容", "consumes": [ "application/json" ], @@ -5903,7 +5784,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "解压文件", "consumes": [ "application/json" ], @@ -5945,7 +5825,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除文件/文件夹", "consumes": [ "application/json" ], @@ -5987,7 +5866,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载文件", "consumes": [ "application/json" ], @@ -6009,7 +5887,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建收藏", "consumes": [ "application/json" ], @@ -6051,7 +5928,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除收藏", "consumes": [ "application/json" ], @@ -6102,7 +5978,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取收藏列表", "consumes": [ "application/json" ], @@ -6135,7 +6010,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改文件权限", "consumes": [ "application/json" ], @@ -6178,7 +6052,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "移动文件", "consumes": [ "application/json" ], @@ -6221,7 +6094,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改文件用户/组", "consumes": [ "application/json" ], @@ -6265,7 +6137,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "按行读取日志文件", "tags": [ "File" ], @@ -6295,14 +6166,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清空回收站文件", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "Clear RecycleBin files", + "summary": "Clear Recycle Bin files", "responses": { "200": { "description": "OK" @@ -6324,14 +6194,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "还原回收站文件", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "Reduce RecycleBin files", + "summary": "Reduce Recycle Bin files", "parameters": [ { "description": "request", @@ -6366,14 +6235,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取回收站文件列表", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "List RecycleBin files", + "summary": "List Recycle Bin files", "parameters": [ { "description": "request", @@ -6399,14 +6267,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取回收站状态", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "Get RecycleBin status", + "summary": "Get Recycle Bin status", "responses": { "200": { "description": "OK" @@ -6421,7 +6288,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改文件名称", "consumes": [ "application/json" ], @@ -6464,7 +6330,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新文件内容", "consumes": [ "application/json" ], @@ -6506,7 +6371,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取文件列表", "consumes": [ "application/json" ], @@ -6542,7 +6406,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取文件夹大小", "consumes": [ "application/json" ], @@ -6584,7 +6447,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "加载文件树", "consumes": [ "application/json" ], @@ -6623,7 +6485,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "上传文件", "tags": [ "File" ], @@ -6660,7 +6521,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "分页获取上传文件", "consumes": [ "application/json" ], @@ -6699,7 +6559,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载远端文件", "consumes": [ "application/json" ], @@ -6743,14 +6602,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "Create group", + "summary": "Create system group", "parameters": [ { "description": "request", @@ -6786,14 +6644,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "Delete group", + "summary": "Delete system group", "parameters": [ { "description": "request", @@ -6845,14 +6702,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "查询系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "List groups", + "summary": "List system groups", "parameters": [ { "description": "request", @@ -6884,14 +6740,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "Update group", + "summary": "Update system group", "parameters": [ { "description": "request", @@ -6927,7 +6782,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "上传文件更新 SSH 配置", "consumes": [ "application/json" ], @@ -6967,7 +6821,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 SSH 配置文件", "tags": [ "SSH" ], @@ -6986,7 +6839,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "生成 SSH 密钥", "consumes": [ "application/json" ], @@ -7026,7 +6878,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 SSH 登录日志", "consumes": [ "application/json" ], @@ -7062,7 +6913,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 SSH 服务状态", "consumes": [ "application/json" ], @@ -7100,7 +6950,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "加载 SSH 配置信息", "tags": [ "SSH" ], @@ -7122,7 +6971,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 SSH 密钥", "consumes": [ "application/json" ], @@ -7155,7 +7003,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 SSH 配置", "consumes": [ "application/json" ], @@ -7198,14 +7045,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取主机工具状态", "consumes": [ "application/json" ], "tags": [ "Host tool" ], - "summary": "Get tool", + "summary": "Get tool status", "parameters": [ { "description": "request", @@ -7231,7 +7077,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作主机工具配置文件", "consumes": [ "application/json" ], @@ -7273,7 +7118,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建主机工具配置", "consumes": [ "application/json" ], @@ -7315,14 +7159,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取主机工具日志", "consumes": [ "application/json" ], "tags": [ "Host tool" ], - "summary": "Get tool", + "summary": "Get tool logs", "parameters": [ { "description": "request", @@ -7348,7 +7191,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作主机工具", "consumes": [ "application/json" ], @@ -7391,7 +7233,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 Supervisor 进程配置", "consumes": [ "application/json" ], @@ -7411,7 +7252,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作守护进程", "consumes": [ "application/json" ], @@ -7453,7 +7293,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作 Supervisor 进程文件", "consumes": [ "application/json" ], @@ -7495,7 +7334,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建主机", "consumes": [ "application/json" ], @@ -7538,7 +7376,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取快速命令列表", "tags": [ "Command" ], @@ -7558,7 +7395,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建快速命令", "consumes": [ "application/json" ], @@ -7601,7 +7437,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除快速命令", "consumes": [ "application/json" ], @@ -7652,7 +7487,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 redis 快速命令列表", "tags": [ "Redis Command" ], @@ -7672,7 +7506,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "保存 Redis 快速命令", "consumes": [ "application/json" ], @@ -7715,7 +7548,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除 redis 快速命令", "consumes": [ "application/json" ], @@ -7766,7 +7598,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 redis 快速命令列表分页", "consumes": [ "application/json" ], @@ -7802,7 +7633,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取快速命令列表分页", "consumes": [ "application/json" ], @@ -7838,7 +7668,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取快速命令树", "consumes": [ "application/json" ], @@ -7863,7 +7692,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新快速命令", "consumes": [ "application/json" ], @@ -7905,7 +7733,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除主机", "consumes": [ "application/json" ], @@ -7956,7 +7783,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取防火墙基础信息", "tags": [ "Firewall" ], @@ -7978,14 +7804,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "批量删除防火墙规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Batch create group", "parameters": [ { "description": "request", @@ -8011,14 +7836,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新防火墙端口转发规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Update firewall port group", "parameters": [ { "description": "request", @@ -8053,14 +7877,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建防火墙 IP 规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Create firewall group", "parameters": [ { "description": "request", @@ -8096,7 +7919,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改防火墙状态", "consumes": [ "application/json" ], @@ -8141,14 +7963,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建防火墙端口规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Create firewall port group", "parameters": [ { "description": "request", @@ -8184,7 +8005,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取防火墙规则列表分页", "consumes": [ "application/json" ], @@ -8220,14 +8040,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 ip 防火墙规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Uodate address group", "parameters": [ { "description": "request", @@ -8253,7 +8072,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新防火墙描述", "consumes": [ "application/json" ], @@ -8286,14 +8104,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新端口防火墙规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Update firewall group", "parameters": [ { "description": "request", @@ -8319,7 +8136,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清空监控数据", "tags": [ "Monitor" ], @@ -8345,7 +8161,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取监控数据", "tags": [ "Monitor" ], @@ -8375,7 +8190,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取主机列表分页", "consumes": [ "application/json" ], @@ -8414,7 +8228,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "测试主机连接", "consumes": [ "application/json" ], @@ -8448,7 +8261,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "测试主机连接", "consumes": [ "application/json" ], @@ -8481,7 +8293,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "加载主机树", "consumes": [ "application/json" ], @@ -8520,7 +8331,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新主机", "consumes": [ "application/json" ], @@ -8563,7 +8373,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "切换分组", "consumes": [ "application/json" ], @@ -8615,7 +8424,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清空操作日志", "consumes": [ "application/json" ], @@ -8660,7 +8468,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统登录日志列表分页", "consumes": [ "application/json" ], @@ -8696,7 +8503,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统操作日志列表分页", "consumes": [ "application/json" ], @@ -8732,7 +8538,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统日志", "tags": [ "Logs" ], @@ -8751,7 +8556,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统日志文件列表", "tags": [ "Logs" ], @@ -8770,7 +8574,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 OpenResty 配置信息", "tags": [ "OpenResty" ], @@ -8792,7 +8595,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清理 OpenResty 代理缓存", "tags": [ "OpenResty" ], @@ -8818,7 +8620,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "上传更新 OpenResty 配置文件", "consumes": [ "application/json" ], @@ -8858,7 +8659,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取部分 OpenResty 配置信息", "consumes": [ "application/json" ], @@ -8897,7 +8697,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 OpenResty 状态信息", "tags": [ "OpenResty" ], @@ -8919,7 +8718,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 OpenResty 配置信息", "consumes": [ "application/json" ], @@ -8970,7 +8768,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "停止进程", "tags": [ "Process" ], @@ -9009,7 +8806,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建运行环境", "consumes": [ "application/json" ], @@ -9051,7 +8847,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取运行环境", "consumes": [ "application/json" ], @@ -9082,7 +8877,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除运行环境", "consumes": [ "application/json" ], @@ -9124,7 +8918,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 Node 项目的 modules", "consumes": [ "application/json" ], @@ -9157,7 +8950,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作 Node 项目 modules", "consumes": [ "application/json" ], @@ -9190,7 +8982,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 Node 项目的 scripts", "consumes": [ "application/json" ], @@ -9223,7 +9014,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作运行环境", "consumes": [ "application/json" ], @@ -9265,7 +9055,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Create Extensions", "consumes": [ "application/json" ], @@ -9298,7 +9087,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Delete Extensions", "consumes": [ "application/json" ], @@ -9331,7 +9119,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Page Extensions", "consumes": [ "application/json" ], @@ -9370,7 +9157,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Update Extensions", "consumes": [ "application/json" ], @@ -9403,7 +9189,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取运行环境列表", "consumes": [ "application/json" ], @@ -9436,7 +9221,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "同步运行环境状态", "consumes": [ "application/json" ], @@ -9458,7 +9242,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新运行环境", "consumes": [ "application/json" ], @@ -9500,14 +9283,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "生成 API 接口密钥", "consumes": [ "application/json" ], "tags": [ "System Setting" ], - "summary": "generate api key", + "summary": "Generate api key", "responses": { "200": { "description": "OK" @@ -9529,7 +9311,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 API 接口配置", "consumes": [ "application/json" ], @@ -9571,7 +9352,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建备份账号", "consumes": [ "application/json" ], @@ -9613,7 +9393,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "备份系统数据", "consumes": [ "application/json" ], @@ -9657,7 +9436,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除备份账号", "consumes": [ "application/json" ], @@ -9708,7 +9486,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 OneDrive 信息", "consumes": [ "application/json" ], @@ -9733,7 +9510,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除备份记录", "consumes": [ "application/json" ], @@ -9784,7 +9560,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载备份记录", "consumes": [ "application/json" ], @@ -9827,7 +9602,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取备份记录列表分页", "consumes": [ "application/json" ], @@ -9860,7 +9634,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过计划任务获取备份记录列表分页", "consumes": [ "application/json" ], @@ -9893,7 +9666,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "恢复系统数据", "consumes": [ "application/json" ], @@ -9938,7 +9710,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "从上传恢复系统数据", "consumes": [ "application/json" ], @@ -9983,7 +9754,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "刷新 OneDrive token", "tags": [ "Backup Account" ], @@ -10002,7 +9772,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取备份账号列表", "tags": [ "Backup Account" ], @@ -10025,7 +9794,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 bucket 列表", "consumes": [ "application/json" ], @@ -10064,7 +9832,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取备份账号内文件列表", "consumes": [ "application/json" ], @@ -10103,7 +9870,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新备份账号信息", "consumes": [ "application/json" ], @@ -10145,11 +9911,10 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取安装根目录", "tags": [ "System Setting" ], - "summary": "Load local backup dir", + "summary": "Load local base dir", "responses": { "200": { "description": "OK", @@ -10167,7 +9932,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新系统监听信息", "consumes": [ "application/json" ], @@ -10210,7 +9974,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "重置过期系统登录密码", "consumes": [ "application/json" ], @@ -10250,7 +10013,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统地址信息", "consumes": [ "application/json" ], @@ -10272,7 +10034,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "隐藏高级功能菜单", "consumes": [ "application/json" ], @@ -10312,7 +10073,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 mfa 信息", "consumes": [ "application/json" ], @@ -10348,7 +10108,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "Mfa 绑定", "consumes": [ "application/json" ], @@ -10388,7 +10147,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新系统登录密码", "consumes": [ "application/json" ], @@ -10428,7 +10186,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新系统端口", "consumes": [ "application/json" ], @@ -10470,7 +10227,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "服务器代理配置", "consumes": [ "application/json" ], @@ -10513,7 +10269,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "加载系统配置信息", "tags": [ "System Setting" ], @@ -10535,7 +10290,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统可用状态", "tags": [ "System Setting" ], @@ -10554,7 +10308,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建系统快照", "consumes": [ "application/json" ], @@ -10597,7 +10350,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除系统快照", "consumes": [ "application/json" ], @@ -10648,7 +10400,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新快照描述信息", "consumes": [ "application/json" ], @@ -10700,7 +10451,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "导入已有快照", "consumes": [ "application/json" ], @@ -10743,7 +10493,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "从系统快照恢复", "consumes": [ "application/json" ], @@ -10794,7 +10543,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "从系统快照回滚", "consumes": [ "application/json" ], @@ -10845,7 +10593,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统快照列表分页", "consumes": [ "application/json" ], @@ -10881,7 +10628,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统快照大小", "consumes": [ "application/json" ], @@ -10914,7 +10660,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取快照状态", "consumes": [ "application/json" ], @@ -10947,7 +10692,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载证书", "tags": [ "System Setting" ], @@ -10966,7 +10710,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取证书信息", "tags": [ "System Setting" ], @@ -10988,7 +10731,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改系统 ssl 登录", "consumes": [ "application/json" ], @@ -11030,7 +10772,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新系统配置", "consumes": [ "application/json" ], @@ -11073,7 +10814,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取版本 release notes", "consumes": [ "application/json" ], @@ -11104,7 +10844,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "系统更新", "consumes": [ "application/json" ], @@ -11146,7 +10885,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建扫描规则", "consumes": [ "application/json" ], @@ -11189,7 +10927,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 Clam 基础信息", "consumes": [ "application/json" ], @@ -11214,7 +10951,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除扫描规则", "consumes": [ "application/json" ], @@ -11265,7 +11001,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取扫描文件", "consumes": [ "application/json" ], @@ -11301,7 +11036,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新病毒扫描配置文件", "consumes": [ "application/json" ], @@ -11334,7 +11068,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "执行病毒扫描", "consumes": [ "application/json" ], @@ -11385,7 +11118,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 Clam 状态", "consumes": [ "application/json" ], @@ -11423,7 +11155,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清空扫描报告", "consumes": [ "application/json" ], @@ -11470,7 +11201,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取扫描结果详情", "consumes": [ "application/json" ], @@ -11503,7 +11233,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取扫描结果列表分页", "consumes": [ "application/json" ], @@ -11539,7 +11268,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取扫描规则列表分页", "consumes": [ "application/json" ], @@ -11575,7 +11303,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改扫描规则状态", "consumes": [ "application/json" ], @@ -11627,7 +11354,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改扫描规则", "consumes": [ "application/json" ], @@ -11670,7 +11396,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "清理系统垃圾文件", "consumes": [ "application/json" ], @@ -11713,7 +11438,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取设备基础信息", "tags": [ "Device" ], @@ -11735,7 +11459,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "检查系统 DNS 配置可用性", "consumes": [ "application/json" ], @@ -11768,7 +11491,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统配置文件", "consumes": [ "application/json" ], @@ -11801,7 +11523,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过文件修改配置", "consumes": [ "application/json" ], @@ -11834,7 +11555,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改系统参数", "consumes": [ "application/json" ], @@ -11877,7 +11597,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改系统 hosts", "tags": [ "Device" ], @@ -11906,7 +11625,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改系统密码", "consumes": [ "application/json" ], @@ -11939,7 +11657,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改系统 Swap", "consumes": [ "application/json" ], @@ -11982,7 +11699,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取系统可用时区选项", "consumes": [ "application/json" ], @@ -12007,7 +11723,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 Fail2ban 基础信息", "tags": [ "Fail2ban" ], @@ -12029,7 +11744,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 fail2ban 配置文件", "consumes": [ "application/json" ], @@ -12051,7 +11765,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 Fail2ban 状态", "consumes": [ "application/json" ], @@ -12089,7 +11802,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "配置 sshd", "consumes": [ "application/json" ], @@ -12118,7 +11830,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 Fail2ban ip", "consumes": [ "application/json" ], @@ -12154,7 +11865,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 Fail2ban 配置", "consumes": [ "application/json" ], @@ -12197,7 +11907,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过文件修改 fail2ban 配置", "consumes": [ "application/json" ], @@ -12230,7 +11939,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建 FTP 账户", "consumes": [ "application/json" ], @@ -12273,7 +11981,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 FTP 基础信息", "tags": [ "FTP" ], @@ -12295,7 +12002,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除 FTP 账户", "consumes": [ "application/json" ], @@ -12346,7 +12052,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 FTP 操作日志", "consumes": [ "application/json" ], @@ -12382,7 +12087,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 FTP 状态", "consumes": [ "application/json" ], @@ -12420,7 +12124,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 FTP 账户列表分页", "consumes": [ "application/json" ], @@ -12456,7 +12159,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "同步 FTP 账户", "consumes": [ "application/json" ], @@ -12496,7 +12198,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改 FTP 账户", "consumes": [ "application/json" ], @@ -12539,7 +12240,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "扫描系统垃圾文件", "tags": [ "Device" ], @@ -12565,7 +12265,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建网站", "consumes": [ "application/json" ], @@ -12607,7 +12306,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 id 查询网站", "consumes": [ "application/json" ], @@ -12641,7 +12339,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 id 查询网站 nginx", "consumes": [ "application/json" ], @@ -12675,7 +12372,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 https 配置", "consumes": [ "application/json" ], @@ -12707,7 +12403,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 https 配置", "consumes": [ "application/json" ], @@ -12761,7 +12456,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建网站 acme", "consumes": [ "application/json" ], @@ -12806,7 +12500,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除网站 acme", "consumes": [ "application/json" ], @@ -12857,7 +12550,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站 acme 列表分页", "consumes": [ "application/json" ], @@ -12893,7 +12585,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取密码访问配置", "consumes": [ "application/json" ], @@ -12926,7 +12617,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新密码访问配置", "consumes": [ "application/json" ], @@ -12959,7 +12649,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建网站 ca", "consumes": [ "application/json" ], @@ -13004,7 +12693,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除网站 ca", "consumes": [ "application/json" ], @@ -13055,7 +12743,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载 CA 证书文件", "consumes": [ "application/json" ], @@ -13106,7 +12793,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "自签 SSL 证书", "consumes": [ "application/json" ], @@ -13157,14 +12843,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "续签 SSL 证书", "consumes": [ "application/json" ], "tags": [ "Website CA" ], - "summary": "Obtain SSL", + "summary": "Renew Obtain SSL", "parameters": [ { "description": "request", @@ -13208,7 +12893,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站 ca 列表分页", "consumes": [ "application/json" ], @@ -13244,7 +12928,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站 ca", "consumes": [ "application/json" ], @@ -13278,7 +12961,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "网站创建前检查", "consumes": [ "application/json" ], @@ -13317,7 +12999,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取 nginx 配置", "consumes": [ "application/json" ], @@ -13353,7 +13034,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 nginx 配置", "consumes": [ "application/json" ], @@ -13404,7 +13084,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取默认 html", "consumes": [ "application/json" ], @@ -13429,7 +13108,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新默认 html", "consumes": [ "application/json" ], @@ -13471,7 +13149,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作网站日志", "consumes": [ "application/json" ], @@ -13523,7 +13200,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除网站", "consumes": [ "application/json" ], @@ -13574,7 +13250,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站目录配置", "consumes": [ "application/json" ], @@ -13607,7 +13282,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新网站目录权限", "consumes": [ "application/json" ], @@ -13658,7 +13332,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新网站目录", "consumes": [ "application/json" ], @@ -13709,7 +13382,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建网站 dns", "consumes": [ "application/json" ], @@ -13751,7 +13423,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除网站 dns", "consumes": [ "application/json" ], @@ -13802,7 +13473,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站 dns 列表分页", "consumes": [ "application/json" ], @@ -13838,7 +13508,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新网站 dns", "consumes": [ "application/json" ], @@ -13880,7 +13549,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建网站域名", "consumes": [ "application/json" ], @@ -13925,7 +13593,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过网站 id 查询域名", "consumes": [ "application/json" ], @@ -13962,7 +13629,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除网站域名", "consumes": [ "application/json" ], @@ -14013,7 +13679,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取防盗链配置", "consumes": [ "application/json" ], @@ -14046,14 +13711,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新防盗链配置", "consumes": [ "application/json" ], "tags": [ "Website" ], - "summary": "Update AntiLeech", + "summary": "Update AntiLeech conf", "parameters": [ { "description": "request", @@ -14079,7 +13743,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站列表", "tags": [ "Website" ], @@ -14104,7 +13767,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作网站日志", "consumes": [ "application/json" ], @@ -14159,7 +13821,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 网站 nginx 配置", "consumes": [ "application/json" ], @@ -14210,7 +13871,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "操作网站", "consumes": [ "application/json" ], @@ -14262,7 +13922,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站列表", "tags": [ "Website" ], @@ -14287,7 +13946,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 网站 PHP 配置", "consumes": [ "application/json" ], @@ -14338,7 +13996,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站 php 配置", "consumes": [ "application/json" ], @@ -14372,7 +14029,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 php 配置文件", "consumes": [ "application/json" ], @@ -14423,7 +14079,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "变更 php 版本", "consumes": [ "application/json" ], @@ -14474,7 +14129,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取反向代理配置", "consumes": [ "application/json" ], @@ -14507,7 +14161,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改反向代理配置", "consumes": [ "application/json" ], @@ -14558,7 +14211,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新反向代理文件", "consumes": [ "application/json" ], @@ -14609,7 +14261,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取重定向配置", "consumes": [ "application/json" ], @@ -14642,7 +14293,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新重定向文件", "consumes": [ "application/json" ], @@ -14693,7 +14343,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "修改重定向配置", "consumes": [ "application/json" ], @@ -14744,7 +14393,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取伪静态配置", "consumes": [ "application/json" ], @@ -14777,7 +14425,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新伪静态配置", "consumes": [ "application/json" ], @@ -14828,7 +14475,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站列表分页", "consumes": [ "application/json" ], @@ -14864,7 +14510,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "创建网站 ssl", "consumes": [ "application/json" ], @@ -14909,7 +14554,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过 id 查询 ssl", "consumes": [ "application/json" ], @@ -14940,7 +14584,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "删除网站 ssl", "consumes": [ "application/json" ], @@ -14991,14 +14634,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "下载证书文件", "consumes": [ "application/json" ], "tags": [ "Website SSL" ], - "summary": "Download SSL file", + "summary": "Download SSL file", "parameters": [ { "description": "request", @@ -15042,7 +14684,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "申请证书", "consumes": [ "application/json" ], @@ -15093,7 +14734,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "解析网站 ssl", "consumes": [ "application/json" ], @@ -15132,7 +14772,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "获取网站 ssl 列表分页", "consumes": [ "application/json" ], @@ -15165,14 +14804,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新 ssl", "consumes": [ "application/json" ], "tags": [ "Website SSL" ], - "summary": "Update ssl", + "summary": "Update Website ssl", "parameters": [ { "description": "request", @@ -15216,14 +14854,13 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "上传 ssl", "consumes": [ "application/json" ], "tags": [ "Website SSL" ], - "summary": "Upload ssl", + "summary": "Upload Website ssl", "parameters": [ { "description": "request", @@ -15258,7 +14895,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "通过网站 id 查询 ssl", "consumes": [ "application/json" ], @@ -15289,7 +14925,6 @@ const docTemplate = `{ "ApiKeyAuth": [] } ], - "description": "更新网站", "consumes": [ "application/json" ], @@ -16180,6 +15815,26 @@ const docTemplate = `{ } } }, + "dto.ContainerLog": { + "type": "object", + "required": [ + "container" + ], + "properties": { + "container": { + "type": "string" + }, + "containerType": { + "type": "string" + }, + "since": { + "type": "string" + }, + "tail": { + "type": "integer" + } + } + }, "dto.ContainerOperate": { "type": "object", "required": [ @@ -23718,13 +23373,13 @@ const docTemplate = `{ }, "securityDefinitions": { "CustomToken": { - "description": "自定义 Token 格式,格式:md5('1panel' + 1Panel-Token + 1Panel-Timestamp)。\n` + "`" + `` + "`" + `` + "`" + `\n示例请求头:\ncurl -X GET \"http://localhost:4004/api/v1/resource\" \\\n-H \"1Panel-Token: \u003c1panel_token\u003e\" \\\n-H \"1Panel-Timestamp: \u003ccurrent_unix_timestamp\u003e\"\n` + "`" + `` + "`" + `` + "`" + `\n- ` + "`" + `1Panel-Token` + "`" + ` 为面板 API 接口密钥。", + "description": "Custom Token Format, Format: md5('1panel' + 1Panel-Token + 1Panel-Timestamp).\n` + "`" + `` + "`" + `` + "`" + `\neg:\ncurl -X GET \"http://localhost:4004/api/v1/resource\" \\\n-H \"1Panel-Token: \u003c1panel_token\u003e\" \\\n-H \"1Panel-Timestamp: \u003ccurrent_unix_timestamp\u003e\"\n` + "`" + `` + "`" + `` + "`" + `\n- ` + "`" + `1Panel-Token` + "`" + ` is the key for the panel API interface.", "type": "apiKey", "name": "1Panel-Token", "in": "Header" }, "Timestamp": { - "description": "- ` + "`" + `1Panel-Timestamp` + "`" + ` 为当前时间的 Unix 时间戳(单位:秒)。", + "description": "- ` + "`" + `1Panel-Timestamp` + "`" + ` is the Unix timestamp of the current time in seconds.", "type": "apiKey", "name": "1Panel-Timestamp", "in": "header" @@ -23739,7 +23394,7 @@ var SwaggerInfo = &swag.Spec{ BasePath: "/api/v1", Schemes: []string{"http", "https"}, Title: "1Panel", - Description: "开源Linux面板", + Description: "Open Source Linux Panel", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", diff --git a/cmd/server/docs/swagger.json b/cmd/server/docs/swagger.json index c738196d0..bf3c120d5 100644 --- a/cmd/server/docs/swagger.json +++ b/cmd/server/docs/swagger.json @@ -5,7 +5,7 @@ ], "swagger": "2.0", "info": { - "description": "开源Linux面板", + "description": "Open Source Linux Panel", "title": "1Panel", "termsOfService": "http://swagger.io/terms/", "contact": {}, @@ -24,7 +24,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 key 获取应用信息", "consumes": [ "application/json" ], @@ -58,7 +57,6 @@ "ApiKeyAuth": [] } ], - "description": "获取应用更新版本", "tags": [ "App" ], @@ -77,7 +75,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 appid 获取应用详情", "consumes": [ "application/json" ], @@ -95,14 +92,14 @@ }, { "type": "string", - "description": "app 版本", + "description": "app version", "name": "version", "in": "path", "required": true }, { "type": "string", - "description": "app 类型", + "description": "app type", "name": "version", "in": "path", "required": true @@ -125,7 +122,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 id 获取应用详情", "consumes": [ "application/json" ], @@ -159,7 +155,6 @@ "ApiKeyAuth": [] } ], - "description": "获取忽略的应用版本", "consumes": [ "application/json" ], @@ -184,7 +179,6 @@ "ApiKeyAuth": [] } ], - "description": "安装应用", "consumes": [ "application/json" ], @@ -229,7 +223,6 @@ "ApiKeyAuth": [] } ], - "description": "检查应用安装情况", "consumes": [ "application/json" ], @@ -265,7 +258,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 key 获取应用默认配置", "consumes": [ "application/json" ], @@ -301,7 +293,6 @@ "ApiKeyAuth": [] } ], - "description": "获取应用连接信息", "consumes": [ "application/json" ], @@ -337,7 +328,6 @@ "ApiKeyAuth": [] } ], - "description": "删除前检查", "consumes": [ "application/json" ], @@ -374,7 +364,6 @@ "ApiKeyAuth": [] } ], - "description": "忽略应用升级版本", "consumes": [ "application/json" ], @@ -416,7 +405,6 @@ "ApiKeyAuth": [] } ], - "description": "获取已安装应用列表", "consumes": [ "application/json" ], @@ -444,7 +432,6 @@ "ApiKeyAuth": [] } ], - "description": "获取应用端口", "consumes": [ "application/json" ], @@ -480,7 +467,6 @@ "ApiKeyAuth": [] } ], - "description": "操作已安装应用", "consumes": [ "application/json" ], @@ -548,7 +534,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 install id 获取应用参数", "consumes": [ "application/json" ], @@ -582,7 +567,6 @@ "ApiKeyAuth": [] } ], - "description": "修改应用参数", "consumes": [ "application/json" ], @@ -624,7 +608,6 @@ "ApiKeyAuth": [] } ], - "description": "修改应用端口", "consumes": [ "application/json" ], @@ -668,7 +651,6 @@ "ApiKeyAuth": [] } ], - "description": "分页获取已安装应用列表", "consumes": [ "application/json" ], @@ -701,7 +683,6 @@ "ApiKeyAuth": [] } ], - "description": "同步已安装应用列表", "tags": [ "App" ], @@ -727,7 +708,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 install id 获取应用更新版本", "consumes": [ "application/json" ], @@ -764,7 +744,6 @@ "ApiKeyAuth": [] } ], - "description": "获取应用列表", "consumes": [ "application/json" ], @@ -797,7 +776,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 key 获取应用 service", "consumes": [ "application/json" ], @@ -834,7 +812,6 @@ "ApiKeyAuth": [] } ], - "description": "同步应用列表", "tags": [ "App" ], @@ -855,7 +832,6 @@ }, "/auth/captcha": { "get": { - "description": "加载验证码", "tags": [ "Auth" ], @@ -872,7 +848,6 @@ }, "/auth/demo": { "get": { - "description": "判断是否为demo环境", "tags": [ "Auth" ], @@ -884,9 +859,21 @@ } } }, + "/auth/intl": { + "get": { + "tags": [ + "Auth" + ], + "summary": "Check System isIntl", + "responses": { + "200": { + "description": "OK" + } + } + } + }, "/auth/language": { "get": { - "description": "获取系统语言设置", "tags": [ "Auth" ], @@ -900,7 +887,6 @@ }, "/auth/login": { "post": { - "description": "用户登录", "consumes": [ "application/json" ], @@ -911,7 +897,7 @@ "parameters": [ { "type": "string", - "description": "安全入口 base64 加密串", + "description": "Secure entrance base64 encrypted string", "name": "EntranceCode", "in": "header", "required": true @@ -943,7 +929,6 @@ "ApiKeyAuth": [] } ], - "description": "用户登出", "tags": [ "Auth" ], @@ -957,7 +942,6 @@ }, "/auth/mfalogin": { "post": { - "description": "用户 mfa 登录", "consumes": [ "application/json" ], @@ -984,8 +968,7 @@ }, "headers": { "EntranceCode": { - "type": "string", - "description": "安全入口" + "type": "string" } } } @@ -999,7 +982,6 @@ "ApiKeyAuth": [] } ], - "description": "创建容器", "consumes": [ "application/json" ], @@ -1042,7 +1024,6 @@ "ApiKeyAuth": [] } ], - "description": "清理容器日志", "consumes": [ "application/json" ], @@ -1079,7 +1060,6 @@ }, "/containers/commit": { "post": { - "description": "容器提交生成新镜像", "consumes": [ "application/json" ], @@ -1112,7 +1092,6 @@ "ApiKeyAuth": [] } ], - "description": "创建容器编排", "consumes": [ "application/json" ], @@ -1154,7 +1133,6 @@ "ApiKeyAuth": [] } ], - "description": "容器编排操作", "consumes": [ "application/json" ], @@ -1197,7 +1175,6 @@ "ApiKeyAuth": [] } ], - "description": "获取编排列表分页", "consumes": [ "application/json" ], @@ -1233,7 +1210,6 @@ "ApiKeyAuth": [] } ], - "description": "docker-compose 日志", "tags": [ "Container Compose" ], @@ -1241,25 +1217,25 @@ "parameters": [ { "type": "string", - "description": "compose 文件地址", + "description": "compose file address", "name": "compose", "in": "query" }, { "type": "string", - "description": "时间筛选", + "description": "date", "name": "since", "in": "query" }, { "type": "string", - "description": "是否追踪", + "description": "follow", "name": "follow", "in": "query" }, { "type": "string", - "description": "显示行号", + "description": "tail", "name": "tail", "in": "query" } @@ -1274,7 +1250,6 @@ "ApiKeyAuth": [] } ], - "description": "测试 compose 是否可用", "consumes": [ "application/json" ], @@ -1316,14 +1291,13 @@ "ApiKeyAuth": [] } ], - "description": "更新容器编排", "consumes": [ "application/json" ], "tags": [ "Container Compose" ], - "summary": "Update compose", + "summary": "Update Container Compose", "parameters": [ { "description": "request", @@ -1358,7 +1332,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 docker 配置信息", "produces": [ "application/json" ], @@ -1383,7 +1356,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 docker 配置信息(表单)", "produces": [ "application/json" ], @@ -1408,7 +1380,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 docker 配置信息", "consumes": [ "application/json" ], @@ -1451,7 +1422,6 @@ "ApiKeyAuth": [] } ], - "description": "上传替换 docker 配置文件", "consumes": [ "application/json" ], @@ -1491,7 +1461,6 @@ "ApiKeyAuth": [] } ], - "description": "Docker 操作", "consumes": [ "application/json" ], @@ -1533,7 +1502,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 docker 服务状态", "produces": [ "application/json" ], @@ -1553,7 +1521,29 @@ }, "/containers/download/log": { "post": { - "description": "下载容器日志", + "security": [ + { + "ApiKeyAuth": [] + } + ], + "consumes": [ + "application/json" + ], + "tags": [ + "Container" + ], + "summary": "Download Container logs", + "parameters": [ + { + "description": "request", + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/dto.ContainerLog" + } + } + ], "responses": {} } }, @@ -1564,7 +1554,6 @@ "ApiKeyAuth": [] } ], - "description": "获取镜像名称列表", "produces": [ "application/json" ], @@ -1592,7 +1581,6 @@ "ApiKeyAuth": [] } ], - "description": "获取所有镜像列表", "produces": [ "application/json" ], @@ -1620,7 +1608,6 @@ "ApiKeyAuth": [] } ], - "description": "构建镜像", "consumes": [ "application/json" ], @@ -1665,7 +1652,6 @@ "ApiKeyAuth": [] } ], - "description": "导入镜像", "consumes": [ "application/json" ], @@ -1707,7 +1693,6 @@ "ApiKeyAuth": [] } ], - "description": "拉取镜像", "consumes": [ "application/json" ], @@ -1762,7 +1747,6 @@ "ApiKeyAuth": [] } ], - "description": "推送镜像", "consumes": [ "application/json" ], @@ -1818,7 +1802,6 @@ "ApiKeyAuth": [] } ], - "description": "删除镜像", "consumes": [ "application/json" ], @@ -1860,7 +1843,6 @@ "ApiKeyAuth": [] } ], - "description": "导出镜像", "consumes": [ "application/json" ], @@ -1904,7 +1886,6 @@ "ApiKeyAuth": [] } ], - "description": "获取镜像列表分页", "consumes": [ "application/json" ], @@ -1943,7 +1924,6 @@ "ApiKeyAuth": [] } ], - "description": "Tag 镜像", "consumes": [ "application/json" ], @@ -1995,7 +1975,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器表单信息", "consumes": [ "application/json" ], @@ -2031,7 +2010,6 @@ "ApiKeyAuth": [] } ], - "description": "容器详情", "consumes": [ "application/json" ], @@ -2067,7 +2045,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 docker ipv6 配置", "consumes": [ "application/json" ], @@ -2107,7 +2084,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器限制", "summary": "Load container limits", "responses": { "200": { @@ -2126,7 +2102,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器名称", "consumes": [ "application/json" ], @@ -2151,7 +2126,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器列表资源占用", "summary": "Load container stats", "responses": { "200": { @@ -2173,7 +2147,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器操作日志", "consumes": [ "application/json" ], @@ -2206,7 +2179,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 docker 日志配置", "consumes": [ "application/json" ], @@ -2246,7 +2218,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器网络列表", "consumes": [ "application/json" ], @@ -2275,7 +2246,6 @@ "ApiKeyAuth": [] } ], - "description": "创建容器网络", "consumes": [ "application/json" ], @@ -2317,7 +2287,6 @@ "ApiKeyAuth": [] } ], - "description": "删除容器网络", "consumes": [ "application/json" ], @@ -2359,7 +2328,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器网络列表分页", "consumes": [ "application/json" ], @@ -2398,7 +2366,6 @@ "ApiKeyAuth": [] } ], - "description": "容器操作", "consumes": [ "application/json" ], @@ -2441,7 +2408,6 @@ "ApiKeyAuth": [] } ], - "description": "容器清理", "consumes": [ "application/json" ], @@ -2486,7 +2452,6 @@ "ApiKeyAuth": [] } ], - "description": "容器重命名", "consumes": [ "application/json" ], @@ -2529,7 +2494,6 @@ "ApiKeyAuth": [] } ], - "description": "获取镜像仓库列表", "produces": [ "application/json" ], @@ -2555,7 +2519,6 @@ "ApiKeyAuth": [] } ], - "description": "创建镜像仓库", "consumes": [ "application/json" ], @@ -2600,7 +2563,6 @@ "ApiKeyAuth": [] } ], - "description": "删除镜像仓库", "consumes": [ "application/json" ], @@ -2654,7 +2616,6 @@ "ApiKeyAuth": [] } ], - "description": "获取镜像仓库列表分页", "consumes": [ "application/json" ], @@ -2693,7 +2654,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 docker 仓库状态", "consumes": [ "application/json" ], @@ -2729,7 +2689,6 @@ "ApiKeyAuth": [] } ], - "description": "更新镜像仓库", "consumes": [ "application/json" ], @@ -2783,7 +2742,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器列表分页", "consumes": [ "application/json" ], @@ -2822,7 +2780,6 @@ "ApiKeyAuth": [] } ], - "description": "容器日志", "tags": [ "Container" ], @@ -2830,25 +2787,25 @@ "parameters": [ { "type": "string", - "description": "容器名称", + "description": "container name", "name": "container", "in": "query" }, { "type": "string", - "description": "时间筛选", + "description": "since", "name": "since", "in": "query" }, { "type": "string", - "description": "是否追踪", + "description": "follow", "name": "follow", "in": "query" }, { "type": "string", - "description": "显示行号", + "description": "tail", "name": "tail", "in": "query" } @@ -2863,7 +2820,6 @@ "ApiKeyAuth": [] } ], - "description": "容器监控信息", "tags": [ "Container" ], @@ -2871,7 +2827,7 @@ "parameters": [ { "type": "integer", - "description": "容器id", + "description": "container id", "name": "id", "in": "path", "required": true @@ -2894,7 +2850,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器编排模版列表", "produces": [ "application/json" ], @@ -2920,7 +2875,6 @@ "ApiKeyAuth": [] } ], - "description": "创建容器编排模版", "consumes": [ "application/json" ], @@ -2962,7 +2916,6 @@ "ApiKeyAuth": [] } ], - "description": "删除容器编排模版", "consumes": [ "application/json" ], @@ -3013,7 +2966,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器编排模版列表分页", "consumes": [ "application/json" ], @@ -3052,7 +3004,6 @@ "ApiKeyAuth": [] } ], - "description": "更新容器编排模版", "consumes": [ "application/json" ], @@ -3103,7 +3054,6 @@ "ApiKeyAuth": [] } ], - "description": "更新容器", "consumes": [ "application/json" ], @@ -3146,7 +3096,6 @@ "ApiKeyAuth": [] } ], - "description": "更新容器镜像", "consumes": [ "application/json" ], @@ -3189,7 +3138,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器存储卷列表", "consumes": [ "application/json" ], @@ -3199,7 +3147,7 @@ "tags": [ "Container Volume" ], - "summary": "List volumes", + "summary": "List Container Volumes", "responses": { "200": { "description": "OK", @@ -3218,14 +3166,13 @@ "ApiKeyAuth": [] } ], - "description": "创建容器存储卷", "consumes": [ "application/json" ], "tags": [ "Container Volume" ], - "summary": "Create volume", + "summary": "Create Container Volume", "parameters": [ { "description": "request", @@ -3260,14 +3207,13 @@ "ApiKeyAuth": [] } ], - "description": "删除容器存储卷", "consumes": [ "application/json" ], "tags": [ "Container Volume" ], - "summary": "Delete volume", + "summary": "Delete Container Volume", "parameters": [ { "description": "request", @@ -3302,7 +3248,6 @@ "ApiKeyAuth": [] } ], - "description": "获取容器存储卷分页", "consumes": [ "application/json" ], @@ -3312,7 +3257,7 @@ "tags": [ "Container Volume" ], - "summary": "Page volumes", + "summary": "Page Container Volumes", "parameters": [ { "description": "request", @@ -3341,7 +3286,6 @@ "ApiKeyAuth": [] } ], - "description": "创建计划任务", "consumes": [ "application/json" ], @@ -3384,7 +3328,6 @@ "ApiKeyAuth": [] } ], - "description": "删除计划任务", "consumes": [ "application/json" ], @@ -3435,7 +3378,6 @@ "ApiKeyAuth": [] } ], - "description": "下载计划任务记录", "consumes": [ "application/json" ], @@ -3486,7 +3428,6 @@ "ApiKeyAuth": [] } ], - "description": "手动执行计划任务", "consumes": [ "application/json" ], @@ -3537,7 +3478,6 @@ "ApiKeyAuth": [] } ], - "description": "清空计划任务记录", "consumes": [ "application/json" ], @@ -3588,7 +3528,6 @@ "ApiKeyAuth": [] } ], - "description": "获取计划任务记录日志", "consumes": [ "application/json" ], @@ -3621,7 +3560,6 @@ "ApiKeyAuth": [] } ], - "description": "获取计划任务分页", "consumes": [ "application/json" ], @@ -3657,7 +3595,6 @@ "ApiKeyAuth": [] } ], - "description": "获取计划任务记录", "consumes": [ "application/json" ], @@ -3693,7 +3630,6 @@ "ApiKeyAuth": [] } ], - "description": "更新计划任务状态", "consumes": [ "application/json" ], @@ -3745,7 +3681,6 @@ "ApiKeyAuth": [] } ], - "description": "更新计划任务", "consumes": [ "application/json" ], @@ -3796,7 +3731,6 @@ "ApiKeyAuth": [] } ], - "description": "获取首页基础数据", "consumes": [ "application/json" ], @@ -3837,7 +3771,6 @@ "ApiKeyAuth": [] } ], - "description": "获取服务器基础数据", "consumes": [ "application/json" ], @@ -3862,7 +3795,6 @@ "ApiKeyAuth": [] } ], - "description": "获取首页实时数据", "consumes": [ "application/json" ], @@ -3898,14 +3830,13 @@ "ApiKeyAuth": [] } ], - "description": "重启服务器/面板", "consumes": [ "application/json" ], "tags": [ "Dashboard" ], - "summary": "System restart", + "summary": "System restart panel", "parameters": [ { "type": "string", @@ -3929,7 +3860,6 @@ "ApiKeyAuth": [] } ], - "description": "创建 mysql 数据库", "consumes": [ "application/json" ], @@ -3971,7 +3901,6 @@ "ApiKeyAuth": [] } ], - "description": "绑定 mysql 数据库用户", "consumes": [ "application/json" ], @@ -4014,7 +3943,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 mysql 访问权限", "consumes": [ "application/json" ], @@ -4065,7 +3993,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 mysql 密码", "consumes": [ "application/json" ], @@ -4116,7 +4043,6 @@ "ApiKeyAuth": [] } ], - "description": "获取数据库基础信息", "consumes": [ "application/json" ], @@ -4152,7 +4078,6 @@ "ApiKeyAuth": [] } ], - "description": "获取数据库配置文件", "consumes": [ "application/json" ], @@ -4185,7 +4110,6 @@ "ApiKeyAuth": [] } ], - "description": "上传替换配置文件", "consumes": [ "application/json" ], @@ -4228,7 +4152,6 @@ "ApiKeyAuth": [] } ], - "description": "创建远程数据库", "consumes": [ "application/json" ], @@ -4271,7 +4194,6 @@ "ApiKeyAuth": [] } ], - "description": "获取远程数据库", "tags": [ "Database" ], @@ -4293,7 +4215,6 @@ "ApiKeyAuth": [] } ], - "description": "检测远程数据库连接性", "consumes": [ "application/json" ], @@ -4336,7 +4257,6 @@ "ApiKeyAuth": [] } ], - "description": "删除远程数据库", "consumes": [ "application/json" ], @@ -4387,11 +4307,10 @@ "ApiKeyAuth": [] } ], - "description": "获取数据库列表", "tags": [ "Database" ], - "summary": "List databases", + "summary": "Retrieve database list based on type", "responses": { "200": { "description": "OK", @@ -4412,7 +4331,6 @@ "ApiKeyAuth": [] } ], - "description": "获取远程数据库列表", "tags": [ "Database" ], @@ -4437,7 +4355,6 @@ "ApiKeyAuth": [] } ], - "description": "获取远程数据库列表分页", "consumes": [ "application/json" ], @@ -4473,7 +4390,6 @@ "ApiKeyAuth": [] } ], - "description": "更新远程数据库", "consumes": [ "application/json" ], @@ -4515,7 +4431,6 @@ "ApiKeyAuth": [] } ], - "description": "删除 mysql 数据库", "consumes": [ "application/json" ], @@ -4566,7 +4481,6 @@ "ApiKeyAuth": [] } ], - "description": "Mysql 数据库删除前检查", "consumes": [ "application/json" ], @@ -4605,7 +4519,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 mysql 数据库库描述信息", "consumes": [ "application/json" ], @@ -4657,7 +4570,6 @@ "ApiKeyAuth": [] } ], - "description": "从服务器获取", "consumes": [ "application/json" ], @@ -4686,7 +4598,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 mysql 数据库列表", "consumes": [ "application/json" ], @@ -4725,7 +4636,6 @@ "ApiKeyAuth": [] } ], - "description": "创建 postgresql 数据库", "consumes": [ "application/json" ], @@ -4767,7 +4677,6 @@ "ApiKeyAuth": [] } ], - "description": "从服务器获取", "consumes": [ "application/json" ], @@ -4796,7 +4705,6 @@ "ApiKeyAuth": [] } ], - "description": "绑定 postgresql 数据库用户", "consumes": [ "application/json" ], @@ -4839,7 +4747,6 @@ "ApiKeyAuth": [] } ], - "description": "删除 postgresql 数据库", "consumes": [ "application/json" ], @@ -4890,7 +4797,6 @@ "ApiKeyAuth": [] } ], - "description": "Postgresql 数据库删除前检查", "consumes": [ "application/json" ], @@ -4929,7 +4835,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 postgresql 数据库库描述信息", "consumes": [ "application/json" ], @@ -4981,7 +4886,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 postgresql 密码", "consumes": [ "application/json" ], @@ -5032,7 +4936,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 postgresql 用户权限", "consumes": [ "application/json" ], @@ -5075,7 +4978,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 postgresql 数据库列表分页", "consumes": [ "application/json" ], @@ -5111,7 +5013,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 redis 配置信息", "consumes": [ "application/json" ], @@ -5147,7 +5048,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 redis 配置信息", "consumes": [ "application/json" ], @@ -5187,7 +5087,6 @@ "ApiKeyAuth": [] } ], - "description": "安装 redis cli", "tags": [ "Database Redis" ], @@ -5206,7 +5105,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 redis 密码", "consumes": [ "application/json" ], @@ -5246,7 +5144,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 redis 持久化配置", "consumes": [ "application/json" ], @@ -5282,7 +5179,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 redis 持久化配置", "consumes": [ "application/json" ], @@ -5322,7 +5218,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 redis 状态信息", "consumes": [ "application/json" ], @@ -5358,7 +5253,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 mysql 远程访问权限", "consumes": [ "application/json" ], @@ -5394,7 +5288,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 mysql 数据库列表分页", "consumes": [ "application/json" ], @@ -5430,7 +5323,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 mysql 状态信息", "consumes": [ "application/json" ], @@ -5466,7 +5358,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 mysql 性能参数信息", "consumes": [ "application/json" ], @@ -5502,7 +5393,6 @@ "ApiKeyAuth": [] } ], - "description": "mysql 性能调优", "consumes": [ "application/json" ], @@ -5542,7 +5432,6 @@ "ApiKeyAuth": [] } ], - "description": "Mysql 远程数据库删除前检查", "consumes": [ "application/json" ], @@ -5581,7 +5470,6 @@ "ApiKeyAuth": [] } ], - "description": "创建文件/文件夹", "consumes": [ "application/json" ], @@ -5623,7 +5511,6 @@ "ApiKeyAuth": [] } ], - "description": "批量删除文件/文件夹", "consumes": [ "application/json" ], @@ -5665,7 +5552,6 @@ "ApiKeyAuth": [] } ], - "description": "批量修改文件权限和用户/组", "consumes": [ "application/json" ], @@ -5710,7 +5596,6 @@ "ApiKeyAuth": [] } ], - "description": "检测文件是否存在", "consumes": [ "application/json" ], @@ -5743,7 +5628,6 @@ "ApiKeyAuth": [] } ], - "description": "分片下载下载文件", "consumes": [ "application/json" ], @@ -5785,11 +5669,10 @@ "ApiKeyAuth": [] } ], - "description": "分片上传文件", "tags": [ "File" ], - "summary": "ChunkUpload file", + "summary": "Chunk upload file", "parameters": [ { "type": "file", @@ -5813,7 +5696,6 @@ "ApiKeyAuth": [] } ], - "description": "压缩文件", "consumes": [ "application/json" ], @@ -5855,7 +5737,6 @@ "ApiKeyAuth": [] } ], - "description": "获取文件内容", "consumes": [ "application/json" ], @@ -5900,7 +5781,6 @@ "ApiKeyAuth": [] } ], - "description": "解压文件", "consumes": [ "application/json" ], @@ -5942,7 +5822,6 @@ "ApiKeyAuth": [] } ], - "description": "删除文件/文件夹", "consumes": [ "application/json" ], @@ -5984,7 +5863,6 @@ "ApiKeyAuth": [] } ], - "description": "下载文件", "consumes": [ "application/json" ], @@ -6006,7 +5884,6 @@ "ApiKeyAuth": [] } ], - "description": "创建收藏", "consumes": [ "application/json" ], @@ -6048,7 +5925,6 @@ "ApiKeyAuth": [] } ], - "description": "删除收藏", "consumes": [ "application/json" ], @@ -6099,7 +5975,6 @@ "ApiKeyAuth": [] } ], - "description": "获取收藏列表", "consumes": [ "application/json" ], @@ -6132,7 +6007,6 @@ "ApiKeyAuth": [] } ], - "description": "修改文件权限", "consumes": [ "application/json" ], @@ -6175,7 +6049,6 @@ "ApiKeyAuth": [] } ], - "description": "移动文件", "consumes": [ "application/json" ], @@ -6218,7 +6091,6 @@ "ApiKeyAuth": [] } ], - "description": "修改文件用户/组", "consumes": [ "application/json" ], @@ -6262,7 +6134,6 @@ "ApiKeyAuth": [] } ], - "description": "按行读取日志文件", "tags": [ "File" ], @@ -6292,14 +6163,13 @@ "ApiKeyAuth": [] } ], - "description": "清空回收站文件", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "Clear RecycleBin files", + "summary": "Clear Recycle Bin files", "responses": { "200": { "description": "OK" @@ -6321,14 +6191,13 @@ "ApiKeyAuth": [] } ], - "description": "还原回收站文件", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "Reduce RecycleBin files", + "summary": "Reduce Recycle Bin files", "parameters": [ { "description": "request", @@ -6363,14 +6232,13 @@ "ApiKeyAuth": [] } ], - "description": "获取回收站文件列表", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "List RecycleBin files", + "summary": "List Recycle Bin files", "parameters": [ { "description": "request", @@ -6396,14 +6264,13 @@ "ApiKeyAuth": [] } ], - "description": "获取回收站状态", "consumes": [ "application/json" ], "tags": [ "File" ], - "summary": "Get RecycleBin status", + "summary": "Get Recycle Bin status", "responses": { "200": { "description": "OK" @@ -6418,7 +6285,6 @@ "ApiKeyAuth": [] } ], - "description": "修改文件名称", "consumes": [ "application/json" ], @@ -6461,7 +6327,6 @@ "ApiKeyAuth": [] } ], - "description": "更新文件内容", "consumes": [ "application/json" ], @@ -6503,7 +6368,6 @@ "ApiKeyAuth": [] } ], - "description": "获取文件列表", "consumes": [ "application/json" ], @@ -6539,7 +6403,6 @@ "ApiKeyAuth": [] } ], - "description": "获取文件夹大小", "consumes": [ "application/json" ], @@ -6581,7 +6444,6 @@ "ApiKeyAuth": [] } ], - "description": "加载文件树", "consumes": [ "application/json" ], @@ -6620,7 +6482,6 @@ "ApiKeyAuth": [] } ], - "description": "上传文件", "tags": [ "File" ], @@ -6657,7 +6518,6 @@ "ApiKeyAuth": [] } ], - "description": "分页获取上传文件", "consumes": [ "application/json" ], @@ -6696,7 +6556,6 @@ "ApiKeyAuth": [] } ], - "description": "下载远端文件", "consumes": [ "application/json" ], @@ -6740,14 +6599,13 @@ "ApiKeyAuth": [] } ], - "description": "创建系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "Create group", + "summary": "Create system group", "parameters": [ { "description": "request", @@ -6783,14 +6641,13 @@ "ApiKeyAuth": [] } ], - "description": "删除系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "Delete group", + "summary": "Delete system group", "parameters": [ { "description": "request", @@ -6842,14 +6699,13 @@ "ApiKeyAuth": [] } ], - "description": "查询系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "List groups", + "summary": "List system groups", "parameters": [ { "description": "request", @@ -6881,14 +6737,13 @@ "ApiKeyAuth": [] } ], - "description": "更新系统组", "consumes": [ "application/json" ], "tags": [ "System Group" ], - "summary": "Update group", + "summary": "Update system group", "parameters": [ { "description": "request", @@ -6924,7 +6779,6 @@ "ApiKeyAuth": [] } ], - "description": "上传文件更新 SSH 配置", "consumes": [ "application/json" ], @@ -6964,7 +6818,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 SSH 配置文件", "tags": [ "SSH" ], @@ -6983,7 +6836,6 @@ "ApiKeyAuth": [] } ], - "description": "生成 SSH 密钥", "consumes": [ "application/json" ], @@ -7023,7 +6875,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 SSH 登录日志", "consumes": [ "application/json" ], @@ -7059,7 +6910,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 SSH 服务状态", "consumes": [ "application/json" ], @@ -7097,7 +6947,6 @@ "ApiKeyAuth": [] } ], - "description": "加载 SSH 配置信息", "tags": [ "SSH" ], @@ -7119,7 +6968,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 SSH 密钥", "consumes": [ "application/json" ], @@ -7152,7 +7000,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 SSH 配置", "consumes": [ "application/json" ], @@ -7195,14 +7042,13 @@ "ApiKeyAuth": [] } ], - "description": "获取主机工具状态", "consumes": [ "application/json" ], "tags": [ "Host tool" ], - "summary": "Get tool", + "summary": "Get tool status", "parameters": [ { "description": "request", @@ -7228,7 +7074,6 @@ "ApiKeyAuth": [] } ], - "description": "操作主机工具配置文件", "consumes": [ "application/json" ], @@ -7270,7 +7115,6 @@ "ApiKeyAuth": [] } ], - "description": "创建主机工具配置", "consumes": [ "application/json" ], @@ -7312,14 +7156,13 @@ "ApiKeyAuth": [] } ], - "description": "获取主机工具日志", "consumes": [ "application/json" ], "tags": [ "Host tool" ], - "summary": "Get tool", + "summary": "Get tool logs", "parameters": [ { "description": "request", @@ -7345,7 +7188,6 @@ "ApiKeyAuth": [] } ], - "description": "操作主机工具", "consumes": [ "application/json" ], @@ -7388,7 +7230,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 Supervisor 进程配置", "consumes": [ "application/json" ], @@ -7408,7 +7249,6 @@ "ApiKeyAuth": [] } ], - "description": "操作守护进程", "consumes": [ "application/json" ], @@ -7450,7 +7290,6 @@ "ApiKeyAuth": [] } ], - "description": "操作 Supervisor 进程文件", "consumes": [ "application/json" ], @@ -7492,7 +7331,6 @@ "ApiKeyAuth": [] } ], - "description": "创建主机", "consumes": [ "application/json" ], @@ -7535,7 +7373,6 @@ "ApiKeyAuth": [] } ], - "description": "获取快速命令列表", "tags": [ "Command" ], @@ -7555,7 +7392,6 @@ "ApiKeyAuth": [] } ], - "description": "创建快速命令", "consumes": [ "application/json" ], @@ -7598,7 +7434,6 @@ "ApiKeyAuth": [] } ], - "description": "删除快速命令", "consumes": [ "application/json" ], @@ -7649,7 +7484,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 redis 快速命令列表", "tags": [ "Redis Command" ], @@ -7669,7 +7503,6 @@ "ApiKeyAuth": [] } ], - "description": "保存 Redis 快速命令", "consumes": [ "application/json" ], @@ -7712,7 +7545,6 @@ "ApiKeyAuth": [] } ], - "description": "删除 redis 快速命令", "consumes": [ "application/json" ], @@ -7763,7 +7595,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 redis 快速命令列表分页", "consumes": [ "application/json" ], @@ -7799,7 +7630,6 @@ "ApiKeyAuth": [] } ], - "description": "获取快速命令列表分页", "consumes": [ "application/json" ], @@ -7835,7 +7665,6 @@ "ApiKeyAuth": [] } ], - "description": "获取快速命令树", "consumes": [ "application/json" ], @@ -7860,7 +7689,6 @@ "ApiKeyAuth": [] } ], - "description": "更新快速命令", "consumes": [ "application/json" ], @@ -7902,7 +7730,6 @@ "ApiKeyAuth": [] } ], - "description": "删除主机", "consumes": [ "application/json" ], @@ -7953,7 +7780,6 @@ "ApiKeyAuth": [] } ], - "description": "获取防火墙基础信息", "tags": [ "Firewall" ], @@ -7975,14 +7801,13 @@ "ApiKeyAuth": [] } ], - "description": "批量删除防火墙规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Batch create group", "parameters": [ { "description": "request", @@ -8008,14 +7833,13 @@ "ApiKeyAuth": [] } ], - "description": "更新防火墙端口转发规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Update firewall port group", "parameters": [ { "description": "request", @@ -8050,14 +7874,13 @@ "ApiKeyAuth": [] } ], - "description": "创建防火墙 IP 规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Create firewall group", "parameters": [ { "description": "request", @@ -8093,7 +7916,6 @@ "ApiKeyAuth": [] } ], - "description": "修改防火墙状态", "consumes": [ "application/json" ], @@ -8138,14 +7960,13 @@ "ApiKeyAuth": [] } ], - "description": "创建防火墙端口规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Create firewall port group", "parameters": [ { "description": "request", @@ -8181,7 +8002,6 @@ "ApiKeyAuth": [] } ], - "description": "获取防火墙规则列表分页", "consumes": [ "application/json" ], @@ -8217,14 +8037,13 @@ "ApiKeyAuth": [] } ], - "description": "更新 ip 防火墙规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Uodate address group", "parameters": [ { "description": "request", @@ -8250,7 +8069,6 @@ "ApiKeyAuth": [] } ], - "description": "更新防火墙描述", "consumes": [ "application/json" ], @@ -8283,14 +8101,13 @@ "ApiKeyAuth": [] } ], - "description": "更新端口防火墙规则", "consumes": [ "application/json" ], "tags": [ "Firewall" ], - "summary": "Create group", + "summary": "Update firewall group", "parameters": [ { "description": "request", @@ -8316,7 +8133,6 @@ "ApiKeyAuth": [] } ], - "description": "清空监控数据", "tags": [ "Monitor" ], @@ -8342,7 +8158,6 @@ "ApiKeyAuth": [] } ], - "description": "获取监控数据", "tags": [ "Monitor" ], @@ -8372,7 +8187,6 @@ "ApiKeyAuth": [] } ], - "description": "获取主机列表分页", "consumes": [ "application/json" ], @@ -8411,7 +8225,6 @@ "ApiKeyAuth": [] } ], - "description": "测试主机连接", "consumes": [ "application/json" ], @@ -8445,7 +8258,6 @@ "ApiKeyAuth": [] } ], - "description": "测试主机连接", "consumes": [ "application/json" ], @@ -8478,7 +8290,6 @@ "ApiKeyAuth": [] } ], - "description": "加载主机树", "consumes": [ "application/json" ], @@ -8517,7 +8328,6 @@ "ApiKeyAuth": [] } ], - "description": "更新主机", "consumes": [ "application/json" ], @@ -8560,7 +8370,6 @@ "ApiKeyAuth": [] } ], - "description": "切换分组", "consumes": [ "application/json" ], @@ -8612,7 +8421,6 @@ "ApiKeyAuth": [] } ], - "description": "清空操作日志", "consumes": [ "application/json" ], @@ -8657,7 +8465,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统登录日志列表分页", "consumes": [ "application/json" ], @@ -8693,7 +8500,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统操作日志列表分页", "consumes": [ "application/json" ], @@ -8729,7 +8535,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统日志", "tags": [ "Logs" ], @@ -8748,7 +8553,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统日志文件列表", "tags": [ "Logs" ], @@ -8767,7 +8571,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 OpenResty 配置信息", "tags": [ "OpenResty" ], @@ -8789,7 +8592,6 @@ "ApiKeyAuth": [] } ], - "description": "清理 OpenResty 代理缓存", "tags": [ "OpenResty" ], @@ -8815,7 +8617,6 @@ "ApiKeyAuth": [] } ], - "description": "上传更新 OpenResty 配置文件", "consumes": [ "application/json" ], @@ -8855,7 +8656,6 @@ "ApiKeyAuth": [] } ], - "description": "获取部分 OpenResty 配置信息", "consumes": [ "application/json" ], @@ -8894,7 +8694,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 OpenResty 状态信息", "tags": [ "OpenResty" ], @@ -8916,7 +8715,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 OpenResty 配置信息", "consumes": [ "application/json" ], @@ -8967,7 +8765,6 @@ "ApiKeyAuth": [] } ], - "description": "停止进程", "tags": [ "Process" ], @@ -9006,7 +8803,6 @@ "ApiKeyAuth": [] } ], - "description": "创建运行环境", "consumes": [ "application/json" ], @@ -9048,7 +8844,6 @@ "ApiKeyAuth": [] } ], - "description": "获取运行环境", "consumes": [ "application/json" ], @@ -9079,7 +8874,6 @@ "ApiKeyAuth": [] } ], - "description": "删除运行环境", "consumes": [ "application/json" ], @@ -9121,7 +8915,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 Node 项目的 modules", "consumes": [ "application/json" ], @@ -9154,7 +8947,6 @@ "ApiKeyAuth": [] } ], - "description": "操作 Node 项目 modules", "consumes": [ "application/json" ], @@ -9187,7 +8979,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 Node 项目的 scripts", "consumes": [ "application/json" ], @@ -9220,7 +9011,6 @@ "ApiKeyAuth": [] } ], - "description": "操作运行环境", "consumes": [ "application/json" ], @@ -9262,7 +9052,6 @@ "ApiKeyAuth": [] } ], - "description": "Create Extensions", "consumes": [ "application/json" ], @@ -9295,7 +9084,6 @@ "ApiKeyAuth": [] } ], - "description": "Delete Extensions", "consumes": [ "application/json" ], @@ -9328,7 +9116,6 @@ "ApiKeyAuth": [] } ], - "description": "Page Extensions", "consumes": [ "application/json" ], @@ -9367,7 +9154,6 @@ "ApiKeyAuth": [] } ], - "description": "Update Extensions", "consumes": [ "application/json" ], @@ -9400,7 +9186,6 @@ "ApiKeyAuth": [] } ], - "description": "获取运行环境列表", "consumes": [ "application/json" ], @@ -9433,7 +9218,6 @@ "ApiKeyAuth": [] } ], - "description": "同步运行环境状态", "consumes": [ "application/json" ], @@ -9455,7 +9239,6 @@ "ApiKeyAuth": [] } ], - "description": "更新运行环境", "consumes": [ "application/json" ], @@ -9497,14 +9280,13 @@ "ApiKeyAuth": [] } ], - "description": "生成 API 接口密钥", "consumes": [ "application/json" ], "tags": [ "System Setting" ], - "summary": "generate api key", + "summary": "Generate api key", "responses": { "200": { "description": "OK" @@ -9526,7 +9308,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 API 接口配置", "consumes": [ "application/json" ], @@ -9568,7 +9349,6 @@ "ApiKeyAuth": [] } ], - "description": "创建备份账号", "consumes": [ "application/json" ], @@ -9610,7 +9390,6 @@ "ApiKeyAuth": [] } ], - "description": "备份系统数据", "consumes": [ "application/json" ], @@ -9654,7 +9433,6 @@ "ApiKeyAuth": [] } ], - "description": "删除备份账号", "consumes": [ "application/json" ], @@ -9705,7 +9483,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 OneDrive 信息", "consumes": [ "application/json" ], @@ -9730,7 +9507,6 @@ "ApiKeyAuth": [] } ], - "description": "删除备份记录", "consumes": [ "application/json" ], @@ -9781,7 +9557,6 @@ "ApiKeyAuth": [] } ], - "description": "下载备份记录", "consumes": [ "application/json" ], @@ -9824,7 +9599,6 @@ "ApiKeyAuth": [] } ], - "description": "获取备份记录列表分页", "consumes": [ "application/json" ], @@ -9857,7 +9631,6 @@ "ApiKeyAuth": [] } ], - "description": "通过计划任务获取备份记录列表分页", "consumes": [ "application/json" ], @@ -9890,7 +9663,6 @@ "ApiKeyAuth": [] } ], - "description": "恢复系统数据", "consumes": [ "application/json" ], @@ -9935,7 +9707,6 @@ "ApiKeyAuth": [] } ], - "description": "从上传恢复系统数据", "consumes": [ "application/json" ], @@ -9980,7 +9751,6 @@ "ApiKeyAuth": [] } ], - "description": "刷新 OneDrive token", "tags": [ "Backup Account" ], @@ -9999,7 +9769,6 @@ "ApiKeyAuth": [] } ], - "description": "获取备份账号列表", "tags": [ "Backup Account" ], @@ -10022,7 +9791,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 bucket 列表", "consumes": [ "application/json" ], @@ -10061,7 +9829,6 @@ "ApiKeyAuth": [] } ], - "description": "获取备份账号内文件列表", "consumes": [ "application/json" ], @@ -10100,7 +9867,6 @@ "ApiKeyAuth": [] } ], - "description": "更新备份账号信息", "consumes": [ "application/json" ], @@ -10142,11 +9908,10 @@ "ApiKeyAuth": [] } ], - "description": "获取安装根目录", "tags": [ "System Setting" ], - "summary": "Load local backup dir", + "summary": "Load local base dir", "responses": { "200": { "description": "OK", @@ -10164,7 +9929,6 @@ "ApiKeyAuth": [] } ], - "description": "更新系统监听信息", "consumes": [ "application/json" ], @@ -10207,7 +9971,6 @@ "ApiKeyAuth": [] } ], - "description": "重置过期系统登录密码", "consumes": [ "application/json" ], @@ -10247,7 +10010,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统地址信息", "consumes": [ "application/json" ], @@ -10269,7 +10031,6 @@ "ApiKeyAuth": [] } ], - "description": "隐藏高级功能菜单", "consumes": [ "application/json" ], @@ -10309,7 +10070,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 mfa 信息", "consumes": [ "application/json" ], @@ -10345,7 +10105,6 @@ "ApiKeyAuth": [] } ], - "description": "Mfa 绑定", "consumes": [ "application/json" ], @@ -10385,7 +10144,6 @@ "ApiKeyAuth": [] } ], - "description": "更新系统登录密码", "consumes": [ "application/json" ], @@ -10425,7 +10183,6 @@ "ApiKeyAuth": [] } ], - "description": "更新系统端口", "consumes": [ "application/json" ], @@ -10467,7 +10224,6 @@ "ApiKeyAuth": [] } ], - "description": "服务器代理配置", "consumes": [ "application/json" ], @@ -10510,7 +10266,6 @@ "ApiKeyAuth": [] } ], - "description": "加载系统配置信息", "tags": [ "System Setting" ], @@ -10532,7 +10287,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统可用状态", "tags": [ "System Setting" ], @@ -10551,7 +10305,6 @@ "ApiKeyAuth": [] } ], - "description": "创建系统快照", "consumes": [ "application/json" ], @@ -10594,7 +10347,6 @@ "ApiKeyAuth": [] } ], - "description": "删除系统快照", "consumes": [ "application/json" ], @@ -10645,7 +10397,6 @@ "ApiKeyAuth": [] } ], - "description": "更新快照描述信息", "consumes": [ "application/json" ], @@ -10697,7 +10448,6 @@ "ApiKeyAuth": [] } ], - "description": "导入已有快照", "consumes": [ "application/json" ], @@ -10740,7 +10490,6 @@ "ApiKeyAuth": [] } ], - "description": "从系统快照恢复", "consumes": [ "application/json" ], @@ -10791,7 +10540,6 @@ "ApiKeyAuth": [] } ], - "description": "从系统快照回滚", "consumes": [ "application/json" ], @@ -10842,7 +10590,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统快照列表分页", "consumes": [ "application/json" ], @@ -10878,7 +10625,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统快照大小", "consumes": [ "application/json" ], @@ -10911,7 +10657,6 @@ "ApiKeyAuth": [] } ], - "description": "获取快照状态", "consumes": [ "application/json" ], @@ -10944,7 +10689,6 @@ "ApiKeyAuth": [] } ], - "description": "下载证书", "tags": [ "System Setting" ], @@ -10963,7 +10707,6 @@ "ApiKeyAuth": [] } ], - "description": "获取证书信息", "tags": [ "System Setting" ], @@ -10985,7 +10728,6 @@ "ApiKeyAuth": [] } ], - "description": "修改系统 ssl 登录", "consumes": [ "application/json" ], @@ -11027,7 +10769,6 @@ "ApiKeyAuth": [] } ], - "description": "更新系统配置", "consumes": [ "application/json" ], @@ -11070,7 +10811,6 @@ "ApiKeyAuth": [] } ], - "description": "获取版本 release notes", "consumes": [ "application/json" ], @@ -11101,7 +10841,6 @@ "ApiKeyAuth": [] } ], - "description": "系统更新", "consumes": [ "application/json" ], @@ -11143,7 +10882,6 @@ "ApiKeyAuth": [] } ], - "description": "创建扫描规则", "consumes": [ "application/json" ], @@ -11186,7 +10924,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 Clam 基础信息", "consumes": [ "application/json" ], @@ -11211,7 +10948,6 @@ "ApiKeyAuth": [] } ], - "description": "删除扫描规则", "consumes": [ "application/json" ], @@ -11262,7 +10998,6 @@ "ApiKeyAuth": [] } ], - "description": "获取扫描文件", "consumes": [ "application/json" ], @@ -11298,7 +11033,6 @@ "ApiKeyAuth": [] } ], - "description": "更新病毒扫描配置文件", "consumes": [ "application/json" ], @@ -11331,7 +11065,6 @@ "ApiKeyAuth": [] } ], - "description": "执行病毒扫描", "consumes": [ "application/json" ], @@ -11382,7 +11115,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 Clam 状态", "consumes": [ "application/json" ], @@ -11420,7 +11152,6 @@ "ApiKeyAuth": [] } ], - "description": "清空扫描报告", "consumes": [ "application/json" ], @@ -11467,7 +11198,6 @@ "ApiKeyAuth": [] } ], - "description": "获取扫描结果详情", "consumes": [ "application/json" ], @@ -11500,7 +11230,6 @@ "ApiKeyAuth": [] } ], - "description": "获取扫描结果列表分页", "consumes": [ "application/json" ], @@ -11536,7 +11265,6 @@ "ApiKeyAuth": [] } ], - "description": "获取扫描规则列表分页", "consumes": [ "application/json" ], @@ -11572,7 +11300,6 @@ "ApiKeyAuth": [] } ], - "description": "修改扫描规则状态", "consumes": [ "application/json" ], @@ -11624,7 +11351,6 @@ "ApiKeyAuth": [] } ], - "description": "修改扫描规则", "consumes": [ "application/json" ], @@ -11667,7 +11393,6 @@ "ApiKeyAuth": [] } ], - "description": "清理系统垃圾文件", "consumes": [ "application/json" ], @@ -11710,7 +11435,6 @@ "ApiKeyAuth": [] } ], - "description": "获取设备基础信息", "tags": [ "Device" ], @@ -11732,7 +11456,6 @@ "ApiKeyAuth": [] } ], - "description": "检查系统 DNS 配置可用性", "consumes": [ "application/json" ], @@ -11765,7 +11488,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统配置文件", "consumes": [ "application/json" ], @@ -11798,7 +11520,6 @@ "ApiKeyAuth": [] } ], - "description": "通过文件修改配置", "consumes": [ "application/json" ], @@ -11831,7 +11552,6 @@ "ApiKeyAuth": [] } ], - "description": "修改系统参数", "consumes": [ "application/json" ], @@ -11874,7 +11594,6 @@ "ApiKeyAuth": [] } ], - "description": "修改系统 hosts", "tags": [ "Device" ], @@ -11903,7 +11622,6 @@ "ApiKeyAuth": [] } ], - "description": "修改系统密码", "consumes": [ "application/json" ], @@ -11936,7 +11654,6 @@ "ApiKeyAuth": [] } ], - "description": "修改系统 Swap", "consumes": [ "application/json" ], @@ -11979,7 +11696,6 @@ "ApiKeyAuth": [] } ], - "description": "获取系统可用时区选项", "consumes": [ "application/json" ], @@ -12004,7 +11720,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 Fail2ban 基础信息", "tags": [ "Fail2ban" ], @@ -12026,7 +11741,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 fail2ban 配置文件", "consumes": [ "application/json" ], @@ -12048,7 +11762,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 Fail2ban 状态", "consumes": [ "application/json" ], @@ -12086,7 +11799,6 @@ "ApiKeyAuth": [] } ], - "description": "配置 sshd", "consumes": [ "application/json" ], @@ -12115,7 +11827,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 Fail2ban ip", "consumes": [ "application/json" ], @@ -12151,7 +11862,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 Fail2ban 配置", "consumes": [ "application/json" ], @@ -12194,7 +11904,6 @@ "ApiKeyAuth": [] } ], - "description": "通过文件修改 fail2ban 配置", "consumes": [ "application/json" ], @@ -12227,7 +11936,6 @@ "ApiKeyAuth": [] } ], - "description": "创建 FTP 账户", "consumes": [ "application/json" ], @@ -12270,7 +11978,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 FTP 基础信息", "tags": [ "FTP" ], @@ -12292,7 +11999,6 @@ "ApiKeyAuth": [] } ], - "description": "删除 FTP 账户", "consumes": [ "application/json" ], @@ -12343,7 +12049,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 FTP 操作日志", "consumes": [ "application/json" ], @@ -12379,7 +12084,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 FTP 状态", "consumes": [ "application/json" ], @@ -12417,7 +12121,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 FTP 账户列表分页", "consumes": [ "application/json" ], @@ -12453,7 +12156,6 @@ "ApiKeyAuth": [] } ], - "description": "同步 FTP 账户", "consumes": [ "application/json" ], @@ -12493,7 +12195,6 @@ "ApiKeyAuth": [] } ], - "description": "修改 FTP 账户", "consumes": [ "application/json" ], @@ -12536,7 +12237,6 @@ "ApiKeyAuth": [] } ], - "description": "扫描系统垃圾文件", "tags": [ "Device" ], @@ -12562,7 +12262,6 @@ "ApiKeyAuth": [] } ], - "description": "创建网站", "consumes": [ "application/json" ], @@ -12604,7 +12303,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 id 查询网站", "consumes": [ "application/json" ], @@ -12638,7 +12336,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 id 查询网站 nginx", "consumes": [ "application/json" ], @@ -12672,7 +12369,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 https 配置", "consumes": [ "application/json" ], @@ -12704,7 +12400,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 https 配置", "consumes": [ "application/json" ], @@ -12758,7 +12453,6 @@ "ApiKeyAuth": [] } ], - "description": "创建网站 acme", "consumes": [ "application/json" ], @@ -12803,7 +12497,6 @@ "ApiKeyAuth": [] } ], - "description": "删除网站 acme", "consumes": [ "application/json" ], @@ -12854,7 +12547,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站 acme 列表分页", "consumes": [ "application/json" ], @@ -12890,7 +12582,6 @@ "ApiKeyAuth": [] } ], - "description": "获取密码访问配置", "consumes": [ "application/json" ], @@ -12923,7 +12614,6 @@ "ApiKeyAuth": [] } ], - "description": "更新密码访问配置", "consumes": [ "application/json" ], @@ -12956,7 +12646,6 @@ "ApiKeyAuth": [] } ], - "description": "创建网站 ca", "consumes": [ "application/json" ], @@ -13001,7 +12690,6 @@ "ApiKeyAuth": [] } ], - "description": "删除网站 ca", "consumes": [ "application/json" ], @@ -13052,7 +12740,6 @@ "ApiKeyAuth": [] } ], - "description": "下载 CA 证书文件", "consumes": [ "application/json" ], @@ -13103,7 +12790,6 @@ "ApiKeyAuth": [] } ], - "description": "自签 SSL 证书", "consumes": [ "application/json" ], @@ -13154,14 +12840,13 @@ "ApiKeyAuth": [] } ], - "description": "续签 SSL 证书", "consumes": [ "application/json" ], "tags": [ "Website CA" ], - "summary": "Obtain SSL", + "summary": "Renew Obtain SSL", "parameters": [ { "description": "request", @@ -13205,7 +12890,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站 ca 列表分页", "consumes": [ "application/json" ], @@ -13241,7 +12925,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站 ca", "consumes": [ "application/json" ], @@ -13275,7 +12958,6 @@ "ApiKeyAuth": [] } ], - "description": "网站创建前检查", "consumes": [ "application/json" ], @@ -13314,7 +12996,6 @@ "ApiKeyAuth": [] } ], - "description": "获取 nginx 配置", "consumes": [ "application/json" ], @@ -13350,7 +13031,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 nginx 配置", "consumes": [ "application/json" ], @@ -13401,7 +13081,6 @@ "ApiKeyAuth": [] } ], - "description": "获取默认 html", "consumes": [ "application/json" ], @@ -13426,7 +13105,6 @@ "ApiKeyAuth": [] } ], - "description": "更新默认 html", "consumes": [ "application/json" ], @@ -13468,7 +13146,6 @@ "ApiKeyAuth": [] } ], - "description": "操作网站日志", "consumes": [ "application/json" ], @@ -13520,7 +13197,6 @@ "ApiKeyAuth": [] } ], - "description": "删除网站", "consumes": [ "application/json" ], @@ -13571,7 +13247,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站目录配置", "consumes": [ "application/json" ], @@ -13604,7 +13279,6 @@ "ApiKeyAuth": [] } ], - "description": "更新网站目录权限", "consumes": [ "application/json" ], @@ -13655,7 +13329,6 @@ "ApiKeyAuth": [] } ], - "description": "更新网站目录", "consumes": [ "application/json" ], @@ -13706,7 +13379,6 @@ "ApiKeyAuth": [] } ], - "description": "创建网站 dns", "consumes": [ "application/json" ], @@ -13748,7 +13420,6 @@ "ApiKeyAuth": [] } ], - "description": "删除网站 dns", "consumes": [ "application/json" ], @@ -13799,7 +13470,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站 dns 列表分页", "consumes": [ "application/json" ], @@ -13835,7 +13505,6 @@ "ApiKeyAuth": [] } ], - "description": "更新网站 dns", "consumes": [ "application/json" ], @@ -13877,7 +13546,6 @@ "ApiKeyAuth": [] } ], - "description": "创建网站域名", "consumes": [ "application/json" ], @@ -13922,7 +13590,6 @@ "ApiKeyAuth": [] } ], - "description": "通过网站 id 查询域名", "consumes": [ "application/json" ], @@ -13959,7 +13626,6 @@ "ApiKeyAuth": [] } ], - "description": "删除网站域名", "consumes": [ "application/json" ], @@ -14010,7 +13676,6 @@ "ApiKeyAuth": [] } ], - "description": "获取防盗链配置", "consumes": [ "application/json" ], @@ -14043,14 +13708,13 @@ "ApiKeyAuth": [] } ], - "description": "更新防盗链配置", "consumes": [ "application/json" ], "tags": [ "Website" ], - "summary": "Update AntiLeech", + "summary": "Update AntiLeech conf", "parameters": [ { "description": "request", @@ -14076,7 +13740,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站列表", "tags": [ "Website" ], @@ -14101,7 +13764,6 @@ "ApiKeyAuth": [] } ], - "description": "操作网站日志", "consumes": [ "application/json" ], @@ -14156,7 +13818,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 网站 nginx 配置", "consumes": [ "application/json" ], @@ -14207,7 +13868,6 @@ "ApiKeyAuth": [] } ], - "description": "操作网站", "consumes": [ "application/json" ], @@ -14259,7 +13919,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站列表", "tags": [ "Website" ], @@ -14284,7 +13943,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 网站 PHP 配置", "consumes": [ "application/json" ], @@ -14335,7 +13993,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站 php 配置", "consumes": [ "application/json" ], @@ -14369,7 +14026,6 @@ "ApiKeyAuth": [] } ], - "description": "更新 php 配置文件", "consumes": [ "application/json" ], @@ -14420,7 +14076,6 @@ "ApiKeyAuth": [] } ], - "description": "变更 php 版本", "consumes": [ "application/json" ], @@ -14471,7 +14126,6 @@ "ApiKeyAuth": [] } ], - "description": "获取反向代理配置", "consumes": [ "application/json" ], @@ -14504,7 +14158,6 @@ "ApiKeyAuth": [] } ], - "description": "修改反向代理配置", "consumes": [ "application/json" ], @@ -14555,7 +14208,6 @@ "ApiKeyAuth": [] } ], - "description": "更新反向代理文件", "consumes": [ "application/json" ], @@ -14606,7 +14258,6 @@ "ApiKeyAuth": [] } ], - "description": "获取重定向配置", "consumes": [ "application/json" ], @@ -14639,7 +14290,6 @@ "ApiKeyAuth": [] } ], - "description": "更新重定向文件", "consumes": [ "application/json" ], @@ -14690,7 +14340,6 @@ "ApiKeyAuth": [] } ], - "description": "修改重定向配置", "consumes": [ "application/json" ], @@ -14741,7 +14390,6 @@ "ApiKeyAuth": [] } ], - "description": "获取伪静态配置", "consumes": [ "application/json" ], @@ -14774,7 +14422,6 @@ "ApiKeyAuth": [] } ], - "description": "更新伪静态配置", "consumes": [ "application/json" ], @@ -14825,7 +14472,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站列表分页", "consumes": [ "application/json" ], @@ -14861,7 +14507,6 @@ "ApiKeyAuth": [] } ], - "description": "创建网站 ssl", "consumes": [ "application/json" ], @@ -14906,7 +14551,6 @@ "ApiKeyAuth": [] } ], - "description": "通过 id 查询 ssl", "consumes": [ "application/json" ], @@ -14937,7 +14581,6 @@ "ApiKeyAuth": [] } ], - "description": "删除网站 ssl", "consumes": [ "application/json" ], @@ -14988,14 +14631,13 @@ "ApiKeyAuth": [] } ], - "description": "下载证书文件", "consumes": [ "application/json" ], "tags": [ "Website SSL" ], - "summary": "Download SSL file", + "summary": "Download SSL file", "parameters": [ { "description": "request", @@ -15039,7 +14681,6 @@ "ApiKeyAuth": [] } ], - "description": "申请证书", "consumes": [ "application/json" ], @@ -15090,7 +14731,6 @@ "ApiKeyAuth": [] } ], - "description": "解析网站 ssl", "consumes": [ "application/json" ], @@ -15129,7 +14769,6 @@ "ApiKeyAuth": [] } ], - "description": "获取网站 ssl 列表分页", "consumes": [ "application/json" ], @@ -15162,14 +14801,13 @@ "ApiKeyAuth": [] } ], - "description": "更新 ssl", "consumes": [ "application/json" ], "tags": [ "Website SSL" ], - "summary": "Update ssl", + "summary": "Update Website ssl", "parameters": [ { "description": "request", @@ -15213,14 +14851,13 @@ "ApiKeyAuth": [] } ], - "description": "上传 ssl", "consumes": [ "application/json" ], "tags": [ "Website SSL" ], - "summary": "Upload ssl", + "summary": "Upload Website ssl", "parameters": [ { "description": "request", @@ -15255,7 +14892,6 @@ "ApiKeyAuth": [] } ], - "description": "通过网站 id 查询 ssl", "consumes": [ "application/json" ], @@ -15286,7 +14922,6 @@ "ApiKeyAuth": [] } ], - "description": "更新网站", "consumes": [ "application/json" ], @@ -16177,6 +15812,26 @@ } } }, + "dto.ContainerLog": { + "type": "object", + "required": [ + "container" + ], + "properties": { + "container": { + "type": "string" + }, + "containerType": { + "type": "string" + }, + "since": { + "type": "string" + }, + "tail": { + "type": "integer" + } + } + }, "dto.ContainerOperate": { "type": "object", "required": [ @@ -23715,13 +23370,13 @@ }, "securityDefinitions": { "CustomToken": { - "description": "自定义 Token 格式,格式:md5('1panel' + 1Panel-Token + 1Panel-Timestamp)。\n```\n示例请求头:\ncurl -X GET \"http://localhost:4004/api/v1/resource\" \\\n-H \"1Panel-Token: \u003c1panel_token\u003e\" \\\n-H \"1Panel-Timestamp: \u003ccurrent_unix_timestamp\u003e\"\n```\n- `1Panel-Token` 为面板 API 接口密钥。", + "description": "Custom Token Format, Format: md5('1panel' + 1Panel-Token + 1Panel-Timestamp).\n```\neg:\ncurl -X GET \"http://localhost:4004/api/v1/resource\" \\\n-H \"1Panel-Token: \u003c1panel_token\u003e\" \\\n-H \"1Panel-Timestamp: \u003ccurrent_unix_timestamp\u003e\"\n```\n- `1Panel-Token` is the key for the panel API interface.", "type": "apiKey", "name": "1Panel-Token", "in": "Header" }, "Timestamp": { - "description": "- `1Panel-Timestamp` 为当前时间的 Unix 时间戳(单位:秒)。", + "description": "- `1Panel-Timestamp` is the Unix timestamp of the current time in seconds.", "type": "apiKey", "name": "1Panel-Timestamp", "in": "header" diff --git a/cmd/server/docs/swagger.yaml b/cmd/server/docs/swagger.yaml index 8cb06a1e4..423957a6a 100644 --- a/cmd/server/docs/swagger.yaml +++ b/cmd/server/docs/swagger.yaml @@ -572,6 +572,19 @@ definitions: systemUsage: type: integer type: object + dto.ContainerLog: + properties: + container: + type: string + containerType: + type: string + since: + type: string + tail: + type: integer + required: + - container + type: object dto.ContainerOperate: properties: autoRemove: @@ -5641,7 +5654,7 @@ definitions: type: object info: contact: {} - description: 开源Linux面板 + description: Open Source Linux Panel license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html @@ -5653,7 +5666,6 @@ paths: get: consumes: - application/json - description: 通过 key 获取应用信息 parameters: - description: app key in: path @@ -5672,7 +5684,6 @@ paths: - App /apps/checkupdate: get: - description: 获取应用更新版本 responses: "200": description: OK @@ -5685,19 +5696,18 @@ paths: get: consumes: - application/json - description: 通过 appid 获取应用详情 parameters: - description: app id in: path name: appId required: true type: integer - - description: app 版本 + - description: app version in: path name: version required: true type: string - - description: app 类型 + - description: app type in: path name: version required: true @@ -5716,7 +5726,6 @@ paths: get: consumes: - application/json - description: 通过 id 获取应用详情 parameters: - description: id in: path @@ -5737,7 +5746,6 @@ paths: get: consumes: - application/json - description: 获取忽略的应用版本 responses: "200": description: OK @@ -5752,7 +5760,6 @@ paths: post: consumes: - application/json - description: 安装应用 parameters: - description: request in: body @@ -5781,7 +5788,6 @@ paths: post: consumes: - application/json - description: 检查应用安装情况 parameters: - description: request in: body @@ -5803,7 +5809,6 @@ paths: post: consumes: - application/json - description: 通过 key 获取应用默认配置 parameters: - description: request in: body @@ -5825,7 +5830,6 @@ paths: get: consumes: - application/json - description: 获取应用连接信息 parameters: - description: request in: body @@ -5847,7 +5851,6 @@ paths: get: consumes: - application/json - description: 删除前检查 parameters: - description: App install id in: path @@ -5870,7 +5873,6 @@ paths: post: consumes: - application/json - description: 忽略应用升级版本 parameters: - description: request in: body @@ -5897,7 +5899,6 @@ paths: get: consumes: - application/json - description: 获取已安装应用列表 responses: "200": description: OK @@ -5914,7 +5915,6 @@ paths: post: consumes: - application/json - description: 获取应用端口 parameters: - description: request in: body @@ -5936,7 +5936,6 @@ paths: post: consumes: - application/json - description: 操作已安装应用 parameters: - description: request in: body @@ -5982,7 +5981,6 @@ paths: get: consumes: - application/json - description: 通过 install id 获取应用参数 parameters: - description: request in: path @@ -6003,7 +6001,6 @@ paths: post: consumes: - application/json - description: 修改应用参数 parameters: - description: request in: body @@ -6030,7 +6027,6 @@ paths: post: consumes: - application/json - description: 修改应用端口 parameters: - description: request in: body @@ -6059,7 +6055,6 @@ paths: post: consumes: - application/json - description: 分页获取已安装应用列表 parameters: - description: request in: body @@ -6077,7 +6072,6 @@ paths: - App /apps/installed/sync: post: - description: 同步已安装应用列表 responses: "200": description: OK @@ -6096,7 +6090,6 @@ paths: post: consumes: - application/json - description: 通过 install id 获取应用更新版本 parameters: - description: request in: path @@ -6119,7 +6112,6 @@ paths: post: consumes: - application/json - description: 获取应用列表 parameters: - description: request in: body @@ -6139,7 +6131,6 @@ paths: get: consumes: - application/json - description: 通过 key 获取应用 service parameters: - description: request in: path @@ -6160,7 +6151,6 @@ paths: - App /apps/sync: post: - description: 同步应用列表 responses: "200": description: OK @@ -6177,7 +6167,6 @@ paths: paramKeys: [] /auth/captcha: get: - description: 加载验证码 responses: "200": description: OK @@ -6188,16 +6177,22 @@ paths: - Auth /auth/demo: get: - description: 判断是否为demo环境 responses: "200": description: OK summary: Check System isDemo tags: - Auth + /auth/intl: + get: + responses: + "200": + description: OK + summary: Check System isIntl + tags: + - Auth /auth/language: get: - description: 获取系统语言设置 responses: "200": description: OK @@ -6208,9 +6203,8 @@ paths: post: consumes: - application/json - description: 用户登录 parameters: - - description: 安全入口 base64 加密串 + - description: Secure entrance base64 encrypted string in: header name: EntranceCode required: true @@ -6231,7 +6225,6 @@ paths: - Auth /auth/logout: post: - description: 用户登出 responses: "200": description: OK @@ -6244,7 +6237,6 @@ paths: post: consumes: - application/json - description: 用户 mfa 登录 parameters: - description: request in: body @@ -6257,7 +6249,6 @@ paths: description: OK headers: EntranceCode: - description: 安全入口 type: string schema: $ref: '#/definitions/dto.UserLoginInfo' @@ -6268,7 +6259,6 @@ paths: post: consumes: - application/json - description: 创建容器 parameters: - description: request in: body @@ -6296,7 +6286,6 @@ paths: post: consumes: - application/json - description: 清理容器日志 parameters: - description: request in: body @@ -6323,7 +6312,6 @@ paths: post: consumes: - application/json - description: 容器提交生成新镜像 parameters: - description: request in: body @@ -6341,7 +6329,6 @@ paths: post: consumes: - application/json - description: 创建容器编排 parameters: - description: request in: body @@ -6368,7 +6355,6 @@ paths: post: consumes: - application/json - description: 容器编排操作 parameters: - description: request in: body @@ -6396,7 +6382,6 @@ paths: post: consumes: - application/json - description: 获取编排列表分页 parameters: - description: request in: body @@ -6416,21 +6401,20 @@ paths: - Container Compose /containers/compose/search/log: get: - description: docker-compose 日志 parameters: - - description: compose 文件地址 + - description: compose file address in: query name: compose type: string - - description: 时间筛选 + - description: date in: query name: since type: string - - description: 是否追踪 + - description: follow in: query name: follow type: string - - description: 显示行号 + - description: tail in: query name: tail type: string @@ -6444,7 +6428,6 @@ paths: post: consumes: - application/json - description: 测试 compose 是否可用 parameters: - description: request in: body @@ -6471,7 +6454,6 @@ paths: post: consumes: - application/json - description: 更新容器编排 parameters: - description: request in: body @@ -6484,7 +6466,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Update compose + summary: Update Container Compose tags: - Container Compose x-panel-log: @@ -6496,7 +6478,6 @@ paths: paramKeys: [] /containers/daemonjson: get: - description: 获取 docker 配置信息 produces: - application/json responses: @@ -6511,7 +6492,6 @@ paths: - Container Docker /containers/daemonjson/file: get: - description: 获取 docker 配置信息(表单) produces: - application/json responses: @@ -6528,7 +6508,6 @@ paths: post: consumes: - application/json - description: 修改 docker 配置信息 parameters: - description: request in: body @@ -6556,7 +6535,6 @@ paths: post: consumes: - application/json - description: 上传替换 docker 配置文件 parameters: - description: request in: body @@ -6582,7 +6560,6 @@ paths: post: consumes: - application/json - description: Docker 操作 parameters: - description: request in: body @@ -6607,7 +6584,6 @@ paths: paramKeys: [] /containers/docker/status: get: - description: 获取 docker 服务状态 produces: - application/json responses: @@ -6622,11 +6598,23 @@ paths: - Container Docker /containers/download/log: post: - description: 下载容器日志 + consumes: + - application/json + parameters: + - description: request + in: body + name: request + required: true + schema: + $ref: '#/definitions/dto.ContainerLog' responses: {} + security: + - ApiKeyAuth: [] + summary: Download Container logs + tags: + - Container /containers/image: get: - description: 获取镜像名称列表 produces: - application/json responses: @@ -6643,7 +6631,6 @@ paths: - Container Image /containers/image/all: get: - description: 获取所有镜像列表 produces: - application/json responses: @@ -6662,7 +6649,6 @@ paths: post: consumes: - application/json - description: 构建镜像 parameters: - description: request in: body @@ -6691,7 +6677,6 @@ paths: post: consumes: - application/json - description: 导入镜像 parameters: - description: request in: body @@ -6718,7 +6703,6 @@ paths: post: consumes: - application/json - description: 拉取镜像 parameters: - description: request in: body @@ -6754,7 +6738,6 @@ paths: post: consumes: - application/json - description: 推送镜像 parameters: - description: request in: body @@ -6791,7 +6774,6 @@ paths: post: consumes: - application/json - description: 删除镜像 parameters: - description: request in: body @@ -6818,7 +6800,6 @@ paths: post: consumes: - application/json - description: 导出镜像 parameters: - description: request in: body @@ -6847,7 +6828,6 @@ paths: post: consumes: - application/json - description: 获取镜像列表分页 parameters: - description: request in: body @@ -6871,7 +6851,6 @@ paths: post: consumes: - application/json - description: Tag 镜像 parameters: - description: request in: body @@ -6905,7 +6884,6 @@ paths: post: consumes: - application/json - description: 获取容器表单信息 parameters: - description: request in: body @@ -6927,7 +6905,6 @@ paths: post: consumes: - application/json - description: 容器详情 parameters: - description: request in: body @@ -6949,7 +6926,6 @@ paths: post: consumes: - application/json - description: 修改 docker ipv6 配置 parameters: - description: request in: body @@ -6973,7 +6949,6 @@ paths: paramKeys: [] /containers/limit: get: - description: 获取容器限制 responses: "200": description: OK @@ -6986,7 +6961,6 @@ paths: post: consumes: - application/json - description: 获取容器名称 produces: - application/json responses: @@ -6999,7 +6973,6 @@ paths: - Container /containers/list/stats: get: - description: 获取容器列表资源占用 responses: "200": description: OK @@ -7014,7 +6987,6 @@ paths: post: consumes: - application/json - description: 获取容器操作日志 parameters: - description: request in: body @@ -7034,7 +7006,6 @@ paths: post: consumes: - application/json - description: 修改 docker 日志配置 parameters: - description: request in: body @@ -7060,7 +7031,6 @@ paths: get: consumes: - application/json - description: 获取容器网络列表 produces: - application/json responses: @@ -7078,7 +7048,6 @@ paths: post: consumes: - application/json - description: 创建容器网络 parameters: - description: request in: body @@ -7105,7 +7074,6 @@ paths: post: consumes: - application/json - description: 删除容器网络 parameters: - description: request in: body @@ -7132,7 +7100,6 @@ paths: post: consumes: - application/json - description: 获取容器网络列表分页 parameters: - description: request in: body @@ -7156,7 +7123,6 @@ paths: post: consumes: - application/json - description: 容器操作 parameters: - description: request in: body @@ -7184,7 +7150,6 @@ paths: post: consumes: - application/json - description: 容器清理 parameters: - description: request in: body @@ -7213,7 +7178,6 @@ paths: post: consumes: - application/json - description: 容器重命名 parameters: - description: request in: body @@ -7239,7 +7203,6 @@ paths: paramKeys: [] /containers/repo: get: - description: 获取镜像仓库列表 produces: - application/json responses: @@ -7257,7 +7220,6 @@ paths: post: consumes: - application/json - description: 创建镜像仓库 parameters: - description: request in: body @@ -7286,7 +7248,6 @@ paths: post: consumes: - application/json - description: 删除镜像仓库 parameters: - description: request in: body @@ -7321,7 +7282,6 @@ paths: post: consumes: - application/json - description: 获取镜像仓库列表分页 parameters: - description: request in: body @@ -7345,7 +7305,6 @@ paths: get: consumes: - application/json - description: 获取 docker 仓库状态 parameters: - description: request in: body @@ -7367,7 +7326,6 @@ paths: post: consumes: - application/json - description: 更新镜像仓库 parameters: - description: request in: body @@ -7402,7 +7360,6 @@ paths: post: consumes: - application/json - description: 获取容器列表分页 parameters: - description: request in: body @@ -7424,21 +7381,20 @@ paths: - Container /containers/search/log: post: - description: 容器日志 parameters: - - description: 容器名称 + - description: container name in: query name: container type: string - - description: 时间筛选 + - description: since in: query name: since type: string - - description: 是否追踪 + - description: follow in: query name: follow type: string - - description: 显示行号 + - description: tail in: query name: tail type: string @@ -7450,9 +7406,8 @@ paths: - Container /containers/stats/:id: get: - description: 容器监控信息 parameters: - - description: 容器id + - description: container id in: path name: id required: true @@ -7469,7 +7424,6 @@ paths: - Container /containers/template: get: - description: 获取容器编排模版列表 produces: - application/json responses: @@ -7487,7 +7441,6 @@ paths: post: consumes: - application/json - description: 创建容器编排模版 parameters: - description: request in: body @@ -7514,7 +7467,6 @@ paths: post: consumes: - application/json - description: 删除容器编排模版 parameters: - description: request in: body @@ -7547,7 +7499,6 @@ paths: post: consumes: - application/json - description: 获取容器编排模版列表分页 parameters: - description: request in: body @@ -7571,7 +7522,6 @@ paths: post: consumes: - application/json - description: 更新容器编排模版 parameters: - description: request in: body @@ -7604,7 +7554,6 @@ paths: post: consumes: - application/json - description: 更新容器 parameters: - description: request in: body @@ -7632,7 +7581,6 @@ paths: post: consumes: - application/json - description: 更新容器镜像 parameters: - description: request in: body @@ -7660,7 +7608,6 @@ paths: get: consumes: - application/json - description: 获取容器存储卷列表 produces: - application/json responses: @@ -7672,13 +7619,12 @@ paths: type: array security: - ApiKeyAuth: [] - summary: List volumes + summary: List Container Volumes tags: - Container Volume post: consumes: - application/json - description: 创建容器存储卷 parameters: - description: request in: body @@ -7691,7 +7637,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create volume + summary: Create Container Volume tags: - Container Volume x-panel-log: @@ -7705,7 +7651,6 @@ paths: post: consumes: - application/json - description: 删除容器存储卷 parameters: - description: request in: body @@ -7718,7 +7663,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Delete volume + summary: Delete Container Volume tags: - Container Volume x-panel-log: @@ -7732,7 +7677,6 @@ paths: post: consumes: - application/json - description: 获取容器存储卷分页 parameters: - description: request in: body @@ -7749,14 +7693,13 @@ paths: $ref: '#/definitions/dto.PageResult' security: - ApiKeyAuth: [] - summary: Page volumes + summary: Page Container Volumes tags: - Container Volume /cronjobs: post: consumes: - application/json - description: 创建计划任务 parameters: - description: request in: body @@ -7784,7 +7727,6 @@ paths: post: consumes: - application/json - description: 删除计划任务 parameters: - description: request in: body @@ -7817,7 +7759,6 @@ paths: post: consumes: - application/json - description: 下载计划任务记录 parameters: - description: request in: body @@ -7850,7 +7791,6 @@ paths: post: consumes: - application/json - description: 手动执行计划任务 parameters: - description: request in: body @@ -7883,7 +7823,6 @@ paths: post: consumes: - application/json - description: 清空计划任务记录 parameters: - description: request in: body @@ -7916,7 +7855,6 @@ paths: post: consumes: - application/json - description: 获取计划任务记录日志 parameters: - description: request in: body @@ -7936,7 +7874,6 @@ paths: post: consumes: - application/json - description: 获取计划任务分页 parameters: - description: request in: body @@ -7958,7 +7895,6 @@ paths: post: consumes: - application/json - description: 获取计划任务记录 parameters: - description: request in: body @@ -7980,7 +7916,6 @@ paths: post: consumes: - application/json - description: 更新计划任务状态 parameters: - description: request in: body @@ -8014,7 +7949,6 @@ paths: post: consumes: - application/json - description: 更新计划任务 parameters: - description: request in: body @@ -8047,7 +7981,6 @@ paths: get: consumes: - application/json - description: 获取首页基础数据 parameters: - description: request in: path @@ -8073,7 +8006,6 @@ paths: get: consumes: - application/json - description: 获取服务器基础数据 responses: "200": description: OK @@ -8088,7 +8020,6 @@ paths: post: consumes: - application/json - description: 获取首页实时数据 parameters: - description: request in: body @@ -8110,7 +8041,6 @@ paths: post: consumes: - application/json - description: 重启服务器/面板 parameters: - description: request in: path @@ -8122,14 +8052,13 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: System restart + summary: System restart panel tags: - Dashboard /databases: post: consumes: - application/json - description: 创建 mysql 数据库 parameters: - description: request in: body @@ -8156,7 +8085,6 @@ paths: post: consumes: - application/json - description: 绑定 mysql 数据库用户 parameters: - description: request in: body @@ -8184,7 +8112,6 @@ paths: post: consumes: - application/json - description: 修改 mysql 访问权限 parameters: - description: request in: body @@ -8217,7 +8144,6 @@ paths: post: consumes: - application/json - description: 修改 mysql 密码 parameters: - description: request in: body @@ -8250,7 +8176,6 @@ paths: post: consumes: - application/json - description: 获取数据库基础信息 parameters: - description: request in: body @@ -8272,7 +8197,6 @@ paths: post: consumes: - application/json - description: 获取数据库配置文件 parameters: - description: request in: body @@ -8292,7 +8216,6 @@ paths: post: consumes: - application/json - description: 上传替换配置文件 parameters: - description: request in: body @@ -8320,7 +8243,6 @@ paths: post: consumes: - application/json - description: 创建远程数据库 parameters: - description: request in: body @@ -8346,7 +8268,6 @@ paths: paramKeys: [] /databases/db/:name: get: - description: 获取远程数据库 responses: "200": description: OK @@ -8361,7 +8282,6 @@ paths: post: consumes: - application/json - description: 检测远程数据库连接性 parameters: - description: request in: body @@ -8389,7 +8309,6 @@ paths: post: consumes: - application/json - description: 删除远程数据库 parameters: - description: request in: body @@ -8420,7 +8339,6 @@ paths: paramKeys: [] /databases/db/item/:type: get: - description: 获取数据库列表 responses: "200": description: OK @@ -8430,12 +8348,11 @@ paths: type: array security: - ApiKeyAuth: [] - summary: List databases + summary: Retrieve database list based on type tags: - Database /databases/db/list/:type: get: - description: 获取远程数据库列表 responses: "200": description: OK @@ -8452,7 +8369,6 @@ paths: post: consumes: - application/json - description: 获取远程数据库列表分页 parameters: - description: request in: body @@ -8474,7 +8390,6 @@ paths: post: consumes: - application/json - description: 更新远程数据库 parameters: - description: request in: body @@ -8501,7 +8416,6 @@ paths: post: consumes: - application/json - description: 删除 mysql 数据库 parameters: - description: request in: body @@ -8534,7 +8448,6 @@ paths: post: consumes: - application/json - description: Mysql 数据库删除前检查 parameters: - description: request in: body @@ -8558,7 +8471,6 @@ paths: post: consumes: - application/json - description: 更新 mysql 数据库库描述信息 parameters: - description: request in: body @@ -8592,7 +8504,6 @@ paths: post: consumes: - application/json - description: 从服务器获取 parameters: - description: request in: body @@ -8610,7 +8521,6 @@ paths: get: consumes: - application/json - description: 获取 mysql 数据库列表 parameters: - description: request in: body @@ -8634,7 +8544,6 @@ paths: post: consumes: - application/json - description: 创建 postgresql 数据库 parameters: - description: request in: body @@ -8661,7 +8570,6 @@ paths: post: consumes: - application/json - description: 从服务器获取 parameters: - description: request in: body @@ -8679,7 +8587,6 @@ paths: post: consumes: - application/json - description: 绑定 postgresql 数据库用户 parameters: - description: request in: body @@ -8707,7 +8614,6 @@ paths: post: consumes: - application/json - description: 删除 postgresql 数据库 parameters: - description: request in: body @@ -8740,7 +8646,6 @@ paths: post: consumes: - application/json - description: Postgresql 数据库删除前检查 parameters: - description: request in: body @@ -8764,7 +8669,6 @@ paths: post: consumes: - application/json - description: 更新 postgresql 数据库库描述信息 parameters: - description: request in: body @@ -8799,7 +8703,6 @@ paths: post: consumes: - application/json - description: 修改 postgresql 密码 parameters: - description: request in: body @@ -8832,7 +8735,6 @@ paths: post: consumes: - application/json - description: 修改 postgresql 用户权限 parameters: - description: request in: body @@ -8860,7 +8762,6 @@ paths: post: consumes: - application/json - description: 获取 postgresql 数据库列表分页 parameters: - description: request in: body @@ -8882,7 +8783,6 @@ paths: post: consumes: - application/json - description: 获取 redis 配置信息 parameters: - description: request in: body @@ -8904,7 +8804,6 @@ paths: post: consumes: - application/json - description: 更新 redis 配置信息 parameters: - description: request in: body @@ -8928,7 +8827,6 @@ paths: paramKeys: [] /databases/redis/install/cli: post: - description: 安装 redis cli responses: "200": description: OK @@ -8941,7 +8839,6 @@ paths: post: consumes: - application/json - description: 更新 redis 密码 parameters: - description: request in: body @@ -8967,7 +8864,6 @@ paths: post: consumes: - application/json - description: 获取 redis 持久化配置 parameters: - description: request in: body @@ -8989,7 +8885,6 @@ paths: post: consumes: - application/json - description: 更新 redis 持久化配置 parameters: - description: request in: body @@ -9015,7 +8910,6 @@ paths: post: consumes: - application/json - description: 获取 redis 状态信息 parameters: - description: request in: body @@ -9037,7 +8931,6 @@ paths: post: consumes: - application/json - description: 获取 mysql 远程访问权限 parameters: - description: request in: body @@ -9059,7 +8952,6 @@ paths: post: consumes: - application/json - description: 获取 mysql 数据库列表分页 parameters: - description: request in: body @@ -9081,7 +8973,6 @@ paths: post: consumes: - application/json - description: 获取 mysql 状态信息 parameters: - description: request in: body @@ -9103,7 +8994,6 @@ paths: post: consumes: - application/json - description: 获取 mysql 性能参数信息 parameters: - description: request in: body @@ -9125,7 +9015,6 @@ paths: post: consumes: - application/json - description: mysql 性能调优 parameters: - description: request in: body @@ -9151,7 +9040,6 @@ paths: post: consumes: - application/json - description: Mysql 远程数据库删除前检查 parameters: - description: request in: body @@ -9175,7 +9063,6 @@ paths: post: consumes: - application/json - description: 创建文件/文件夹 parameters: - description: request in: body @@ -9202,7 +9089,6 @@ paths: post: consumes: - application/json - description: 批量删除文件/文件夹 parameters: - description: request in: body @@ -9229,7 +9115,6 @@ paths: post: consumes: - application/json - description: 批量修改文件权限和用户/组 parameters: - description: request in: body @@ -9259,7 +9144,6 @@ paths: post: consumes: - application/json - description: 检测文件是否存在 parameters: - description: request in: body @@ -9279,7 +9163,6 @@ paths: post: consumes: - application/json - description: 分片下载下载文件 parameters: - description: request in: body @@ -9304,7 +9187,6 @@ paths: paramKeys: [] /files/chunkupload: post: - description: 分片上传文件 parameters: - description: request in: formData @@ -9316,14 +9198,13 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: ChunkUpload file + summary: Chunk upload file tags: - File /files/compress: post: consumes: - application/json - description: 压缩文件 parameters: - description: request in: body @@ -9350,7 +9231,6 @@ paths: post: consumes: - application/json - description: 获取文件内容 parameters: - description: request in: body @@ -9379,7 +9259,6 @@ paths: post: consumes: - application/json - description: 解压文件 parameters: - description: request in: body @@ -9406,7 +9285,6 @@ paths: post: consumes: - application/json - description: 删除文件/文件夹 parameters: - description: request in: body @@ -9433,7 +9311,6 @@ paths: get: consumes: - application/json - description: 下载文件 responses: "200": description: OK @@ -9446,7 +9323,6 @@ paths: post: consumes: - application/json - description: 创建收藏 parameters: - description: request in: body @@ -9473,7 +9349,6 @@ paths: post: consumes: - application/json - description: 删除收藏 parameters: - description: request in: body @@ -9506,7 +9381,6 @@ paths: post: consumes: - application/json - description: 获取收藏列表 parameters: - description: request in: body @@ -9526,7 +9400,6 @@ paths: post: consumes: - application/json - description: 修改文件权限 parameters: - description: request in: body @@ -9554,7 +9427,6 @@ paths: post: consumes: - application/json - description: 移动文件 parameters: - description: request in: body @@ -9582,7 +9454,6 @@ paths: post: consumes: - application/json - description: 修改文件用户/组 parameters: - description: request in: body @@ -9609,7 +9480,6 @@ paths: paramKeys: [] /files/read: post: - description: 按行读取日志文件 parameters: - description: request in: body @@ -9629,13 +9499,12 @@ paths: post: consumes: - application/json - description: 清空回收站文件 responses: "200": description: OK security: - ApiKeyAuth: [] - summary: Clear RecycleBin files + summary: Clear Recycle Bin files tags: - File x-panel-log: @@ -9648,7 +9517,6 @@ paths: post: consumes: - application/json - description: 还原回收站文件 parameters: - description: request in: body @@ -9661,7 +9529,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Reduce RecycleBin files + summary: Reduce Recycle Bin files tags: - File x-panel-log: @@ -9675,7 +9543,6 @@ paths: post: consumes: - application/json - description: 获取回收站文件列表 parameters: - description: request in: body @@ -9688,27 +9555,25 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: List RecycleBin files + summary: List Recycle Bin files tags: - File /files/recycle/status: get: consumes: - application/json - description: 获取回收站状态 responses: "200": description: OK security: - ApiKeyAuth: [] - summary: Get RecycleBin status + summary: Get Recycle Bin status tags: - File /files/rename: post: consumes: - application/json - description: 修改文件名称 parameters: - description: request in: body @@ -9736,7 +9601,6 @@ paths: post: consumes: - application/json - description: 更新文件内容 parameters: - description: request in: body @@ -9763,7 +9627,6 @@ paths: post: consumes: - application/json - description: 获取文件列表 parameters: - description: request in: body @@ -9785,7 +9648,6 @@ paths: post: consumes: - application/json - description: 获取文件夹大小 parameters: - description: request in: body @@ -9812,7 +9674,6 @@ paths: post: consumes: - application/json - description: 加载文件树 parameters: - description: request in: body @@ -9834,7 +9695,6 @@ paths: - File /files/upload: post: - description: 上传文件 parameters: - description: request in: formData @@ -9860,7 +9720,6 @@ paths: post: consumes: - application/json - description: 分页获取上传文件 parameters: - description: request in: body @@ -9884,7 +9743,6 @@ paths: post: consumes: - application/json - description: 下载远端文件 parameters: - description: request in: body @@ -9913,7 +9771,6 @@ paths: post: consumes: - application/json - description: 创建系统组 parameters: - description: request in: body @@ -9926,7 +9783,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Create system group tags: - System Group x-panel-log: @@ -9941,7 +9798,6 @@ paths: post: consumes: - application/json - description: 删除系统组 parameters: - description: request in: body @@ -9954,7 +9810,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Delete group + summary: Delete system group tags: - System Group x-panel-log: @@ -9980,7 +9836,6 @@ paths: post: consumes: - application/json - description: 查询系统组 parameters: - description: request in: body @@ -9997,14 +9852,13 @@ paths: type: array security: - ApiKeyAuth: [] - summary: List groups + summary: List system groups tags: - System Group /groups/update: post: consumes: - application/json - description: 更新系统组 parameters: - description: request in: body @@ -10017,7 +9871,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Update group + summary: Update system group tags: - System Group x-panel-log: @@ -10032,7 +9886,6 @@ paths: post: consumes: - application/json - description: 上传文件更新 SSH 配置 parameters: - description: request in: body @@ -10056,7 +9909,6 @@ paths: paramKeys: [] /host/ssh/conf: get: - description: 获取 SSH 配置文件 responses: "200": description: OK @@ -10069,7 +9921,6 @@ paths: post: consumes: - application/json - description: 生成 SSH 密钥 parameters: - description: request in: body @@ -10095,7 +9946,6 @@ paths: post: consumes: - application/json - description: 获取 SSH 登录日志 parameters: - description: request in: body @@ -10117,7 +9967,6 @@ paths: post: consumes: - application/json - description: 修改 SSH 服务状态 parameters: - description: request in: body @@ -10140,7 +9989,6 @@ paths: paramKeys: [] /host/ssh/search: post: - description: 加载 SSH 配置信息 responses: "200": description: OK @@ -10155,7 +10003,6 @@ paths: post: consumes: - application/json - description: 获取 SSH 密钥 parameters: - description: request in: body @@ -10175,7 +10022,6 @@ paths: post: consumes: - application/json - description: 更新 SSH 配置 parameters: - description: request in: body @@ -10203,7 +10049,6 @@ paths: post: consumes: - application/json - description: 获取主机工具状态 parameters: - description: request in: body @@ -10216,14 +10061,13 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Get tool + summary: Get tool status tags: - Host tool /host/tool/config: post: consumes: - application/json - description: 操作主机工具配置文件 parameters: - description: request in: body @@ -10250,7 +10094,6 @@ paths: post: consumes: - application/json - description: 创建主机工具配置 parameters: - description: request in: body @@ -10277,7 +10120,6 @@ paths: post: consumes: - application/json - description: 获取主机工具日志 parameters: - description: request in: body @@ -10290,14 +10132,13 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Get tool + summary: Get tool logs tags: - Host tool /host/tool/operate: post: consumes: - application/json - description: 操作主机工具 parameters: - description: request in: body @@ -10325,7 +10166,6 @@ paths: get: consumes: - application/json - description: 获取 Supervisor 进程配置 responses: "200": description: OK @@ -10337,7 +10177,6 @@ paths: post: consumes: - application/json - description: 操作守护进程 parameters: - description: request in: body @@ -10364,7 +10203,6 @@ paths: post: consumes: - application/json - description: 操作 Supervisor 进程文件 parameters: - description: request in: body @@ -10391,7 +10229,6 @@ paths: post: consumes: - application/json - description: 创建主机 parameters: - description: request in: body @@ -10417,7 +10254,6 @@ paths: paramKeys: [] /hosts/command: get: - description: 获取快速命令列表 responses: "200": description: OK @@ -10431,7 +10267,6 @@ paths: post: consumes: - application/json - description: 创建快速命令 parameters: - description: request in: body @@ -10459,7 +10294,6 @@ paths: post: consumes: - application/json - description: 删除快速命令 parameters: - description: request in: body @@ -10490,7 +10324,6 @@ paths: paramKeys: [] /hosts/command/redis: get: - description: 获取 redis 快速命令列表 responses: "200": description: OK @@ -10504,7 +10337,6 @@ paths: post: consumes: - application/json - description: 保存 Redis 快速命令 parameters: - description: request in: body @@ -10532,7 +10364,6 @@ paths: post: consumes: - application/json - description: 删除 redis 快速命令 parameters: - description: request in: body @@ -10565,7 +10396,6 @@ paths: post: consumes: - application/json - description: 获取 redis 快速命令列表分页 parameters: - description: request in: body @@ -10587,7 +10417,6 @@ paths: post: consumes: - application/json - description: 获取快速命令列表分页 parameters: - description: request in: body @@ -10609,7 +10438,6 @@ paths: get: consumes: - application/json - description: 获取快速命令树 responses: "200": description: OK @@ -10624,7 +10452,6 @@ paths: post: consumes: - application/json - description: 更新快速命令 parameters: - description: request in: body @@ -10651,7 +10478,6 @@ paths: post: consumes: - application/json - description: 删除主机 parameters: - description: request in: body @@ -10682,7 +10508,6 @@ paths: paramKeys: [] /hosts/firewall/base: get: - description: 获取防火墙基础信息 responses: "200": description: OK @@ -10697,7 +10522,6 @@ paths: post: consumes: - application/json - description: 批量删除防火墙规则 parameters: - description: request in: body @@ -10710,14 +10534,13 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Batch create group tags: - Firewall /hosts/firewall/forward: post: consumes: - application/json - description: 更新防火墙端口转发规则 parameters: - description: request in: body @@ -10730,7 +10553,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Update firewall port group tags: - Firewall x-panel-log: @@ -10744,7 +10567,6 @@ paths: post: consumes: - application/json - description: 创建防火墙 IP 规则 parameters: - description: request in: body @@ -10757,7 +10579,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Create firewall group tags: - Firewall x-panel-log: @@ -10772,7 +10594,6 @@ paths: post: consumes: - application/json - description: 修改防火墙状态 parameters: - description: request in: body @@ -10801,7 +10622,6 @@ paths: post: consumes: - application/json - description: 创建防火墙端口规则 parameters: - description: request in: body @@ -10814,7 +10634,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Create firewall port group tags: - Firewall x-panel-log: @@ -10829,7 +10649,6 @@ paths: post: consumes: - application/json - description: 获取防火墙规则列表分页 parameters: - description: request in: body @@ -10851,7 +10670,6 @@ paths: post: consumes: - application/json - description: 更新 ip 防火墙规则 parameters: - description: request in: body @@ -10864,14 +10682,13 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Uodate address group tags: - Firewall /hosts/firewall/update/description: post: consumes: - application/json - description: 更新防火墙描述 parameters: - description: request in: body @@ -10891,7 +10708,6 @@ paths: post: consumes: - application/json - description: 更新端口防火墙规则 parameters: - description: request in: body @@ -10904,12 +10720,11 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Create group + summary: Update firewall group tags: - Firewall /hosts/monitor/clean: post: - description: 清空监控数据 responses: "200": description: OK @@ -10926,7 +10741,6 @@ paths: paramKeys: [] /hosts/monitor/search: post: - description: 获取监控数据 parameters: - description: request in: body @@ -10946,7 +10760,6 @@ paths: post: consumes: - application/json - description: 获取主机列表分页 parameters: - description: request in: body @@ -10970,7 +10783,6 @@ paths: post: consumes: - application/json - description: 测试主机连接 parameters: - description: request in: path @@ -10991,7 +10803,6 @@ paths: post: consumes: - application/json - description: 测试主机连接 parameters: - description: request in: body @@ -11011,7 +10822,6 @@ paths: post: consumes: - application/json - description: 加载主机树 parameters: - description: request in: body @@ -11035,7 +10845,6 @@ paths: post: consumes: - application/json - description: 更新主机 parameters: - description: request in: body @@ -11063,7 +10872,6 @@ paths: post: consumes: - application/json - description: 切换分组 parameters: - description: request in: body @@ -11097,7 +10905,6 @@ paths: post: consumes: - application/json - description: 清空操作日志 parameters: - description: request in: body @@ -11126,7 +10933,6 @@ paths: post: consumes: - application/json - description: 获取系统登录日志列表分页 parameters: - description: request in: body @@ -11148,7 +10954,6 @@ paths: post: consumes: - application/json - description: 获取系统操作日志列表分页 parameters: - description: request in: body @@ -11168,7 +10973,6 @@ paths: - Logs /logs/system: post: - description: 获取系统日志 responses: "200": description: OK @@ -11179,7 +10983,6 @@ paths: - Logs /logs/system/files: get: - description: 获取系统日志文件列表 responses: "200": description: OK @@ -11190,7 +10993,6 @@ paths: - Logs /openresty: get: - description: 获取 OpenResty 配置信息 responses: "200": description: OK @@ -11203,7 +11005,6 @@ paths: - OpenResty /openresty/clear: post: - description: 清理 OpenResty 代理缓存 responses: "200": description: OK @@ -11222,7 +11023,6 @@ paths: post: consumes: - application/json - description: 上传更新 OpenResty 配置文件 parameters: - description: request in: body @@ -11248,7 +11048,6 @@ paths: post: consumes: - application/json - description: 获取部分 OpenResty 配置信息 parameters: - description: request in: body @@ -11270,7 +11069,6 @@ paths: - OpenResty /openresty/status: get: - description: 获取 OpenResty 状态信息 responses: "200": description: OK @@ -11285,7 +11083,6 @@ paths: post: consumes: - application/json - description: 更新 OpenResty 配置信息 parameters: - description: request in: body @@ -11316,7 +11113,6 @@ paths: paramKeys: [] /process/stop: post: - description: 停止进程 parameters: - description: request in: body @@ -11343,7 +11139,6 @@ paths: post: consumes: - application/json - description: 创建运行环境 parameters: - description: request in: body @@ -11370,7 +11165,6 @@ paths: get: consumes: - application/json - description: 获取运行环境 parameters: - description: request in: path @@ -11389,7 +11183,6 @@ paths: post: consumes: - application/json - description: 删除运行环境 parameters: - description: request in: body @@ -11416,7 +11209,6 @@ paths: post: consumes: - application/json - description: 获取 Node 项目的 modules parameters: - description: request in: body @@ -11436,7 +11228,6 @@ paths: post: consumes: - application/json - description: 操作 Node 项目 modules parameters: - description: request in: body @@ -11456,7 +11247,6 @@ paths: post: consumes: - application/json - description: 获取 Node 项目的 scripts parameters: - description: request in: body @@ -11476,7 +11266,6 @@ paths: post: consumes: - application/json - description: 操作运行环境 parameters: - description: request in: body @@ -11503,7 +11292,6 @@ paths: post: consumes: - application/json - description: Create Extensions parameters: - description: request in: body @@ -11523,7 +11311,6 @@ paths: post: consumes: - application/json - description: Delete Extensions parameters: - description: request in: body @@ -11543,7 +11330,6 @@ paths: post: consumes: - application/json - description: Page Extensions parameters: - description: request in: body @@ -11567,7 +11353,6 @@ paths: post: consumes: - application/json - description: Update Extensions parameters: - description: request in: body @@ -11587,7 +11372,6 @@ paths: post: consumes: - application/json - description: 获取运行环境列表 parameters: - description: request in: body @@ -11607,7 +11391,6 @@ paths: post: consumes: - application/json - description: 同步运行环境状态 responses: "200": description: OK @@ -11620,7 +11403,6 @@ paths: post: consumes: - application/json - description: 更新运行环境 parameters: - description: request in: body @@ -11647,13 +11429,12 @@ paths: post: consumes: - application/json - description: 生成 API 接口密钥 responses: "200": description: OK security: - ApiKeyAuth: [] - summary: generate api key + summary: Generate api key tags: - System Setting x-panel-log: @@ -11666,7 +11447,6 @@ paths: post: consumes: - application/json - description: 更新 API 接口配置 parameters: - description: request in: body @@ -11693,7 +11473,6 @@ paths: post: consumes: - application/json - description: 创建备份账号 parameters: - description: request in: body @@ -11720,7 +11499,6 @@ paths: post: consumes: - application/json - description: 备份系统数据 parameters: - description: request in: body @@ -11749,7 +11527,6 @@ paths: post: consumes: - application/json - description: 删除备份账号 parameters: - description: request in: body @@ -11782,7 +11559,6 @@ paths: get: consumes: - application/json - description: 获取 OneDrive 信息 responses: "200": description: OK @@ -11797,7 +11573,6 @@ paths: post: consumes: - application/json - description: 删除备份记录 parameters: - description: request in: body @@ -11830,7 +11605,6 @@ paths: post: consumes: - application/json - description: 下载备份记录 parameters: - description: request in: body @@ -11858,7 +11632,6 @@ paths: post: consumes: - application/json - description: 获取备份记录列表分页 parameters: - description: request in: body @@ -11878,7 +11651,6 @@ paths: post: consumes: - application/json - description: 通过计划任务获取备份记录列表分页 parameters: - description: request in: body @@ -11898,7 +11670,6 @@ paths: post: consumes: - application/json - description: 恢复系统数据 parameters: - description: request in: body @@ -11928,7 +11699,6 @@ paths: post: consumes: - application/json - description: 从上传恢复系统数据 parameters: - description: request in: body @@ -11956,7 +11726,6 @@ paths: paramKeys: [] /settings/backup/refresh/onedrive: post: - description: 刷新 OneDrive token responses: "200": description: OK @@ -11967,7 +11736,6 @@ paths: - Backup Account /settings/backup/search: get: - description: 获取备份账号列表 responses: "200": description: OK @@ -11983,7 +11751,6 @@ paths: post: consumes: - application/json - description: 获取 bucket 列表 parameters: - description: request in: body @@ -12007,7 +11774,6 @@ paths: post: consumes: - application/json - description: 获取备份账号内文件列表 parameters: - description: request in: body @@ -12031,7 +11797,6 @@ paths: post: consumes: - application/json - description: 更新备份账号信息 parameters: - description: request in: body @@ -12056,7 +11821,6 @@ paths: paramKeys: [] /settings/basedir: get: - description: 获取安装根目录 responses: "200": description: OK @@ -12064,14 +11828,13 @@ paths: type: string security: - ApiKeyAuth: [] - summary: Load local backup dir + summary: Load local base dir tags: - System Setting /settings/bind/update: post: consumes: - application/json - description: 更新系统监听信息 parameters: - description: request in: body @@ -12099,7 +11862,6 @@ paths: post: consumes: - application/json - description: 重置过期系统登录密码 parameters: - description: request in: body @@ -12125,7 +11887,6 @@ paths: get: consumes: - application/json - description: 获取系统地址信息 responses: "200": description: OK @@ -12138,7 +11899,6 @@ paths: post: consumes: - application/json - description: 隐藏高级功能菜单 parameters: - description: request in: body @@ -12164,7 +11924,6 @@ paths: post: consumes: - application/json - description: 获取 mfa 信息 parameters: - description: request in: body @@ -12186,7 +11945,6 @@ paths: post: consumes: - application/json - description: Mfa 绑定 parameters: - description: request in: body @@ -12212,7 +11970,6 @@ paths: post: consumes: - application/json - description: 更新系统登录密码 parameters: - description: request in: body @@ -12238,7 +11995,6 @@ paths: post: consumes: - application/json - description: 更新系统端口 parameters: - description: request in: body @@ -12265,7 +12021,6 @@ paths: post: consumes: - application/json - description: 服务器代理配置 parameters: - description: request in: body @@ -12291,7 +12046,6 @@ paths: paramKeys: [] /settings/search: post: - description: 加载系统配置信息 responses: "200": description: OK @@ -12304,7 +12058,6 @@ paths: - System Setting /settings/search/available: get: - description: 获取系统可用状态 responses: "200": description: OK @@ -12317,7 +12070,6 @@ paths: post: consumes: - application/json - description: 创建系统快照 parameters: - description: request in: body @@ -12345,7 +12097,6 @@ paths: post: consumes: - application/json - description: 删除系统快照 parameters: - description: request in: body @@ -12378,7 +12129,6 @@ paths: post: consumes: - application/json - description: 更新快照描述信息 parameters: - description: request in: body @@ -12412,7 +12162,6 @@ paths: post: consumes: - application/json - description: 导入已有快照 parameters: - description: request in: body @@ -12440,7 +12189,6 @@ paths: post: consumes: - application/json - description: 从系统快照恢复 parameters: - description: request in: body @@ -12473,7 +12221,6 @@ paths: post: consumes: - application/json - description: 从系统快照回滚 parameters: - description: request in: body @@ -12506,7 +12253,6 @@ paths: post: consumes: - application/json - description: 获取系统快照列表分页 parameters: - description: request in: body @@ -12528,7 +12274,6 @@ paths: post: consumes: - application/json - description: 获取系统快照大小 parameters: - description: request in: body @@ -12548,7 +12293,6 @@ paths: post: consumes: - application/json - description: 获取快照状态 parameters: - description: request in: body @@ -12566,7 +12310,6 @@ paths: - System Setting /settings/ssl/download: post: - description: 下载证书 responses: "200": description: OK @@ -12577,7 +12320,6 @@ paths: - System Setting /settings/ssl/info: get: - description: 获取证书信息 responses: "200": description: OK @@ -12592,7 +12334,6 @@ paths: post: consumes: - application/json - description: 修改系统 ssl 登录 parameters: - description: request in: body @@ -12619,7 +12360,6 @@ paths: post: consumes: - application/json - description: 更新系统配置 parameters: - description: request in: body @@ -12647,7 +12387,6 @@ paths: get: consumes: - application/json - description: 获取版本 release notes parameters: - description: request in: body @@ -12666,7 +12405,6 @@ paths: post: consumes: - application/json - description: 系统更新 parameters: - description: request in: body @@ -12693,7 +12431,6 @@ paths: post: consumes: - application/json - description: 创建扫描规则 parameters: - description: request in: body @@ -12721,7 +12458,6 @@ paths: get: consumes: - application/json - description: 获取 Clam 基础信息 responses: "200": description: OK @@ -12736,7 +12472,6 @@ paths: post: consumes: - application/json - description: 删除扫描规则 parameters: - description: request in: body @@ -12769,7 +12504,6 @@ paths: post: consumes: - application/json - description: 获取扫描文件 parameters: - description: request in: body @@ -12791,7 +12525,6 @@ paths: post: consumes: - application/json - description: 更新病毒扫描配置文件 parameters: - description: request in: body @@ -12811,7 +12544,6 @@ paths: post: consumes: - application/json - description: 执行病毒扫描 parameters: - description: request in: body @@ -12844,7 +12576,6 @@ paths: post: consumes: - application/json - description: 修改 Clam 状态 parameters: - description: request in: body @@ -12869,7 +12600,6 @@ paths: post: consumes: - application/json - description: 清空扫描报告 parameters: - description: request in: body @@ -12900,7 +12630,6 @@ paths: post: consumes: - application/json - description: 获取扫描结果详情 parameters: - description: request in: body @@ -12920,7 +12649,6 @@ paths: post: consumes: - application/json - description: 获取扫描结果列表分页 parameters: - description: request in: body @@ -12942,7 +12670,6 @@ paths: post: consumes: - application/json - description: 获取扫描规则列表分页 parameters: - description: request in: body @@ -12964,7 +12691,6 @@ paths: post: consumes: - application/json - description: 修改扫描规则状态 parameters: - description: request in: body @@ -12998,7 +12724,6 @@ paths: post: consumes: - application/json - description: 修改扫描规则 parameters: - description: request in: body @@ -13026,7 +12751,6 @@ paths: post: consumes: - application/json - description: 清理系统垃圾文件 parameters: - description: request in: body @@ -13052,7 +12776,6 @@ paths: paramKeys: [] /toolbox/device/base: post: - description: 获取设备基础信息 responses: "200": description: OK @@ -13067,7 +12790,6 @@ paths: post: consumes: - application/json - description: 检查系统 DNS 配置可用性 parameters: - description: request in: body @@ -13087,7 +12809,6 @@ paths: post: consumes: - application/json - description: 获取系统配置文件 parameters: - description: request in: body @@ -13107,7 +12828,6 @@ paths: post: consumes: - application/json - description: 通过文件修改配置 parameters: - description: request in: body @@ -13127,7 +12847,6 @@ paths: post: consumes: - application/json - description: 修改系统参数 parameters: - description: request in: body @@ -13153,7 +12872,6 @@ paths: paramKeys: [] /toolbox/device/update/host: post: - description: 修改系统 hosts responses: "200": description: OK @@ -13174,7 +12892,6 @@ paths: post: consumes: - application/json - description: 修改系统密码 parameters: - description: request in: body @@ -13194,7 +12911,6 @@ paths: post: consumes: - application/json - description: 修改系统 Swap parameters: - description: request in: body @@ -13222,7 +12938,6 @@ paths: get: consumes: - application/json - description: 获取系统可用时区选项 responses: "200": description: OK @@ -13235,7 +12950,6 @@ paths: - Device /toolbox/fail2ban/base: get: - description: 获取 Fail2ban 基础信息 responses: "200": description: OK @@ -13250,7 +12964,6 @@ paths: get: consumes: - application/json - description: 获取 fail2ban 配置文件 responses: "200": description: OK @@ -13263,7 +12976,6 @@ paths: post: consumes: - application/json - description: 修改 Fail2ban 状态 parameters: - description: request in: body @@ -13288,7 +13000,6 @@ paths: post: consumes: - application/json - description: 配置 sshd parameters: - description: request in: body @@ -13306,7 +13017,6 @@ paths: post: consumes: - application/json - description: 获取 Fail2ban ip parameters: - description: request in: body @@ -13328,7 +13038,6 @@ paths: post: consumes: - application/json - description: 修改 Fail2ban 配置 parameters: - description: request in: body @@ -13356,7 +13065,6 @@ paths: post: consumes: - application/json - description: 通过文件修改 fail2ban 配置 parameters: - description: request in: body @@ -13376,7 +13084,6 @@ paths: post: consumes: - application/json - description: 创建 FTP 账户 parameters: - description: request in: body @@ -13402,7 +13109,6 @@ paths: paramKeys: [] /toolbox/ftp/base: get: - description: 获取 FTP 基础信息 responses: "200": description: OK @@ -13417,7 +13123,6 @@ paths: post: consumes: - application/json - description: 删除 FTP 账户 parameters: - description: request in: body @@ -13450,7 +13155,6 @@ paths: post: consumes: - application/json - description: 获取 FTP 操作日志 parameters: - description: request in: body @@ -13472,7 +13176,6 @@ paths: post: consumes: - application/json - description: 修改 FTP 状态 parameters: - description: request in: body @@ -13497,7 +13200,6 @@ paths: post: consumes: - application/json - description: 获取 FTP 账户列表分页 parameters: - description: request in: body @@ -13519,7 +13221,6 @@ paths: post: consumes: - application/json - description: 同步 FTP 账户 parameters: - description: request in: body @@ -13545,7 +13246,6 @@ paths: post: consumes: - application/json - description: 修改 FTP 账户 parameters: - description: request in: body @@ -13571,7 +13271,6 @@ paths: paramKeys: [] /toolbox/scan: post: - description: 扫描系统垃圾文件 responses: "200": description: OK @@ -13590,7 +13289,6 @@ paths: post: consumes: - application/json - description: 创建网站 parameters: - description: request in: body @@ -13617,7 +13315,6 @@ paths: get: consumes: - application/json - description: 通过 id 查询网站 parameters: - description: request in: path @@ -13638,7 +13335,6 @@ paths: get: consumes: - application/json - description: 通过 id 查询网站 nginx parameters: - description: request in: path @@ -13659,7 +13355,6 @@ paths: get: consumes: - application/json - description: 获取 https 配置 parameters: - description: request in: path @@ -13679,7 +13374,6 @@ paths: post: consumes: - application/json - description: 更新 https 配置 parameters: - description: request in: body @@ -13714,7 +13408,6 @@ paths: post: consumes: - application/json - description: 创建网站 acme parameters: - description: request in: body @@ -13743,7 +13436,6 @@ paths: post: consumes: - application/json - description: 删除网站 acme parameters: - description: request in: body @@ -13776,7 +13468,6 @@ paths: post: consumes: - application/json - description: 获取网站 acme 列表分页 parameters: - description: request in: body @@ -13798,7 +13489,6 @@ paths: post: consumes: - application/json - description: 获取密码访问配置 parameters: - description: request in: body @@ -13818,7 +13508,6 @@ paths: post: consumes: - application/json - description: 更新密码访问配置 parameters: - description: request in: body @@ -13838,7 +13527,6 @@ paths: post: consumes: - application/json - description: 创建网站 ca parameters: - description: request in: body @@ -13867,7 +13555,6 @@ paths: get: consumes: - application/json - description: 获取网站 ca parameters: - description: id in: path @@ -13888,7 +13575,6 @@ paths: post: consumes: - application/json - description: 删除网站 ca parameters: - description: request in: body @@ -13921,7 +13607,6 @@ paths: post: consumes: - application/json - description: 下载 CA 证书文件 parameters: - description: request in: body @@ -13954,7 +13639,6 @@ paths: post: consumes: - application/json - description: 自签 SSL 证书 parameters: - description: request in: body @@ -13987,7 +13671,6 @@ paths: post: consumes: - application/json - description: 续签 SSL 证书 parameters: - description: request in: body @@ -14000,7 +13683,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Obtain SSL + summary: Renew Obtain SSL tags: - Website CA x-panel-log: @@ -14020,7 +13703,6 @@ paths: post: consumes: - application/json - description: 获取网站 ca 列表分页 parameters: - description: request in: body @@ -14042,7 +13724,6 @@ paths: post: consumes: - application/json - description: 网站创建前检查 parameters: - description: request in: body @@ -14066,7 +13747,6 @@ paths: post: consumes: - application/json - description: 获取 nginx 配置 parameters: - description: request in: body @@ -14088,7 +13768,6 @@ paths: post: consumes: - application/json - description: 更新 nginx 配置 parameters: - description: request in: body @@ -14121,7 +13800,6 @@ paths: get: consumes: - application/json - description: 获取默认 html responses: "200": description: OK @@ -14136,7 +13814,6 @@ paths: post: consumes: - application/json - description: 更新默认 html parameters: - description: request in: body @@ -14163,7 +13840,6 @@ paths: post: consumes: - application/json - description: 操作网站日志 parameters: - description: request in: body @@ -14197,7 +13873,6 @@ paths: post: consumes: - application/json - description: 删除网站 parameters: - description: request in: body @@ -14230,7 +13905,6 @@ paths: post: consumes: - application/json - description: 获取网站目录配置 parameters: - description: request in: body @@ -14250,7 +13924,6 @@ paths: post: consumes: - application/json - description: 更新网站目录权限 parameters: - description: request in: body @@ -14283,7 +13956,6 @@ paths: post: consumes: - application/json - description: 更新网站目录 parameters: - description: request in: body @@ -14316,7 +13988,6 @@ paths: post: consumes: - application/json - description: 创建网站 dns parameters: - description: request in: body @@ -14343,7 +14014,6 @@ paths: post: consumes: - application/json - description: 删除网站 dns parameters: - description: request in: body @@ -14376,7 +14046,6 @@ paths: post: consumes: - application/json - description: 获取网站 dns 列表分页 parameters: - description: request in: body @@ -14398,7 +14067,6 @@ paths: post: consumes: - application/json - description: 更新网站 dns parameters: - description: request in: body @@ -14425,7 +14093,6 @@ paths: post: consumes: - application/json - description: 创建网站域名 parameters: - description: request in: body @@ -14454,7 +14121,6 @@ paths: get: consumes: - application/json - description: 通过网站 id 查询域名 parameters: - description: request in: path @@ -14477,7 +14143,6 @@ paths: post: consumes: - application/json - description: 删除网站域名 parameters: - description: request in: body @@ -14510,7 +14175,6 @@ paths: post: consumes: - application/json - description: 获取防盗链配置 parameters: - description: request in: body @@ -14530,7 +14194,6 @@ paths: post: consumes: - application/json - description: 更新防盗链配置 parameters: - description: request in: body @@ -14543,12 +14206,11 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Update AntiLeech + summary: Update AntiLeech conf tags: - Website /websites/list: get: - description: 获取网站列表 responses: "200": description: OK @@ -14565,7 +14227,6 @@ paths: post: consumes: - application/json - description: 操作网站日志 parameters: - description: request in: body @@ -14601,7 +14262,6 @@ paths: post: consumes: - application/json - description: 更新 网站 nginx 配置 parameters: - description: request in: body @@ -14634,7 +14294,6 @@ paths: post: consumes: - application/json - description: 操作网站 parameters: - description: request in: body @@ -14666,7 +14325,6 @@ paths: paramKeys: [] /websites/options: get: - description: 获取网站列表 responses: "200": description: OK @@ -14683,7 +14341,6 @@ paths: post: consumes: - application/json - description: 更新 网站 PHP 配置 parameters: - description: request in: body @@ -14716,7 +14373,6 @@ paths: get: consumes: - application/json - description: 获取网站 php 配置 parameters: - description: request in: path @@ -14737,7 +14393,6 @@ paths: post: consumes: - application/json - description: 更新 php 配置文件 parameters: - description: request in: body @@ -14770,7 +14425,6 @@ paths: post: consumes: - application/json - description: 变更 php 版本 parameters: - description: request in: body @@ -14803,7 +14457,6 @@ paths: post: consumes: - application/json - description: 获取反向代理配置 parameters: - description: request in: body @@ -14823,7 +14476,6 @@ paths: post: consumes: - application/json - description: 修改反向代理配置 parameters: - description: request in: body @@ -14856,7 +14508,6 @@ paths: post: consumes: - application/json - description: 更新反向代理文件 parameters: - description: request in: body @@ -14889,7 +14540,6 @@ paths: post: consumes: - application/json - description: 获取重定向配置 parameters: - description: request in: body @@ -14909,7 +14559,6 @@ paths: post: consumes: - application/json - description: 更新重定向文件 parameters: - description: request in: body @@ -14942,7 +14591,6 @@ paths: post: consumes: - application/json - description: 修改重定向配置 parameters: - description: request in: body @@ -14975,7 +14623,6 @@ paths: post: consumes: - application/json - description: 获取伪静态配置 parameters: - description: request in: body @@ -14995,7 +14642,6 @@ paths: post: consumes: - application/json - description: 更新伪静态配置 parameters: - description: request in: body @@ -15028,7 +14674,6 @@ paths: post: consumes: - application/json - description: 获取网站列表分页 parameters: - description: request in: body @@ -15050,7 +14695,6 @@ paths: post: consumes: - application/json - description: 创建网站 ssl parameters: - description: request in: body @@ -15079,7 +14723,6 @@ paths: get: consumes: - application/json - description: 通过 id 查询 ssl parameters: - description: request in: path @@ -15098,7 +14741,6 @@ paths: post: consumes: - application/json - description: 删除网站 ssl parameters: - description: request in: body @@ -15131,7 +14773,6 @@ paths: post: consumes: - application/json - description: 下载证书文件 parameters: - description: request in: body @@ -15144,7 +14785,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Download SSL file + summary: Download SSL file tags: - Website SSL x-panel-log: @@ -15164,7 +14805,6 @@ paths: post: consumes: - application/json - description: 申请证书 parameters: - description: request in: body @@ -15197,7 +14837,6 @@ paths: post: consumes: - application/json - description: 解析网站 ssl parameters: - description: request in: body @@ -15221,7 +14860,6 @@ paths: post: consumes: - application/json - description: 获取网站 ssl 列表分页 parameters: - description: request in: body @@ -15241,7 +14879,6 @@ paths: post: consumes: - application/json - description: 更新 ssl parameters: - description: request in: body @@ -15254,7 +14891,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Update ssl + summary: Update Website ssl tags: - Website SSL x-panel-log: @@ -15274,7 +14911,6 @@ paths: post: consumes: - application/json - description: 上传 ssl parameters: - description: request in: body @@ -15287,7 +14923,7 @@ paths: description: OK security: - ApiKeyAuth: [] - summary: Upload ssl + summary: Upload Website ssl tags: - Website SSL x-panel-log: @@ -15301,7 +14937,6 @@ paths: get: consumes: - application/json - description: 通过网站 id 查询 ssl parameters: - description: request in: path @@ -15320,7 +14955,6 @@ paths: post: consumes: - application/json - description: 更新网站 parameters: - description: request in: body @@ -15349,19 +14983,20 @@ schemes: securityDefinitions: CustomToken: description: |- - 自定义 Token 格式,格式:md5('1panel' + 1Panel-Token + 1Panel-Timestamp)。 + Custom Token Format, Format: md5('1panel' + 1Panel-Token + 1Panel-Timestamp). ``` - 示例请求头: + eg: curl -X GET "http://localhost:4004/api/v1/resource" \ -H "1Panel-Token: <1panel_token>" \ -H "1Panel-Timestamp: " ``` - - `1Panel-Token` 为面板 API 接口密钥。 + - `1Panel-Token` is the key for the panel API interface. in: Header name: 1Panel-Token type: apiKey Timestamp: - description: '- `1Panel-Timestamp` 为当前时间的 Unix 时间戳(单位:秒)。' + description: '- `1Panel-Timestamp` is the Unix timestamp of the current time in + seconds.' in: header name: 1Panel-Timestamp type: apiKey diff --git a/cmd/server/main.go b/cmd/server/main.go index fe326d7f5..c0251c090 100644 --- a/cmd/server/main.go +++ b/cmd/server/main.go @@ -11,7 +11,7 @@ import ( // @title 1Panel // @version 1.0 -// @description 开源Linux面板 +// @description Open Source Linux Panel // @termsOfService http://swagger.io/terms/ // @license.name Apache 2.0 // @license.url http://www.apache.org/licenses/LICENSE-2.0.html @@ -19,14 +19,14 @@ import ( // @schemes http https // @securityDefinitions.apikey CustomToken -// @description 自定义 Token 格式,格式:md5('1panel' + 1Panel-Token + 1Panel-Timestamp)。 +// @description Custom Token Format, Format: md5('1panel' + 1Panel-Token + 1Panel-Timestamp). // @description ``` -// @description 示例请求头: +// @description eg: // @description curl -X GET "http://localhost:4004/api/v1/resource" \ // @description -H "1Panel-Token: <1panel_token>" \ // @description -H "1Panel-Timestamp: " // @description ``` -// @description - `1Panel-Token` 为面板 API 接口密钥。 +// @description - `1Panel-Token` is the key for the panel API interface. // @type apiKey // @in Header // @name 1Panel-Token @@ -34,7 +34,7 @@ import ( // @type apiKey // @in header // @name 1Panel-Timestamp -// @description - `1Panel-Timestamp` 为当前时间的 Unix 时间戳(单位:秒)。 +// @description - `1Panel-Timestamp` is the Unix timestamp of the current time in seconds. //go:generate swag init -o ./docs -g main.go -d ../../backend -g ../cmd/server/main.go func main() {