-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yml
296 lines (296 loc) · 6.42 KB
/
swagger.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
swagger: "2.0"
info:
title: PacGen
description: PAC file generator, provides access to simple REST API for managing proxy profiles and routing rules
version: 1.0.0
consumes:
- application/json
produces:
- application/json
schemes:
- http
basePath: /api/v1
security:
- basicAuth: [ ]
paths:
/rules:
get:
tags:
- rules
responses:
200:
description: list of rules
schema:
type: array
items:
$ref: "#/definitions/rule_read"
post:
tags:
- rules
parameters:
- in: body
name: body
schema:
$ref: "#/definitions/rule_create_update"
responses:
201:
description: rule created
headers:
Location:
type: string
format: uri
description: url of the created rule
409:
description: there is no proxy profile with the given id
schema:
$ref: "#/definitions/error"
422:
description: validation error
/rules/{id}:
get:
tags:
- rules
parameters:
- in: path
name: id
type: integer
format: int64
required: true
responses:
200:
description: rule found
schema:
type: object
$ref: "#/definitions/rule_read"
404:
description: rule not found
schema:
$ref: "#/definitions/error"
put:
tags:
- rules
parameters:
- in: path
name: id
type: integer
format: int64
required: true
description: id of the rule to update
- in: body
name: body
required: true
schema:
$ref: "#/definitions/rule_create_update"
responses:
204:
description: rule updated
400:
description: invalid path parameter
schema:
$ref: "#/definitions/error"
404:
description: rule not found
schema:
$ref: "#/definitions/error"
422:
description: validation error
delete:
tags:
- rules
parameters:
- in: path
name: id
type: integer
format: int64
required: true
description: id of the rule to delete
responses:
204:
description: rule deleted
404:
description: rule not found
schema:
$ref: "#/definitions/error"
/profiles:
get:
tags:
- profiles
responses:
200:
description: list of profiles
schema:
type: array
items:
$ref: "#/definitions/proxy_profile_read"
post:
tags:
- profiles
parameters:
- in: body
name: body
schema:
$ref: "#/definitions/proxy_profile_create_update"
responses:
201:
description: profile created
headers:
Location:
type: string
format: uri
description: url of the created profile
409:
description: there is already a profile with the given name
schema:
$ref: "#/definitions/error"
422:
description: validation error
/profiles/{id}:
get:
tags:
- profiles
parameters:
- in: path
name: id
type: integer
format: int64
required: true
description: id of the profile to get
responses:
200:
description: profile found
schema:
type: object
$ref: "#/definitions/proxy_profile_read"
400:
description: invalid path parameter
schema:
$ref: "#/definitions/error"
404:
description: profile not found
schema:
$ref: "#/definitions/error"
put:
tags:
- profiles
parameters:
- in: path
name: id
type: integer
format: int64
required: true
description: id of the profile to update
- in: body
name: body
required: true
schema:
$ref: "#/definitions/proxy_profile_create_update"
responses:
204:
description: profile updated
400:
description: invalid path parameter
schema:
$ref: "#/definitions/error"
delete:
tags:
- profiles
parameters:
- in: path
name: id
type: integer
format: int64
required: true
description: id of the profile to delete
responses:
204:
description: profile deleted
400:
description: invalid path parameter
schema:
$ref: "#/definitions/error"
404:
description: profile not found
schema:
$ref: "#/definitions/error"
definitions:
proxy_profile_read:
type: object
required:
- id
- name
- type
- address
properties:
id:
type: integer
format: int64
name:
type: string
type:
type: string
enum:
- socks5
- socks4
- http
- https
address:
type: string
proxy_profile_create_update:
type: object
required:
- name
- type
- address
properties:
name:
type: string
type:
type: string
enum:
- socks5
- socks4
- http
- https
address:
type: string
rule_read:
type: object
required:
- id
- regexp
- proxy_profile_id
properties:
id:
type: integer
format: int64
regexp:
type: string
minLength: 1
proxy_profile_id:
type: integer
format: int64
rule_create_update:
type: object
required:
- domain
- mode
- proxy_profile_id
properties:
domain:
type: string
minLength: 1
mode:
type: string
enum:
- domain
- domain_and_subdomains
proxy_profile_id:
type: integer
format: int64
error:
type: object
required:
- error
properties:
error:
type: string