starred/godoxy-yusing
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-04-23 00:38:33 +02:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

docs(api): update swagger docs

Browse Source
This commit is contained in:
yusing
2025-08-17 01:50:38 +08:00
parent ba9cb083cf
commit d2f317b44d
3 changed files with 58 additions and 266 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -850,9 +850,7 @@ const docTemplate = `{
}, },
"417": { "417": {
"description": "Validation failed", "description": "Validation failed",
"schema": { "schema": {}
"$ref": "#/definitions/ErrorResponse"
}
}, },
"500": { "500": {
"description": "Internal server error", "description": "Internal server error",
@@ -1807,9 +1805,17 @@ const docTemplate = `{
"is_host_network_mode": { "is_host_network_mode": {
"type": "boolean" "type": "boolean"
}, },
"labels": {
"description": "for displaying in UI",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"mounts": { "mounts": {
"type": "array", "description": "source:destination",
"items": { "type": "object",
"additionalProperties": {
"type": "string" "type": "string"
} }
}, },
@@ -1852,8 +1858,14 @@ const docTemplate = `{
"name": { "name": {
"type": "string" "type": "string"
}, },
"sha256": {
"type": "string"
},
"tag": { "tag": {
"type": "string" "type": "string"
},
"version": {
"type": "string"
} }
} }
}, },
@@ -2021,70 +2033,6 @@ 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": { "HealthMap": {
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
@@ -2543,14 +2491,6 @@ const docTemplate = `{
"excluded": { "excluded": {
"type": "boolean" "type": "boolean"
}, },
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
]
},
"healthcheck": { "healthcheck": {
"$ref": "#/definitions/HealthCheckConfig" "$ref": "#/definitions/HealthCheckConfig"
}, },
@@ -3285,14 +3225,6 @@ const docTemplate = `{
"excluded": { "excluded": {
"type": "boolean" "type": "boolean"
}, },
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
]
},
"healthcheck": { "healthcheck": {
"$ref": "#/definitions/HealthCheckConfig" "$ref": "#/definitions/HealthCheckConfig"
}, },

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

@@ -855,9 +855,7 @@
}, },
"417": { "417": {
"description": "Validation failed", "description": "Validation failed",
"schema": { "schema": {}
"$ref": "#/definitions/ErrorResponse"
}
}, },
"500": { "500": {
"description": "Internal server error", "description": "Internal server error",
@@ -1880,9 +1878,19 @@
"x-nullable": false, "x-nullable": false,
"x-omitempty": false "x-omitempty": false
}, },
"labels": {
"description": "for displaying in UI",
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-nullable": false,
"x-omitempty": false
},
"mounts": { "mounts": {
"type": "array", "description": "source:destination",
"items": { "type": "object",
"additionalProperties": {
"type": "string" "type": "string"
}, },
"x-nullable": false, "x-nullable": false,
@@ -1945,10 +1953,20 @@
"x-nullable": false, "x-nullable": false,
"x-omitempty": false "x-omitempty": false
}, },
"sha256": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
},
"tag": { "tag": {
"type": "string", "type": "string",
"x-nullable": false, "x-nullable": false,
"x-omitempty": false "x-omitempty": false
},
"version": {
"type": "string",
"x-nullable": false,
"x-omitempty": false
} }
}, },
"x-nullable": false, "x-nullable": false,
@@ -2178,104 +2196,6 @@
"x-nullable": false, "x-nullable": false,
"x-omitempty": 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": { "HealthMap": {
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
@@ -2920,16 +2840,6 @@
"x-nullable": false, "x-nullable": false,
"x-omitempty": false "x-omitempty": false
}, },
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
],
"x-nullable": false,
"x-omitempty": false
},
"healthcheck": { "healthcheck": {
"$ref": "#/definitions/HealthCheckConfig", "$ref": "#/definitions/HealthCheckConfig",
"x-nullable": false, "x-nullable": false,
@@ -3980,16 +3890,6 @@
"x-nullable": false, "x-nullable": false,
"x-omitempty": false "x-omitempty": false
}, },
"health": {
"description": "for swagger",
"allOf": [
{
"$ref": "#/definitions/HealthJSON"
}
],
"x-nullable": false,
"x-omitempty": false
},
"healthcheck": { "healthcheck": {
"$ref": "#/definitions/HealthCheckConfig", "$ref": "#/definitions/HealthCheckConfig",
"x-nullable": false, "x-nullable": false,

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

@@ -66,10 +66,16 @@ definitions:
type: boolean type: boolean
is_host_network_mode: is_host_network_mode:
type: boolean type: boolean
mounts: labels:
items: additionalProperties:
type: string type: string
type: array description: for displaying in UI
type: object
mounts:
additionalProperties:
type: string
description: source:destination
type: object
network: network:
type: string type: string
private_hostname: private_hostname:
@@ -93,8 +99,12 @@ definitions:
type: string type: string
name: name:
type: string type: string
sha256:
type: string
tag: tag:
type: string type: string
version:
type: string
type: object type: object
ContainerResponse: ContainerResponse:
properties: properties:
@@ -216,47 +226,6 @@ definitions:
use_get: use_get:
type: boolean type: boolean
type: object 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: HealthMap:
additionalProperties: additionalProperties:
$ref: '#/definitions/routes.HealthInfo' $ref: '#/definitions/routes.HealthInfo'
@@ -427,11 +396,11 @@ definitions:
- 1mo - 1mo
type: string type: string
x-enum-comments: x-enum-comments:
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d' MetricsPeriod1d: '@name MetricsPeriod1d'
MetricsPeriod1h: '@name MetricsPeriod1h' MetricsPeriod1h: '@name MetricsPeriod1h'
MetricsPeriod1mo: '@name MetricsPeriod1mo' MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m' MetricsPeriod5m: '@name MetricsPeriod5m'
MetricsPeriod15m: '@name MetricsPeriod15m'
x-enum-varnames: x-enum-varnames:
- MetricsPeriod5m - MetricsPeriod5m
- MetricsPeriod15m - MetricsPeriod15m
@@ -566,10 +535,6 @@ definitions:
type: boolean type: boolean
excluded: excluded:
type: boolean type: boolean
health:
allOf:
- $ref: '#/definitions/HealthJSON'
description: for swagger
healthcheck: healthcheck:
$ref: '#/definitions/HealthCheckConfig' $ref: '#/definitions/HealthCheckConfig'
homepage: homepage:
@@ -1095,10 +1060,6 @@ definitions:
type: boolean type: boolean
excluded: excluded:
type: boolean type: boolean
health:
allOf:
- $ref: '#/definitions/HealthJSON'
description: for swagger
healthcheck: healthcheck:
$ref: '#/definitions/HealthCheckConfig' $ref: '#/definitions/HealthCheckConfig'
homepage: homepage:
@@ -1813,8 +1774,7 @@ paths:
$ref: '#/definitions/ErrorResponse' $ref: '#/definitions/ErrorResponse'
"417": "417":
description: Validation failed description: Validation failed
schema: schema: {}
$ref: '#/definitions/ErrorResponse'
"500": "500":
description: Internal server error description: Internal server error
schema: schema:
@@ -2115,11 +2075,11 @@ paths:
name: period name: period
type: string type: string
x-enum-comments: x-enum-comments:
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d' MetricsPeriod1d: '@name MetricsPeriod1d'
MetricsPeriod1h: '@name MetricsPeriod1h' MetricsPeriod1h: '@name MetricsPeriod1h'
MetricsPeriod1mo: '@name MetricsPeriod1mo' MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m' MetricsPeriod5m: '@name MetricsPeriod5m'
MetricsPeriod15m: '@name MetricsPeriod15m'
x-enum-varnames: x-enum-varnames:
- MetricsPeriod5m - MetricsPeriod5m
- MetricsPeriod15m - MetricsPeriod15m
@@ -2169,11 +2129,11 @@ paths:
name: interval name: interval
type: string type: string
x-enum-comments: x-enum-comments:
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d'
MetricsPeriod1h: '@name MetricsPeriod1h' MetricsPeriod1h: '@name MetricsPeriod1h'
MetricsPeriod1mo: '@name MetricsPeriod1mo' MetricsPeriod1mo: '@name MetricsPeriod1mo'
MetricsPeriod5m: '@name MetricsPeriod5m' MetricsPeriod5m: '@name MetricsPeriod5m'
MetricsPeriod15m: '@name MetricsPeriod15m'
MetricsPeriod1d: '@name MetricsPeriod1d'
x-enum-varnames: x-enum-varnames:
- MetricsPeriod5m - MetricsPeriod5m
- MetricsPeriod15m - MetricsPeriod15m