@platzio/sdk 0.6.0-beta.1 → 0.6.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/openapi.yaml ADDED
@@ -0,0 +1,4564 @@
1
+ openapi: 3.0.3
2
+ info:
3
+ title: platz-api
4
+ description: ''
5
+ license:
6
+ name: ''
7
+ version: 0.1.0
8
+ paths:
9
+ /api/v2/auth/google:
10
+ get:
11
+ tags:
12
+ - Authentication
13
+ operationId: startGoogleLogin
14
+ responses:
15
+ '200':
16
+ description: ''
17
+ content:
18
+ application/json:
19
+ schema:
20
+ $ref: '#/components/schemas/StartGoogleLoginResponse'
21
+ /api/v2/auth/google/callback:
22
+ post:
23
+ tags:
24
+ - Authentication
25
+ operationId: finishGoogleLogin
26
+ requestBody:
27
+ content:
28
+ application/json:
29
+ schema:
30
+ $ref: '#/components/schemas/OAuth2Response'
31
+ required: true
32
+ responses:
33
+ '200':
34
+ description: ''
35
+ content:
36
+ application/json:
37
+ schema:
38
+ $ref: '#/components/schemas/FinishGoogleLoginResponse'
39
+ /api/v2/auth/me:
40
+ get:
41
+ tags:
42
+ - Authentication
43
+ operationId: authMe
44
+ responses:
45
+ '200':
46
+ description: ''
47
+ content:
48
+ application/json:
49
+ schema:
50
+ $ref: '#/components/schemas/MeResponse'
51
+ security:
52
+ - access_token: []
53
+ - user_token: []
54
+ /api/v2/bots:
55
+ get:
56
+ tags:
57
+ - Bots
58
+ operationId: allBots
59
+ parameters:
60
+ - name: display_name
61
+ in: query
62
+ required: false
63
+ schema:
64
+ type: string
65
+ nullable: true
66
+ - name: page
67
+ in: query
68
+ required: false
69
+ schema:
70
+ type: integer
71
+ format: int64
72
+ nullable: true
73
+ - name: per_page
74
+ in: query
75
+ required: false
76
+ schema:
77
+ type: integer
78
+ format: int64
79
+ nullable: true
80
+ responses:
81
+ '200':
82
+ description: ''
83
+ content:
84
+ application/json:
85
+ schema:
86
+ type: object
87
+ required:
88
+ - page
89
+ - per_page
90
+ - items
91
+ - num_total
92
+ properties:
93
+ page:
94
+ type: integer
95
+ format: int64
96
+ example: '1'
97
+ per_page:
98
+ type: integer
99
+ format: int64
100
+ example: '50'
101
+ items:
102
+ type: array
103
+ items:
104
+ type: object
105
+ required:
106
+ - id
107
+ - created_at
108
+ - display_name
109
+ properties:
110
+ id:
111
+ type: string
112
+ format: uuid
113
+ created_at:
114
+ type: string
115
+ format: date-time
116
+ display_name:
117
+ type: string
118
+ num_total:
119
+ type: integer
120
+ format: int64
121
+ example: '1'
122
+ security:
123
+ - access_token: []
124
+ - user_token: []
125
+ /api/v2/bots/{id}:
126
+ get:
127
+ tags:
128
+ - Bots
129
+ operationId: getBot
130
+ parameters:
131
+ - name: id
132
+ in: path
133
+ required: true
134
+ schema:
135
+ type: string
136
+ format: uuid
137
+ responses:
138
+ '200':
139
+ description: ''
140
+ content:
141
+ application/json:
142
+ schema:
143
+ $ref: '#/components/schemas/Bot'
144
+ security:
145
+ - access_token: []
146
+ - user_token: []
147
+ put:
148
+ tags:
149
+ - Bots
150
+ operationId: updateBot
151
+ parameters:
152
+ - name: id
153
+ in: path
154
+ required: true
155
+ schema:
156
+ type: string
157
+ format: uuid
158
+ requestBody:
159
+ content:
160
+ application/json:
161
+ schema:
162
+ $ref: '#/components/schemas/UpdateBot'
163
+ required: true
164
+ responses:
165
+ '200':
166
+ description: ''
167
+ content:
168
+ application/json:
169
+ schema:
170
+ $ref: '#/components/schemas/Bot'
171
+ security:
172
+ - access_token: []
173
+ - user_token: []
174
+ /api/v2/deployment-kinds:
175
+ get:
176
+ tags:
177
+ - Deployment Kinds
178
+ operationId: allDeploymentKinds
179
+ parameters:
180
+ - name: name
181
+ in: query
182
+ required: false
183
+ schema:
184
+ type: string
185
+ nullable: true
186
+ - name: page
187
+ in: query
188
+ required: false
189
+ schema:
190
+ type: integer
191
+ format: int64
192
+ nullable: true
193
+ - name: per_page
194
+ in: query
195
+ required: false
196
+ schema:
197
+ type: integer
198
+ format: int64
199
+ nullable: true
200
+ responses:
201
+ '200':
202
+ description: ''
203
+ content:
204
+ application/json:
205
+ schema:
206
+ type: object
207
+ required:
208
+ - page
209
+ - per_page
210
+ - items
211
+ - num_total
212
+ properties:
213
+ page:
214
+ type: integer
215
+ format: int64
216
+ example: '1'
217
+ per_page:
218
+ type: integer
219
+ format: int64
220
+ example: '50'
221
+ items:
222
+ type: array
223
+ items:
224
+ type: object
225
+ required:
226
+ - id
227
+ - created_at
228
+ - name
229
+ properties:
230
+ id:
231
+ type: string
232
+ format: uuid
233
+ created_at:
234
+ type: string
235
+ format: date-time
236
+ name:
237
+ type: string
238
+ num_total:
239
+ type: integer
240
+ format: int64
241
+ example: '1'
242
+ security:
243
+ - access_token: []
244
+ - user_token: []
245
+ /api/v2/deployment-kinds/{id}:
246
+ get:
247
+ tags:
248
+ - Deployment Kinds
249
+ operationId: getDeploymentKind
250
+ parameters:
251
+ - name: id
252
+ in: path
253
+ required: true
254
+ schema:
255
+ type: string
256
+ format: uuid
257
+ responses:
258
+ '200':
259
+ description: ''
260
+ content:
261
+ application/json:
262
+ schema:
263
+ $ref: '#/components/schemas/DeploymentKind'
264
+ security:
265
+ - access_token: []
266
+ - user_token: []
267
+ put:
268
+ tags:
269
+ - Deployment Kinds
270
+ operationId: updateDeploymentKind
271
+ parameters:
272
+ - name: id
273
+ in: path
274
+ required: true
275
+ schema:
276
+ type: string
277
+ format: uuid
278
+ requestBody:
279
+ content:
280
+ application/json:
281
+ schema:
282
+ $ref: '#/components/schemas/UpdateDeploymentKind'
283
+ required: true
284
+ responses:
285
+ '200':
286
+ description: ''
287
+ content:
288
+ application/json:
289
+ schema:
290
+ $ref: '#/components/schemas/DeploymentKind'
291
+ security:
292
+ - access_token: []
293
+ - user_token: []
294
+ /api/v2/deployment-permissions:
295
+ get:
296
+ tags:
297
+ - Deployment Permissions
298
+ operationId: allDeploymentPermissions
299
+ parameters:
300
+ - name: env_id
301
+ in: query
302
+ required: false
303
+ schema:
304
+ type: string
305
+ format: uuid
306
+ nullable: true
307
+ - name: page
308
+ in: query
309
+ required: false
310
+ schema:
311
+ type: integer
312
+ format: int64
313
+ nullable: true
314
+ - name: per_page
315
+ in: query
316
+ required: false
317
+ schema:
318
+ type: integer
319
+ format: int64
320
+ nullable: true
321
+ responses:
322
+ '200':
323
+ description: ''
324
+ content:
325
+ application/json:
326
+ schema:
327
+ type: object
328
+ required:
329
+ - page
330
+ - per_page
331
+ - items
332
+ - num_total
333
+ properties:
334
+ page:
335
+ type: integer
336
+ format: int64
337
+ example: '1'
338
+ per_page:
339
+ type: integer
340
+ format: int64
341
+ example: '50'
342
+ items:
343
+ type: array
344
+ items:
345
+ type: object
346
+ required:
347
+ - id
348
+ - created_at
349
+ - env_id
350
+ - user_id
351
+ - kind_id
352
+ - role
353
+ properties:
354
+ id:
355
+ type: string
356
+ format: uuid
357
+ created_at:
358
+ type: string
359
+ format: date-time
360
+ env_id:
361
+ type: string
362
+ format: uuid
363
+ user_id:
364
+ type: string
365
+ format: uuid
366
+ kind_id:
367
+ type: string
368
+ format: uuid
369
+ role:
370
+ $ref: '#/components/schemas/UserDeploymentRole'
371
+ num_total:
372
+ type: integer
373
+ format: int64
374
+ example: '1'
375
+ security:
376
+ - access_token: []
377
+ - user_token: []
378
+ post:
379
+ tags:
380
+ - Deployment Permissions
381
+ operationId: createDeploymentPermission
382
+ requestBody:
383
+ content:
384
+ application/json:
385
+ schema:
386
+ $ref: '#/components/schemas/NewDeploymentPermission'
387
+ required: true
388
+ responses:
389
+ '201':
390
+ description: ''
391
+ content:
392
+ application/json:
393
+ schema:
394
+ $ref: '#/components/schemas/DeploymentPermission'
395
+ security:
396
+ - access_token: []
397
+ - user_token: []
398
+ /api/v2/deployment-permissions/{id}:
399
+ get:
400
+ tags:
401
+ - Deployment Permissions
402
+ operationId: getDeploymentPermission
403
+ parameters:
404
+ - name: id
405
+ in: path
406
+ required: true
407
+ schema:
408
+ type: string
409
+ format: uuid
410
+ responses:
411
+ '200':
412
+ description: ''
413
+ content:
414
+ application/json:
415
+ schema:
416
+ $ref: '#/components/schemas/DeploymentPermission'
417
+ security:
418
+ - access_token: []
419
+ - user_token: []
420
+ delete:
421
+ tags:
422
+ - Deployment Permissions
423
+ operationId: deleteDeploymentPermission
424
+ parameters:
425
+ - name: id
426
+ in: path
427
+ required: true
428
+ schema:
429
+ type: string
430
+ format: uuid
431
+ responses:
432
+ '204':
433
+ description: ''
434
+ security:
435
+ - access_token: []
436
+ - user_token: []
437
+ /api/v2/deployment-resource-types:
438
+ get:
439
+ tags:
440
+ - Deployment Resource Types
441
+ operationId: allDeploymentResourceTypes
442
+ parameters:
443
+ - name: env_id
444
+ in: query
445
+ required: false
446
+ schema:
447
+ type: string
448
+ format: uuid
449
+ nullable: true
450
+ - name: deployment_kind_id
451
+ in: query
452
+ required: false
453
+ schema:
454
+ type: string
455
+ format: uuid
456
+ nullable: true
457
+ - name: key
458
+ in: query
459
+ required: false
460
+ schema:
461
+ type: string
462
+ nullable: true
463
+ - name: page
464
+ in: query
465
+ required: false
466
+ schema:
467
+ type: integer
468
+ format: int64
469
+ nullable: true
470
+ - name: per_page
471
+ in: query
472
+ required: false
473
+ schema:
474
+ type: integer
475
+ format: int64
476
+ nullable: true
477
+ responses:
478
+ '200':
479
+ description: ''
480
+ content:
481
+ application/json:
482
+ schema:
483
+ type: object
484
+ required:
485
+ - page
486
+ - per_page
487
+ - items
488
+ - num_total
489
+ properties:
490
+ page:
491
+ type: integer
492
+ format: int64
493
+ example: '1'
494
+ per_page:
495
+ type: integer
496
+ format: int64
497
+ example: '50'
498
+ items:
499
+ type: array
500
+ items:
501
+ type: object
502
+ required:
503
+ - id
504
+ - created_at
505
+ - env_id
506
+ - deployment_kind_id
507
+ - key
508
+ - spec
509
+ properties:
510
+ id:
511
+ type: string
512
+ format: uuid
513
+ created_at:
514
+ type: string
515
+ format: date-time
516
+ env_id:
517
+ type: string
518
+ format: uuid
519
+ nullable: true
520
+ deployment_kind_id:
521
+ type: string
522
+ format: uuid
523
+ key:
524
+ type: string
525
+ spec:
526
+ $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1Spec'
527
+ num_total:
528
+ type: integer
529
+ format: int64
530
+ example: '1'
531
+ security:
532
+ - access_token: []
533
+ - user_token: []
534
+ /api/v2/deployment-resource-types/{id}:
535
+ get:
536
+ tags:
537
+ - Deployment Resource Types
538
+ operationId: getDeploymentResourceType
539
+ parameters:
540
+ - name: id
541
+ in: path
542
+ required: true
543
+ schema:
544
+ type: string
545
+ format: uuid
546
+ responses:
547
+ '200':
548
+ description: ''
549
+ content:
550
+ application/json:
551
+ schema:
552
+ $ref: '#/components/schemas/DeploymentResourceType'
553
+ security:
554
+ - access_token: []
555
+ - user_token: []
556
+ /api/v2/deployment-resources:
557
+ get:
558
+ tags:
559
+ - Deployment Resources
560
+ operationId: allDeploymentResources
561
+ parameters:
562
+ - name: type_id
563
+ in: query
564
+ required: false
565
+ schema:
566
+ type: string
567
+ format: uuid
568
+ nullable: true
569
+ - name: page
570
+ in: query
571
+ required: false
572
+ schema:
573
+ type: integer
574
+ format: int64
575
+ nullable: true
576
+ - name: per_page
577
+ in: query
578
+ required: false
579
+ schema:
580
+ type: integer
581
+ format: int64
582
+ nullable: true
583
+ responses:
584
+ '200':
585
+ description: ''
586
+ content:
587
+ application/json:
588
+ schema:
589
+ type: object
590
+ required:
591
+ - page
592
+ - per_page
593
+ - items
594
+ - num_total
595
+ properties:
596
+ page:
597
+ type: integer
598
+ format: int64
599
+ example: '1'
600
+ per_page:
601
+ type: integer
602
+ format: int64
603
+ example: '50'
604
+ items:
605
+ type: array
606
+ items:
607
+ type: object
608
+ required:
609
+ - id
610
+ - created_at
611
+ - type_id
612
+ - deployment_id
613
+ - name
614
+ - exists
615
+ - props
616
+ - sync_status
617
+ - sync_reason
618
+ properties:
619
+ id:
620
+ type: string
621
+ format: uuid
622
+ created_at:
623
+ type: string
624
+ format: date-time
625
+ type_id:
626
+ type: string
627
+ format: uuid
628
+ deployment_id:
629
+ type: string
630
+ format: uuid
631
+ nullable: true
632
+ name:
633
+ type: string
634
+ exists:
635
+ type: boolean
636
+ props: {}
637
+ sync_status:
638
+ $ref: '#/components/schemas/DeploymentResourceSyncStatus'
639
+ sync_reason:
640
+ type: string
641
+ nullable: true
642
+ num_total:
643
+ type: integer
644
+ format: int64
645
+ example: '1'
646
+ security:
647
+ - access_token: []
648
+ - user_token: []
649
+ post:
650
+ tags:
651
+ - Deployment Resources
652
+ operationId: createDeploymentResource
653
+ requestBody:
654
+ content:
655
+ application/json:
656
+ schema:
657
+ $ref: '#/components/schemas/NewDeploymentResource'
658
+ required: true
659
+ responses:
660
+ '201':
661
+ description: ''
662
+ content:
663
+ application/json:
664
+ schema:
665
+ $ref: '#/components/schemas/DeploymentResource'
666
+ security:
667
+ - access_token: []
668
+ - user_token: []
669
+ /api/v2/deployment-resources/{id}:
670
+ get:
671
+ tags:
672
+ - Deployment Resources
673
+ operationId: getDeploymentResource
674
+ parameters:
675
+ - name: id
676
+ in: path
677
+ required: true
678
+ schema:
679
+ type: string
680
+ format: uuid
681
+ responses:
682
+ '200':
683
+ description: ''
684
+ content:
685
+ application/json:
686
+ schema:
687
+ $ref: '#/components/schemas/DeploymentResource'
688
+ security:
689
+ - access_token: []
690
+ - user_token: []
691
+ put:
692
+ tags:
693
+ - Deployment Resources
694
+ operationId: updateDeploymentResource
695
+ parameters:
696
+ - name: id
697
+ in: path
698
+ required: true
699
+ schema:
700
+ type: string
701
+ format: uuid
702
+ requestBody:
703
+ content:
704
+ application/json:
705
+ schema:
706
+ $ref: '#/components/schemas/UpdateDeploymentResource'
707
+ required: true
708
+ responses:
709
+ '200':
710
+ description: ''
711
+ content:
712
+ application/json:
713
+ schema:
714
+ $ref: '#/components/schemas/DeploymentResource'
715
+ security:
716
+ - access_token: []
717
+ - user_token: []
718
+ delete:
719
+ tags:
720
+ - Deployment Resources
721
+ operationId: deleteDeploymentResource
722
+ parameters:
723
+ - name: id
724
+ in: path
725
+ required: true
726
+ schema:
727
+ type: string
728
+ format: uuid
729
+ responses:
730
+ '204':
731
+ description: ''
732
+ security:
733
+ - access_token: []
734
+ - user_token: []
735
+ /api/v2/deployment-tasks:
736
+ get:
737
+ tags:
738
+ - Deployment Tasks
739
+ operationId: allDeploymentTasks
740
+ parameters:
741
+ - name: cluster_id
742
+ in: query
743
+ required: false
744
+ schema:
745
+ type: string
746
+ format: uuid
747
+ nullable: true
748
+ - name: deployment_id
749
+ in: query
750
+ required: false
751
+ schema:
752
+ type: string
753
+ format: uuid
754
+ nullable: true
755
+ - name: page
756
+ in: query
757
+ required: false
758
+ schema:
759
+ type: integer
760
+ format: int64
761
+ nullable: true
762
+ - name: per_page
763
+ in: query
764
+ required: false
765
+ schema:
766
+ type: integer
767
+ format: int64
768
+ nullable: true
769
+ responses:
770
+ '200':
771
+ description: ''
772
+ content:
773
+ application/json:
774
+ schema:
775
+ type: object
776
+ required:
777
+ - page
778
+ - per_page
779
+ - items
780
+ - num_total
781
+ properties:
782
+ page:
783
+ type: integer
784
+ format: int64
785
+ example: '1'
786
+ per_page:
787
+ type: integer
788
+ format: int64
789
+ example: '50'
790
+ items:
791
+ type: array
792
+ items:
793
+ type: object
794
+ required:
795
+ - id
796
+ - created_at
797
+ - execute_at
798
+ - first_attempted_at
799
+ - started_at
800
+ - finished_at
801
+ - cluster_id
802
+ - deployment_id
803
+ - acting_user_id
804
+ - acting_deployment_id
805
+ - canceled_by_user_id
806
+ - canceled_by_deployment_id
807
+ - operation
808
+ - status
809
+ - reason
810
+ properties:
811
+ id:
812
+ type: string
813
+ format: uuid
814
+ created_at:
815
+ type: string
816
+ format: date-time
817
+ execute_at:
818
+ type: string
819
+ format: date-time
820
+ first_attempted_at:
821
+ type: string
822
+ format: date-time
823
+ nullable: true
824
+ started_at:
825
+ type: string
826
+ format: date-time
827
+ nullable: true
828
+ finished_at:
829
+ type: string
830
+ format: date-time
831
+ nullable: true
832
+ cluster_id:
833
+ type: string
834
+ format: uuid
835
+ deployment_id:
836
+ type: string
837
+ format: uuid
838
+ acting_user_id:
839
+ type: string
840
+ format: uuid
841
+ nullable: true
842
+ acting_deployment_id:
843
+ type: string
844
+ format: uuid
845
+ nullable: true
846
+ canceled_by_user_id:
847
+ type: string
848
+ format: uuid
849
+ nullable: true
850
+ canceled_by_deployment_id:
851
+ type: string
852
+ format: uuid
853
+ nullable: true
854
+ operation:
855
+ $ref: '#/components/schemas/DeploymentTaskOperation'
856
+ status:
857
+ $ref: '#/components/schemas/DeploymentTaskStatus'
858
+ reason:
859
+ type: string
860
+ nullable: true
861
+ num_total:
862
+ type: integer
863
+ format: int64
864
+ example: '1'
865
+ security:
866
+ - access_token: []
867
+ - user_token: []
868
+ post:
869
+ tags:
870
+ - Deployment Tasks
871
+ operationId: createDeploymentTask
872
+ requestBody:
873
+ content:
874
+ application/json:
875
+ schema:
876
+ $ref: '#/components/schemas/CreateDeploymentTask'
877
+ required: true
878
+ responses:
879
+ '201':
880
+ description: ''
881
+ content:
882
+ application/json:
883
+ schema:
884
+ $ref: '#/components/schemas/DeploymentTask'
885
+ security:
886
+ - access_token: []
887
+ - user_token: []
888
+ /api/v2/deployment-tasks/{id}:
889
+ get:
890
+ tags:
891
+ - Deployment Tasks
892
+ operationId: getDeploymentTask
893
+ parameters:
894
+ - name: id
895
+ in: path
896
+ required: true
897
+ schema:
898
+ type: string
899
+ format: uuid
900
+ responses:
901
+ '200':
902
+ description: ''
903
+ content:
904
+ application/json:
905
+ schema:
906
+ $ref: '#/components/schemas/DeploymentTask'
907
+ security:
908
+ - access_token: []
909
+ - user_token: []
910
+ /api/v2/deployments:
911
+ get:
912
+ tags:
913
+ - Deployments
914
+ operationId: allDeployments
915
+ parameters:
916
+ - name: name
917
+ in: query
918
+ required: false
919
+ schema:
920
+ type: string
921
+ nullable: true
922
+ - name: kind_id
923
+ in: query
924
+ required: false
925
+ schema:
926
+ type: string
927
+ format: uuid
928
+ nullable: true
929
+ - name: cluster_id
930
+ in: query
931
+ required: false
932
+ schema:
933
+ type: string
934
+ format: uuid
935
+ nullable: true
936
+ - name: enabled
937
+ in: query
938
+ required: false
939
+ schema:
940
+ type: boolean
941
+ nullable: true
942
+ - name: page
943
+ in: query
944
+ required: false
945
+ schema:
946
+ type: integer
947
+ format: int64
948
+ nullable: true
949
+ - name: per_page
950
+ in: query
951
+ required: false
952
+ schema:
953
+ type: integer
954
+ format: int64
955
+ nullable: true
956
+ responses:
957
+ '200':
958
+ description: ''
959
+ content:
960
+ application/json:
961
+ schema:
962
+ type: object
963
+ required:
964
+ - page
965
+ - per_page
966
+ - items
967
+ - num_total
968
+ properties:
969
+ page:
970
+ type: integer
971
+ format: int64
972
+ example: '1'
973
+ per_page:
974
+ type: integer
975
+ format: int64
976
+ example: '50'
977
+ items:
978
+ type: array
979
+ items:
980
+ type: object
981
+ required:
982
+ - id
983
+ - created_at
984
+ - name
985
+ - kind_id
986
+ - cluster_id
987
+ - enabled
988
+ - status
989
+ - description_md
990
+ - reason
991
+ - revision_id
992
+ - reported_status
993
+ - helm_chart_id
994
+ - config
995
+ - values_override
996
+ properties:
997
+ id:
998
+ type: string
999
+ format: uuid
1000
+ created_at:
1001
+ type: string
1002
+ format: date-time
1003
+ name:
1004
+ type: string
1005
+ kind_id:
1006
+ type: string
1007
+ format: uuid
1008
+ cluster_id:
1009
+ type: string
1010
+ format: uuid
1011
+ enabled:
1012
+ type: boolean
1013
+ status:
1014
+ $ref: '#/components/schemas/DeploymentStatus'
1015
+ description_md:
1016
+ type: string
1017
+ nullable: true
1018
+ reason:
1019
+ type: string
1020
+ nullable: true
1021
+ revision_id:
1022
+ type: string
1023
+ format: uuid
1024
+ nullable: true
1025
+ reported_status:
1026
+ allOf:
1027
+ - $ref: '#/components/schemas/DeploymentReportedStatus'
1028
+ nullable: true
1029
+ helm_chart_id:
1030
+ type: string
1031
+ format: uuid
1032
+ config: {}
1033
+ values_override:
1034
+ nullable: true
1035
+ num_total:
1036
+ type: integer
1037
+ format: int64
1038
+ example: '1'
1039
+ security:
1040
+ - access_token: []
1041
+ - user_token: []
1042
+ post:
1043
+ tags:
1044
+ - Deployments
1045
+ operationId: createDeployment
1046
+ requestBody:
1047
+ content:
1048
+ application/json:
1049
+ schema:
1050
+ $ref: '#/components/schemas/NewDeployment'
1051
+ required: true
1052
+ responses:
1053
+ '201':
1054
+ description: ''
1055
+ content:
1056
+ application/json:
1057
+ schema:
1058
+ $ref: '#/components/schemas/Deployment'
1059
+ security:
1060
+ - access_token: []
1061
+ - user_token: []
1062
+ /api/v2/deployments/{id}:
1063
+ get:
1064
+ tags:
1065
+ - Deployments
1066
+ operationId: getDeployment
1067
+ parameters:
1068
+ - name: id
1069
+ in: path
1070
+ required: true
1071
+ schema:
1072
+ type: string
1073
+ format: uuid
1074
+ responses:
1075
+ '200':
1076
+ description: ''
1077
+ content:
1078
+ application/json:
1079
+ schema:
1080
+ $ref: '#/components/schemas/Deployment'
1081
+ security:
1082
+ - access_token: []
1083
+ - user_token: []
1084
+ put:
1085
+ tags:
1086
+ - Deployments
1087
+ operationId: updateDeployment
1088
+ parameters:
1089
+ - name: id
1090
+ in: path
1091
+ required: true
1092
+ schema:
1093
+ type: string
1094
+ format: uuid
1095
+ requestBody:
1096
+ content:
1097
+ application/json:
1098
+ schema:
1099
+ $ref: '#/components/schemas/UpdateDeployment'
1100
+ required: true
1101
+ responses:
1102
+ '200':
1103
+ description: ''
1104
+ content:
1105
+ application/json:
1106
+ schema:
1107
+ $ref: '#/components/schemas/Deployment'
1108
+ security:
1109
+ - access_token: []
1110
+ - user_token: []
1111
+ delete:
1112
+ tags:
1113
+ - Deployments
1114
+ operationId: deleteDeployment
1115
+ parameters:
1116
+ - name: id
1117
+ in: path
1118
+ required: true
1119
+ schema:
1120
+ type: string
1121
+ format: uuid
1122
+ responses:
1123
+ '204':
1124
+ description: ''
1125
+ security:
1126
+ - access_token: []
1127
+ - user_token: []
1128
+ /api/v2/env-user-permissions:
1129
+ get:
1130
+ tags:
1131
+ - Env User Permissions
1132
+ operationId: allEnvUserPermissions
1133
+ parameters:
1134
+ - name: env_id
1135
+ in: query
1136
+ required: false
1137
+ schema:
1138
+ type: string
1139
+ format: uuid
1140
+ nullable: true
1141
+ - name: page
1142
+ in: query
1143
+ required: false
1144
+ schema:
1145
+ type: integer
1146
+ format: int64
1147
+ nullable: true
1148
+ - name: per_page
1149
+ in: query
1150
+ required: false
1151
+ schema:
1152
+ type: integer
1153
+ format: int64
1154
+ nullable: true
1155
+ responses:
1156
+ '200':
1157
+ description: ''
1158
+ content:
1159
+ application/json:
1160
+ schema:
1161
+ type: object
1162
+ required:
1163
+ - page
1164
+ - per_page
1165
+ - items
1166
+ - num_total
1167
+ properties:
1168
+ page:
1169
+ type: integer
1170
+ format: int64
1171
+ example: '1'
1172
+ per_page:
1173
+ type: integer
1174
+ format: int64
1175
+ example: '50'
1176
+ items:
1177
+ type: array
1178
+ items:
1179
+ type: object
1180
+ required:
1181
+ - id
1182
+ - created_at
1183
+ - env_id
1184
+ - user_id
1185
+ - role
1186
+ properties:
1187
+ id:
1188
+ type: string
1189
+ format: uuid
1190
+ created_at:
1191
+ type: string
1192
+ format: date-time
1193
+ env_id:
1194
+ type: string
1195
+ format: uuid
1196
+ user_id:
1197
+ type: string
1198
+ format: uuid
1199
+ role:
1200
+ $ref: '#/components/schemas/EnvUserRole'
1201
+ num_total:
1202
+ type: integer
1203
+ format: int64
1204
+ example: '1'
1205
+ security:
1206
+ - access_token: []
1207
+ - user_token: []
1208
+ post:
1209
+ tags:
1210
+ - Env User Permissions
1211
+ operationId: createEnvUserPermission
1212
+ requestBody:
1213
+ content:
1214
+ application/json:
1215
+ schema:
1216
+ $ref: '#/components/schemas/NewEnvUserPermission'
1217
+ required: true
1218
+ responses:
1219
+ '201':
1220
+ description: ''
1221
+ content:
1222
+ application/json:
1223
+ schema:
1224
+ $ref: '#/components/schemas/EnvUserPermission'
1225
+ security:
1226
+ - access_token: []
1227
+ - user_token: []
1228
+ /api/v2/env-user-permissions/{id}:
1229
+ get:
1230
+ tags:
1231
+ - Env User Permissions
1232
+ operationId: getEnvUserPermission
1233
+ parameters:
1234
+ - name: id
1235
+ in: path
1236
+ required: true
1237
+ schema:
1238
+ type: string
1239
+ format: uuid
1240
+ responses:
1241
+ '200':
1242
+ description: ''
1243
+ content:
1244
+ application/json:
1245
+ schema:
1246
+ $ref: '#/components/schemas/EnvUserPermission'
1247
+ security:
1248
+ - access_token: []
1249
+ - user_token: []
1250
+ delete:
1251
+ tags:
1252
+ - Env User Permissions
1253
+ operationId: deleteEnvUserPermission
1254
+ parameters:
1255
+ - name: id
1256
+ in: path
1257
+ required: true
1258
+ schema:
1259
+ type: string
1260
+ format: uuid
1261
+ responses:
1262
+ '204':
1263
+ description: ''
1264
+ security:
1265
+ - access_token: []
1266
+ - user_token: []
1267
+ /api/v2/envs:
1268
+ get:
1269
+ tags:
1270
+ - Envs
1271
+ operationId: allEnvs
1272
+ parameters:
1273
+ - name: name
1274
+ in: query
1275
+ required: false
1276
+ schema:
1277
+ type: string
1278
+ nullable: true
1279
+ - name: auto_add_new_users
1280
+ in: query
1281
+ required: false
1282
+ schema:
1283
+ type: boolean
1284
+ nullable: true
1285
+ - name: page
1286
+ in: query
1287
+ required: false
1288
+ schema:
1289
+ type: integer
1290
+ format: int64
1291
+ nullable: true
1292
+ - name: per_page
1293
+ in: query
1294
+ required: false
1295
+ schema:
1296
+ type: integer
1297
+ format: int64
1298
+ nullable: true
1299
+ responses:
1300
+ '200':
1301
+ description: ''
1302
+ content:
1303
+ application/json:
1304
+ schema:
1305
+ type: object
1306
+ required:
1307
+ - page
1308
+ - per_page
1309
+ - items
1310
+ - num_total
1311
+ properties:
1312
+ page:
1313
+ type: integer
1314
+ format: int64
1315
+ example: '1'
1316
+ per_page:
1317
+ type: integer
1318
+ format: int64
1319
+ example: '50'
1320
+ items:
1321
+ type: array
1322
+ items:
1323
+ type: object
1324
+ required:
1325
+ - id
1326
+ - created_at
1327
+ - name
1328
+ - node_selector
1329
+ - tolerations
1330
+ - auto_add_new_users
1331
+ properties:
1332
+ id:
1333
+ type: string
1334
+ format: uuid
1335
+ created_at:
1336
+ type: string
1337
+ format: date-time
1338
+ name:
1339
+ type: string
1340
+ node_selector: {}
1341
+ tolerations: {}
1342
+ auto_add_new_users:
1343
+ type: boolean
1344
+ num_total:
1345
+ type: integer
1346
+ format: int64
1347
+ example: '1'
1348
+ security:
1349
+ - access_token: []
1350
+ - user_token: []
1351
+ post:
1352
+ tags:
1353
+ - Envs
1354
+ operationId: createEnv
1355
+ requestBody:
1356
+ content:
1357
+ application/json:
1358
+ schema:
1359
+ $ref: '#/components/schemas/NewEnv'
1360
+ required: true
1361
+ responses:
1362
+ '201':
1363
+ description: ''
1364
+ content:
1365
+ application/json:
1366
+ schema:
1367
+ $ref: '#/components/schemas/Env'
1368
+ security:
1369
+ - access_token: []
1370
+ - user_token: []
1371
+ /api/v2/envs/{id}:
1372
+ get:
1373
+ tags:
1374
+ - Envs
1375
+ operationId: getEnv
1376
+ parameters:
1377
+ - name: id
1378
+ in: path
1379
+ required: true
1380
+ schema:
1381
+ type: string
1382
+ format: uuid
1383
+ responses:
1384
+ '200':
1385
+ description: ''
1386
+ content:
1387
+ application/json:
1388
+ schema:
1389
+ $ref: '#/components/schemas/Env'
1390
+ security:
1391
+ - access_token: []
1392
+ - user_token: []
1393
+ put:
1394
+ tags:
1395
+ - Envs
1396
+ operationId: updateEnv
1397
+ parameters:
1398
+ - name: id
1399
+ in: path
1400
+ required: true
1401
+ schema:
1402
+ type: string
1403
+ format: uuid
1404
+ requestBody:
1405
+ content:
1406
+ application/json:
1407
+ schema:
1408
+ $ref: '#/components/schemas/UpdateEnv'
1409
+ required: true
1410
+ responses:
1411
+ '200':
1412
+ description: ''
1413
+ content:
1414
+ application/json:
1415
+ schema:
1416
+ $ref: '#/components/schemas/Env'
1417
+ security:
1418
+ - access_token: []
1419
+ - user_token: []
1420
+ delete:
1421
+ tags:
1422
+ - Envs
1423
+ operationId: deleteEnv
1424
+ parameters:
1425
+ - name: id
1426
+ in: path
1427
+ required: true
1428
+ schema:
1429
+ type: string
1430
+ format: uuid
1431
+ responses:
1432
+ '204':
1433
+ description: ''
1434
+ security:
1435
+ - access_token: []
1436
+ - user_token: []
1437
+ /api/v2/helm-charts:
1438
+ get:
1439
+ tags:
1440
+ - Helm Charts
1441
+ operationId: allHelmCharts
1442
+ parameters:
1443
+ - name: helm_registry_id
1444
+ in: query
1445
+ required: false
1446
+ schema:
1447
+ type: string
1448
+ format: uuid
1449
+ nullable: true
1450
+ - name: parsed_branch
1451
+ in: query
1452
+ required: false
1453
+ schema:
1454
+ type: string
1455
+ nullable: true
1456
+ - name: page
1457
+ in: query
1458
+ required: false
1459
+ schema:
1460
+ type: integer
1461
+ format: int64
1462
+ nullable: true
1463
+ - name: per_page
1464
+ in: query
1465
+ required: false
1466
+ schema:
1467
+ type: integer
1468
+ format: int64
1469
+ nullable: true
1470
+ responses:
1471
+ '200':
1472
+ description: ''
1473
+ content:
1474
+ application/json:
1475
+ schema:
1476
+ type: object
1477
+ required:
1478
+ - page
1479
+ - per_page
1480
+ - items
1481
+ - num_total
1482
+ properties:
1483
+ page:
1484
+ type: integer
1485
+ format: int64
1486
+ example: '1'
1487
+ per_page:
1488
+ type: integer
1489
+ format: int64
1490
+ example: '50'
1491
+ items:
1492
+ type: array
1493
+ items:
1494
+ type: object
1495
+ required:
1496
+ - id
1497
+ - created_at
1498
+ - helm_registry_id
1499
+ - image_digest
1500
+ - image_tag
1501
+ - available
1502
+ - values_ui
1503
+ - actions_schema
1504
+ - features
1505
+ - resource_types
1506
+ - error
1507
+ - tag_format_id
1508
+ - parsed_version
1509
+ - parsed_revision
1510
+ - parsed_branch
1511
+ - parsed_commit
1512
+ properties:
1513
+ id:
1514
+ type: string
1515
+ format: uuid
1516
+ created_at:
1517
+ type: string
1518
+ format: date-time
1519
+ helm_registry_id:
1520
+ type: string
1521
+ format: uuid
1522
+ image_digest:
1523
+ type: string
1524
+ image_tag:
1525
+ type: string
1526
+ available:
1527
+ type: boolean
1528
+ values_ui:
1529
+ allOf:
1530
+ - $ref: '#/components/schemas/UiSchema'
1531
+ nullable: true
1532
+ actions_schema:
1533
+ allOf:
1534
+ - $ref: '#/components/schemas/ChartExtActions'
1535
+ nullable: true
1536
+ features:
1537
+ allOf:
1538
+ - $ref: '#/components/schemas/ChartExtFeatures'
1539
+ nullable: true
1540
+ resource_types:
1541
+ allOf:
1542
+ - $ref: '#/components/schemas/ChartExtResourceTypes'
1543
+ nullable: true
1544
+ error:
1545
+ type: string
1546
+ nullable: true
1547
+ tag_format_id:
1548
+ type: string
1549
+ format: uuid
1550
+ nullable: true
1551
+ parsed_version:
1552
+ type: string
1553
+ nullable: true
1554
+ parsed_revision:
1555
+ type: string
1556
+ nullable: true
1557
+ parsed_branch:
1558
+ type: string
1559
+ nullable: true
1560
+ parsed_commit:
1561
+ type: string
1562
+ nullable: true
1563
+ num_total:
1564
+ type: integer
1565
+ format: int64
1566
+ example: '1'
1567
+ security:
1568
+ - access_token: []
1569
+ - user_token: []
1570
+ /api/v2/helm-charts/{id}:
1571
+ get:
1572
+ tags:
1573
+ - Helm Charts
1574
+ operationId: getHelmChart
1575
+ parameters:
1576
+ - name: id
1577
+ in: path
1578
+ required: true
1579
+ schema:
1580
+ type: string
1581
+ format: uuid
1582
+ responses:
1583
+ '200':
1584
+ description: ''
1585
+ content:
1586
+ application/json:
1587
+ schema:
1588
+ $ref: '#/components/schemas/HelmChart'
1589
+ security:
1590
+ - access_token: []
1591
+ - user_token: []
1592
+ /api/v2/helm-registries:
1593
+ get:
1594
+ tags:
1595
+ - Helm Registries
1596
+ operationId: allHelmRegistries
1597
+ parameters:
1598
+ - name: repo_name
1599
+ in: query
1600
+ required: false
1601
+ schema:
1602
+ type: string
1603
+ nullable: true
1604
+ - name: kind_id
1605
+ in: query
1606
+ required: false
1607
+ schema:
1608
+ type: string
1609
+ format: uuid
1610
+ nullable: true
1611
+ - name: page
1612
+ in: query
1613
+ required: false
1614
+ schema:
1615
+ type: integer
1616
+ format: int64
1617
+ nullable: true
1618
+ - name: per_page
1619
+ in: query
1620
+ required: false
1621
+ schema:
1622
+ type: integer
1623
+ format: int64
1624
+ nullable: true
1625
+ responses:
1626
+ '200':
1627
+ description: ''
1628
+ content:
1629
+ application/json:
1630
+ schema:
1631
+ type: object
1632
+ required:
1633
+ - page
1634
+ - per_page
1635
+ - items
1636
+ - num_total
1637
+ properties:
1638
+ page:
1639
+ type: integer
1640
+ format: int64
1641
+ example: '1'
1642
+ per_page:
1643
+ type: integer
1644
+ format: int64
1645
+ example: '50'
1646
+ items:
1647
+ type: array
1648
+ items:
1649
+ type: object
1650
+ required:
1651
+ - id
1652
+ - created_at
1653
+ - domain_name
1654
+ - repo_name
1655
+ - kind_id
1656
+ - available
1657
+ - fa_icon
1658
+ properties:
1659
+ id:
1660
+ type: string
1661
+ format: uuid
1662
+ created_at:
1663
+ type: string
1664
+ format: date-time
1665
+ domain_name:
1666
+ type: string
1667
+ repo_name:
1668
+ type: string
1669
+ kind_id:
1670
+ type: string
1671
+ format: uuid
1672
+ available:
1673
+ type: boolean
1674
+ fa_icon:
1675
+ type: string
1676
+ num_total:
1677
+ type: integer
1678
+ format: int64
1679
+ example: '1'
1680
+ security:
1681
+ - access_token: []
1682
+ - user_token: []
1683
+ /api/v2/helm-registries/{id}:
1684
+ get:
1685
+ tags:
1686
+ - Helm Registries
1687
+ operationId: getHelmRegistry
1688
+ parameters:
1689
+ - name: id
1690
+ in: path
1691
+ required: true
1692
+ schema:
1693
+ type: string
1694
+ format: uuid
1695
+ responses:
1696
+ '200':
1697
+ description: ''
1698
+ content:
1699
+ application/json:
1700
+ schema:
1701
+ $ref: '#/components/schemas/HelmRegistry'
1702
+ security:
1703
+ - access_token: []
1704
+ - user_token: []
1705
+ put:
1706
+ tags:
1707
+ - Helm Registries
1708
+ operationId: updateHelmRegistry
1709
+ parameters:
1710
+ - name: id
1711
+ in: path
1712
+ required: true
1713
+ schema:
1714
+ type: string
1715
+ format: uuid
1716
+ requestBody:
1717
+ content:
1718
+ application/json:
1719
+ schema:
1720
+ $ref: '#/components/schemas/UpdateHelmRegistry'
1721
+ required: true
1722
+ responses:
1723
+ '200':
1724
+ description: ''
1725
+ content:
1726
+ application/json:
1727
+ schema:
1728
+ $ref: '#/components/schemas/HelmRegistry'
1729
+ security:
1730
+ - access_token: []
1731
+ - user_token: []
1732
+ /api/v2/helm-tag-formats:
1733
+ get:
1734
+ tags:
1735
+ - Helm Tag Formats
1736
+ operationId: allHelmTagFormats
1737
+ parameters:
1738
+ - name: pattern
1739
+ in: query
1740
+ required: false
1741
+ schema:
1742
+ type: string
1743
+ nullable: true
1744
+ - name: page
1745
+ in: query
1746
+ required: false
1747
+ schema:
1748
+ type: integer
1749
+ format: int64
1750
+ nullable: true
1751
+ - name: per_page
1752
+ in: query
1753
+ required: false
1754
+ schema:
1755
+ type: integer
1756
+ format: int64
1757
+ nullable: true
1758
+ responses:
1759
+ '200':
1760
+ description: ''
1761
+ content:
1762
+ application/json:
1763
+ schema:
1764
+ type: object
1765
+ required:
1766
+ - page
1767
+ - per_page
1768
+ - items
1769
+ - num_total
1770
+ properties:
1771
+ page:
1772
+ type: integer
1773
+ format: int64
1774
+ example: '1'
1775
+ per_page:
1776
+ type: integer
1777
+ format: int64
1778
+ example: '50'
1779
+ items:
1780
+ type: array
1781
+ items:
1782
+ type: object
1783
+ required:
1784
+ - id
1785
+ - created_at
1786
+ - pattern
1787
+ properties:
1788
+ id:
1789
+ type: string
1790
+ format: uuid
1791
+ created_at:
1792
+ type: string
1793
+ format: date-time
1794
+ pattern:
1795
+ type: string
1796
+ num_total:
1797
+ type: integer
1798
+ format: int64
1799
+ example: '1'
1800
+ security:
1801
+ - access_token: []
1802
+ - user_token: []
1803
+ post:
1804
+ tags:
1805
+ - Helm Tag Formats
1806
+ operationId: createHelmTagFormat
1807
+ requestBody:
1808
+ content:
1809
+ application/json:
1810
+ schema:
1811
+ $ref: '#/components/schemas/NewHelmTagFormat'
1812
+ required: true
1813
+ responses:
1814
+ '201':
1815
+ description: ''
1816
+ content:
1817
+ application/json:
1818
+ schema:
1819
+ $ref: '#/components/schemas/HelmTagFormat'
1820
+ security:
1821
+ - access_token: []
1822
+ - user_token: []
1823
+ /api/v2/helm-tag-formats/{id}:
1824
+ get:
1825
+ tags:
1826
+ - Helm Tag Formats
1827
+ operationId: getHelmTagFormat
1828
+ parameters:
1829
+ - name: id
1830
+ in: path
1831
+ required: true
1832
+ schema:
1833
+ type: string
1834
+ format: uuid
1835
+ responses:
1836
+ '200':
1837
+ description: ''
1838
+ content:
1839
+ application/json:
1840
+ schema:
1841
+ $ref: '#/components/schemas/HelmTagFormat'
1842
+ security:
1843
+ - access_token: []
1844
+ - user_token: []
1845
+ delete:
1846
+ tags:
1847
+ - Helm Tag Formats
1848
+ operationId: deleteHelmTagFormat
1849
+ parameters:
1850
+ - name: id
1851
+ in: path
1852
+ required: true
1853
+ schema:
1854
+ type: string
1855
+ format: uuid
1856
+ responses:
1857
+ '204':
1858
+ description: ''
1859
+ security:
1860
+ - access_token: []
1861
+ - user_token: []
1862
+ /api/v2/k8s-clusters:
1863
+ get:
1864
+ tags:
1865
+ - Kubernetes Clusters
1866
+ operationId: allK8sClusters
1867
+ parameters:
1868
+ - name: env_id
1869
+ in: query
1870
+ required: false
1871
+ schema:
1872
+ type: string
1873
+ format: uuid
1874
+ nullable: true
1875
+ - name: name
1876
+ in: query
1877
+ required: false
1878
+ schema:
1879
+ type: string
1880
+ nullable: true
1881
+ - name: page
1882
+ in: query
1883
+ required: false
1884
+ schema:
1885
+ type: integer
1886
+ format: int64
1887
+ nullable: true
1888
+ - name: per_page
1889
+ in: query
1890
+ required: false
1891
+ schema:
1892
+ type: integer
1893
+ format: int64
1894
+ nullable: true
1895
+ responses:
1896
+ '200':
1897
+ description: ''
1898
+ content:
1899
+ application/json:
1900
+ schema:
1901
+ type: object
1902
+ required:
1903
+ - page
1904
+ - per_page
1905
+ - items
1906
+ - num_total
1907
+ properties:
1908
+ page:
1909
+ type: integer
1910
+ format: int64
1911
+ example: '1'
1912
+ per_page:
1913
+ type: integer
1914
+ format: int64
1915
+ example: '50'
1916
+ items:
1917
+ type: array
1918
+ items:
1919
+ type: object
1920
+ required:
1921
+ - id
1922
+ - env_id
1923
+ - provider_id
1924
+ - created_at
1925
+ - last_seen_at
1926
+ - name
1927
+ - region_name
1928
+ - is_ok
1929
+ - not_ok_reason
1930
+ - ignore
1931
+ - ingress_domain
1932
+ - ingress_class
1933
+ - ingress_tls_secret_name
1934
+ - grafana_url
1935
+ - grafana_datasource_name
1936
+ properties:
1937
+ id:
1938
+ type: string
1939
+ format: uuid
1940
+ env_id:
1941
+ type: string
1942
+ format: uuid
1943
+ nullable: true
1944
+ provider_id:
1945
+ type: string
1946
+ created_at:
1947
+ type: string
1948
+ format: date-time
1949
+ last_seen_at:
1950
+ type: string
1951
+ format: date-time
1952
+ name:
1953
+ type: string
1954
+ region_name:
1955
+ type: string
1956
+ is_ok:
1957
+ type: boolean
1958
+ not_ok_reason:
1959
+ type: string
1960
+ nullable: true
1961
+ ignore:
1962
+ type: boolean
1963
+ ingress_domain:
1964
+ type: string
1965
+ nullable: true
1966
+ ingress_class:
1967
+ type: string
1968
+ nullable: true
1969
+ ingress_tls_secret_name:
1970
+ type: string
1971
+ nullable: true
1972
+ grafana_url:
1973
+ type: string
1974
+ nullable: true
1975
+ grafana_datasource_name:
1976
+ type: string
1977
+ nullable: true
1978
+ num_total:
1979
+ type: integer
1980
+ format: int64
1981
+ example: '1'
1982
+ security:
1983
+ - access_token: []
1984
+ - user_token: []
1985
+ /api/v2/k8s-clusters/{id}:
1986
+ get:
1987
+ tags:
1988
+ - Kubernetes Clusters
1989
+ operationId: getK8sCluster
1990
+ parameters:
1991
+ - name: id
1992
+ in: path
1993
+ required: true
1994
+ schema:
1995
+ type: string
1996
+ format: uuid
1997
+ responses:
1998
+ '200':
1999
+ description: ''
2000
+ content:
2001
+ application/json:
2002
+ schema:
2003
+ $ref: '#/components/schemas/K8sCluster'
2004
+ security:
2005
+ - access_token: []
2006
+ - user_token: []
2007
+ put:
2008
+ tags:
2009
+ - Kubernetes Clusters
2010
+ operationId: updateK8sCluster
2011
+ parameters:
2012
+ - name: id
2013
+ in: path
2014
+ required: true
2015
+ schema:
2016
+ type: string
2017
+ format: uuid
2018
+ requestBody:
2019
+ content:
2020
+ application/json:
2021
+ schema:
2022
+ $ref: '#/components/schemas/UpdateK8sCluster'
2023
+ required: true
2024
+ responses:
2025
+ '200':
2026
+ description: ''
2027
+ content:
2028
+ application/json:
2029
+ schema:
2030
+ $ref: '#/components/schemas/K8sCluster'
2031
+ security:
2032
+ - access_token: []
2033
+ - user_token: []
2034
+ delete:
2035
+ tags:
2036
+ - Kubernetes Clusters
2037
+ operationId: deleteK8sCluster
2038
+ parameters:
2039
+ - name: id
2040
+ in: path
2041
+ required: true
2042
+ schema:
2043
+ type: string
2044
+ format: uuid
2045
+ responses:
2046
+ '204':
2047
+ description: ''
2048
+ security:
2049
+ - access_token: []
2050
+ - user_token: []
2051
+ /api/v2/k8s-resources:
2052
+ get:
2053
+ tags:
2054
+ - Kubernetes Resources
2055
+ operationId: allK8sResources
2056
+ parameters:
2057
+ - name: cluster_id
2058
+ in: query
2059
+ required: false
2060
+ schema:
2061
+ type: string
2062
+ format: uuid
2063
+ nullable: true
2064
+ - name: deployment_id
2065
+ in: query
2066
+ required: false
2067
+ schema:
2068
+ type: string
2069
+ format: uuid
2070
+ nullable: true
2071
+ - name: kind
2072
+ in: query
2073
+ required: false
2074
+ schema:
2075
+ type: string
2076
+ nullable: true
2077
+ - name: name
2078
+ in: query
2079
+ required: false
2080
+ schema:
2081
+ type: string
2082
+ nullable: true
2083
+ - name: page
2084
+ in: query
2085
+ required: false
2086
+ schema:
2087
+ type: integer
2088
+ format: int64
2089
+ nullable: true
2090
+ - name: per_page
2091
+ in: query
2092
+ required: false
2093
+ schema:
2094
+ type: integer
2095
+ format: int64
2096
+ nullable: true
2097
+ responses:
2098
+ '200':
2099
+ description: ''
2100
+ content:
2101
+ application/json:
2102
+ schema:
2103
+ type: object
2104
+ required:
2105
+ - page
2106
+ - per_page
2107
+ - items
2108
+ - num_total
2109
+ properties:
2110
+ page:
2111
+ type: integer
2112
+ format: int64
2113
+ example: '1'
2114
+ per_page:
2115
+ type: integer
2116
+ format: int64
2117
+ example: '50'
2118
+ items:
2119
+ type: array
2120
+ items:
2121
+ type: object
2122
+ required:
2123
+ - id
2124
+ - last_updated_at
2125
+ - cluster_id
2126
+ - deployment_id
2127
+ - kind
2128
+ - api_version
2129
+ - name
2130
+ - status_color
2131
+ - metadata
2132
+ properties:
2133
+ id:
2134
+ type: string
2135
+ format: uuid
2136
+ last_updated_at:
2137
+ type: string
2138
+ format: date-time
2139
+ cluster_id:
2140
+ type: string
2141
+ format: uuid
2142
+ deployment_id:
2143
+ type: string
2144
+ format: uuid
2145
+ kind:
2146
+ type: string
2147
+ api_version:
2148
+ type: string
2149
+ name:
2150
+ type: string
2151
+ status_color:
2152
+ type: array
2153
+ items:
2154
+ type: string
2155
+ metadata: {}
2156
+ num_total:
2157
+ type: integer
2158
+ format: int64
2159
+ example: '1'
2160
+ security:
2161
+ - access_token: []
2162
+ - user_token: []
2163
+ /api/v2/k8s-resources/{id}:
2164
+ get:
2165
+ tags:
2166
+ - Kubernetes Resources
2167
+ operationId: getK8sResource
2168
+ parameters:
2169
+ - name: id
2170
+ in: path
2171
+ required: true
2172
+ schema:
2173
+ type: string
2174
+ format: uuid
2175
+ responses:
2176
+ '200':
2177
+ description: ''
2178
+ content:
2179
+ application/json:
2180
+ schema:
2181
+ $ref: '#/components/schemas/K8sResource'
2182
+ security:
2183
+ - access_token: []
2184
+ - user_token: []
2185
+ /api/v2/secrets:
2186
+ get:
2187
+ tags:
2188
+ - Secrets
2189
+ operationId: allSecrets
2190
+ parameters:
2191
+ - name: env_id
2192
+ in: query
2193
+ required: false
2194
+ schema:
2195
+ type: string
2196
+ format: uuid
2197
+ nullable: true
2198
+ - name: collection
2199
+ in: query
2200
+ required: false
2201
+ schema:
2202
+ type: string
2203
+ nullable: true
2204
+ - name: name
2205
+ in: query
2206
+ required: false
2207
+ schema:
2208
+ type: string
2209
+ nullable: true
2210
+ - name: page
2211
+ in: query
2212
+ required: false
2213
+ schema:
2214
+ type: integer
2215
+ format: int64
2216
+ nullable: true
2217
+ - name: per_page
2218
+ in: query
2219
+ required: false
2220
+ schema:
2221
+ type: integer
2222
+ format: int64
2223
+ nullable: true
2224
+ responses:
2225
+ '200':
2226
+ description: ''
2227
+ content:
2228
+ application/json:
2229
+ schema:
2230
+ type: object
2231
+ required:
2232
+ - page
2233
+ - per_page
2234
+ - items
2235
+ - num_total
2236
+ properties:
2237
+ page:
2238
+ type: integer
2239
+ format: int64
2240
+ example: '1'
2241
+ per_page:
2242
+ type: integer
2243
+ format: int64
2244
+ example: '50'
2245
+ items:
2246
+ type: array
2247
+ items:
2248
+ type: object
2249
+ required:
2250
+ - id
2251
+ - created_at
2252
+ - updated_at
2253
+ - env_id
2254
+ - collection
2255
+ - name
2256
+ properties:
2257
+ id:
2258
+ type: string
2259
+ format: uuid
2260
+ created_at:
2261
+ type: string
2262
+ format: date-time
2263
+ updated_at:
2264
+ type: string
2265
+ format: date-time
2266
+ env_id:
2267
+ type: string
2268
+ format: uuid
2269
+ collection:
2270
+ type: string
2271
+ name:
2272
+ type: string
2273
+ num_total:
2274
+ type: integer
2275
+ format: int64
2276
+ example: '1'
2277
+ security:
2278
+ - access_token: []
2279
+ - user_token: []
2280
+ post:
2281
+ tags:
2282
+ - Secrets
2283
+ operationId: createSecret
2284
+ requestBody:
2285
+ content:
2286
+ application/json:
2287
+ schema:
2288
+ $ref: '#/components/schemas/NewSecret'
2289
+ required: true
2290
+ responses:
2291
+ '201':
2292
+ description: ''
2293
+ content:
2294
+ application/json:
2295
+ schema:
2296
+ $ref: '#/components/schemas/Secret'
2297
+ security:
2298
+ - access_token: []
2299
+ - user_token: []
2300
+ /api/v2/secrets/{id}:
2301
+ get:
2302
+ tags:
2303
+ - Secrets
2304
+ operationId: getSecret
2305
+ parameters:
2306
+ - name: id
2307
+ in: path
2308
+ required: true
2309
+ schema:
2310
+ type: string
2311
+ format: uuid
2312
+ responses:
2313
+ '200':
2314
+ description: ''
2315
+ content:
2316
+ application/json:
2317
+ schema:
2318
+ $ref: '#/components/schemas/Secret'
2319
+ security:
2320
+ - access_token: []
2321
+ - user_token: []
2322
+ put:
2323
+ tags:
2324
+ - Secrets
2325
+ operationId: updateSecret
2326
+ parameters:
2327
+ - name: id
2328
+ in: path
2329
+ required: true
2330
+ schema:
2331
+ type: string
2332
+ format: uuid
2333
+ requestBody:
2334
+ content:
2335
+ application/json:
2336
+ schema:
2337
+ $ref: '#/components/schemas/UpdateSecret'
2338
+ required: true
2339
+ responses:
2340
+ '200':
2341
+ description: ''
2342
+ content:
2343
+ application/json:
2344
+ schema:
2345
+ $ref: '#/components/schemas/Secret'
2346
+ security:
2347
+ - access_token: []
2348
+ - user_token: []
2349
+ delete:
2350
+ tags:
2351
+ - Secrets
2352
+ operationId: deleteSecret
2353
+ parameters:
2354
+ - name: id
2355
+ in: path
2356
+ required: true
2357
+ schema:
2358
+ type: string
2359
+ format: uuid
2360
+ responses:
2361
+ '204':
2362
+ description: ''
2363
+ security:
2364
+ - access_token: []
2365
+ - user_token: []
2366
+ /api/v2/server:
2367
+ get:
2368
+ tags:
2369
+ - Server
2370
+ operationId: getServerInfo
2371
+ responses:
2372
+ '200':
2373
+ description: ''
2374
+ content:
2375
+ application/json:
2376
+ schema:
2377
+ $ref: '#/components/schemas/ServerInfo'
2378
+ security:
2379
+ - access_token: []
2380
+ - user_token: []
2381
+ /api/v2/user-tokens:
2382
+ get:
2383
+ tags:
2384
+ - User Tokens
2385
+ operationId: allUserTokens
2386
+ parameters:
2387
+ - name: user_id
2388
+ in: query
2389
+ required: false
2390
+ schema:
2391
+ type: string
2392
+ format: uuid
2393
+ nullable: true
2394
+ - name: page
2395
+ in: query
2396
+ required: false
2397
+ schema:
2398
+ type: integer
2399
+ format: int64
2400
+ nullable: true
2401
+ - name: per_page
2402
+ in: query
2403
+ required: false
2404
+ schema:
2405
+ type: integer
2406
+ format: int64
2407
+ nullable: true
2408
+ responses:
2409
+ '200':
2410
+ description: ''
2411
+ content:
2412
+ application/json:
2413
+ schema:
2414
+ type: object
2415
+ required:
2416
+ - page
2417
+ - per_page
2418
+ - items
2419
+ - num_total
2420
+ properties:
2421
+ page:
2422
+ type: integer
2423
+ format: int64
2424
+ example: '1'
2425
+ per_page:
2426
+ type: integer
2427
+ format: int64
2428
+ example: '50'
2429
+ items:
2430
+ type: array
2431
+ items:
2432
+ type: object
2433
+ required:
2434
+ - id
2435
+ - user_id
2436
+ - created_at
2437
+ properties:
2438
+ id:
2439
+ type: string
2440
+ format: uuid
2441
+ user_id:
2442
+ type: string
2443
+ format: uuid
2444
+ created_at:
2445
+ type: string
2446
+ format: date-time
2447
+ num_total:
2448
+ type: integer
2449
+ format: int64
2450
+ example: '1'
2451
+ security:
2452
+ - access_token: []
2453
+ - user_token: []
2454
+ post:
2455
+ tags:
2456
+ - User Tokens
2457
+ operationId: createUserToken
2458
+ requestBody:
2459
+ content:
2460
+ application/json:
2461
+ schema:
2462
+ $ref: '#/components/schemas/CreateUserToken'
2463
+ required: true
2464
+ responses:
2465
+ '201':
2466
+ description: ''
2467
+ content:
2468
+ application/json:
2469
+ schema:
2470
+ $ref: '#/components/schemas/CreatedUserToken'
2471
+ security:
2472
+ - access_token: []
2473
+ - user_token: []
2474
+ /api/v2/user-tokens/{id}:
2475
+ get:
2476
+ tags:
2477
+ - User Tokens
2478
+ operationId: getUserToken
2479
+ parameters:
2480
+ - name: id
2481
+ in: path
2482
+ required: true
2483
+ schema:
2484
+ type: string
2485
+ format: uuid
2486
+ responses:
2487
+ '200':
2488
+ description: ''
2489
+ content:
2490
+ application/json:
2491
+ schema:
2492
+ $ref: '#/components/schemas/UserToken'
2493
+ security:
2494
+ - access_token: []
2495
+ - user_token: []
2496
+ delete:
2497
+ tags:
2498
+ - User Tokens
2499
+ operationId: deleteUserToken
2500
+ parameters:
2501
+ - name: id
2502
+ in: path
2503
+ required: true
2504
+ schema:
2505
+ type: string
2506
+ format: uuid
2507
+ responses:
2508
+ '204':
2509
+ description: ''
2510
+ security:
2511
+ - access_token: []
2512
+ - user_token: []
2513
+ /api/v2/users:
2514
+ get:
2515
+ tags:
2516
+ - Users
2517
+ operationId: allUsers
2518
+ parameters:
2519
+ - name: display_name
2520
+ in: query
2521
+ required: false
2522
+ schema:
2523
+ type: string
2524
+ nullable: true
2525
+ - name: email
2526
+ in: query
2527
+ required: false
2528
+ schema:
2529
+ type: string
2530
+ nullable: true
2531
+ - name: is_active
2532
+ in: query
2533
+ required: false
2534
+ schema:
2535
+ type: boolean
2536
+ nullable: true
2537
+ - name: page
2538
+ in: query
2539
+ required: false
2540
+ schema:
2541
+ type: integer
2542
+ format: int64
2543
+ nullable: true
2544
+ - name: per_page
2545
+ in: query
2546
+ required: false
2547
+ schema:
2548
+ type: integer
2549
+ format: int64
2550
+ nullable: true
2551
+ responses:
2552
+ '200':
2553
+ description: ''
2554
+ content:
2555
+ application/json:
2556
+ schema:
2557
+ type: object
2558
+ required:
2559
+ - page
2560
+ - per_page
2561
+ - items
2562
+ - num_total
2563
+ properties:
2564
+ page:
2565
+ type: integer
2566
+ format: int64
2567
+ example: '1'
2568
+ per_page:
2569
+ type: integer
2570
+ format: int64
2571
+ example: '50'
2572
+ items:
2573
+ type: array
2574
+ items:
2575
+ type: object
2576
+ required:
2577
+ - id
2578
+ - created_at
2579
+ - display_name
2580
+ - email
2581
+ - is_admin
2582
+ - is_active
2583
+ properties:
2584
+ id:
2585
+ type: string
2586
+ format: uuid
2587
+ created_at:
2588
+ type: string
2589
+ format: date-time
2590
+ display_name:
2591
+ type: string
2592
+ email:
2593
+ type: string
2594
+ is_admin:
2595
+ type: boolean
2596
+ is_active:
2597
+ type: boolean
2598
+ num_total:
2599
+ type: integer
2600
+ format: int64
2601
+ example: '1'
2602
+ security:
2603
+ - access_token: []
2604
+ - user_token: []
2605
+ /api/v2/users/{id}:
2606
+ get:
2607
+ tags:
2608
+ - Users
2609
+ operationId: getUser
2610
+ parameters:
2611
+ - name: id
2612
+ in: path
2613
+ required: true
2614
+ schema:
2615
+ type: string
2616
+ format: uuid
2617
+ responses:
2618
+ '200':
2619
+ description: ''
2620
+ content:
2621
+ application/json:
2622
+ schema:
2623
+ $ref: '#/components/schemas/User'
2624
+ security:
2625
+ - access_token: []
2626
+ - user_token: []
2627
+ put:
2628
+ tags:
2629
+ - Users
2630
+ operationId: updateUser
2631
+ parameters:
2632
+ - name: id
2633
+ in: path
2634
+ required: true
2635
+ schema:
2636
+ type: string
2637
+ format: uuid
2638
+ requestBody:
2639
+ content:
2640
+ application/json:
2641
+ schema:
2642
+ $ref: '#/components/schemas/UpdateUser'
2643
+ required: true
2644
+ responses:
2645
+ '200':
2646
+ description: ''
2647
+ content:
2648
+ application/json:
2649
+ schema:
2650
+ $ref: '#/components/schemas/User'
2651
+ security:
2652
+ - access_token: []
2653
+ - user_token: []
2654
+ components:
2655
+ schemas:
2656
+ Bot:
2657
+ type: object
2658
+ required:
2659
+ - id
2660
+ - created_at
2661
+ - display_name
2662
+ properties:
2663
+ id:
2664
+ type: string
2665
+ format: uuid
2666
+ created_at:
2667
+ type: string
2668
+ format: date-time
2669
+ display_name:
2670
+ type: string
2671
+ CancelDeploymentTask:
2672
+ type: object
2673
+ required:
2674
+ - reason
2675
+ properties:
2676
+ reason:
2677
+ type: string
2678
+ nullable: true
2679
+ ChartExt:
2680
+ type: object
2681
+ properties:
2682
+ metadata:
2683
+ allOf:
2684
+ - $ref: '#/components/schemas/ChartMetadata'
2685
+ nullable: true
2686
+ ui_schema:
2687
+ allOf:
2688
+ - $ref: '#/components/schemas/UiSchema'
2689
+ nullable: true
2690
+ actions:
2691
+ allOf:
2692
+ - $ref: '#/components/schemas/ChartExtActions'
2693
+ nullable: true
2694
+ features:
2695
+ allOf:
2696
+ - $ref: '#/components/schemas/ChartExtFeatures'
2697
+ nullable: true
2698
+ resource_types:
2699
+ allOf:
2700
+ - $ref: '#/components/schemas/ChartExtResourceTypes'
2701
+ nullable: true
2702
+ error:
2703
+ type: string
2704
+ nullable: true
2705
+ ChartExtActionEndpoint:
2706
+ type: string
2707
+ enum:
2708
+ - standard_ingress
2709
+ ChartExtActionMethod:
2710
+ type: string
2711
+ enum:
2712
+ - GET
2713
+ - POST
2714
+ - PUT
2715
+ - PATCH
2716
+ - DELETE
2717
+ ChartExtActionTarget:
2718
+ type: object
2719
+ required:
2720
+ - endpoint
2721
+ - path
2722
+ - method
2723
+ properties:
2724
+ endpoint:
2725
+ $ref: '#/components/schemas/ChartExtActionEndpoint'
2726
+ path:
2727
+ type: string
2728
+ method:
2729
+ $ref: '#/components/schemas/ChartExtActionMethod'
2730
+ ChartExtActionUserDeploymentRole:
2731
+ type: string
2732
+ enum:
2733
+ - Owner
2734
+ - Maintainer
2735
+ ChartExtActionV0:
2736
+ allOf:
2737
+ - $ref: '#/components/schemas/ChartExtActionTarget'
2738
+ - type: object
2739
+ required:
2740
+ - id
2741
+ - allowed_role
2742
+ - title
2743
+ - description
2744
+ properties:
2745
+ id:
2746
+ type: string
2747
+ allowed_role:
2748
+ $ref: '#/components/schemas/ChartExtActionUserDeploymentRole'
2749
+ allowed_on_statuses:
2750
+ type: array
2751
+ items:
2752
+ type: string
2753
+ title:
2754
+ type: string
2755
+ fontawesome_icon:
2756
+ type: string
2757
+ nullable: true
2758
+ description:
2759
+ type: string
2760
+ dangerous:
2761
+ type: boolean
2762
+ ui_schema:
2763
+ allOf:
2764
+ - $ref: '#/components/schemas/UiSchema'
2765
+ nullable: true
2766
+ ChartExtActionV1Beta1:
2767
+ type: object
2768
+ required:
2769
+ - apiVersion
2770
+ - kind
2771
+ - spec
2772
+ properties:
2773
+ apiVersion:
2774
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
2775
+ kind:
2776
+ $ref: '#/components/schemas/ChartExtKindAction'
2777
+ spec:
2778
+ $ref: '#/components/schemas/ChartExtActionV0'
2779
+ ChartExtActions:
2780
+ oneOf:
2781
+ - $ref: '#/components/schemas/ChartExtActionsV1Beta1'
2782
+ - $ref: '#/components/schemas/ChartExtActionsV0'
2783
+ ChartExtActionsV0:
2784
+ type: object
2785
+ required:
2786
+ - schema_version
2787
+ - actions
2788
+ properties:
2789
+ schema_version:
2790
+ type: integer
2791
+ format: int64
2792
+ minimum: 0
2793
+ actions:
2794
+ type: array
2795
+ items:
2796
+ $ref: '#/components/schemas/ChartExtActionV0'
2797
+ ChartExtActionsV1Beta1:
2798
+ type: array
2799
+ items:
2800
+ $ref: '#/components/schemas/ChartExtActionV1Beta1'
2801
+ ChartExtCardinality:
2802
+ type: string
2803
+ enum:
2804
+ - Many
2805
+ - OnePerCluster
2806
+ ChartExtDeploymentDisplay:
2807
+ type: object
2808
+ properties:
2809
+ name:
2810
+ allOf:
2811
+ - $ref: '#/components/schemas/ChartExtDeploymentDisplayName'
2812
+ nullable: true
2813
+ icon:
2814
+ allOf:
2815
+ - $ref: '#/components/schemas/ChartExtDeploymentDisplayIcon'
2816
+ nullable: true
2817
+ additionalProperties: false
2818
+ ChartExtDeploymentDisplayIcon:
2819
+ type: object
2820
+ required:
2821
+ - font_awesome
2822
+ properties:
2823
+ font_awesome:
2824
+ type: string
2825
+ additionalProperties: false
2826
+ ChartExtDeploymentDisplayName:
2827
+ oneOf:
2828
+ - type: string
2829
+ enum:
2830
+ - DeploymentName
2831
+ - type: object
2832
+ required:
2833
+ - InputField
2834
+ properties:
2835
+ InputField:
2836
+ $ref: '#/components/schemas/ChartExtDeploymentDisplayNameInputField'
2837
+ ChartExtDeploymentDisplayNameInputField:
2838
+ type: object
2839
+ required:
2840
+ - name
2841
+ properties:
2842
+ name:
2843
+ type: string
2844
+ additionalProperties: false
2845
+ ChartExtFeatures:
2846
+ oneOf:
2847
+ - $ref: '#/components/schemas/ChartExtFeaturesV1Beta2'
2848
+ - $ref: '#/components/schemas/ChartExtFeaturesV1Beta1'
2849
+ - $ref: '#/components/schemas/ChartExtFeaturesV0'
2850
+ ChartExtFeaturesSpec:
2851
+ type: object
2852
+ properties:
2853
+ ingress:
2854
+ $ref: '#/components/schemas/ChartExtIngress'
2855
+ status:
2856
+ allOf:
2857
+ - $ref: '#/components/schemas/ChartExtStatusFeature'
2858
+ nullable: true
2859
+ cardinality:
2860
+ $ref: '#/components/schemas/ChartExtCardinality'
2861
+ reinstall_dependencies:
2862
+ type: boolean
2863
+ description: |-
2864
+ Should dependent deployments be reinstalled when this deployment
2865
+ config/values are updated. This doesn't apply to renames or
2866
+ moving between clusters which always reinstalls dependencies.
2867
+ node_selector_paths:
2868
+ type: array
2869
+ items:
2870
+ type: array
2871
+ items:
2872
+ type: string
2873
+ description: |-
2874
+ Paths to inject the node selector to. Node selector is always
2875
+ added at the values top level `nodeSelector`.
2876
+ tolerations_paths:
2877
+ type: array
2878
+ items:
2879
+ type: array
2880
+ items:
2881
+ type: string
2882
+ description: Same for tolerations
2883
+ display:
2884
+ $ref: '#/components/schemas/ChartExtDeploymentDisplay'
2885
+ ChartExtFeaturesV0:
2886
+ type: object
2887
+ properties:
2888
+ standard_ingress:
2889
+ type: boolean
2890
+ description: |-
2891
+ When true, values.yaml is injected with an `ingress` section
2892
+ that matches the structure generated by `helm create`. This
2893
+ generates the hostname and sets TLS correctly.
2894
+ status:
2895
+ allOf:
2896
+ - $ref: '#/components/schemas/ChartExtStatusFeature'
2897
+ nullable: true
2898
+ cardinality:
2899
+ $ref: '#/components/schemas/ChartExtCardinality'
2900
+ reinstall_dependencies:
2901
+ type: boolean
2902
+ description: |-
2903
+ Should dependent deployments be reinstalled when this deployment
2904
+ config/values are updated. This doesn't apply to renames or
2905
+ moving between clusters which always reinstalls dependencies.
2906
+ node_selector_paths:
2907
+ type: array
2908
+ items:
2909
+ type: array
2910
+ items:
2911
+ type: string
2912
+ description: |-
2913
+ Paths to inject the node selector to. Node selector is always
2914
+ added at the values top level `nodeSelector`.
2915
+ tolerations_paths:
2916
+ type: array
2917
+ items:
2918
+ type: array
2919
+ items:
2920
+ type: string
2921
+ description: Same for tolerations
2922
+ ChartExtFeaturesV1Beta1:
2923
+ type: object
2924
+ required:
2925
+ - apiVersion
2926
+ - kind
2927
+ - spec
2928
+ properties:
2929
+ apiVersion:
2930
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
2931
+ kind:
2932
+ $ref: '#/components/schemas/ChartExtKindFeatures'
2933
+ spec:
2934
+ $ref: '#/components/schemas/ChartExtFeaturesV0'
2935
+ ChartExtFeaturesV1Beta2:
2936
+ type: object
2937
+ required:
2938
+ - apiVersion
2939
+ - kind
2940
+ - spec
2941
+ properties:
2942
+ apiVersion:
2943
+ $ref: '#/components/schemas/ChartExtVersionV1Beta2'
2944
+ kind:
2945
+ $ref: '#/components/schemas/ChartExtKindFeatures'
2946
+ spec:
2947
+ $ref: '#/components/schemas/ChartExtFeaturesSpec'
2948
+ ChartExtIngress:
2949
+ type: object
2950
+ required:
2951
+ - enabled
2952
+ properties:
2953
+ enabled:
2954
+ type: boolean
2955
+ hostname_format:
2956
+ $ref: '#/components/schemas/ChartExtIngressHostnameFormat'
2957
+ ChartExtIngressHostnameFormat:
2958
+ type: string
2959
+ enum:
2960
+ - Name
2961
+ - KindAndName
2962
+ ChartExtKindAction:
2963
+ type: string
2964
+ enum:
2965
+ - Action
2966
+ ChartExtKindFeatures:
2967
+ type: string
2968
+ enum:
2969
+ - Features
2970
+ ChartExtKindResourceType:
2971
+ type: string
2972
+ enum:
2973
+ - ResourceType
2974
+ ChartExtKindValuesUi:
2975
+ type: string
2976
+ enum:
2977
+ - ValuesUi
2978
+ ChartExtResourceLifecycleActionV1Beta1:
2979
+ type: object
2980
+ properties:
2981
+ allowed_role:
2982
+ allOf:
2983
+ - $ref: '#/components/schemas/ChartExtActionUserDeploymentRole'
2984
+ nullable: true
2985
+ target:
2986
+ allOf:
2987
+ - $ref: '#/components/schemas/ChartExtActionTarget'
2988
+ nullable: true
2989
+ ChartExtResourceLifecycleV1Beta1:
2990
+ type: object
2991
+ properties:
2992
+ create:
2993
+ allOf:
2994
+ - $ref: '#/components/schemas/ChartExtResourceLifecycleActionV1Beta1'
2995
+ nullable: true
2996
+ update:
2997
+ allOf:
2998
+ - $ref: '#/components/schemas/ChartExtResourceLifecycleActionV1Beta1'
2999
+ nullable: true
3000
+ delete:
3001
+ allOf:
3002
+ - $ref: '#/components/schemas/ChartExtResourceLifecycleActionV1Beta1'
3003
+ nullable: true
3004
+ ChartExtResourceType:
3005
+ oneOf:
3006
+ - $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1'
3007
+ ChartExtResourceTypeV1Beta1:
3008
+ type: object
3009
+ required:
3010
+ - apiVersion
3011
+ - kind
3012
+ - key
3013
+ - spec
3014
+ properties:
3015
+ apiVersion:
3016
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
3017
+ kind:
3018
+ $ref: '#/components/schemas/ChartExtKindResourceType'
3019
+ key:
3020
+ type: string
3021
+ spec:
3022
+ $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1Spec'
3023
+ ChartExtResourceTypeV1Beta1Spec:
3024
+ type: object
3025
+ required:
3026
+ - name_singular
3027
+ - name_plural
3028
+ - fontawesome_icon
3029
+ - values_ui
3030
+ properties:
3031
+ name_singular:
3032
+ type: string
3033
+ name_plural:
3034
+ type: string
3035
+ fontawesome_icon:
3036
+ type: string
3037
+ global:
3038
+ type: boolean
3039
+ values_ui:
3040
+ $ref: '#/components/schemas/UiSchemaV0'
3041
+ lifecycle:
3042
+ $ref: '#/components/schemas/ChartExtResourceLifecycleV1Beta1'
3043
+ ChartExtResourceTypes:
3044
+ type: array
3045
+ items:
3046
+ $ref: '#/components/schemas/ChartExtResourceType'
3047
+ ChartExtStatusFeature:
3048
+ type: object
3049
+ required:
3050
+ - endpoint
3051
+ - path
3052
+ - refresh_interval_secs
3053
+ properties:
3054
+ endpoint:
3055
+ $ref: '#/components/schemas/ChartExtActionEndpoint'
3056
+ path:
3057
+ type: string
3058
+ refresh_interval_secs:
3059
+ type: integer
3060
+ format: int64
3061
+ minimum: 0
3062
+ ChartExtVersionV1Beta1:
3063
+ type: string
3064
+ enum:
3065
+ - platz.io/v1beta1
3066
+ ChartExtVersionV1Beta2:
3067
+ type: string
3068
+ enum:
3069
+ - platz.io/v1beta2
3070
+ ChartMetadata:
3071
+ type: object
3072
+ required:
3073
+ - version
3074
+ properties:
3075
+ version:
3076
+ type: string
3077
+ git_commit:
3078
+ type: string
3079
+ nullable: true
3080
+ git_branch:
3081
+ type: string
3082
+ nullable: true
3083
+ git_repo:
3084
+ type: string
3085
+ nullable: true
3086
+ git_provider:
3087
+ type: string
3088
+ nullable: true
3089
+ CreateDeploymentTask:
3090
+ type: object
3091
+ required:
3092
+ - deployment_id
3093
+ - operation
3094
+ properties:
3095
+ deployment_id:
3096
+ type: string
3097
+ format: uuid
3098
+ operation:
3099
+ $ref: '#/components/schemas/DeploymentTaskOperation'
3100
+ execute_at:
3101
+ type: string
3102
+ format: date-time
3103
+ nullable: true
3104
+ CreateUserToken:
3105
+ type: object
3106
+ required:
3107
+ - user_id
3108
+ properties:
3109
+ user_id:
3110
+ type: string
3111
+ format: uuid
3112
+ nullable: true
3113
+ CreatedUserToken:
3114
+ type: object
3115
+ required:
3116
+ - created_token
3117
+ properties:
3118
+ created_token:
3119
+ type: string
3120
+ DbEvent:
3121
+ type: object
3122
+ required:
3123
+ - operation
3124
+ - table
3125
+ - data
3126
+ properties:
3127
+ operation:
3128
+ $ref: '#/components/schemas/DbEventOperation'
3129
+ table:
3130
+ $ref: '#/components/schemas/DbTable'
3131
+ data:
3132
+ $ref: '#/components/schemas/DbEventData'
3133
+ DbEventData:
3134
+ type: object
3135
+ required:
3136
+ - id
3137
+ properties:
3138
+ id:
3139
+ type: string
3140
+ format: uuid
3141
+ DbEventOperation:
3142
+ type: string
3143
+ enum:
3144
+ - INSERT
3145
+ - UPDATE
3146
+ - DELETE
3147
+ DbTable:
3148
+ type: string
3149
+ enum:
3150
+ - bots
3151
+ - deployment_kinds
3152
+ - deployment_resources
3153
+ - deployment_resource_types
3154
+ - deployments
3155
+ - deployment_tasks
3156
+ - deployment_permissions
3157
+ - envs
3158
+ - env_user_permissions
3159
+ - helm_registries
3160
+ - helm_charts
3161
+ - helm_tag_formats
3162
+ - k8s_clusters
3163
+ - k8s_resources
3164
+ - secrets
3165
+ - settings
3166
+ - users
3167
+ DbTableOrDeploymentResource:
3168
+ oneOf:
3169
+ - $ref: '#/components/schemas/DbTable'
3170
+ - type: object
3171
+ required:
3172
+ - deployment
3173
+ - type
3174
+ properties:
3175
+ deployment:
3176
+ type: string
3177
+ type:
3178
+ type: string
3179
+ - type: string
3180
+ Deployment:
3181
+ type: object
3182
+ required:
3183
+ - id
3184
+ - created_at
3185
+ - name
3186
+ - kind_id
3187
+ - cluster_id
3188
+ - enabled
3189
+ - status
3190
+ - description_md
3191
+ - reason
3192
+ - revision_id
3193
+ - reported_status
3194
+ - helm_chart_id
3195
+ - config
3196
+ - values_override
3197
+ properties:
3198
+ id:
3199
+ type: string
3200
+ format: uuid
3201
+ created_at:
3202
+ type: string
3203
+ format: date-time
3204
+ name:
3205
+ type: string
3206
+ kind_id:
3207
+ type: string
3208
+ format: uuid
3209
+ cluster_id:
3210
+ type: string
3211
+ format: uuid
3212
+ enabled:
3213
+ type: boolean
3214
+ status:
3215
+ $ref: '#/components/schemas/DeploymentStatus'
3216
+ description_md:
3217
+ type: string
3218
+ nullable: true
3219
+ reason:
3220
+ type: string
3221
+ nullable: true
3222
+ revision_id:
3223
+ type: string
3224
+ format: uuid
3225
+ nullable: true
3226
+ reported_status:
3227
+ allOf:
3228
+ - $ref: '#/components/schemas/DeploymentReportedStatus'
3229
+ nullable: true
3230
+ helm_chart_id:
3231
+ type: string
3232
+ format: uuid
3233
+ config: {}
3234
+ values_override:
3235
+ nullable: true
3236
+ DeploymentInstallTask:
3237
+ type: object
3238
+ required:
3239
+ - helm_chart_id
3240
+ - config_inputs
3241
+ - values_override
3242
+ properties:
3243
+ helm_chart_id:
3244
+ type: string
3245
+ format: uuid
3246
+ config_inputs: {}
3247
+ values_override:
3248
+ nullable: true
3249
+ DeploymentInvokeActionTask:
3250
+ type: object
3251
+ required:
3252
+ - helm_chart_id
3253
+ - action_id
3254
+ - body
3255
+ properties:
3256
+ helm_chart_id:
3257
+ type: string
3258
+ format: uuid
3259
+ action_id:
3260
+ type: string
3261
+ body: {}
3262
+ DeploymentKind:
3263
+ type: object
3264
+ required:
3265
+ - id
3266
+ - created_at
3267
+ - name
3268
+ properties:
3269
+ id:
3270
+ type: string
3271
+ format: uuid
3272
+ created_at:
3273
+ type: string
3274
+ format: date-time
3275
+ name:
3276
+ type: string
3277
+ DeploymentPermission:
3278
+ type: object
3279
+ required:
3280
+ - id
3281
+ - created_at
3282
+ - env_id
3283
+ - user_id
3284
+ - kind_id
3285
+ - role
3286
+ properties:
3287
+ id:
3288
+ type: string
3289
+ format: uuid
3290
+ created_at:
3291
+ type: string
3292
+ format: date-time
3293
+ env_id:
3294
+ type: string
3295
+ format: uuid
3296
+ user_id:
3297
+ type: string
3298
+ format: uuid
3299
+ kind_id:
3300
+ type: string
3301
+ format: uuid
3302
+ role:
3303
+ $ref: '#/components/schemas/UserDeploymentRole'
3304
+ DeploymentRecreaseTask:
3305
+ type: object
3306
+ required:
3307
+ - old_cluster_id
3308
+ - old_namespace
3309
+ - new_cluster_id
3310
+ - new_namespace
3311
+ properties:
3312
+ old_cluster_id:
3313
+ type: string
3314
+ format: uuid
3315
+ old_namespace:
3316
+ type: string
3317
+ new_cluster_id:
3318
+ type: string
3319
+ format: uuid
3320
+ new_namespace:
3321
+ type: string
3322
+ DeploymentReinstallTask:
3323
+ type: object
3324
+ required:
3325
+ - reason
3326
+ properties:
3327
+ reason:
3328
+ type: string
3329
+ DeploymentReportedMetric:
3330
+ type: object
3331
+ required:
3332
+ - value
3333
+ - unit
3334
+ - short_description
3335
+ - color
3336
+ properties:
3337
+ value:
3338
+ type: string
3339
+ unit:
3340
+ type: string
3341
+ short_description:
3342
+ type: string
3343
+ color:
3344
+ allOf:
3345
+ - $ref: '#/components/schemas/DeploymentReportedStatusColor'
3346
+ nullable: true
3347
+ DeploymentReportedNotice:
3348
+ type: object
3349
+ required:
3350
+ - level
3351
+ - text
3352
+ properties:
3353
+ level:
3354
+ $ref: '#/components/schemas/DeploymentReportedNoticeLevel'
3355
+ text:
3356
+ type: string
3357
+ DeploymentReportedNoticeLevel:
3358
+ type: string
3359
+ enum:
3360
+ - Info
3361
+ - Warning
3362
+ - Danger
3363
+ DeploymentReportedStatus:
3364
+ type: object
3365
+ required:
3366
+ - timestamp
3367
+ - get_successful
3368
+ - content
3369
+ - error
3370
+ properties:
3371
+ timestamp:
3372
+ type: string
3373
+ format: date-time
3374
+ get_successful:
3375
+ type: boolean
3376
+ content:
3377
+ allOf:
3378
+ - $ref: '#/components/schemas/DeploymentReportedStatusContent'
3379
+ nullable: true
3380
+ error:
3381
+ type: string
3382
+ nullable: true
3383
+ DeploymentReportedStatusColor:
3384
+ type: string
3385
+ enum:
3386
+ - primary
3387
+ - success
3388
+ - danger
3389
+ - warning
3390
+ - secondary
3391
+ DeploymentReportedStatusContent:
3392
+ type: object
3393
+ required:
3394
+ - status
3395
+ - primary_metric
3396
+ - metrics
3397
+ properties:
3398
+ status:
3399
+ $ref: '#/components/schemas/DeploymentReportedStatusSummary'
3400
+ primary_metric:
3401
+ allOf:
3402
+ - $ref: '#/components/schemas/DeploymentReportedMetric'
3403
+ nullable: true
3404
+ metrics:
3405
+ type: array
3406
+ items:
3407
+ $ref: '#/components/schemas/DeploymentReportedMetric'
3408
+ nullable: true
3409
+ notices:
3410
+ type: array
3411
+ items:
3412
+ $ref: '#/components/schemas/DeploymentReportedNotice'
3413
+ DeploymentReportedStatusSummary:
3414
+ type: object
3415
+ required:
3416
+ - name
3417
+ - color
3418
+ properties:
3419
+ name:
3420
+ type: string
3421
+ color:
3422
+ $ref: '#/components/schemas/DeploymentReportedStatusColor'
3423
+ DeploymentResource:
3424
+ type: object
3425
+ required:
3426
+ - id
3427
+ - created_at
3428
+ - type_id
3429
+ - deployment_id
3430
+ - name
3431
+ - exists
3432
+ - props
3433
+ - sync_status
3434
+ - sync_reason
3435
+ properties:
3436
+ id:
3437
+ type: string
3438
+ format: uuid
3439
+ created_at:
3440
+ type: string
3441
+ format: date-time
3442
+ type_id:
3443
+ type: string
3444
+ format: uuid
3445
+ deployment_id:
3446
+ type: string
3447
+ format: uuid
3448
+ nullable: true
3449
+ name:
3450
+ type: string
3451
+ exists:
3452
+ type: boolean
3453
+ props: {}
3454
+ sync_status:
3455
+ $ref: '#/components/schemas/DeploymentResourceSyncStatus'
3456
+ sync_reason:
3457
+ type: string
3458
+ nullable: true
3459
+ DeploymentResourceSyncStatus:
3460
+ type: string
3461
+ enum:
3462
+ - Creating
3463
+ - Updating
3464
+ - Deleting
3465
+ - Ready
3466
+ - Error
3467
+ DeploymentResourceType:
3468
+ type: object
3469
+ required:
3470
+ - id
3471
+ - created_at
3472
+ - env_id
3473
+ - deployment_kind_id
3474
+ - key
3475
+ - spec
3476
+ properties:
3477
+ id:
3478
+ type: string
3479
+ format: uuid
3480
+ created_at:
3481
+ type: string
3482
+ format: date-time
3483
+ env_id:
3484
+ type: string
3485
+ format: uuid
3486
+ nullable: true
3487
+ deployment_kind_id:
3488
+ type: string
3489
+ format: uuid
3490
+ key:
3491
+ type: string
3492
+ spec:
3493
+ $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1Spec'
3494
+ DeploymentRestartK8sResourceTask:
3495
+ type: object
3496
+ required:
3497
+ - resource_id
3498
+ - resource_name
3499
+ properties:
3500
+ resource_id:
3501
+ type: string
3502
+ format: uuid
3503
+ resource_name:
3504
+ type: string
3505
+ DeploymentStatus:
3506
+ type: string
3507
+ enum:
3508
+ - Unknown
3509
+ - Installing
3510
+ - Renaming
3511
+ - Upgrading
3512
+ - Running
3513
+ - Error
3514
+ - Uninstalling
3515
+ - Uninstalled
3516
+ - Deleting
3517
+ DeploymentTask:
3518
+ type: object
3519
+ required:
3520
+ - id
3521
+ - created_at
3522
+ - execute_at
3523
+ - first_attempted_at
3524
+ - started_at
3525
+ - finished_at
3526
+ - cluster_id
3527
+ - deployment_id
3528
+ - acting_user_id
3529
+ - acting_deployment_id
3530
+ - canceled_by_user_id
3531
+ - canceled_by_deployment_id
3532
+ - operation
3533
+ - status
3534
+ - reason
3535
+ properties:
3536
+ id:
3537
+ type: string
3538
+ format: uuid
3539
+ created_at:
3540
+ type: string
3541
+ format: date-time
3542
+ execute_at:
3543
+ type: string
3544
+ format: date-time
3545
+ first_attempted_at:
3546
+ type: string
3547
+ format: date-time
3548
+ nullable: true
3549
+ started_at:
3550
+ type: string
3551
+ format: date-time
3552
+ nullable: true
3553
+ finished_at:
3554
+ type: string
3555
+ format: date-time
3556
+ nullable: true
3557
+ cluster_id:
3558
+ type: string
3559
+ format: uuid
3560
+ deployment_id:
3561
+ type: string
3562
+ format: uuid
3563
+ acting_user_id:
3564
+ type: string
3565
+ format: uuid
3566
+ nullable: true
3567
+ acting_deployment_id:
3568
+ type: string
3569
+ format: uuid
3570
+ nullable: true
3571
+ canceled_by_user_id:
3572
+ type: string
3573
+ format: uuid
3574
+ nullable: true
3575
+ canceled_by_deployment_id:
3576
+ type: string
3577
+ format: uuid
3578
+ nullable: true
3579
+ operation:
3580
+ $ref: '#/components/schemas/DeploymentTaskOperation'
3581
+ status:
3582
+ $ref: '#/components/schemas/DeploymentTaskStatus'
3583
+ reason:
3584
+ type: string
3585
+ nullable: true
3586
+ DeploymentTaskOperation:
3587
+ oneOf:
3588
+ - type: object
3589
+ required:
3590
+ - Install
3591
+ properties:
3592
+ Install:
3593
+ $ref: '#/components/schemas/DeploymentInstallTask'
3594
+ - type: object
3595
+ required:
3596
+ - Upgrade
3597
+ properties:
3598
+ Upgrade:
3599
+ $ref: '#/components/schemas/DeploymentUpgradeTask'
3600
+ - type: object
3601
+ required:
3602
+ - Reinstall
3603
+ properties:
3604
+ Reinstall:
3605
+ $ref: '#/components/schemas/DeploymentReinstallTask'
3606
+ - type: object
3607
+ required:
3608
+ - Recreate
3609
+ properties:
3610
+ Recreate:
3611
+ $ref: '#/components/schemas/DeploymentRecreaseTask'
3612
+ - type: object
3613
+ required:
3614
+ - Uninstall
3615
+ properties:
3616
+ Uninstall:
3617
+ $ref: '#/components/schemas/DeploymentUninstallTask'
3618
+ - type: object
3619
+ required:
3620
+ - InvokeAction
3621
+ properties:
3622
+ InvokeAction:
3623
+ $ref: '#/components/schemas/DeploymentInvokeActionTask'
3624
+ - type: object
3625
+ required:
3626
+ - RestartK8sResource
3627
+ properties:
3628
+ RestartK8sResource:
3629
+ $ref: '#/components/schemas/DeploymentRestartK8sResourceTask'
3630
+ DeploymentTaskStatus:
3631
+ type: string
3632
+ enum:
3633
+ - Pending
3634
+ - Started
3635
+ - Failed
3636
+ - Canceled
3637
+ - Done
3638
+ DeploymentUninstallTask:
3639
+ type: object
3640
+ DeploymentUpgradeTask:
3641
+ type: object
3642
+ required:
3643
+ - helm_chart_id
3644
+ - prev_helm_chart_id
3645
+ - config_inputs
3646
+ - config_delta
3647
+ - values_override
3648
+ properties:
3649
+ helm_chart_id:
3650
+ type: string
3651
+ format: uuid
3652
+ prev_helm_chart_id:
3653
+ type: string
3654
+ format: uuid
3655
+ nullable: true
3656
+ config_inputs: {}
3657
+ config_delta:
3658
+ allOf:
3659
+ - $ref: '#/components/schemas/JsonDiff'
3660
+ nullable: true
3661
+ values_override:
3662
+ nullable: true
3663
+ Env:
3664
+ type: object
3665
+ required:
3666
+ - id
3667
+ - created_at
3668
+ - name
3669
+ - node_selector
3670
+ - tolerations
3671
+ - auto_add_new_users
3672
+ properties:
3673
+ id:
3674
+ type: string
3675
+ format: uuid
3676
+ created_at:
3677
+ type: string
3678
+ format: date-time
3679
+ name:
3680
+ type: string
3681
+ node_selector: {}
3682
+ tolerations: {}
3683
+ auto_add_new_users:
3684
+ type: boolean
3685
+ EnvUserPermission:
3686
+ type: object
3687
+ required:
3688
+ - id
3689
+ - created_at
3690
+ - env_id
3691
+ - user_id
3692
+ - role
3693
+ properties:
3694
+ id:
3695
+ type: string
3696
+ format: uuid
3697
+ created_at:
3698
+ type: string
3699
+ format: date-time
3700
+ env_id:
3701
+ type: string
3702
+ format: uuid
3703
+ user_id:
3704
+ type: string
3705
+ format: uuid
3706
+ role:
3707
+ $ref: '#/components/schemas/EnvUserRole'
3708
+ EnvUserRole:
3709
+ type: string
3710
+ enum:
3711
+ - Admin
3712
+ - User
3713
+ FinishGoogleLoginResponse:
3714
+ type: object
3715
+ required:
3716
+ - access_token
3717
+ properties:
3718
+ access_token:
3719
+ type: string
3720
+ HelmChart:
3721
+ type: object
3722
+ required:
3723
+ - id
3724
+ - created_at
3725
+ - helm_registry_id
3726
+ - image_digest
3727
+ - image_tag
3728
+ - available
3729
+ - values_ui
3730
+ - actions_schema
3731
+ - features
3732
+ - resource_types
3733
+ - error
3734
+ - tag_format_id
3735
+ - parsed_version
3736
+ - parsed_revision
3737
+ - parsed_branch
3738
+ - parsed_commit
3739
+ properties:
3740
+ id:
3741
+ type: string
3742
+ format: uuid
3743
+ created_at:
3744
+ type: string
3745
+ format: date-time
3746
+ helm_registry_id:
3747
+ type: string
3748
+ format: uuid
3749
+ image_digest:
3750
+ type: string
3751
+ image_tag:
3752
+ type: string
3753
+ available:
3754
+ type: boolean
3755
+ values_ui:
3756
+ allOf:
3757
+ - $ref: '#/components/schemas/UiSchema'
3758
+ nullable: true
3759
+ actions_schema:
3760
+ allOf:
3761
+ - $ref: '#/components/schemas/ChartExtActions'
3762
+ nullable: true
3763
+ features:
3764
+ allOf:
3765
+ - $ref: '#/components/schemas/ChartExtFeatures'
3766
+ nullable: true
3767
+ resource_types:
3768
+ allOf:
3769
+ - $ref: '#/components/schemas/ChartExtResourceTypes'
3770
+ nullable: true
3771
+ error:
3772
+ type: string
3773
+ nullable: true
3774
+ tag_format_id:
3775
+ type: string
3776
+ format: uuid
3777
+ nullable: true
3778
+ parsed_version:
3779
+ type: string
3780
+ nullable: true
3781
+ parsed_revision:
3782
+ type: string
3783
+ nullable: true
3784
+ parsed_branch:
3785
+ type: string
3786
+ nullable: true
3787
+ parsed_commit:
3788
+ type: string
3789
+ nullable: true
3790
+ HelmRegistry:
3791
+ type: object
3792
+ required:
3793
+ - id
3794
+ - created_at
3795
+ - domain_name
3796
+ - repo_name
3797
+ - kind_id
3798
+ - available
3799
+ - fa_icon
3800
+ properties:
3801
+ id:
3802
+ type: string
3803
+ format: uuid
3804
+ created_at:
3805
+ type: string
3806
+ format: date-time
3807
+ domain_name:
3808
+ type: string
3809
+ repo_name:
3810
+ type: string
3811
+ kind_id:
3812
+ type: string
3813
+ format: uuid
3814
+ available:
3815
+ type: boolean
3816
+ fa_icon:
3817
+ type: string
3818
+ HelmTagFormat:
3819
+ type: object
3820
+ required:
3821
+ - id
3822
+ - created_at
3823
+ - pattern
3824
+ properties:
3825
+ id:
3826
+ type: string
3827
+ format: uuid
3828
+ created_at:
3829
+ type: string
3830
+ format: date-time
3831
+ pattern:
3832
+ type: string
3833
+ JsonDiff:
3834
+ type: object
3835
+ additionalProperties:
3836
+ $ref: '#/components/schemas/JsonDiffPair'
3837
+ JsonDiffPair:
3838
+ type: array
3839
+ items: {}
3840
+ description: ''
3841
+ maxItems: 2
3842
+ minItems: 2
3843
+ K8sCluster:
3844
+ type: object
3845
+ required:
3846
+ - id
3847
+ - env_id
3848
+ - provider_id
3849
+ - created_at
3850
+ - last_seen_at
3851
+ - name
3852
+ - region_name
3853
+ - is_ok
3854
+ - not_ok_reason
3855
+ - ignore
3856
+ - ingress_domain
3857
+ - ingress_class
3858
+ - ingress_tls_secret_name
3859
+ - grafana_url
3860
+ - grafana_datasource_name
3861
+ properties:
3862
+ id:
3863
+ type: string
3864
+ format: uuid
3865
+ env_id:
3866
+ type: string
3867
+ format: uuid
3868
+ nullable: true
3869
+ provider_id:
3870
+ type: string
3871
+ created_at:
3872
+ type: string
3873
+ format: date-time
3874
+ last_seen_at:
3875
+ type: string
3876
+ format: date-time
3877
+ name:
3878
+ type: string
3879
+ region_name:
3880
+ type: string
3881
+ is_ok:
3882
+ type: boolean
3883
+ not_ok_reason:
3884
+ type: string
3885
+ nullable: true
3886
+ ignore:
3887
+ type: boolean
3888
+ ingress_domain:
3889
+ type: string
3890
+ nullable: true
3891
+ ingress_class:
3892
+ type: string
3893
+ nullable: true
3894
+ ingress_tls_secret_name:
3895
+ type: string
3896
+ nullable: true
3897
+ grafana_url:
3898
+ type: string
3899
+ nullable: true
3900
+ grafana_datasource_name:
3901
+ type: string
3902
+ nullable: true
3903
+ K8sResource:
3904
+ type: object
3905
+ required:
3906
+ - id
3907
+ - last_updated_at
3908
+ - cluster_id
3909
+ - deployment_id
3910
+ - kind
3911
+ - api_version
3912
+ - name
3913
+ - status_color
3914
+ - metadata
3915
+ properties:
3916
+ id:
3917
+ type: string
3918
+ format: uuid
3919
+ last_updated_at:
3920
+ type: string
3921
+ format: date-time
3922
+ cluster_id:
3923
+ type: string
3924
+ format: uuid
3925
+ deployment_id:
3926
+ type: string
3927
+ format: uuid
3928
+ kind:
3929
+ type: string
3930
+ api_version:
3931
+ type: string
3932
+ name:
3933
+ type: string
3934
+ status_color:
3935
+ type: array
3936
+ items:
3937
+ type: string
3938
+ metadata: {}
3939
+ MeResponse:
3940
+ oneOf:
3941
+ - type: object
3942
+ required:
3943
+ - User
3944
+ properties:
3945
+ User:
3946
+ $ref: '#/components/schemas/User'
3947
+ - type: object
3948
+ required:
3949
+ - Bot
3950
+ properties:
3951
+ Bot:
3952
+ $ref: '#/components/schemas/Bot'
3953
+ - type: object
3954
+ required:
3955
+ - Deployment
3956
+ properties:
3957
+ Deployment:
3958
+ type: object
3959
+ required:
3960
+ - id
3961
+ - name
3962
+ properties:
3963
+ id:
3964
+ type: string
3965
+ format: uuid
3966
+ name:
3967
+ type: string
3968
+ NewBot:
3969
+ type: object
3970
+ required:
3971
+ - display_name
3972
+ properties:
3973
+ display_name:
3974
+ type: string
3975
+ NewDeployment:
3976
+ type: object
3977
+ required:
3978
+ - kind_id
3979
+ - cluster_id
3980
+ - helm_chart_id
3981
+ - config
3982
+ - values_override
3983
+ properties:
3984
+ name:
3985
+ type: string
3986
+ kind_id:
3987
+ type: string
3988
+ format: uuid
3989
+ cluster_id:
3990
+ type: string
3991
+ format: uuid
3992
+ helm_chart_id:
3993
+ type: string
3994
+ format: uuid
3995
+ config:
3996
+ nullable: true
3997
+ values_override:
3998
+ nullable: true
3999
+ NewDeploymentPermission:
4000
+ type: object
4001
+ required:
4002
+ - env_id
4003
+ - user_id
4004
+ - kind_id
4005
+ - role
4006
+ properties:
4007
+ env_id:
4008
+ type: string
4009
+ format: uuid
4010
+ user_id:
4011
+ type: string
4012
+ format: uuid
4013
+ kind_id:
4014
+ type: string
4015
+ format: uuid
4016
+ role:
4017
+ $ref: '#/components/schemas/UserDeploymentRole'
4018
+ NewDeploymentResource:
4019
+ type: object
4020
+ required:
4021
+ - type_id
4022
+ - deployment_id
4023
+ - name
4024
+ - props
4025
+ properties:
4026
+ id:
4027
+ type: string
4028
+ format: uuid
4029
+ nullable: true
4030
+ created_at:
4031
+ type: string
4032
+ format: date-time
4033
+ nullable: true
4034
+ type_id:
4035
+ type: string
4036
+ format: uuid
4037
+ deployment_id:
4038
+ type: string
4039
+ format: uuid
4040
+ name:
4041
+ type: string
4042
+ props: {}
4043
+ sync_status:
4044
+ allOf:
4045
+ - $ref: '#/components/schemas/DeploymentResourceSyncStatus'
4046
+ nullable: true
4047
+ NewEnv:
4048
+ type: object
4049
+ required:
4050
+ - name
4051
+ properties:
4052
+ name:
4053
+ type: string
4054
+ auto_add_new_users:
4055
+ type: boolean
4056
+ NewEnvUserPermission:
4057
+ type: object
4058
+ required:
4059
+ - env_id
4060
+ - user_id
4061
+ - role
4062
+ properties:
4063
+ env_id:
4064
+ type: string
4065
+ format: uuid
4066
+ user_id:
4067
+ type: string
4068
+ format: uuid
4069
+ role:
4070
+ $ref: '#/components/schemas/EnvUserRole'
4071
+ NewHelmTagFormat:
4072
+ type: object
4073
+ required:
4074
+ - pattern
4075
+ properties:
4076
+ pattern:
4077
+ type: string
4078
+ NewSecret:
4079
+ type: object
4080
+ required:
4081
+ - env_id
4082
+ - collection
4083
+ - name
4084
+ - contents
4085
+ properties:
4086
+ env_id:
4087
+ type: string
4088
+ format: uuid
4089
+ collection:
4090
+ type: string
4091
+ name:
4092
+ type: string
4093
+ contents:
4094
+ type: string
4095
+ OAuth2Response:
4096
+ type: object
4097
+ required:
4098
+ - auth_code
4099
+ properties:
4100
+ auth_code:
4101
+ type: string
4102
+ Secret:
4103
+ type: object
4104
+ required:
4105
+ - id
4106
+ - created_at
4107
+ - updated_at
4108
+ - env_id
4109
+ - collection
4110
+ - name
4111
+ properties:
4112
+ id:
4113
+ type: string
4114
+ format: uuid
4115
+ created_at:
4116
+ type: string
4117
+ format: date-time
4118
+ updated_at:
4119
+ type: string
4120
+ format: date-time
4121
+ env_id:
4122
+ type: string
4123
+ format: uuid
4124
+ collection:
4125
+ type: string
4126
+ name:
4127
+ type: string
4128
+ SerializedUiSchemaInputType:
4129
+ type: object
4130
+ required:
4131
+ - type
4132
+ properties:
4133
+ type:
4134
+ type: string
4135
+ itemType:
4136
+ type: string
4137
+ nullable: true
4138
+ collection:
4139
+ nullable: true
4140
+ ServerInfo:
4141
+ type: object
4142
+ required:
4143
+ - version
4144
+ properties:
4145
+ version:
4146
+ type: string
4147
+ StartGoogleLoginResponse:
4148
+ type: object
4149
+ required:
4150
+ - redirect_url
4151
+ properties:
4152
+ redirect_url:
4153
+ type: string
4154
+ UiSchema:
4155
+ oneOf:
4156
+ - $ref: '#/components/schemas/UiSchemaV1Beta1'
4157
+ - $ref: '#/components/schemas/UiSchemaV0'
4158
+ UiSchemaFieldValuePair:
4159
+ type: object
4160
+ required:
4161
+ - field
4162
+ - value
4163
+ properties:
4164
+ field:
4165
+ type: string
4166
+ value: {}
4167
+ UiSchemaInput:
4168
+ allOf:
4169
+ - $ref: '#/components/schemas/SerializedUiSchemaInputType'
4170
+ - type: object
4171
+ required:
4172
+ - id
4173
+ - label
4174
+ properties:
4175
+ id:
4176
+ type: string
4177
+ label:
4178
+ type: string
4179
+ initialValue:
4180
+ nullable: true
4181
+ helpText:
4182
+ type: string
4183
+ nullable: true
4184
+ required:
4185
+ type: boolean
4186
+ sensitive:
4187
+ type: boolean
4188
+ options:
4189
+ type: array
4190
+ items:
4191
+ $ref: '#/components/schemas/UiSchemaInputFieldOption'
4192
+ nullable: true
4193
+ showIfAll:
4194
+ type: array
4195
+ items:
4196
+ $ref: '#/components/schemas/UiSchemaFieldValuePair'
4197
+ nullable: true
4198
+ showIf:
4199
+ nullable: true
4200
+ filters:
4201
+ type: array
4202
+ items:
4203
+ $ref: '#/components/schemas/UiSchemaInputFieldValue'
4204
+ nullable: true
4205
+ minimum:
4206
+ type: string
4207
+ nullable: true
4208
+ maximum:
4209
+ type: string
4210
+ nullable: true
4211
+ step:
4212
+ type: string
4213
+ nullable: true
4214
+ UiSchemaInputFieldOption:
4215
+ type: object
4216
+ required:
4217
+ - value
4218
+ properties:
4219
+ value: {}
4220
+ label:
4221
+ type: string
4222
+ nullable: true
4223
+ helpText:
4224
+ type: string
4225
+ nullable: true
4226
+ UiSchemaInputFieldValue:
4227
+ type: object
4228
+ required:
4229
+ - field
4230
+ - value
4231
+ properties:
4232
+ field:
4233
+ type: string
4234
+ value: {}
4235
+ UiSchemaInputRef:
4236
+ oneOf:
4237
+ - type: object
4238
+ required:
4239
+ - FieldValue
4240
+ properties:
4241
+ FieldValue:
4242
+ $ref: '#/components/schemas/UiSchemaInputRefField'
4243
+ - type: object
4244
+ required:
4245
+ - FieldProperty
4246
+ properties:
4247
+ FieldProperty:
4248
+ $ref: '#/components/schemas/UiSchemaInputRefProperty'
4249
+ UiSchemaInputRefField:
4250
+ type: object
4251
+ required:
4252
+ - input
4253
+ properties:
4254
+ input:
4255
+ type: string
4256
+ UiSchemaInputRefProperty:
4257
+ type: object
4258
+ required:
4259
+ - input
4260
+ - property
4261
+ properties:
4262
+ input:
4263
+ type: string
4264
+ property:
4265
+ type: string
4266
+ UiSchemaInputSingleType:
4267
+ oneOf:
4268
+ - type: string
4269
+ enum:
4270
+ - text
4271
+ - type: string
4272
+ enum:
4273
+ - number
4274
+ - type: object
4275
+ required:
4276
+ - CollectionSelect
4277
+ properties:
4278
+ CollectionSelect:
4279
+ type: object
4280
+ required:
4281
+ - collection
4282
+ properties:
4283
+ collection: {}
4284
+ - type: string
4285
+ enum:
4286
+ - RadioSelect
4287
+ - type: string
4288
+ enum:
4289
+ - DaysAndHour
4290
+ - type: string
4291
+ enum:
4292
+ - Checkbox
4293
+ UiSchemaInputType:
4294
+ type: object
4295
+ required:
4296
+ - single_type
4297
+ - is_array
4298
+ properties:
4299
+ single_type:
4300
+ $ref: '#/components/schemas/UiSchemaInputSingleType'
4301
+ is_array:
4302
+ type: boolean
4303
+ UiSchemaOutputSecrets:
4304
+ type: object
4305
+ additionalProperties:
4306
+ type: object
4307
+ additionalProperties:
4308
+ $ref: '#/components/schemas/UiSchemaInputRef'
4309
+ UiSchemaOutputValue:
4310
+ type: object
4311
+ required:
4312
+ - path
4313
+ - value
4314
+ properties:
4315
+ path:
4316
+ type: array
4317
+ items:
4318
+ type: string
4319
+ value:
4320
+ $ref: '#/components/schemas/UiSchemaInputRef'
4321
+ UiSchemaOutputs:
4322
+ type: object
4323
+ required:
4324
+ - values
4325
+ properties:
4326
+ values:
4327
+ type: array
4328
+ items:
4329
+ $ref: '#/components/schemas/UiSchemaOutputValue'
4330
+ secrets:
4331
+ $ref: '#/components/schemas/UiSchemaOutputSecrets'
4332
+ UiSchemaV0:
4333
+ type: object
4334
+ required:
4335
+ - inputs
4336
+ properties:
4337
+ inputs:
4338
+ type: array
4339
+ items:
4340
+ $ref: '#/components/schemas/UiSchemaInput'
4341
+ outputs:
4342
+ $ref: '#/components/schemas/UiSchemaOutputs'
4343
+ additionalProperties: false
4344
+ UiSchemaV1Beta1:
4345
+ allOf:
4346
+ - $ref: '#/components/schemas/UiSchemaV0'
4347
+ - type: object
4348
+ required:
4349
+ - apiVersion
4350
+ - kind
4351
+ properties:
4352
+ apiVersion:
4353
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
4354
+ kind:
4355
+ $ref: '#/components/schemas/ChartExtKindValuesUi'
4356
+ UpdateBot:
4357
+ type: object
4358
+ properties:
4359
+ display_name:
4360
+ type: string
4361
+ nullable: true
4362
+ UpdateDeployment:
4363
+ type: object
4364
+ properties:
4365
+ name:
4366
+ type: string
4367
+ nullable: true
4368
+ cluster_id:
4369
+ type: string
4370
+ format: uuid
4371
+ nullable: true
4372
+ helm_chart_id:
4373
+ type: string
4374
+ format: uuid
4375
+ nullable: true
4376
+ config:
4377
+ nullable: true
4378
+ values_override:
4379
+ nullable: true
4380
+ enabled:
4381
+ type: boolean
4382
+ nullable: true
4383
+ description_md:
4384
+ type: string
4385
+ nullable: true
4386
+ UpdateDeploymentKind:
4387
+ type: object
4388
+ required:
4389
+ - name
4390
+ properties:
4391
+ name:
4392
+ type: string
4393
+ UpdateDeploymentResource:
4394
+ type: object
4395
+ properties:
4396
+ name:
4397
+ type: string
4398
+ nullable: true
4399
+ props:
4400
+ nullable: true
4401
+ UpdateEnv:
4402
+ type: object
4403
+ properties:
4404
+ name:
4405
+ type: string
4406
+ nullable: true
4407
+ node_selector:
4408
+ nullable: true
4409
+ tolerations:
4410
+ nullable: true
4411
+ auto_add_new_users:
4412
+ type: boolean
4413
+ nullable: true
4414
+ UpdateHelmRegistry:
4415
+ type: object
4416
+ properties:
4417
+ fa_icon:
4418
+ type: string
4419
+ nullable: true
4420
+ UpdateK8sCluster:
4421
+ type: object
4422
+ properties:
4423
+ env_id:
4424
+ type: string
4425
+ format: uuid
4426
+ nullable: true
4427
+ ignore:
4428
+ type: boolean
4429
+ nullable: true
4430
+ ingress_domain:
4431
+ type: string
4432
+ nullable: true
4433
+ ingress_class:
4434
+ type: string
4435
+ nullable: true
4436
+ ingress_tls_secret_name:
4437
+ type: string
4438
+ nullable: true
4439
+ grafana_url:
4440
+ type: string
4441
+ nullable: true
4442
+ grafana_datasource_name:
4443
+ type: string
4444
+ nullable: true
4445
+ UpdateSecret:
4446
+ type: object
4447
+ properties:
4448
+ name:
4449
+ type: string
4450
+ nullable: true
4451
+ contents:
4452
+ type: string
4453
+ nullable: true
4454
+ UpdateUser:
4455
+ type: object
4456
+ properties:
4457
+ is_admin:
4458
+ type: boolean
4459
+ nullable: true
4460
+ is_active:
4461
+ type: boolean
4462
+ nullable: true
4463
+ User:
4464
+ type: object
4465
+ required:
4466
+ - id
4467
+ - created_at
4468
+ - display_name
4469
+ - email
4470
+ - is_admin
4471
+ - is_active
4472
+ properties:
4473
+ id:
4474
+ type: string
4475
+ format: uuid
4476
+ created_at:
4477
+ type: string
4478
+ format: date-time
4479
+ display_name:
4480
+ type: string
4481
+ email:
4482
+ type: string
4483
+ is_admin:
4484
+ type: boolean
4485
+ is_active:
4486
+ type: boolean
4487
+ UserDeploymentRole:
4488
+ type: string
4489
+ enum:
4490
+ - Owner
4491
+ - Maintainer
4492
+ UserToken:
4493
+ type: object
4494
+ required:
4495
+ - id
4496
+ - user_id
4497
+ - created_at
4498
+ properties:
4499
+ id:
4500
+ type: string
4501
+ format: uuid
4502
+ user_id:
4503
+ type: string
4504
+ format: uuid
4505
+ created_at:
4506
+ type: string
4507
+ format: date-time
4508
+ securitySchemes:
4509
+ access_token:
4510
+ type: http
4511
+ scheme: bearer
4512
+ bearerFormat: JWT
4513
+ user_token:
4514
+ type: apiKey
4515
+ in: header
4516
+ name: x-platz-token
4517
+ tags:
4518
+ - name: Authentication
4519
+ description: |
4520
+ APIs for logging into Platz and getting information about the current user.
4521
+ - name: Deployment Kinds
4522
+ description: "Deployment kinds map between kind IDs and their names.\n "
4523
+ - name: Deployment Permissions
4524
+ description: "APIs for setting deployment permissions per user.\n\nSee UserDeploymentRole for more information.\n "
4525
+ - name: Deployment Resource Types
4526
+ description: "Deployment resource types are custom types defined in a chart's extensions\ncontained in the `platz` directory in the deployment Helm chart.\n "
4527
+ - name: Deployment Resources
4528
+ description: ''
4529
+ - name: Deployment Tasks
4530
+ description: "Deployment tasks are all operations performed on each deployment, along with\ntheir status.\n "
4531
+ - name: Deployments
4532
+ description: |
4533
+ This collection contains deployments of Helm chart into envs.
4534
+ - name: Env User Permissions
4535
+ description: "Controls which envs each user can see.\n "
4536
+ - name: Envs
4537
+ description: "Envs contain deployments and all related settings resources for those\ndeployments, such as deployment permissions.\n "
4538
+ - name: Helm Charts
4539
+ description: "This collection contains Helm charts detected by the chart-discovery service.\n "
4540
+ - name: Helm Registries
4541
+ description: "This collection contains Helm registries detected by the chart-discovery\nservice.\n\nNew registries are created automatically for Helm chart whenever new charts\nare created in those registries.\n "
4542
+ - name: Helm Tag Formats
4543
+ description: "Helm tag formats are how Platz parsed tags of Helm charts in registries.\n\nEach format is a regular expression containing groups for the chart version,\nGit commit and branch.\n "
4544
+ - name: Kubernetes Clusters
4545
+ description: "This collection contains Kubernetes clusters detected by Plaz.\n "
4546
+ - name: Kubernetes Resources
4547
+ description: "This collection contains Kubernetes resources of Platz deployments.\n\nKubernetes resources are automatically tracked in every namespace created by\nPlatz.\n "
4548
+ - name: Secrets
4549
+ description: "Secrets are stored in envs and can be referenced by chart inputs by using the\n`secrets` collection.\n\nKubernetes secrets are created during deployment as defined in the chart\nextensions. See chart extensions documentation for more information.\n "
4550
+ - name: Server
4551
+ description: Return information about the Platz server.
4552
+ - name: User Tokens
4553
+ description: |
4554
+ User tokens allow users to authenticate using a long-lived token that can be
4555
+ used in direct API calls, CLI, etc.
4556
+
4557
+ User tokens are passed in the `x-platz-token` header.
4558
+ - name: Users
4559
+ description: This collection contains all users in Platz.
4560
+ - name: Bots
4561
+ description: This collection contains all bots in Platz.
4562
+ - name: Events
4563
+ description: Events sent through the Websocket.
4564
+