diff --git a/internal/api/v1/cert/info.go b/internal/api/v1/cert/info.go index 2d627c5b..bc29542c 100644 --- a/internal/api/v1/cert/info.go +++ b/internal/api/v1/cert/info.go @@ -17,6 +17,7 @@ type CertInfo struct { EmailAddresses []string `json:"email_addresses"` } // @name CertInfo +// @x-id "info" // @BasePath /api/v1 // @Summary Get cert info // @Description Get cert info diff --git a/internal/api/v1/cert/renew.go b/internal/api/v1/cert/renew.go index 423604e2..1ace7800 100644 --- a/internal/api/v1/cert/renew.go +++ b/internal/api/v1/cert/renew.go @@ -13,6 +13,7 @@ import ( "github.com/yusing/go-proxy/internal/net/gphttp/websocket" ) +// @x-id "renew" // @BasePath /api/v1 // @Summary Renew cert // @Description Renew cert diff --git a/internal/api/v1/docker/containers.go b/internal/api/v1/docker/containers.go index 6d8c657b..f89b13de 100644 --- a/internal/api/v1/docker/containers.go +++ b/internal/api/v1/docker/containers.go @@ -19,6 +19,7 @@ type Container struct { State ContainerState `json:"state"` } // @name ContainerResponse +// @x-id "containers" // @BasePath /api/v1 // @Summary Get containers // @Description Get containers diff --git a/internal/api/v1/docker/info.go b/internal/api/v1/docker/info.go index 04da35b4..84ee126a 100644 --- a/internal/api/v1/docker/info.go +++ b/internal/api/v1/docker/info.go @@ -42,6 +42,7 @@ func toDockerInfo(info dockerSystem.Info) dockerInfo { } } +// @x-id "info" // @BasePath /api/v1 // @Summary Get docker info // @Description Get docker info diff --git a/internal/api/v1/docker/logs.go b/internal/api/v1/docker/logs.go index 37daf5eb..bfa392c3 100644 --- a/internal/api/v1/docker/logs.go +++ b/internal/api/v1/docker/logs.go @@ -27,6 +27,7 @@ type LogsQueryParams struct { Levels string `form:"levels"` } // @name LogsQueryParams +// @x-id "logs" // @BasePath /api/v1 // @Summary Get docker container logs // @Description Get docker container logs diff --git a/internal/api/v1/docs/docs.go b/internal/api/v1/docs/docs.go index 3cfb5800..d8483a62 100644 --- a/internal/api/v1/docs/docs.go +++ b/internal/api/v1/docs/docs.go @@ -336,7 +336,8 @@ const docTemplate = `{ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "info" } }, "/cert/renew": { @@ -371,7 +372,8 @@ const docTemplate = `{ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "renew" } }, "/docker/containers": { @@ -409,7 +411,8 @@ const docTemplate = `{ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "containers" } }, "/docker/info": { @@ -447,7 +450,8 @@ const docTemplate = `{ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "info" } }, "/docker/logs/{server}/{container}": { @@ -538,7 +542,8 @@ const docTemplate = `{ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "logs" } }, "/favicon": { diff --git a/internal/api/v1/docs/swagger.json b/internal/api/v1/docs/swagger.json index 49d2bf33..182b15ad 100644 --- a/internal/api/v1/docs/swagger.json +++ b/internal/api/v1/docs/swagger.json @@ -332,7 +332,9 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "info", + "operationId": "info" } }, "/cert/renew": { @@ -367,7 +369,9 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "renew", + "operationId": "renew" } }, "/docker/containers": { @@ -405,7 +409,9 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "containers", + "operationId": "containers" } }, "/docker/info": { @@ -443,7 +449,9 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "info", + "operationId": "info" } }, "/docker/logs/{server}/{container}": { @@ -534,7 +542,9 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-id": "logs", + "operationId": "logs" } }, "/favicon": { diff --git a/internal/api/v1/docs/swagger.yaml b/internal/api/v1/docs/swagger.yaml index 4806d0d2..6e765847 100644 --- a/internal/api/v1/docs/swagger.yaml +++ b/internal/api/v1/docs/swagger.yaml @@ -427,11 +427,11 @@ definitions: - 1mo type: string x-enum-comments: - MetricsPeriod15m: '@name MetricsPeriod15m' MetricsPeriod1d: '@name MetricsPeriod1d' MetricsPeriod1h: '@name MetricsPeriod1h' MetricsPeriod1mo: '@name MetricsPeriod1mo' MetricsPeriod5m: '@name MetricsPeriod5m' + MetricsPeriod15m: '@name MetricsPeriod15m' x-enum-varnames: - MetricsPeriod5m - MetricsPeriod15m @@ -1467,6 +1467,7 @@ paths: summary: Get cert info tags: - cert + x-id: info /cert/renew: post: consumes: @@ -1490,6 +1491,7 @@ paths: summary: Renew cert tags: - cert + x-id: renew /docker/containers: get: consumes: @@ -1515,6 +1517,7 @@ paths: summary: Get containers tags: - docker + x-id: containers /docker/info: get: consumes: @@ -1540,6 +1543,7 @@ paths: summary: Get docker info tags: - docker + x-id: info /docker/logs/{server}/{container}: get: consumes: @@ -1601,6 +1605,7 @@ paths: tags: - docker - websocket + x-id: logs /favicon: get: consumes: @@ -2110,11 +2115,11 @@ paths: name: period type: string x-enum-comments: - MetricsPeriod15m: '@name MetricsPeriod15m' MetricsPeriod1d: '@name MetricsPeriod1d' MetricsPeriod1h: '@name MetricsPeriod1h' MetricsPeriod1mo: '@name MetricsPeriod1mo' MetricsPeriod5m: '@name MetricsPeriod5m' + MetricsPeriod15m: '@name MetricsPeriod15m' x-enum-varnames: - MetricsPeriod5m - MetricsPeriod15m