starred/godoxy-yusing
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-04-17 14:09:44 +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

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

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