mirror of
https://github.com/1Panel-dev/1Panel.git
synced 2025-12-19 22:09:03 +08:00
ref: Adjust Swagger format
This commit is contained in:
parent
a034b03c1d
commit
05addd4cde
14 changed files with 1324 additions and 441 deletions
|
|
@ -200,7 +200,7 @@ func (b *BaseApi) GetAppListUpdate(c *gin.Context) {
|
||||||
// @Summary Get app icon by app_id
|
// @Summary Get app icon by app_id
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param appId path integer true "app id"
|
// @Param appId path integer true "app id"
|
||||||
// @Success 200 {file} file "app icon"
|
// @Success 200 {string} file "app icon"
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /apps/icon/:appId [get]
|
// @Router /apps/icon/:appId [get]
|
||||||
|
|
|
||||||
|
|
@ -502,7 +502,6 @@ func (b *BaseApi) Inspect(c *gin.Context) {
|
||||||
helper.SuccessWithData(c, result)
|
helper.SuccessWithData(c, result)
|
||||||
}
|
}
|
||||||
|
|
||||||
// @Router /containers/download/log [post]
|
|
||||||
func (b *BaseApi) DownloadContainerLogs(c *gin.Context) {
|
func (b *BaseApi) DownloadContainerLogs(c *gin.Context) {
|
||||||
var req dto.ContainerLog
|
var req dto.ContainerLog
|
||||||
if err := helper.CheckBindAndValidate(&req, c); err != nil {
|
if err := helper.CheckBindAndValidate(&req, c); err != nil {
|
||||||
|
|
@ -716,6 +715,7 @@ func (b *BaseApi) ComposeUpdate(c *gin.Context) {
|
||||||
// @Param since query string false "时间筛选"
|
// @Param since query string false "时间筛选"
|
||||||
// @Param follow query string false "是否追踪"
|
// @Param follow query string false "是否追踪"
|
||||||
// @Param tail query string false "显示行号"
|
// @Param tail query string false "显示行号"
|
||||||
|
// @Success 200
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /containers/search/log [get]
|
// @Router /containers/search/log [get]
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ func (b *BaseApi) LoadDashboardOsInfo(c *gin.Context) {
|
||||||
// @Tags Dashboard
|
// @Tags Dashboard
|
||||||
// @Summary Load app launcher
|
// @Summary Load app launcher
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Success 200 {Array} dto.AppLauncher
|
// @Success 200 {array} dto.AppLauncher
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /dashboard/app/launcher [get]
|
// @Router /dashboard/app/launcher [get]
|
||||||
|
|
@ -44,7 +44,7 @@ func (b *BaseApi) LoadAppLauncher(c *gin.Context) {
|
||||||
// @Summary Load app launcher options
|
// @Summary Load app launcher options
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.SearchByFilter true "request"
|
// @Param request body dto.SearchByFilter true "request"
|
||||||
// @Success 200 {Array} dto.LauncherOption
|
// @Success 200 {array} dto.LauncherOption
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /dashboard/app/launcher/option [post]
|
// @Router /dashboard/app/launcher/option [post]
|
||||||
|
|
@ -85,7 +85,7 @@ func (b *BaseApi) UpdateAppLauncher(c *gin.Context) {
|
||||||
|
|
||||||
// @Tags Dashboard
|
// @Tags Dashboard
|
||||||
// @Summary Load quick jump options
|
// @Summary Load quick jump options
|
||||||
// @Success 200 {Array} dto.QuickJump
|
// @Success 200 {array} dto.QuickJump
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /dashboard/quick/option [get]
|
// @Router /dashboard/quick/option [get]
|
||||||
|
|
@ -181,7 +181,7 @@ func (b *BaseApi) LoadDashboardCurrentInfo(c *gin.Context) {
|
||||||
|
|
||||||
// @Tags Dashboard
|
// @Tags Dashboard
|
||||||
// @Summary Load top cpu processes
|
// @Summary Load top cpu processes
|
||||||
// @Success 200 {Array} dto.Process
|
// @Success 200 {array} dto.Process
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /dashboard/current/top/cpu [get]
|
// @Router /dashboard/current/top/cpu [get]
|
||||||
|
|
@ -192,7 +192,7 @@ func (b *BaseApi) LoadDashboardTopCPU(c *gin.Context) {
|
||||||
|
|
||||||
// @Tags Dashboard
|
// @Tags Dashboard
|
||||||
// @Summary Load top memory processes
|
// @Summary Load top memory processes
|
||||||
// @Success 200 {Array} dto.Process
|
// @Success 200 {array} dto.Process
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /dashboard/current/top/mem [get]
|
// @Router /dashboard/current/top/mem [get]
|
||||||
|
|
|
||||||
|
|
@ -214,6 +214,7 @@ func (b *BaseApi) ListDBFormatCollationOptions(c *gin.Context) {
|
||||||
// @Summary Load mysql database from remote
|
// @Summary Load mysql database from remote
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.MysqlLoadDB true "request"
|
// @Param request body dto.MysqlLoadDB true "request"
|
||||||
|
// @Success 200
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /databases/load [post]
|
// @Router /databases/load [post]
|
||||||
|
|
|
||||||
|
|
@ -167,6 +167,7 @@ func (b *BaseApi) SearchPostgresql(c *gin.Context) {
|
||||||
// @Summary Load postgresql database from remote
|
// @Summary Load postgresql database from remote
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.PostgresqlLoadDB true "request"
|
// @Param request body dto.PostgresqlLoadDB true "request"
|
||||||
|
// @Success 200
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /databases/pg/:database/load [post]
|
// @Router /databases/pg/:database/load [post]
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ func (b *BaseApi) LoadDeviceBaseInfo(c *gin.Context) {
|
||||||
// @Tags Device
|
// @Tags Device
|
||||||
// @Summary list time zone options
|
// @Summary list time zone options
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Success 200 {Array} string
|
// @Success 200 {array} string
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /toolbox/device/zone/options [get]
|
// @Router /toolbox/device/zone/options [get]
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ func (b *BaseApi) LoadFail2BanBaseInfo(c *gin.Context) {
|
||||||
// @Summary Page fail2ban ip list
|
// @Summary Page fail2ban ip list
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.Fail2BanSearch true "request"
|
// @Param request body dto.Fail2BanSearch true "request"
|
||||||
// @Success 200 {Array} string
|
// @Success 200 {array} string
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /toolbox/fail2ban/search [post]
|
// @Router /toolbox/fail2ban/search [post]
|
||||||
|
|
@ -51,6 +51,7 @@ func (b *BaseApi) SearchFail2Ban(c *gin.Context) {
|
||||||
// @Summary Operate fail2ban
|
// @Summary Operate fail2ban
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.Operate true "request"
|
// @Param request body dto.Operate true "request"
|
||||||
|
// @Success 200
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /toolbox/fail2ban/operate [post]
|
// @Router /toolbox/fail2ban/operate [post]
|
||||||
|
|
@ -72,7 +73,8 @@ func (b *BaseApi) OperateFail2Ban(c *gin.Context) {
|
||||||
// @Tags Fail2ban
|
// @Tags Fail2ban
|
||||||
// @Summary Operate sshd of fail2ban
|
// @Summary Operate sshd of fail2ban
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.Operate true "request"
|
// @Param request body dto.Fail2BanSet true "request"
|
||||||
|
// @Success 200
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /toolbox/fail2ban/operate/sshd [post]
|
// @Router /toolbox/fail2ban/operate/sshd [post]
|
||||||
|
|
|
||||||
|
|
@ -54,6 +54,7 @@ func (b *BaseApi) LoadFtpLogInfo(c *gin.Context) {
|
||||||
// @Summary Operate FTP
|
// @Summary Operate FTP
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.Operate true "request"
|
// @Param request body dto.Operate true "request"
|
||||||
|
// @Success 200
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /toolbox/ftp/operate [post]
|
// @Router /toolbox/ftp/operate [post]
|
||||||
|
|
|
||||||
|
|
@ -34,7 +34,7 @@ func (b *BaseApi) LoadMonitor(c *gin.Context) {
|
||||||
// @Tags Monitor
|
// @Tags Monitor
|
||||||
// @Summary Load monitor data
|
// @Summary Load monitor data
|
||||||
// @Param request body dto.MonitorGPUSearch true "request"
|
// @Param request body dto.MonitorGPUSearch true "request"
|
||||||
// @Success 200 {object} dto.dto.MonitorGPUData
|
// @Success 200 {object} dto.MonitorGPUData
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /hosts/monitor/gpu/search [post]
|
// @Router /hosts/monitor/gpu/search [post]
|
||||||
|
|
|
||||||
|
|
@ -86,7 +86,7 @@ func (b *BaseApi) CheckLocalConn(c *gin.Context) {
|
||||||
|
|
||||||
// @Tags System Setting
|
// @Tags System Setting
|
||||||
// @Summary Check local conn info
|
// @Summary Check local conn info
|
||||||
// @Success 200 {bool} isOk
|
// @Success 200 {boolean} isOk
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /settings/ssh/check/info [post]
|
// @Router /settings/ssh/check/info [post]
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ import (
|
||||||
// @Tags Host
|
// @Tags Host
|
||||||
// @Summary Check if a system component exists
|
// @Summary Check if a system component exists
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param name query string true "Component name to check (e.g., rsync, docker)"
|
// @Param name path string true "Component name to check (e.g., rsync, docker)"
|
||||||
// @Success 200 {object} response.ComponentInfo
|
// @Success 200 {object} response.ComponentInfo
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
|
|
|
||||||
|
|
@ -154,7 +154,7 @@ func (b *BaseApi) SearchCommand(c *gin.Context) {
|
||||||
// @Summary Tree commands
|
// @Summary Tree commands
|
||||||
// @Accept json
|
// @Accept json
|
||||||
// @Param request body dto.OperateByType true "request"
|
// @Param request body dto.OperateByType true "request"
|
||||||
// @Success 200 {Array} dto.CommandTree
|
// @Success 200 {array} dto.CommandTree
|
||||||
// @Security ApiKeyAuth
|
// @Security ApiKeyAuth
|
||||||
// @Security Timestamp
|
// @Security Timestamp
|
||||||
// @Router /core/commands/tree [get]
|
// @Router /core/commands/tree [get]
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
Loading…
Add table
Reference in a new issue