fix(api): added missing "x-id"s

This commit is contained in:
yusing
2025-08-16 23:24:03 +08:00
parent 11af9d107a
commit 6b89cd9106
8 changed files with 37 additions and 12 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -42,6 +42,7 @@ func toDockerInfo(info dockerSystem.Info) dockerInfo {
}
}
// @x-id "info"
// @BasePath /api/v1
// @Summary Get docker info
// @Description Get docker info

View File

@@ -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

View File

@@ -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": {

View File

@@ -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": {

View File

@@ -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