starred/godoxy-yusing
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-03-22 00:59:11 +01:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

fix(api): missing health field for route in docs and generated api code

Browse Source
This commit is contained in:
yusing
2025-08-17 14:33:53 +08:00
parent c19d82c876
commit e52c86e0b7
4 changed files with 254 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
internal/api/v1/docs/docs.go
View File

@@ -2033,6 +2033,70 @@ const docTemplate = `{
}
}
},
"HealthExtra": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/LoadBalancerConfig"
},
"pool": {
"type": "object",
"additionalProperties": {}
}
}
},
"HealthJSON": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/HealthCheckConfig"
},
"detail": {
"type": "string"
},
"extra": {
"allOf": [
{
"$ref": "#/definitions/HealthExtra"
}
],
"x-nullable": true
},
"lastSeen": {
"type": "integer"
},
"lastSeenStr": {
"type": "string"
},
"latency": {
"type": "number"
},
"latencyStr": {
"type": "string"
},
"name": {
"type": "string"
},
"started": {
"type": "integer"
},
"startedStr": {
"type": "string"
},
"status": {
"type": "string"
},
"uptime": {
"type": "number"
},
"uptimeStr": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"HealthMap": {
"type": "object",
"additionalProperties": {
@@ -2491,6 +2555,14 @@ const docTemplate = `{
"excluded": {
"type": "boolean"
},
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
]
},
"healthcheck": {
"$ref": "#/definitions/HealthCheckConfig"
},
@@ -3225,6 +3297,14 @@ const docTemplate = `{
"excluded": {
"type": "boolean"
},
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
]
},
"healthcheck": {
"$ref": "#/definitions/HealthCheckConfig"
},

118
internal/api/v1/docs/swagger.json
View File

@@ -2196,6 +2196,104 @@
"x-nullable": false,
"x-omitempty": false
},
"HealthExtra": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/LoadBalancerConfig",
"x-nullable": false,
"x-omitempty": false
},
"pool": {
"type": "object",
"additionalProperties": {},
"x-nullable": false,
"x-omitempty": false
}
},
"x-nullable": false,
"x-omitempty": false
},
"HealthJSON": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/HealthCheckConfig",
"x-nullable": false,
"x-omitempty": false
},
"detail": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"extra": {
"allOf": [
{
"$ref": "#/definitions/HealthExtra"
}
],
"x-nullable": true
},
"lastSeen": {
"type": "integer",
"x-nullable": false,
"x-omitempty": false
},
"lastSeenStr": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"latency": {
"type": "number",
"x-nullable": false,
"x-omitempty": false
},
"latencyStr": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"name": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"started": {
"type": "integer",
"x-nullable": false,
"x-omitempty": false
},
"startedStr": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"status": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"uptime": {
"type": "number",
"x-nullable": false,
"x-omitempty": false
},
"uptimeStr": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"url": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
}
},
"x-nullable": false,
"x-omitempty": false
},
"HealthMap": {
"type": "object",
"additionalProperties": {
@@ -2840,6 +2938,16 @@
"x-nullable": false,
"x-omitempty": false
},
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
],
"x-nullable": false,
"x-omitempty": false
},
"healthcheck": {
"$ref": "#/definitions/HealthCheckConfig",
"x-nullable": false,
@@ -3890,6 +3998,16 @@
"x-nullable": false,
"x-omitempty": false
},
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
],
"x-nullable": false,
"x-omitempty": false
},
"healthcheck": {
"$ref": "#/definitions/HealthCheckConfig",
"x-nullable": false,

61
internal/api/v1/docs/swagger.yaml
View File

@@ -226,6 +226,47 @@ definitions:
use_get:
type: boolean
type: object
HealthExtra:
properties:
config:
$ref: '#/definitions/LoadBalancerConfig'
pool:
additionalProperties: {}
type: object
type: object
HealthJSON:
properties:
config:
$ref: '#/definitions/HealthCheckConfig'
detail:
type: string
extra:
allOf:
- $ref: '#/definitions/HealthExtra'
x-nullable: true
lastSeen:
type: integer
lastSeenStr:
type: string
latency:
type: number
latencyStr:
type: string
name:
type: string
started:
type: integer
startedStr:
type: string
status:
type: string
uptime:
type: number
uptimeStr:
type: string
url:
type: string
type: object
HealthMap:
additionalProperties:
$ref: '#/definitions/routes.HealthInfo'
@@ -396,11 +437,11 @@ definitions:
- 1mo
type: string
x-enum-comments:
MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m'
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d'
MetricsPeriod1h: '@name MetricsPeriod1h'
MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m'
x-enum-varnames:
- MetricsPeriod5m
- MetricsPeriod15m
@@ -535,6 +576,10 @@ definitions:
type: boolean
excluded:
type: boolean
health:
allOf:
- $ref: '#/definitions/HealthJSON'
description: for swagger
healthcheck:
$ref: '#/definitions/HealthCheckConfig'
homepage:
@@ -1060,6 +1105,10 @@ definitions:
type: boolean
excluded:
type: boolean
health:
allOf:
- $ref: '#/definitions/HealthJSON'
description: for swagger
healthcheck:
$ref: '#/definitions/HealthCheckConfig'
homepage:
@@ -2075,11 +2124,11 @@ paths:
name: period
type: string
x-enum-comments:
MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m'
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d'
MetricsPeriod1h: '@name MetricsPeriod1h'
MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m'
x-enum-varnames:
- MetricsPeriod5m
- MetricsPeriod15m
@@ -2129,11 +2178,11 @@ paths:
name: interval
type: string
x-enum-comments:
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d'
MetricsPeriod1h: '@name MetricsPeriod1h'
MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m'
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d'
x-enum-varnames:
- MetricsPeriod5m
- MetricsPeriod15m

2
internal/route/route.go
View File

@@ -53,7 +53,7 @@ type (
Idlewatcher *types.IdlewatcherConfig `json:"idlewatcher,omitempty" extensions:"x-nullable"`
HealthMon types.HealthMonitor `json:"health,omitempty" swaggerignore:"true"`
// for swagger
HealthJSON *types.HealthJSON `json:"-" form:"health"`
HealthJSON *types.HealthJSON `json:",omitempty" form:"health"`
Metadata `deserialize:"-"`
}