gh_mirrors/1Panel
1
0
Fork 0
mirror of https://github.com/1Panel-dev/1Panel.git synced 2025-01-19 00:09:16 +08:00
Code

fix: Fix missing response types in Swagger API endpoints (#7611)

Browse Source 
Refs #7607
This commit is contained in:
蘭 2024-12-31 17:57:55 +08:00 committed by GitHub
parent 9c376300ff
commit 5bc7bc6aac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
32 changed files with 3643 additions and 267 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
backend/app/api/v1/app.go
View File

@ -13,7 +13,7 @@ import (
// @Summary List apps // @Summary List apps
// @Accept json // @Accept json
// @Param request body request.AppSearch true "request" // @Param request body request.AppSearch true "request"
// @Success 200 // @Success 200 {object} response.AppRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /apps/search [post] // @Router /apps/search [post]
@ -183,7 +183,7 @@ func (b *BaseApi) GetAppTags(c *gin.Context) {
// @Tags App // @Tags App
// @Summary Get app list update // @Summary Get app list update
// @Success 200 // @Success 200 {object} response.AppUpdateRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /apps/checkupdate [get] // @Router /apps/checkupdate [get]

8
backend/app/api/v1/app_install.go
View File

@ -13,7 +13,7 @@ import (
// @Summary Page app installed // @Summary Page app installed
// @Accept json // @Accept json
// @Param request body request.AppInstalledSearch true "request" // @Param request body request.AppInstalledSearch true "request"
// @Success 200 // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /apps/installed/search [post] // @Router /apps/installed/search [post]
@ -45,7 +45,7 @@ func (b *BaseApi) SearchAppInstalled(c *gin.Context) {
// @Tags App // @Tags App
// @Summary List app installed // @Summary List app installed
// @Accept json // @Accept json
// @Success 200 array dto.AppInstallInfo // @Success 200 {array} dto.AppInstallInfo
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /apps/installed/list [get] // @Router /apps/installed/list [get]
@ -105,7 +105,7 @@ func (b *BaseApi) LoadPort(c *gin.Context) {
// @Accept json // @Accept json
// @Param request body dto.OperationWithNameAndType true "request" // @Param request body dto.OperationWithNameAndType true "request"
// @Param key path string true "key" // @Param key path string true "key"
// @Success 200 {string} response.DatabaseConn // @Success 200 {object} response.DatabaseConn
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /apps/installed/conninfo/{key} [get] // @Router /apps/installed/conninfo/{key} [get]
@ -266,7 +266,7 @@ func (b *BaseApi) GetDefaultConfig(c *gin.Context) {
// @Summary Search params by appInstallId // @Summary Search params by appInstallId
// @Accept json // @Accept json
// @Param appInstallId path string true "request" // @Param appInstallId path string true "request"
// @Success 200 {object} response.AppParam // @Success 200 {object} response.AppConfig
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /apps/installed/params/{appInstallId} [get] // @Router /apps/installed/params/{appInstallId} [get]

6
backend/app/api/v1/auth.go
View File

@ -119,7 +119,7 @@ func (b *BaseApi) GetResponsePage(c *gin.Context) {
// @Tags Auth // @Tags Auth
// @Summary Check System isDemo // @Summary Check System isDemo
// @Success 200 // @Success 200 {boolean} isDemo
// @Router /auth/demo [get] // @Router /auth/demo [get]
func (b *BaseApi) CheckIsDemo(c *gin.Context) { func (b *BaseApi) CheckIsDemo(c *gin.Context) {
helper.SuccessWithData(c, global.CONF.System.IsDemo) helper.SuccessWithData(c, global.CONF.System.IsDemo)
@ -127,7 +127,7 @@ func (b *BaseApi) CheckIsDemo(c *gin.Context) {
// @Tags Auth // @Tags Auth
// @Summary Check System isIntl // @Summary Check System isIntl
// @Success 200 // @Success 200 {boolean} isIntl
// @Router /auth/intl [get] // @Router /auth/intl [get]
func (b *BaseApi) CheckIsIntl(c *gin.Context) { func (b *BaseApi) CheckIsIntl(c *gin.Context) {
helper.SuccessWithData(c, global.CONF.System.IsIntl) helper.SuccessWithData(c, global.CONF.System.IsIntl)
@ -135,7 +135,7 @@ func (b *BaseApi) CheckIsIntl(c *gin.Context) {
// @Tags Auth // @Tags Auth
// @Summary Load System Language // @Summary Load System Language
// @Success 200 // @Success 200 {string} language
// @Router /auth/language [get] // @Router /auth/language [get]
func (b *BaseApi) GetLanguage(c *gin.Context) { func (b *BaseApi) GetLanguage(c *gin.Context) {
settingInfo, err := settingService.GetSettingInfo() settingInfo, err := settingService.GetSettingInfo()

8
backend/app/api/v1/backup.go
View File

@ -64,7 +64,7 @@ func (b *BaseApi) RefreshOneDriveToken(c *gin.Context) {
// @Summary List buckets // @Summary List buckets
// @Accept json // @Accept json
// @Param request body dto.ForBuckets true "request" // @Param request body dto.ForBuckets true "request"
// @Success 200 {array} string // @Success 200 {array} object
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/backup/search [post] // @Router /settings/backup/search [post]
@ -140,7 +140,7 @@ func (b *BaseApi) DeleteBackup(c *gin.Context) {
// @Summary Page backup records // @Summary Page backup records
// @Accept json // @Accept json
// @Param request body dto.RecordSearch true "request" // @Param request body dto.RecordSearch true "request"
// @Success 200 // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/backup/record/search [post] // @Router /settings/backup/record/search [post]
@ -166,7 +166,7 @@ func (b *BaseApi) SearchBackupRecords(c *gin.Context) {
// @Summary Page backup records by cronjob // @Summary Page backup records by cronjob
// @Accept json // @Accept json
// @Param request body dto.RecordSearchByCronjob true "request" // @Param request body dto.RecordSearchByCronjob true "request"
// @Success 200 // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/backup/record/search/bycronjob [post] // @Router /settings/backup/record/search/bycronjob [post]
@ -192,7 +192,7 @@ func (b *BaseApi) SearchBackupRecordsByCronjob(c *gin.Context) {
// @Summary Download backup record // @Summary Download backup record
// @Accept json // @Accept json
// @Param request body dto.DownloadRecord true "request" // @Param request body dto.DownloadRecord true "request"
// @Success 200 // @Success 200 {string} filePath
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/backup/record/download [post] // @Router /settings/backup/record/download [post]

4
backend/app/api/v1/clam.go
View File

@ -191,7 +191,7 @@ func (b *BaseApi) SearchClamRecord(c *gin.Context) {
// @Summary Load clam record detail // @Summary Load clam record detail
// @Accept json // @Accept json
// @Param request body dto.ClamLogReq true "request" // @Param request body dto.ClamLogReq true "request"
// @Success 200 // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /toolbox/clam/record/log [post] // @Router /toolbox/clam/record/log [post]
@ -214,7 +214,7 @@ func (b *BaseApi) LoadClamRecordLog(c *gin.Context) {
// @Summary Load clam file // @Summary Load clam file
// @Accept json // @Accept json
// @Param request body dto.ClamFileReq true "request" // @Param request body dto.ClamFileReq true "request"
// @Success 200 {object} dto.PageResult // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /toolbox/clam/file/search [post] // @Router /toolbox/clam/file/search [post]

8
backend/app/api/v1/container.go
View File

@ -41,7 +41,7 @@ func (b *BaseApi) SearchContainer(c *gin.Context) {
// @Summary List containers // @Summary List containers
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 // @Success 200 {array} string
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /containers/list [post] // @Router /containers/list [post]
@ -83,7 +83,7 @@ func (b *BaseApi) SearchCompose(c *gin.Context) {
// @Summary Test compose // @Summary Test compose
// @Accept json // @Accept json
// @Param request body dto.ComposeCreate true "request" // @Param request body dto.ComposeCreate true "request"
// @Success 200 // @Success 200 {boolean} isOK
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /containers/compose/test [post] // @Router /containers/compose/test [post]
@ -106,7 +106,7 @@ func (b *BaseApi) TestCompose(c *gin.Context) {
// @Summary Create compose // @Summary Create compose
// @Accept json // @Accept json
// @Param request body dto.ComposeCreate true "request" // @Param request body dto.ComposeCreate true "request"
// @Success 200 // @Success 200 {string} log
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /containers/compose [post] // @Router /containers/compose [post]
@ -312,7 +312,7 @@ func (b *BaseApi) CleanContainerLog(c *gin.Context) {
// @Summary Load container log // @Summary Load container log
// @Accept json // @Accept json
// @Param request body dto.OperationWithNameAndType true "request" // @Param request body dto.OperationWithNameAndType true "request"
// @Success 200 // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /containers/load/log [post] // @Router /containers/load/log [post]

2
backend/app/api/v1/cronjob.go
View File

@ -92,7 +92,7 @@ func (b *BaseApi) SearchJobRecords(c *gin.Context) {
// @Summary Load Cronjob record log // @Summary Load Cronjob record log
// @Accept json // @Accept json
// @Param request body dto.OperateByID true "request" // @Param request body dto.OperateByID true "request"
// @Success 200 // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /cronjobs/records/log [post] // @Router /cronjobs/records/log [post]

2
backend/app/api/v1/database.go
View File

@ -43,7 +43,7 @@ func (b *BaseApi) CreateDatabase(c *gin.Context) {
// @Summary Check database // @Summary Check database
// @Accept json // @Accept json
// @Param request body dto.DatabaseCreate true "request" // @Param request body dto.DatabaseCreate true "request"
// @Success 200 // @Success 200 {boolean} isOk
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /databases/db/check [post] // @Router /databases/db/check [post]

2
backend/app/api/v1/database_common.go
View File

@ -34,7 +34,7 @@ func (b *BaseApi) LoadDBBaseInfo(c *gin.Context) {
// @Summary Load Database conf // @Summary Load Database conf
// @Accept json // @Accept json
// @Param request body dto.OperationWithNameAndType true "request" // @Param request body dto.OperationWithNameAndType true "request"
// @Success 200 // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /databases/common/load/file [post] // @Router /databases/common/load/file [post]

6
backend/app/api/v1/device.go
View File

@ -46,7 +46,7 @@ func (b *BaseApi) LoadTimeOption(c *gin.Context) {
// @Summary load conf // @Summary load conf
// @Accept json // @Accept json
// @Param request body dto.OperationWithName true "request" // @Param request body dto.OperationWithName true "request"
// @Success 200 // @Success 200 {array} string
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /toolbox/device/conf [post] // @Router /toolbox/device/conf [post]
@ -185,7 +185,7 @@ func (b *BaseApi) UpdateDeviceSwap(c *gin.Context) {
// @Summary Check device DNS conf // @Summary Check device DNS conf
// @Accept json // @Accept json
// @Param request body dto.SettingUpdate true "request" // @Param request body dto.SettingUpdate true "request"
// @Success 200 // @Success 200 {boolean} data
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /toolbox/device/check/dns [post] // @Router /toolbox/device/check/dns [post]
@ -206,7 +206,7 @@ func (b *BaseApi) CheckDNS(c *gin.Context) {
// @Tags Device // @Tags Device
// @Summary Scan system // @Summary Scan system
// @Success 200 // @Success 200 {object} dto.CleanData
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /toolbox/scan [post] // @Router /toolbox/scan [post]

2
backend/app/api/v1/fail2ban.go
View File

@ -118,7 +118,7 @@ func (b *BaseApi) UpdateFail2BanConf(c *gin.Context) {
// @Tags Fail2ban // @Tags Fail2ban
// @Summary Load fail2ban conf // @Summary Load fail2ban conf
// @Accept json // @Accept json
// @Success 200 // @Success 200 {string} file
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /toolbox/fail2ban/load/conf [get] // @Router /toolbox/fail2ban/load/conf [get]

4
backend/app/api/v1/favorite.go
View File

@ -12,7 +12,7 @@ import (
// @Summary List favorites // @Summary List favorites
// @Accept json // @Accept json
// @Param request body dto.PageInfo true "request" // @Param request body dto.PageInfo true "request"
// @Success 200 // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/favorite/search [post] // @Router /files/favorite/search [post]
@ -36,7 +36,7 @@ func (b *BaseApi) SearchFavorite(c *gin.Context) {
// @Summary Create favorite // @Summary Create favorite
// @Accept json // @Accept json
// @Param request body request.FavoriteCreate true "request" // @Param request body request.FavoriteCreate true "request"
// @Success 200 // @Success 200 {object} model.Favorite
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/favorite [post] // @Router /files/favorite [post]

14
backend/app/api/v1/file.go
View File

@ -39,19 +39,19 @@ func (b *BaseApi) ListFiles(c *gin.Context) {
if err := helper.CheckBindAndValidate(&req, c); err != nil { if err := helper.CheckBindAndValidate(&req, c); err != nil {
return return
} }
files, err := fileService.GetFileList(req) fileList, err := fileService.GetFileList(req)
if err != nil { if err != nil {
helper.ErrorWithDetail(c, constant.CodeErrInternalServer, constant.ErrTypeInternalServer, err) helper.ErrorWithDetail(c, constant.CodeErrInternalServer, constant.ErrTypeInternalServer, err)
return return
} }
helper.SuccessWithData(c, files) helper.SuccessWithData(c, fileList)
} }
// @Tags File // @Tags File
// @Summary Page file // @Summary Page file
// @Accept json // @Accept json
// @Param request body request.SearchUploadWithPage true "request" // @Param request body request.SearchUploadWithPage true "request"
// @Success 200 {array} response.FileInfo // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/upload/search [post] // @Router /files/upload/search [post]
@ -401,7 +401,7 @@ func (b *BaseApi) UploadFiles(c *gin.Context) {
// @Summary Check file exist // @Summary Check file exist
// @Accept json // @Accept json
// @Param request body request.FilePathCheck true "request" // @Param request body request.FilePathCheck true "request"
// @Success 200 // @Success 200 {boolean} isOk
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/check [post] // @Router /files/check [post]
@ -442,7 +442,7 @@ func (b *BaseApi) ChangeFileName(c *gin.Context) {
// @Summary Wget file // @Summary Wget file
// @Accept json // @Accept json
// @Param request body request.FileWget true "request" // @Param request body request.FileWget true "request"
// @Success 200 // @Success 200 {object} response.FileWgetRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/wget [post] // @Router /files/wget [post]
@ -584,7 +584,7 @@ func (b *BaseApi) DownloadChunkFiles(c *gin.Context) {
// @Summary Load file size // @Summary Load file size
// @Accept json // @Accept json
// @Param request body request.DirSizeReq true "request" // @Param request body request.DirSizeReq true "request"
// @Success 200 // @Success 200 {object} response.DirSizeRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/size [post] // @Router /files/size [post]
@ -786,7 +786,7 @@ func (b *BaseApi) Keys(c *gin.Context) {
// @Tags File // @Tags File
// @Summary Read file by Line // @Summary Read file by Line
// @Param request body request.FileReadByLineReq true "request" // @Param request body request.FileReadByLineReq true "request"
// @Success 200 // @Success 200 {object} response.FileLineContent
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/read [post] // @Router /files/read [post]

2
backend/app/api/v1/firewall.go
View File

@ -53,7 +53,7 @@ func (b *BaseApi) SearchFirewallRule(c *gin.Context) {
// @Summary Page firewall status // @Summary Page firewall status
// @Accept json // @Accept json
// @Param request body dto.FirewallOperation true "request" // @Param request body dto.FirewallOperation true "request"
// @Success 200 {object} dto.PageResult // @Success 200
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /hosts/firewall/operate [post] // @Router /hosts/firewall/operate [post]

6
backend/app/api/v1/host.go
View File

@ -12,7 +12,7 @@ import (
// @Summary Create host // @Summary Create host
// @Accept json // @Accept json
// @Param request body dto.HostOperate true "request" // @Param request body dto.HostOperate true "request"
// @Success 200 // @Success 200 {object} dto.HostInfo
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /hosts [post] // @Router /hosts [post]
@ -35,7 +35,7 @@ func (b *BaseApi) CreateHost(c *gin.Context) {
// @Summary Test host conn by info // @Summary Test host conn by info
// @Accept json // @Accept json
// @Param request body dto.HostConnTest true "request" // @Param request body dto.HostConnTest true "request"
// @Success 200 // @Success 200 {boolean} connStatus
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /hosts/test/byinfo [post] // @Router /hosts/test/byinfo [post]
@ -95,7 +95,7 @@ func (b *BaseApi) HostTree(c *gin.Context) {
// @Summary Page host // @Summary Page host
// @Accept json // @Accept json
// @Param request body dto.SearchHostWithPage true "request" // @Param request body dto.SearchHostWithPage true "request"
// @Success 200 {array} dto.HostTree // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /hosts/search [post] // @Router /hosts/search [post]

10
backend/app/api/v1/host_tool.go
View File

@ -11,7 +11,7 @@ import (
// @Summary Get tool status // @Summary Get tool status
// @Accept json // @Accept json
// @Param request body request.HostToolReq true "request" // @Param request body request.HostToolReq true "request"
// @Success 200 // @Success 200 {object} response.HostToolRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/tool [post] // @Router /host/tool [post]
@ -77,7 +77,7 @@ func (b *BaseApi) OperateTool(c *gin.Context) {
// @Summary Get tool config // @Summary Get tool config
// @Accept json // @Accept json
// @Param request body request.HostToolConfig true "request" // @Param request body request.HostToolConfig true "request"
// @Success 200 // @Success 200 {object} response.HostToolConfig
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/tool/config [post] // @Router /host/tool/config [post]
@ -100,7 +100,7 @@ func (b *BaseApi) OperateToolConfig(c *gin.Context) {
// @Summary Get tool logs // @Summary Get tool logs
// @Accept json // @Accept json
// @Param request body request.HostToolLogReq true "request" // @Param request body request.HostToolLogReq true "request"
// @Success 200 // @Success 200 {string} logContent
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/tool/log [post] // @Router /host/tool/log [post]
@ -144,7 +144,7 @@ func (b *BaseApi) OperateProcess(c *gin.Context) {
// @Tags Host tool // @Tags Host tool
// @Summary Get Supervisor process config // @Summary Get Supervisor process config
// @Accept json // @Accept json
// @Success 200 // @Success 200 {object} response.SupervisorProcessConfig
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/tool/supervisor/process [get] // @Router /host/tool/supervisor/process [get]
@ -161,7 +161,7 @@ func (b *BaseApi) GetProcess(c *gin.Context) {
// @Summary Get Supervisor process config // @Summary Get Supervisor process config
// @Accept json // @Accept json
// @Param request body request.SupervisorProcessFileReq true "request" // @Param request body request.SupervisorProcessFileReq true "request"
// @Success 200 // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/tool/supervisor/process/file [post] // @Router /host/tool/supervisor/process/file [post]

4
backend/app/api/v1/image.go
View File

@ -94,7 +94,7 @@ func (b *BaseApi) ImageBuild(c *gin.Context) {
// @Summary Pull image // @Summary Pull image
// @Accept json // @Accept json
// @Param request body dto.ImagePull true "request" // @Param request body dto.ImagePull true "request"
// @Success 200 {string} log // @Success 200 {string} logPath
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /containers/image/pull [post] // @Router /containers/image/pull [post]
@ -118,7 +118,7 @@ func (b *BaseApi) ImagePull(c *gin.Context) {
// @Summary Push image // @Summary Push image
// @Accept json // @Accept json
// @Param request body dto.ImagePush true "request" // @Param request body dto.ImagePush true "request"
// @Success 200 {string} log // @Success 200 {string} logPath
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /containers/image/push [post] // @Router /containers/image/push [post]

6
backend/app/api/v1/logs.go
View File

@ -63,7 +63,7 @@ func (b *BaseApi) GetOperationLogs(c *gin.Context) {
// @Summary Clean operation logs // @Summary Clean operation logs
// @Accept json // @Accept json
// @Param request body dto.CleanLog true "request" // @Param request body dto.CleanLog true "request"
// @Success 200 {object} dto.PageResult // @Success 200
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /logs/clean [post] // @Router /logs/clean [post]
@ -84,7 +84,7 @@ func (b *BaseApi) CleanLogs(c *gin.Context) {
// @Tags Logs // @Tags Logs
// @Summary Load system log files // @Summary Load system log files
// @Success 200 // @Success 200 {array} string
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /logs/system/files [get] // @Router /logs/system/files [get]
@ -100,7 +100,7 @@ func (b *BaseApi) GetSystemFiles(c *gin.Context) {
// @Tags Logs // @Tags Logs
// @Summary Load system logs // @Summary Load system logs
// @Success 200 // @Success 200 {string} data
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /logs/system [post] // @Router /logs/system [post]

2
backend/app/api/v1/monitor.go
View File

@ -18,7 +18,7 @@ import (
// @Tags Monitor // @Tags Monitor
// @Summary Load monitor datas // @Summary Load monitor datas
// @Param request body dto.MonitorSearch true "request" // @Param request body dto.MonitorSearch true "request"
// @Success 200 // @Success 200 {array} dto.MonitorData
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /hosts/monitor/search [post] // @Router /hosts/monitor/search [post]

2
backend/app/api/v1/nginx.go
View File

@ -9,7 +9,7 @@ import (
// @Tags OpenResty // @Tags OpenResty
// @Summary Load OpenResty conf // @Summary Load OpenResty conf
// @Success 200 {object} response.FileInfo // @Success 200 {object} response.NginxFile
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /openresty [get] // @Router /openresty [get]

4
backend/app/api/v1/recycle_bin.go
View File

@ -12,7 +12,7 @@ import (
// @Summary List Recycle Bin files // @Summary List Recycle Bin files
// @Accept json // @Accept json
// @Param request body dto.PageInfo true "request" // @Param request body dto.PageInfo true "request"
// @Success 200 // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/recycle/search [post] // @Router /files/recycle/search [post]
@ -72,7 +72,7 @@ func (b *BaseApi) ClearRecycleBinFile(c *gin.Context) {
// @Tags File // @Tags File
// @Summary Get Recycle Bin status // @Summary Get Recycle Bin status
// @Accept json // @Accept json
// @Success 200 // @Success 200 {string} content
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /files/recycle/status [get] // @Router /files/recycle/status [get]

10
backend/app/api/v1/runtime.go
View File

@ -12,7 +12,7 @@ import (
// @Summary List runtimes // @Summary List runtimes
// @Accept json // @Accept json
// @Param request body request.RuntimeSearch true "request" // @Param request body request.RuntimeSearch true "request"
// @Success 200 // @Success 200 {object} dto.PageResult
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /runtimes/search [post] // @Router /runtimes/search [post]
@ -36,7 +36,7 @@ func (b *BaseApi) SearchRuntimes(c *gin.Context) {
// @Summary Create runtime // @Summary Create runtime
// @Accept json // @Accept json
// @Param request body request.RuntimeCreate true "request" // @Param request body request.RuntimeCreate true "request"
// @Success 200 // @Success 200 {object} model.Runtime
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /runtimes [post] // @Router /runtimes [post]
@ -115,7 +115,7 @@ func (b *BaseApi) UpdateRuntime(c *gin.Context) {
// @Summary Get runtime // @Summary Get runtime
// @Accept json // @Accept json
// @Param id path string true "request" // @Param id path string true "request"
// @Success 200 // @Success 200 {object} response.RuntimeDTO
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /runtimes/{id} [get] // @Router /runtimes/{id} [get]
@ -137,7 +137,7 @@ func (b *BaseApi) GetRuntime(c *gin.Context) {
// @Summary Get Node package scripts // @Summary Get Node package scripts
// @Accept json // @Accept json
// @Param request body request.NodePackageReq true "request" // @Param request body request.NodePackageReq true "request"
// @Success 200 // @Success 200 {array} response.PackageScripts
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /runtimes/node/package [post] // @Router /runtimes/node/package [post]
@ -180,7 +180,7 @@ func (b *BaseApi) OperateRuntime(c *gin.Context) {
// @Summary Get Node modules // @Summary Get Node modules
// @Accept json // @Accept json
// @Param request body request.NodeModuleReq true "request" // @Param request body request.NodeModuleReq true "request"
// @Success 200 // @Success 200 {array} response.NodeModule
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /runtimes/node/modules [post] // @Router /runtimes/node/modules [post]

6
backend/app/api/v1/setting.go
View File

@ -160,7 +160,7 @@ func (b *BaseApi) UpdateSSL(c *gin.Context) {
// @Tags System Setting // @Tags System Setting
// @Summary Load system cert info // @Summary Load system cert info
// @Success 200 {object} dto.SettingInfo // @Success 200 {object} dto.SSLInfo
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/ssl/info [get] // @Router /settings/ssl/info [get]
@ -192,7 +192,7 @@ func (b *BaseApi) DownloadSSL(c *gin.Context) {
// @Tags System Setting // @Tags System Setting
// @Summary Load system address // @Summary Load system address
// @Accept json // @Accept json
// @Success 200 // @Success 200 {array} string
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/interface [get] // @Router /settings/interface [get]
@ -346,7 +346,7 @@ func (b *BaseApi) MFABind(c *gin.Context) {
// @Tags System Setting // @Tags System Setting
// @Summary Generate api key // @Summary Generate api key
// @Accept json // @Accept json
// @Success 200 // @Success 200 {string} apiKey
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/api/config/generate/key [post] // @Router /settings/api/config/generate/key [post]

4
backend/app/api/v1/snapshot.go
View File

@ -55,7 +55,7 @@ func (b *BaseApi) ImportSnapshot(c *gin.Context) {
// @Summary Load Snapshot status // @Summary Load Snapshot status
// @Accept json // @Accept json
// @Param request body dto.OperateByID true "request" // @Param request body dto.OperateByID true "request"
// @Success 200 // @Success 200 {object} dto.SnapshotStatus
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/snapshot/status [post] // @Router /settings/snapshot/status [post]
@ -124,7 +124,7 @@ func (b *BaseApi) SearchSnapshot(c *gin.Context) {
// @Summary Load system snapshot size // @Summary Load system snapshot size
// @Accept json // @Accept json
// @Param request body dto.PageSnapshot true "request" // @Param request body dto.PageSnapshot true "request"
// @Success 200 // @Success 200 {array} dto.SnapshotFile
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/snapshot/size [post] // @Router /settings/snapshot/size [post]

4
backend/app/api/v1/ssh.go
View File

@ -114,7 +114,7 @@ func (b *BaseApi) GenerateSSH(c *gin.Context) {
// @Summary Load host SSH secret // @Summary Load host SSH secret
// @Accept json // @Accept json
// @Param request body dto.GenerateLoad true "request" // @Param request body dto.GenerateLoad true "request"
// @Success 200 // @Success 200 {string} data
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/ssh/secret [post] // @Router /host/ssh/secret [post]
@ -156,7 +156,7 @@ func (b *BaseApi) LoadSSHLogs(c *gin.Context) {
// @Tags SSH // @Tags SSH
// @Summary Load host SSH conf // @Summary Load host SSH conf
// @Success 200 // @Success 200 {string} data
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /host/ssh/conf [get] // @Router /host/ssh/conf [get]

2
backend/app/api/v1/upgrade.go
View File

@ -26,7 +26,7 @@ func (b *BaseApi) GetUpgradeInfo(c *gin.Context) {
// @Summary Load release notes by version // @Summary Load release notes by version
// @Accept json // @Accept json
// @Param request body dto.Upgrade true "request" // @Param request body dto.Upgrade true "request"
// @Success 200 // @Success 200 {string} notes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /settings/upgrade [get] // @Router /settings/upgrade [get]

16
backend/app/api/v1/website.go
View File

@ -51,7 +51,7 @@ func (b *BaseApi) GetWebsites(c *gin.Context) {
// @Tags Website // @Tags Website
// @Summary List website names // @Summary List website names
// @Success 200 {array} string // @Success 200 {array} response.WebsiteOption
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/options [get] // @Router /websites/options [get]
@ -470,7 +470,7 @@ func (b *BaseApi) ChangePHPVersion(c *gin.Context) {
// @Summary Get rewrite conf // @Summary Get rewrite conf
// @Accept json // @Accept json
// @Param request body request.NginxRewriteReq true "request" // @Param request body request.NginxRewriteReq true "request"
// @Success 200 // @Success 200 {object} response.NginxRewriteRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/rewrite [post] // @Router /websites/rewrite [post]
@ -554,7 +554,7 @@ func (b *BaseApi) UpdateSiteDirPermission(c *gin.Context) {
// @Summary Get proxy conf // @Summary Get proxy conf
// @Accept json // @Accept json
// @Param request body request.WebsiteProxyReq true "request" // @Param request body request.WebsiteProxyReq true "request"
// @Success 200 // @Success 200 {array} request.WebsiteProxyConfig
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/proxies [post] // @Router /websites/proxies [post]
@ -618,7 +618,7 @@ func (b *BaseApi) UpdateProxyConfigFile(c *gin.Context) {
// @Summary Get AuthBasic conf // @Summary Get AuthBasic conf
// @Accept json // @Accept json
// @Param request body request.NginxAuthReq true "request" // @Param request body request.NginxAuthReq true "request"
// @Success 200 // @Success 200 {object} response.NginxAuthRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/auths [post] // @Router /websites/auths [post]
@ -659,7 +659,7 @@ func (b *BaseApi) UpdateAuthConfig(c *gin.Context) {
// @Summary Get AntiLeech conf // @Summary Get AntiLeech conf
// @Accept json // @Accept json
// @Param request body request.NginxCommonReq true "request" // @Param request body request.NginxCommonReq true "request"
// @Success 200 // @Success 200 {object} response.NginxAntiLeechRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/leech [post] // @Router /websites/leech [post]
@ -722,7 +722,7 @@ func (b *BaseApi) UpdateRedirectConfig(c *gin.Context) {
// @Summary Get redirect conf // @Summary Get redirect conf
// @Accept json // @Accept json
// @Param request body request.WebsiteProxyReq true "request" // @Param request body request.WebsiteProxyReq true "request"
// @Success 200 // @Success 200 {array} response.NginxRedirectConfig
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/redirect [post] // @Router /websites/redirect [post]
@ -764,7 +764,7 @@ func (b *BaseApi) UpdateRedirectConfigFile(c *gin.Context) {
// @Summary Get website dir // @Summary Get website dir
// @Accept json // @Accept json
// @Param request body request.WebsiteCommonReq true "request" // @Param request body request.WebsiteCommonReq true "request"
// @Success 200 // @Success 200 {object} response.WebsiteDirConfig
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/dir [post] // @Router /websites/dir [post]
@ -785,7 +785,7 @@ func (b *BaseApi) GetDirConfig(c *gin.Context) {
// @Summary Get default html // @Summary Get default html
// @Accept json // @Accept json
// @Param type path string true "type" // @Param type path string true "type"
// @Success 200 {object} response.FileInfo // @Success 200 {object} response.WebsiteHtmlRes
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/default/html/{type} [get] // @Router /websites/default/html/{type} [get]

2
backend/app/api/v1/website_domain.go
View File

@ -32,7 +32,7 @@ func (b *BaseApi) DeleteWebDomain(c *gin.Context) {
// @Summary Create website domain // @Summary Create website domain
// @Accept json // @Accept json
// @Param request body request.WebsiteDomainCreate true "request" // @Param request body request.WebsiteDomainCreate true "request"
// @Success 200 {object} model.WebsiteDomain // @Success 200 {array} model.WebsiteDomain
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/domains [post] // @Router /websites/domains [post]

6
backend/app/api/v1/website_ssl.go
View File

@ -17,7 +17,7 @@ import (
// @Summary Page website ssl // @Summary Page website ssl
// @Accept json // @Accept json
// @Param request body request.WebsiteSSLSearch true "request" // @Param request body request.WebsiteSSLSearch true "request"
// @Success 200 // @Success 200 {array} response.WebsiteSSLDTO
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/ssl/search [post] // @Router /websites/ssl/search [post]
@ -135,7 +135,7 @@ func (b *BaseApi) DeleteWebsiteSSL(c *gin.Context) {
// @Summary Search website ssl by website id // @Summary Search website ssl by website id
// @Accept json // @Accept json
// @Param websiteId path integer true "request" // @Param websiteId path integer true "request"
// @Success 200 // @Success 200 {object} response.WebsiteSSLDTO
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/ssl/website/{websiteId} [get] // @Router /websites/ssl/website/{websiteId} [get]
@ -157,7 +157,7 @@ func (b *BaseApi) GetWebsiteSSLByWebsiteId(c *gin.Context) {
// @Summary Search website ssl by id // @Summary Search website ssl by id
// @Accept json // @Accept json
// @Param id path integer true "request" // @Param id path integer true "request"
// @Success 200 // @Success 200 {object} response.WebsiteSSLDTO
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Security Timestamp // @Security Timestamp
// @Router /websites/ssl/{id} [get] // @Router /websites/ssl/{id} [get]

1440
cmd/server/docs/docs.go
View File

File diff suppressed because it is too large Load Diff

1440
cmd/server/docs/swagger.json
View File

File diff suppressed because it is too large Load Diff

874
cmd/server/docs/swagger.yaml
View File

File diff suppressed because it is too large Load Diff