go-gost/x
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update swagger.yaml

Browse Source
This commit is contained in:
ginuerzh
2023-11-19 16:59:22 +08:00
parent 44064e4dd1
commit 79c15f2c37
1 changed files with 278 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

289
api/swagger.yaml
View File

@ -34,6 +34,8 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisLoader' $ref: '#/definitions/RedisLoader'
reload: reload:
@ -71,6 +73,8 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisLoader' $ref: '#/definitions/RedisLoader'
reload: reload:
@ -91,6 +95,8 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisLoader' $ref: '#/definitions/RedisLoader'
reload: reload:
@ -107,9 +113,6 @@ definitions:
ChainConfig: ChainConfig:
properties: properties:
hops: hops:
description: |-
REMOVED since beta.6
Selector *SelectorConfig `yaml:",omitempty" json:"selector,omitempty"`
items: items:
$ref: '#/definitions/HopConfig' $ref: '#/definitions/HopConfig'
type: array type: array
@ -204,6 +207,16 @@ definitions:
$ref: '#/definitions/LimiterConfig' $ref: '#/definitions/LimiterConfig'
type: array type: array
x-go-name: RLimiters x-go-name: RLimiters
routers:
items:
$ref: '#/definitions/RouterConfig'
type: array
x-go-name: Routers
sds:
items:
$ref: '#/definitions/SDConfig'
type: array
x-go-name: SDs
services: services:
items: items:
$ref: '#/definitions/ServiceConfig' $ref: '#/definitions/ServiceConfig'
@ -273,6 +286,8 @@ definitions:
addr: addr:
type: string type: string
x-go-name: Addr x-go-name: Addr
auth:
$ref: '#/definitions/AuthConfig'
bypass: bypass:
type: string type: string
x-go-name: Bypass x-go-name: Bypass
@ -284,12 +299,22 @@ definitions:
host: host:
type: string type: string
x-go-name: Host x-go-name: Host
http:
$ref: '#/definitions/HTTPNodeConfig'
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
network:
type: string
x-go-name: Network
path:
type: string
x-go-name: Path
protocol: protocol:
type: string type: string
x-go-name: Protocol x-go-name: Protocol
tls:
$ref: '#/definitions/TLSNodeConfig'
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
ForwarderConfig: ForwarderConfig:
@ -304,12 +329,6 @@ definitions:
x-go-name: Nodes x-go-name: Nodes
selector: selector:
$ref: '#/definitions/SelectorConfig' $ref: '#/definitions/SelectorConfig'
targets:
description: DEPRECATED by nodes since beta.4
items:
type: string
type: array
x-go-name: Targets
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
HTTPLoader: HTTPLoader:
@ -321,6 +340,27 @@ definitions:
x-go-name: URL x-go-name: URL
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
HTTPNodeConfig:
properties:
header:
additionalProperties:
type: string
type: object
x-go-name: Header
host:
type: string
x-go-name: Host
type: object
x-go-package: github.com/go-gost/x/config
HTTPRecorder:
properties:
timeout:
$ref: '#/definitions/Duration'
url:
type: string
x-go-name: URL
type: object
x-go-package: github.com/go-gost/x/config
HandlerConfig: HandlerConfig:
properties: properties:
auth: auth:
@ -338,9 +378,9 @@ definitions:
x-go-name: Chain x-go-name: Chain
chainGroup: chainGroup:
$ref: '#/definitions/ChainGroupConfig' $ref: '#/definitions/ChainGroupConfig'
ingress: limiter:
type: string type: string
x-go-name: Ingress x-go-name: Limiter
metadata: metadata:
additionalProperties: {} additionalProperties: {}
type: object type: object
@ -366,9 +406,13 @@ definitions:
type: string type: string
type: array type: array
x-go-name: Bypasses x-go-name: Bypasses
file:
$ref: '#/definitions/FileLoader'
hosts: hosts:
type: string type: string
x-go-name: Hosts x-go-name: Hosts
http:
$ref: '#/definitions/HTTPLoader'
interface: interface:
type: string type: string
x-go-name: Interface x-go-name: Interface
@ -380,6 +424,12 @@ definitions:
$ref: '#/definitions/NodeConfig' $ref: '#/definitions/NodeConfig'
type: array type: array
x-go-name: Nodes x-go-name: Nodes
plugin:
$ref: '#/definitions/PluginConfig'
redis:
$ref: '#/definitions/RedisLoader'
reload:
$ref: '#/definitions/Duration'
resolver: resolver:
type: string type: string
x-go-name: Resolver x-go-name: Resolver
@ -418,6 +468,8 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisLoader' $ref: '#/definitions/RedisLoader'
reload: reload:
@ -433,6 +485,8 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisLoader' $ref: '#/definitions/RedisLoader'
reload: reload:
@ -468,6 +522,8 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisLoader' $ref: '#/definitions/RedisLoader'
reload: reload:
@ -564,6 +620,11 @@ definitions:
addr: addr:
type: string type: string
x-go-name: Addr x-go-name: Addr
auth:
$ref: '#/definitions/AuthConfig'
auther:
type: string
x-go-name: Auther
path: path:
type: string type: string
x-go-name: Path x-go-name: Path
@ -574,6 +635,9 @@ definitions:
addr: addr:
type: string type: string
x-go-name: Addr x-go-name: Addr
async:
type: boolean
x-go-name: Async
chain: chain:
type: string type: string
x-go-name: Chain x-go-name: Chain
@ -583,6 +647,9 @@ definitions:
hostname: hostname:
type: string type: string
x-go-name: Hostname x-go-name: Hostname
only:
type: string
x-go-name: Only
prefer: prefer:
type: string type: string
x-go-name: Prefer x-go-name: Prefer
@ -597,6 +664,8 @@ definitions:
addr: addr:
type: string type: string
x-go-name: Addr x-go-name: Addr
auth:
$ref: '#/definitions/AuthConfig'
bypass: bypass:
type: string type: string
x-go-name: Bypass x-go-name: Bypass
@ -615,6 +684,8 @@ definitions:
hosts: hosts:
type: string type: string
x-go-name: Hosts x-go-name: Hosts
http:
$ref: '#/definitions/HTTPNodeConfig'
interface: interface:
type: string type: string
x-go-name: Interface x-go-name: Interface
@ -625,6 +696,12 @@ definitions:
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
network:
type: string
x-go-name: Network
path:
type: string
x-go-name: Path
protocol: protocol:
type: string type: string
x-go-name: Protocol x-go-name: Protocol
@ -633,6 +710,25 @@ definitions:
x-go-name: Resolver x-go-name: Resolver
sockopts: sockopts:
$ref: '#/definitions/SockOptsConfig' $ref: '#/definitions/SockOptsConfig'
tls:
$ref: '#/definitions/TLSNodeConfig'
type: object
x-go-package: github.com/go-gost/x/config
PluginConfig:
properties:
addr:
type: string
x-go-name: Addr
timeout:
$ref: '#/definitions/Duration'
tls:
$ref: '#/definitions/TLSConfig'
token:
type: string
x-go-name: Token
type:
type: string
x-go-name: Type
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
ProfilingConfig: ProfilingConfig:
@ -646,15 +742,24 @@ definitions:
properties: properties:
file: file:
$ref: '#/definitions/FileRecorder' $ref: '#/definitions/FileRecorder'
http:
$ref: '#/definitions/HTTPRecorder'
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis: redis:
$ref: '#/definitions/RedisRecorder' $ref: '#/definitions/RedisRecorder'
tcp:
$ref: '#/definitions/TCPRecorder'
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
RecorderObject: RecorderObject:
properties: properties:
Metadata:
additionalProperties: {}
type: object
name: name:
type: string type: string
x-go-name: Name x-go-name: Name
@ -713,6 +818,8 @@ definitions:
$ref: '#/definitions/NameserverConfig' $ref: '#/definitions/NameserverConfig'
type: array type: array
x-go-name: Nameservers x-go-name: Nameservers
plugin:
$ref: '#/definitions/PluginConfig'
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
Response: Response:
@ -726,6 +833,47 @@ definitions:
x-go-name: Msg x-go-name: Msg
type: object type: object
x-go-package: github.com/go-gost/x/api x-go-package: github.com/go-gost/x/api
RouterConfig:
properties:
file:
$ref: '#/definitions/FileLoader'
http:
$ref: '#/definitions/HTTPLoader'
name:
type: string
x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
redis:
$ref: '#/definitions/RedisLoader'
reload:
$ref: '#/definitions/Duration'
routes:
items:
$ref: '#/definitions/RouterRouteConfig'
type: array
x-go-name: Routes
type: object
x-go-package: github.com/go-gost/x/config
RouterRouteConfig:
properties:
gateway:
type: string
x-go-name: Gateway
net:
type: string
x-go-name: Net
type: object
x-go-package: github.com/go-gost/x/config
SDConfig:
properties:
name:
type: string
x-go-name: Name
plugin:
$ref: '#/definitions/PluginConfig'
type: object
x-go-package: github.com/go-gost/x/config
SelectorConfig: SelectorConfig:
properties: properties:
failTimeout: failTimeout:
@ -809,6 +957,15 @@ definitions:
x-go-name: Mark x-go-name: Mark
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
TCPRecorder:
properties:
addr:
type: string
x-go-name: Addr
timeout:
$ref: '#/definitions/Duration'
type: object
x-go-package: github.com/go-gost/x/config
TLSConfig: TLSConfig:
properties: properties:
caFile: caFile:
@ -823,6 +980,8 @@ definitions:
keyFile: keyFile:
type: string type: string
x-go-name: KeyFile x-go-name: KeyFile
options:
$ref: '#/definitions/TLSOptions'
organization: organization:
type: string type: string
x-go-name: Organization x-go-name: Organization
@ -836,6 +995,33 @@ definitions:
$ref: '#/definitions/Duration' $ref: '#/definitions/Duration'
type: object type: object
x-go-package: github.com/go-gost/x/config x-go-package: github.com/go-gost/x/config
TLSNodeConfig:
properties:
options:
$ref: '#/definitions/TLSOptions'
secure:
type: boolean
x-go-name: Secure
serverName:
type: string
x-go-name: ServerName
type: object
x-go-package: github.com/go-gost/x/config
TLSOptions:
properties:
cipherSuites:
items:
type: string
type: array
x-go-name: CipherSuites
maxVersion:
type: string
x-go-name: MaxVersion
minVersion:
type: string
x-go-name: MinVersion
type: object
x-go-package: github.com/go-gost/x/config
info: info:
title: Documentation of Web API. title: Documentation of Web API.
version: 1.0.0 version: 1.0.0
@ -866,6 +1052,11 @@ paths:
name: format name: format
type: string type: string
x-go-name: Format x-go-name: Format
- description: file path, default is gost.yaml|gost.json in current working directory.
in: query
name: path
type: string
x-go-name: Path
responses: responses:
"200": "200":
$ref: '#/responses/saveConfigResponse' $ref: '#/responses/saveConfigResponse'
@ -1513,6 +1704,64 @@ paths:
summary: Update rate limiter by name, the limiter must already exist. summary: Update rate limiter by name, the limiter must already exist.
tags: tags:
- Limiter - Limiter
/config/routers:
post:
operationId: createRouterRequest
parameters:
- in: body
name: data
schema:
$ref: '#/definitions/RouterConfig'
x-go-name: Data
responses:
"200":
$ref: '#/responses/createRouterResponse'
security:
- basicAuth:
- '[]'
summary: Create a new router, the name of the router must be unique in router list.
tags:
- Router
/config/routers/{router}:
delete:
operationId: deleteRouterRequest
parameters:
- in: path
name: router
required: true
type: string
x-go-name: Router
responses:
"200":
$ref: '#/responses/deleteRouterResponse'
security:
- basicAuth:
- '[]'
summary: Delete router by name.
tags:
- Router
put:
operationId: updateRouterRequest
parameters:
- in: path
name: router
required: true
type: string
x-go-name: Router
- in: body
name: data
schema:
$ref: '#/definitions/RouterConfig'
x-go-name: Data
responses:
"200":
$ref: '#/responses/updateRouterResponse'
security:
- basicAuth:
- '[]'
summary: Update router by name, the router must already exist.
tags:
- Router
/config/services: /config/services:
post: post:
operationId: createServiceRequest operationId: createServiceRequest
@ -1640,6 +1889,12 @@ responses:
Data: {} Data: {}
schema: schema:
$ref: '#/definitions/Response' $ref: '#/definitions/Response'
createRouterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
createServiceResponse: createServiceResponse:
description: successful operation. description: successful operation.
headers: headers:
@ -1712,6 +1967,12 @@ responses:
Data: {} Data: {}
schema: schema:
$ref: '#/definitions/Response' $ref: '#/definitions/Response'
deleteRouterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
deleteServiceResponse: deleteServiceResponse:
description: successful operation. description: successful operation.
headers: headers:
@ -1796,6 +2057,12 @@ responses:
Data: {} Data: {}
schema: schema:
$ref: '#/definitions/Response' $ref: '#/definitions/Response'
updateRouterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
updateServiceResponse: updateServiceResponse:
description: successful operation. description: successful operation.
headers: headers: