-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathopenapi.yaml
More file actions
700 lines (700 loc) · 17.2 KB
/
openapi.yaml
File metadata and controls
700 lines (700 loc) · 17.2 KB
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
openapi: 3.1.0
info:
title: FastAPI
version: 0.1.0
paths:
/hook:
post:
summary: Webhook Handler
operationId: webhook_handler_hook_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Webhook Handler Hook Post
/update-upstream/{project}/{service}:
get:
summary: Get Hook Handler
description: Handle requests to update the upstream
operationId: get_hook_handler_update_upstream__project___service__get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: path
required: true
schema:
type: string
title: Project
- name: service
in: path
required: true
schema:
type: string
title: Service
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/update-upstream/{project}:
get:
summary: Get Hook Handler
description: Handle requests to update the upstream
operationId: get_hook_handler_update_upstream__project__get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: path
required: true
schema:
type: string
title: Project
- name: service
in: query
required: false
schema:
type: string
title: Service
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project}:
get:
summary: Get Projects Handler
description: Get the list of all or one project
operationId: get_projects_handler_projects__project__get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: path
required: true
schema:
type: string
title: Project
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Project-Output'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects:
get:
summary: Get Projects Handler
description: Get the list of all or one project
operationId: get_projects_handler_projects_get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: query
required: false
schema:
type: string
title: Project
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project-Output'
title: Response Get Projects Handler Projects Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Project
summary: Upsert Project Handler
description: Create or update a project
operationId: upsert_project_handler_projects_put
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Project-Input'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Project
summary: Upsert Project Handler
description: Create or update a project
operationId: upsert_project_handler_projects_post
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Project-Input'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project}/services/{service}:
get:
summary: Get Project Services Handler
description: Get the list of a project's services, or a specific one
operationId: get_project_services_handler_projects__project__services__service__get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: path
required: true
schema:
type: string
title: Project
- name: service
in: path
required: true
schema:
type: string
title: Service
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Service-Output'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project}/services:
get:
summary: Get Project Services Handler
description: Get the list of a project's services, or a specific one
operationId: get_project_services_handler_projects__project__services_get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: path
required: true
schema:
type: string
title: Project
- name: service
in: query
required: false
schema:
type: string
title: Service
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service-Output'
title: Response Get Project Services Handler Projects Project Services
Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services:
get:
summary: Get Services Handler
description: Get the list of all services
operationId: get_services_handler_services_get
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service-Output'
title: Response Get Services Handler Services Get
put:
tags:
- Service
summary: Upsert Service Handler
description: Create or update a service
operationId: upsert_service_handler_services_put
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: query
required: true
schema:
type: string
title: Project
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Service-Input'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Service
summary: Upsert Service Handler
description: Create or update a service
operationId: upsert_service_handler_services_post
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: query
required: true
schema:
type: string
title: Project
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Service-Input'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project}/services/{service}/env:
patch:
tags:
- Env
summary: Patch Env Handler
description: Update env for a project service
operationId: patch_env_handler_projects__project__services__service__env_patch
security:
- APIKeyQuery: []
- APIKeyHeader: []
- HTTPBearer: []
parameters:
- name: project
in: path
required: true
schema:
type: string
title: Project
- name: service
in: path
required: true
schema:
type: string
title: Service
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Env'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
Env:
properties: {}
additionalProperties: true
type: object
title: Env
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
Ingress:
properties:
domain:
type: string
title: Domain
hostport:
type: integer
title: Hostport
passthrough:
type: boolean
title: Passthrough
default: false
path_prefix:
type: string
title: Path Prefix
path_remove:
type: boolean
title: Path Remove
default: false
port:
type: integer
title: Port
default: 8080
protocol:
allOf:
- $ref: '#/components/schemas/Protocol'
default: tcp
proxyprotocol:
anyOf:
- $ref: '#/components/schemas/ProxyProtocol'
- type: 'null'
default: '2'
router:
allOf:
- $ref: '#/components/schemas/Router'
default: http
tls:
allOf:
- $ref: '#/components/schemas/TLS'
expose:
type: boolean
title: Expose
default: false
type: object
title: Ingress
description: Ingress model
Project-Input:
properties:
description:
type: string
title: Description
env:
allOf:
- $ref: '#/components/schemas/Env'
enabled:
type: boolean
title: Enabled
default: true
name:
type: string
title: Name
services:
items:
$ref: '#/components/schemas/Service-Input'
type: array
title: Services
default: []
type: object
required:
- name
title: Project
description: Project model
Project-Output:
properties:
description:
type: string
title: Description
env:
allOf:
- $ref: '#/components/schemas/Env'
enabled:
type: boolean
title: Enabled
default: true
name:
type: string
title: Name
services:
items:
$ref: '#/components/schemas/Service-Output'
type: array
title: Services
default: []
type: object
required:
- name
title: Project
description: Project model
Protocol:
type: string
enum:
- tcp
- udp
title: Protocol
description: Protocol enum
ProxyProtocol:
type: string
enum:
- '1'
- '2'
title: ProxyProtocol
description: ProxyProtocol enum
Router:
type: string
enum:
- http
- tcp
- udp
title: Router
description: Router enum
Service-Input:
properties:
additional_properties:
type: object
title: Additional Properties
default: {}
command:
anyOf:
- type: string
- type: 'null'
title: Command
depends_on:
anyOf:
- items:
type: string
type: array
- type: object
title: Depends On
default: []
env:
allOf:
- $ref: '#/components/schemas/Env'
default: {}
host:
type: string
title: Host
image:
type: string
title: Image
ingress:
items:
$ref: '#/components/schemas/Ingress'
type: array
title: Ingress
labels:
items:
type: string
type: array
title: Labels
default: []
restart:
type: string
title: Restart
default: unless-stopped
volumes:
items:
type: string
type: array
title: Volumes
default: []
type: object
required:
- host
title: Service
description: Service model
Service-Output:
properties:
additional_properties:
type: object
title: Additional Properties
default: {}
command:
anyOf:
- type: string
- type: 'null'
title: Command
depends_on:
anyOf:
- items:
type: string
type: array
- type: object
title: Depends On
default: []
env:
allOf:
- $ref: '#/components/schemas/Env'
default: {}
host:
type: string
title: Host
image:
type: string
title: Image
ingress:
items:
$ref: '#/components/schemas/Ingress'
type: array
title: Ingress
labels:
items:
type: string
type: array
title: Labels
default: []
restart:
type: string
title: Restart
default: unless-stopped
volumes:
items:
type: string
type: array
title: Volumes
default: []
type: object
required:
- host
title: Service
description: Service model
TLS:
properties:
main:
type: string
title: Main
sans:
items:
type: string
type: array
title: Sans
default: []
type: object
title: TLS
description: TLS model
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
APIKeyQuery:
type: apiKey
in: query
name: apikey
APIKeyHeader:
type: apiKey
in: header
name: X-API-KEY
HTTPBearer:
type: http
scheme: bearer