mirror of
https://github.com/yusing/godoxy.git
synced 2026-03-22 00:59:11 +01:00
docs(api): update swagger docs with field descriptions and operationId rename
- Add minimum: 0 validation to LogRetention properties (days, keep_size, last) - Add "interned" descriptions to fstype, path, and name fields - Rename operationId and x-id from "routes" to "list" for GET /route endpoint
This commit is contained in:
@@ -2946,8 +2946,8 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-id": "routes",
|
||||
"operationId": "routes"
|
||||
"x-id": "list",
|
||||
"operationId": "list"
|
||||
}
|
||||
},
|
||||
"/route/playground": {
|
||||
@@ -4844,16 +4844,19 @@
|
||||
"properties": {
|
||||
"days": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"keep_size": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"last": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
}
|
||||
@@ -6644,11 +6647,13 @@
|
||||
"x-omitempty": false
|
||||
},
|
||||
"fstype": {
|
||||
"description": "interned",
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
},
|
||||
"path": {
|
||||
"description": "interned",
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
@@ -6995,6 +7000,7 @@
|
||||
"x-omitempty": false
|
||||
},
|
||||
"name": {
|
||||
"description": "interned",
|
||||
"type": "string",
|
||||
"x-nullable": false,
|
||||
"x-omitempty": false
|
||||
|
||||
@@ -767,10 +767,13 @@ definitions:
|
||||
LogRetention:
|
||||
properties:
|
||||
days:
|
||||
minimum: 0
|
||||
type: integer
|
||||
keep_size:
|
||||
minimum: 0
|
||||
type: integer
|
||||
last:
|
||||
minimum: 0
|
||||
type: integer
|
||||
type: object
|
||||
MetricsPeriod:
|
||||
@@ -1690,8 +1693,10 @@ definitions:
|
||||
free:
|
||||
type: integer
|
||||
fstype:
|
||||
description: interned
|
||||
type: string
|
||||
path:
|
||||
description: interned
|
||||
type: string
|
||||
total:
|
||||
type: number
|
||||
@@ -1832,12 +1837,12 @@ definitions:
|
||||
type: string
|
||||
kernel_version:
|
||||
type: string
|
||||
load_avg_5m:
|
||||
type: string
|
||||
load_avg_15m:
|
||||
type: string
|
||||
load_avg_1m:
|
||||
type: string
|
||||
load_avg_5m:
|
||||
type: string
|
||||
mem_pct:
|
||||
type: string
|
||||
mem_total:
|
||||
@@ -1886,6 +1891,7 @@ definitions:
|
||||
high:
|
||||
type: number
|
||||
name:
|
||||
description: interned
|
||||
type: string
|
||||
temperature:
|
||||
type: number
|
||||
@@ -3932,7 +3938,7 @@ paths:
|
||||
tags:
|
||||
- route
|
||||
- websocket
|
||||
x-id: routes
|
||||
x-id: list
|
||||
/route/playground:
|
||||
post:
|
||||
consumes:
|
||||
|
||||
@@ -15,7 +15,7 @@ import (
|
||||
|
||||
type RouteType route.Route // @name Route
|
||||
|
||||
// @x-id "routes"
|
||||
// @x-id "list"
|
||||
// @BasePath /api/v1
|
||||
// @Summary List routes
|
||||
// @Description List routes
|
||||
Reference in New Issue
Block a user