@platzio/sdk 0.5.0-beta.10 → 0.5.0-beta.12

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,3374 @@
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/deployment-permissions:
55
+ get:
56
+ tags:
57
+ - Deployment Permissions
58
+ operationId: allDeploymentPermissions
59
+ parameters:
60
+ - name: env_id
61
+ in: query
62
+ required: false
63
+ schema:
64
+ type: string
65
+ format: uuid
66
+ nullable: true
67
+ - name: page
68
+ in: query
69
+ required: false
70
+ schema:
71
+ type: integer
72
+ format: int64
73
+ nullable: true
74
+ - name: per_page
75
+ in: query
76
+ required: false
77
+ schema:
78
+ type: integer
79
+ format: int64
80
+ nullable: true
81
+ responses:
82
+ '200':
83
+ description: ''
84
+ content:
85
+ application/json:
86
+ schema:
87
+ type: object
88
+ required:
89
+ - page
90
+ - per_page
91
+ - items
92
+ - num_total
93
+ properties:
94
+ page:
95
+ type: integer
96
+ format: int64
97
+ example: '1'
98
+ per_page:
99
+ type: integer
100
+ format: int64
101
+ example: '50'
102
+ items:
103
+ type: array
104
+ items:
105
+ type: object
106
+ required:
107
+ - id
108
+ - created_at
109
+ - env_id
110
+ - user_id
111
+ - kind
112
+ - role
113
+ properties:
114
+ id:
115
+ type: string
116
+ format: uuid
117
+ created_at:
118
+ type: string
119
+ format: date-time
120
+ env_id:
121
+ type: string
122
+ format: uuid
123
+ user_id:
124
+ type: string
125
+ format: uuid
126
+ kind:
127
+ type: string
128
+ role:
129
+ $ref: '#/components/schemas/UserDeploymentRole'
130
+ num_total:
131
+ type: integer
132
+ format: int64
133
+ example: '1'
134
+ security:
135
+ - access_token: []
136
+ - user_token: []
137
+ post:
138
+ tags:
139
+ - Deployment Permissions
140
+ operationId: createDeploymentPermission
141
+ requestBody:
142
+ content:
143
+ application/json:
144
+ schema:
145
+ $ref: '#/components/schemas/NewDeploymentPermission'
146
+ required: true
147
+ responses:
148
+ '201':
149
+ description: ''
150
+ content:
151
+ application/json:
152
+ schema:
153
+ $ref: '#/components/schemas/DeploymentPermission'
154
+ security:
155
+ - access_token: []
156
+ - user_token: []
157
+ /api/v2/deployment-permissions/{id}:
158
+ get:
159
+ tags:
160
+ - Deployment Permissions
161
+ operationId: getDeploymentPermission
162
+ parameters:
163
+ - name: id
164
+ in: path
165
+ required: true
166
+ schema:
167
+ type: string
168
+ format: uuid
169
+ responses:
170
+ '200':
171
+ description: ''
172
+ content:
173
+ application/json:
174
+ schema:
175
+ $ref: '#/components/schemas/DeploymentPermission'
176
+ security:
177
+ - access_token: []
178
+ - user_token: []
179
+ delete:
180
+ tags:
181
+ - Deployment Permissions
182
+ operationId: deleteDeploymentPermission
183
+ parameters:
184
+ - name: id
185
+ in: path
186
+ required: true
187
+ schema:
188
+ type: string
189
+ format: uuid
190
+ responses:
191
+ '204':
192
+ description: ''
193
+ security:
194
+ - access_token: []
195
+ - user_token: []
196
+ /api/v2/deployment-resource-types:
197
+ get:
198
+ tags:
199
+ - Deployment Resource Types
200
+ operationId: allDeploymentResourceTypes
201
+ parameters:
202
+ - name: env_id
203
+ in: query
204
+ required: false
205
+ schema:
206
+ type: string
207
+ format: uuid
208
+ nullable: true
209
+ - name: deployment_kind
210
+ in: query
211
+ required: false
212
+ schema:
213
+ type: string
214
+ nullable: true
215
+ - name: key
216
+ in: query
217
+ required: false
218
+ schema:
219
+ type: string
220
+ nullable: true
221
+ - name: page
222
+ in: query
223
+ required: false
224
+ schema:
225
+ type: integer
226
+ format: int64
227
+ nullable: true
228
+ - name: per_page
229
+ in: query
230
+ required: false
231
+ schema:
232
+ type: integer
233
+ format: int64
234
+ nullable: true
235
+ responses:
236
+ '200':
237
+ description: ''
238
+ content:
239
+ application/json:
240
+ schema:
241
+ type: object
242
+ required:
243
+ - page
244
+ - per_page
245
+ - items
246
+ - num_total
247
+ properties:
248
+ page:
249
+ type: integer
250
+ format: int64
251
+ example: '1'
252
+ per_page:
253
+ type: integer
254
+ format: int64
255
+ example: '50'
256
+ items:
257
+ type: array
258
+ items:
259
+ type: object
260
+ required:
261
+ - id
262
+ - created_at
263
+ - deployment_kind
264
+ - key
265
+ - spec
266
+ properties:
267
+ id:
268
+ type: string
269
+ format: uuid
270
+ created_at:
271
+ type: string
272
+ format: date-time
273
+ env_id:
274
+ type: string
275
+ format: uuid
276
+ nullable: true
277
+ deployment_kind:
278
+ type: string
279
+ key:
280
+ type: string
281
+ spec: {}
282
+ num_total:
283
+ type: integer
284
+ format: int64
285
+ example: '1'
286
+ security:
287
+ - access_token: []
288
+ - user_token: []
289
+ /api/v2/deployment-resource-types/{id}:
290
+ get:
291
+ tags:
292
+ - Deployment Resource Types
293
+ operationId: getDeploymentResourceType
294
+ parameters:
295
+ - name: id
296
+ in: path
297
+ required: true
298
+ schema:
299
+ type: string
300
+ format: uuid
301
+ responses:
302
+ '200':
303
+ description: ''
304
+ content:
305
+ application/json:
306
+ schema:
307
+ $ref: '#/components/schemas/DeploymentResourceType'
308
+ security:
309
+ - access_token: []
310
+ - user_token: []
311
+ /api/v2/deployment-resources:
312
+ get:
313
+ tags:
314
+ - Deployment Resources
315
+ operationId: allDeploymentResources
316
+ parameters:
317
+ - name: type_id
318
+ in: query
319
+ required: false
320
+ schema:
321
+ type: string
322
+ format: uuid
323
+ nullable: true
324
+ - name: page
325
+ in: query
326
+ required: false
327
+ schema:
328
+ type: integer
329
+ format: int64
330
+ nullable: true
331
+ - name: per_page
332
+ in: query
333
+ required: false
334
+ schema:
335
+ type: integer
336
+ format: int64
337
+ nullable: true
338
+ responses:
339
+ '200':
340
+ description: ''
341
+ content:
342
+ application/json:
343
+ schema:
344
+ type: object
345
+ required:
346
+ - page
347
+ - per_page
348
+ - items
349
+ - num_total
350
+ properties:
351
+ page:
352
+ type: integer
353
+ format: int64
354
+ example: '1'
355
+ per_page:
356
+ type: integer
357
+ format: int64
358
+ example: '50'
359
+ items:
360
+ type: array
361
+ items:
362
+ type: object
363
+ required:
364
+ - id
365
+ - created_at
366
+ - type_id
367
+ - name
368
+ - exists
369
+ - props
370
+ - sync_status
371
+ properties:
372
+ id:
373
+ type: string
374
+ format: uuid
375
+ created_at:
376
+ type: string
377
+ format: date-time
378
+ type_id:
379
+ type: string
380
+ format: uuid
381
+ deployment_id:
382
+ type: string
383
+ format: uuid
384
+ nullable: true
385
+ name:
386
+ type: string
387
+ exists:
388
+ type: boolean
389
+ props: {}
390
+ sync_status:
391
+ $ref: '#/components/schemas/DeploymentResourceSyncStatus'
392
+ sync_reason:
393
+ type: string
394
+ nullable: true
395
+ num_total:
396
+ type: integer
397
+ format: int64
398
+ example: '1'
399
+ security:
400
+ - access_token: []
401
+ - user_token: []
402
+ post:
403
+ tags:
404
+ - Deployment Resources
405
+ operationId: createDeploymentResource
406
+ requestBody:
407
+ content:
408
+ application/json:
409
+ schema:
410
+ $ref: '#/components/schemas/NewDeploymentResource'
411
+ required: true
412
+ responses:
413
+ '201':
414
+ description: ''
415
+ content:
416
+ application/json:
417
+ schema:
418
+ $ref: '#/components/schemas/DeploymentResource'
419
+ security:
420
+ - access_token: []
421
+ - user_token: []
422
+ /api/v2/deployment-resources/{id}:
423
+ get:
424
+ tags:
425
+ - Deployment Resources
426
+ operationId: getDeploymentResource
427
+ parameters:
428
+ - name: id
429
+ in: path
430
+ required: true
431
+ schema:
432
+ type: string
433
+ format: uuid
434
+ responses:
435
+ '200':
436
+ description: ''
437
+ content:
438
+ application/json:
439
+ schema:
440
+ $ref: '#/components/schemas/DeploymentResource'
441
+ security:
442
+ - access_token: []
443
+ - user_token: []
444
+ put:
445
+ tags:
446
+ - Deployment Resources
447
+ operationId: updateDeploymentResource
448
+ parameters:
449
+ - name: id
450
+ in: path
451
+ required: true
452
+ schema:
453
+ type: string
454
+ format: uuid
455
+ requestBody:
456
+ content:
457
+ application/json:
458
+ schema:
459
+ $ref: '#/components/schemas/UpdateDeploymentResource'
460
+ required: true
461
+ responses:
462
+ '200':
463
+ description: ''
464
+ content:
465
+ application/json:
466
+ schema:
467
+ $ref: '#/components/schemas/DeploymentResource'
468
+ security:
469
+ - access_token: []
470
+ - user_token: []
471
+ delete:
472
+ tags:
473
+ - Deployment Resources
474
+ operationId: deleteDeploymentResource
475
+ parameters:
476
+ - name: id
477
+ in: path
478
+ required: true
479
+ schema:
480
+ type: string
481
+ format: uuid
482
+ responses:
483
+ '204':
484
+ description: ''
485
+ security:
486
+ - access_token: []
487
+ - user_token: []
488
+ /api/v2/deployment-tasks:
489
+ get:
490
+ tags:
491
+ - Deployment Tasks
492
+ operationId: allDeploymentTasks
493
+ parameters:
494
+ - name: cluster_id
495
+ in: query
496
+ required: false
497
+ schema:
498
+ type: string
499
+ format: uuid
500
+ nullable: true
501
+ - name: deployment_id
502
+ in: query
503
+ required: false
504
+ schema:
505
+ type: string
506
+ format: uuid
507
+ nullable: true
508
+ - name: page
509
+ in: query
510
+ required: false
511
+ schema:
512
+ type: integer
513
+ format: int64
514
+ nullable: true
515
+ - name: per_page
516
+ in: query
517
+ required: false
518
+ schema:
519
+ type: integer
520
+ format: int64
521
+ nullable: true
522
+ responses:
523
+ '200':
524
+ description: ''
525
+ content:
526
+ application/json:
527
+ schema:
528
+ type: object
529
+ required:
530
+ - page
531
+ - per_page
532
+ - items
533
+ - num_total
534
+ properties:
535
+ page:
536
+ type: integer
537
+ format: int64
538
+ example: '1'
539
+ per_page:
540
+ type: integer
541
+ format: int64
542
+ example: '50'
543
+ items:
544
+ type: array
545
+ items:
546
+ type: object
547
+ required:
548
+ - id
549
+ - created_at
550
+ - cluster_id
551
+ - deployment_id
552
+ - operation
553
+ - status
554
+ properties:
555
+ id:
556
+ type: string
557
+ format: uuid
558
+ created_at:
559
+ type: string
560
+ format: date-time
561
+ first_attempted_at:
562
+ type: string
563
+ format: date-time
564
+ nullable: true
565
+ started_at:
566
+ type: string
567
+ format: date-time
568
+ nullable: true
569
+ finished_at:
570
+ type: string
571
+ format: date-time
572
+ nullable: true
573
+ cluster_id:
574
+ type: string
575
+ format: uuid
576
+ deployment_id:
577
+ type: string
578
+ format: uuid
579
+ acting_user_id:
580
+ type: string
581
+ format: uuid
582
+ nullable: true
583
+ acting_deployment_id:
584
+ type: string
585
+ format: uuid
586
+ nullable: true
587
+ operation:
588
+ $ref: '#/components/schemas/DeploymentTaskOperation'
589
+ status:
590
+ $ref: '#/components/schemas/DeploymentTaskStatus'
591
+ reason:
592
+ type: string
593
+ nullable: true
594
+ num_total:
595
+ type: integer
596
+ format: int64
597
+ example: '1'
598
+ security:
599
+ - access_token: []
600
+ - user_token: []
601
+ post:
602
+ tags:
603
+ - Deployment Tasks
604
+ operationId: createDeploymentTask
605
+ requestBody:
606
+ content:
607
+ application/json:
608
+ schema:
609
+ $ref: '#/components/schemas/CreateDeploymentTask'
610
+ required: true
611
+ responses:
612
+ '201':
613
+ description: ''
614
+ content:
615
+ application/json:
616
+ schema:
617
+ $ref: '#/components/schemas/DeploymentTask'
618
+ security:
619
+ - access_token: []
620
+ - user_token: []
621
+ /api/v2/deployment-tasks/{id}:
622
+ get:
623
+ tags:
624
+ - Deployment Tasks
625
+ operationId: getDeploymentTask
626
+ parameters:
627
+ - name: id
628
+ in: path
629
+ required: true
630
+ schema:
631
+ type: string
632
+ format: uuid
633
+ responses:
634
+ '200':
635
+ description: ''
636
+ content:
637
+ application/json:
638
+ schema:
639
+ $ref: '#/components/schemas/DeploymentTask'
640
+ security:
641
+ - access_token: []
642
+ - user_token: []
643
+ /api/v2/deployments:
644
+ get:
645
+ tags:
646
+ - Deployments
647
+ operationId: allDeployments
648
+ parameters:
649
+ - name: name
650
+ in: query
651
+ required: false
652
+ schema:
653
+ type: string
654
+ nullable: true
655
+ - name: kind
656
+ in: query
657
+ required: false
658
+ schema:
659
+ type: string
660
+ nullable: true
661
+ - name: cluster_id
662
+ in: query
663
+ required: false
664
+ schema:
665
+ type: string
666
+ format: uuid
667
+ nullable: true
668
+ - name: enabled
669
+ in: query
670
+ required: false
671
+ schema:
672
+ type: boolean
673
+ nullable: true
674
+ - name: page
675
+ in: query
676
+ required: false
677
+ schema:
678
+ type: integer
679
+ format: int64
680
+ nullable: true
681
+ - name: per_page
682
+ in: query
683
+ required: false
684
+ schema:
685
+ type: integer
686
+ format: int64
687
+ nullable: true
688
+ responses:
689
+ '200':
690
+ description: ''
691
+ content:
692
+ application/json:
693
+ schema:
694
+ type: object
695
+ required:
696
+ - page
697
+ - per_page
698
+ - items
699
+ - num_total
700
+ properties:
701
+ page:
702
+ type: integer
703
+ format: int64
704
+ example: '1'
705
+ per_page:
706
+ type: integer
707
+ format: int64
708
+ example: '50'
709
+ items:
710
+ type: array
711
+ items:
712
+ type: object
713
+ required:
714
+ - id
715
+ - created_at
716
+ - name
717
+ - kind
718
+ - cluster_id
719
+ - enabled
720
+ - status
721
+ - reported_status
722
+ - helm_chart_id
723
+ - config
724
+ properties:
725
+ id:
726
+ type: string
727
+ format: uuid
728
+ created_at:
729
+ type: string
730
+ format: date-time
731
+ name:
732
+ type: string
733
+ kind:
734
+ type: string
735
+ cluster_id:
736
+ type: string
737
+ format: uuid
738
+ enabled:
739
+ type: boolean
740
+ status:
741
+ $ref: '#/components/schemas/DeploymentStatus'
742
+ description_md:
743
+ type: string
744
+ nullable: true
745
+ reason:
746
+ type: string
747
+ nullable: true
748
+ revision_id:
749
+ type: string
750
+ format: uuid
751
+ nullable: true
752
+ reported_status:
753
+ $ref: '#/components/schemas/DeploymentReportedStatus'
754
+ helm_chart_id:
755
+ type: string
756
+ format: uuid
757
+ config: {}
758
+ values_override:
759
+ nullable: true
760
+ num_total:
761
+ type: integer
762
+ format: int64
763
+ example: '1'
764
+ security:
765
+ - access_token: []
766
+ - user_token: []
767
+ post:
768
+ tags:
769
+ - Deployments
770
+ operationId: createDeployment
771
+ requestBody:
772
+ content:
773
+ application/json:
774
+ schema:
775
+ $ref: '#/components/schemas/NewDeployment'
776
+ required: true
777
+ responses:
778
+ '201':
779
+ description: ''
780
+ content:
781
+ application/json:
782
+ schema:
783
+ $ref: '#/components/schemas/Deployment'
784
+ security:
785
+ - access_token: []
786
+ - user_token: []
787
+ /api/v2/deployments/{id}:
788
+ get:
789
+ tags:
790
+ - Deployments
791
+ operationId: getDeployment
792
+ parameters:
793
+ - name: id
794
+ in: path
795
+ required: true
796
+ schema:
797
+ type: string
798
+ format: uuid
799
+ responses:
800
+ '200':
801
+ description: ''
802
+ content:
803
+ application/json:
804
+ schema:
805
+ $ref: '#/components/schemas/Deployment'
806
+ security:
807
+ - access_token: []
808
+ - user_token: []
809
+ put:
810
+ tags:
811
+ - Deployments
812
+ operationId: updateDeployment
813
+ parameters:
814
+ - name: id
815
+ in: path
816
+ required: true
817
+ schema:
818
+ type: string
819
+ format: uuid
820
+ requestBody:
821
+ content:
822
+ application/json:
823
+ schema:
824
+ $ref: '#/components/schemas/UpdateDeployment'
825
+ required: true
826
+ responses:
827
+ '200':
828
+ description: ''
829
+ content:
830
+ application/json:
831
+ schema:
832
+ $ref: '#/components/schemas/Deployment'
833
+ security:
834
+ - access_token: []
835
+ - user_token: []
836
+ delete:
837
+ tags:
838
+ - Deployments
839
+ operationId: deleteDeployment
840
+ parameters:
841
+ - name: id
842
+ in: path
843
+ required: true
844
+ schema:
845
+ type: string
846
+ format: uuid
847
+ responses:
848
+ '204':
849
+ description: ''
850
+ security:
851
+ - access_token: []
852
+ - user_token: []
853
+ /api/v2/env-user-permissions:
854
+ get:
855
+ tags:
856
+ - Env User Permissions
857
+ operationId: allEnvUserPermissions
858
+ parameters:
859
+ - name: env_id
860
+ in: query
861
+ required: false
862
+ schema:
863
+ type: string
864
+ format: uuid
865
+ nullable: true
866
+ - name: page
867
+ in: query
868
+ required: false
869
+ schema:
870
+ type: integer
871
+ format: int64
872
+ nullable: true
873
+ - name: per_page
874
+ in: query
875
+ required: false
876
+ schema:
877
+ type: integer
878
+ format: int64
879
+ nullable: true
880
+ responses:
881
+ '200':
882
+ description: ''
883
+ content:
884
+ application/json:
885
+ schema:
886
+ type: object
887
+ required:
888
+ - page
889
+ - per_page
890
+ - items
891
+ - num_total
892
+ properties:
893
+ page:
894
+ type: integer
895
+ format: int64
896
+ example: '1'
897
+ per_page:
898
+ type: integer
899
+ format: int64
900
+ example: '50'
901
+ items:
902
+ type: array
903
+ items:
904
+ type: object
905
+ required:
906
+ - id
907
+ - created_at
908
+ - env_id
909
+ - user_id
910
+ - role
911
+ properties:
912
+ id:
913
+ type: string
914
+ format: uuid
915
+ created_at:
916
+ type: string
917
+ format: date-time
918
+ env_id:
919
+ type: string
920
+ format: uuid
921
+ user_id:
922
+ type: string
923
+ format: uuid
924
+ role:
925
+ $ref: '#/components/schemas/EnvUserRole'
926
+ num_total:
927
+ type: integer
928
+ format: int64
929
+ example: '1'
930
+ security:
931
+ - access_token: []
932
+ - user_token: []
933
+ post:
934
+ tags:
935
+ - Env User Permissions
936
+ operationId: createEnvUserPermission
937
+ requestBody:
938
+ content:
939
+ application/json:
940
+ schema:
941
+ $ref: '#/components/schemas/NewEnvUserPermission'
942
+ required: true
943
+ responses:
944
+ '201':
945
+ description: ''
946
+ content:
947
+ application/json:
948
+ schema:
949
+ $ref: '#/components/schemas/EnvUserPermission'
950
+ security:
951
+ - access_token: []
952
+ - user_token: []
953
+ /api/v2/env-user-permissions/{id}:
954
+ get:
955
+ tags:
956
+ - Env User Permissions
957
+ operationId: getEnvUserPermission
958
+ parameters:
959
+ - name: id
960
+ in: path
961
+ required: true
962
+ schema:
963
+ type: string
964
+ format: uuid
965
+ responses:
966
+ '200':
967
+ description: ''
968
+ content:
969
+ application/json:
970
+ schema:
971
+ $ref: '#/components/schemas/EnvUserPermission'
972
+ security:
973
+ - access_token: []
974
+ - user_token: []
975
+ delete:
976
+ tags:
977
+ - Env User Permissions
978
+ operationId: deleteEnvUserPermission
979
+ parameters:
980
+ - name: id
981
+ in: path
982
+ required: true
983
+ schema:
984
+ type: string
985
+ format: uuid
986
+ responses:
987
+ '204':
988
+ description: ''
989
+ security:
990
+ - access_token: []
991
+ - user_token: []
992
+ /api/v2/envs:
993
+ get:
994
+ tags:
995
+ - Envs
996
+ operationId: allEnvs
997
+ parameters:
998
+ - name: name
999
+ in: query
1000
+ required: false
1001
+ schema:
1002
+ type: string
1003
+ nullable: true
1004
+ - name: auto_add_new_users
1005
+ in: query
1006
+ required: false
1007
+ schema:
1008
+ type: boolean
1009
+ nullable: true
1010
+ - name: page
1011
+ in: query
1012
+ required: false
1013
+ schema:
1014
+ type: integer
1015
+ format: int64
1016
+ nullable: true
1017
+ - name: per_page
1018
+ in: query
1019
+ required: false
1020
+ schema:
1021
+ type: integer
1022
+ format: int64
1023
+ nullable: true
1024
+ responses:
1025
+ '200':
1026
+ description: ''
1027
+ content:
1028
+ application/json:
1029
+ schema:
1030
+ type: object
1031
+ required:
1032
+ - page
1033
+ - per_page
1034
+ - items
1035
+ - num_total
1036
+ properties:
1037
+ page:
1038
+ type: integer
1039
+ format: int64
1040
+ example: '1'
1041
+ per_page:
1042
+ type: integer
1043
+ format: int64
1044
+ example: '50'
1045
+ items:
1046
+ type: array
1047
+ items:
1048
+ type: object
1049
+ required:
1050
+ - id
1051
+ - created_at
1052
+ - name
1053
+ - node_selector
1054
+ - tolerations
1055
+ - auto_add_new_users
1056
+ properties:
1057
+ id:
1058
+ type: string
1059
+ format: uuid
1060
+ created_at:
1061
+ type: string
1062
+ format: date-time
1063
+ name:
1064
+ type: string
1065
+ node_selector: {}
1066
+ tolerations: {}
1067
+ auto_add_new_users:
1068
+ type: boolean
1069
+ num_total:
1070
+ type: integer
1071
+ format: int64
1072
+ example: '1'
1073
+ security:
1074
+ - access_token: []
1075
+ - user_token: []
1076
+ post:
1077
+ tags:
1078
+ - Envs
1079
+ operationId: createEnv
1080
+ requestBody:
1081
+ content:
1082
+ application/json:
1083
+ schema:
1084
+ $ref: '#/components/schemas/NewEnv'
1085
+ required: true
1086
+ responses:
1087
+ '201':
1088
+ description: ''
1089
+ content:
1090
+ application/json:
1091
+ schema:
1092
+ $ref: '#/components/schemas/Env'
1093
+ security:
1094
+ - access_token: []
1095
+ - user_token: []
1096
+ /api/v2/envs/{id}:
1097
+ get:
1098
+ tags:
1099
+ - Envs
1100
+ operationId: getEnv
1101
+ parameters:
1102
+ - name: id
1103
+ in: path
1104
+ required: true
1105
+ schema:
1106
+ type: string
1107
+ format: uuid
1108
+ responses:
1109
+ '200':
1110
+ description: ''
1111
+ content:
1112
+ application/json:
1113
+ schema:
1114
+ $ref: '#/components/schemas/Env'
1115
+ security:
1116
+ - access_token: []
1117
+ - user_token: []
1118
+ put:
1119
+ tags:
1120
+ - Envs
1121
+ operationId: updateEnv
1122
+ parameters:
1123
+ - name: id
1124
+ in: path
1125
+ required: true
1126
+ schema:
1127
+ type: string
1128
+ format: uuid
1129
+ requestBody:
1130
+ content:
1131
+ application/json:
1132
+ schema:
1133
+ $ref: '#/components/schemas/UpdateEnv'
1134
+ required: true
1135
+ responses:
1136
+ '200':
1137
+ description: ''
1138
+ content:
1139
+ application/json:
1140
+ schema:
1141
+ $ref: '#/components/schemas/Env'
1142
+ security:
1143
+ - access_token: []
1144
+ - user_token: []
1145
+ /api/v2/helm-charts:
1146
+ get:
1147
+ tags:
1148
+ - Helm Charts
1149
+ operationId: allHelmCharts
1150
+ parameters:
1151
+ - name: helm_registry_id
1152
+ in: query
1153
+ required: false
1154
+ schema:
1155
+ type: string
1156
+ format: uuid
1157
+ nullable: true
1158
+ - name: parsed_branch
1159
+ in: query
1160
+ required: false
1161
+ schema:
1162
+ type: string
1163
+ nullable: true
1164
+ - name: page
1165
+ in: query
1166
+ required: false
1167
+ schema:
1168
+ type: integer
1169
+ format: int64
1170
+ nullable: true
1171
+ - name: per_page
1172
+ in: query
1173
+ required: false
1174
+ schema:
1175
+ type: integer
1176
+ format: int64
1177
+ nullable: true
1178
+ responses:
1179
+ '200':
1180
+ description: ''
1181
+ content:
1182
+ application/json:
1183
+ schema:
1184
+ type: object
1185
+ required:
1186
+ - page
1187
+ - per_page
1188
+ - items
1189
+ - num_total
1190
+ properties:
1191
+ page:
1192
+ type: integer
1193
+ format: int64
1194
+ example: '1'
1195
+ per_page:
1196
+ type: integer
1197
+ format: int64
1198
+ example: '50'
1199
+ items:
1200
+ type: array
1201
+ items:
1202
+ type: object
1203
+ required:
1204
+ - id
1205
+ - created_at
1206
+ - helm_registry_id
1207
+ - image_digest
1208
+ - image_tag
1209
+ - available
1210
+ properties:
1211
+ id:
1212
+ type: string
1213
+ format: uuid
1214
+ created_at:
1215
+ type: string
1216
+ format: date-time
1217
+ helm_registry_id:
1218
+ type: string
1219
+ format: uuid
1220
+ image_digest:
1221
+ type: string
1222
+ image_tag:
1223
+ type: string
1224
+ available:
1225
+ type: boolean
1226
+ values_ui:
1227
+ nullable: true
1228
+ actions_schema:
1229
+ nullable: true
1230
+ features:
1231
+ nullable: true
1232
+ resource_types:
1233
+ nullable: true
1234
+ error:
1235
+ type: string
1236
+ nullable: true
1237
+ tag_format_id:
1238
+ type: string
1239
+ format: uuid
1240
+ nullable: true
1241
+ parsed_version:
1242
+ type: string
1243
+ nullable: true
1244
+ parsed_revision:
1245
+ type: string
1246
+ nullable: true
1247
+ parsed_branch:
1248
+ type: string
1249
+ nullable: true
1250
+ parsed_commit:
1251
+ type: string
1252
+ nullable: true
1253
+ num_total:
1254
+ type: integer
1255
+ format: int64
1256
+ example: '1'
1257
+ security:
1258
+ - access_token: []
1259
+ - user_token: []
1260
+ /api/v2/helm-charts/{id}:
1261
+ get:
1262
+ tags:
1263
+ - Helm Charts
1264
+ operationId: getHelmChart
1265
+ parameters:
1266
+ - name: id
1267
+ in: path
1268
+ required: true
1269
+ schema:
1270
+ type: string
1271
+ format: uuid
1272
+ responses:
1273
+ '200':
1274
+ description: ''
1275
+ content:
1276
+ application/json:
1277
+ schema:
1278
+ $ref: '#/components/schemas/HelmChart'
1279
+ security:
1280
+ - access_token: []
1281
+ - user_token: []
1282
+ /api/v2/helm-registries:
1283
+ get:
1284
+ tags:
1285
+ - Helm Registries
1286
+ operationId: allHelmRegistries
1287
+ parameters:
1288
+ - name: repo_name
1289
+ in: query
1290
+ required: false
1291
+ schema:
1292
+ type: string
1293
+ nullable: true
1294
+ - name: kind
1295
+ in: query
1296
+ required: false
1297
+ schema:
1298
+ type: string
1299
+ nullable: true
1300
+ - name: page
1301
+ in: query
1302
+ required: false
1303
+ schema:
1304
+ type: integer
1305
+ format: int64
1306
+ nullable: true
1307
+ - name: per_page
1308
+ in: query
1309
+ required: false
1310
+ schema:
1311
+ type: integer
1312
+ format: int64
1313
+ nullable: true
1314
+ responses:
1315
+ '200':
1316
+ description: ''
1317
+ content:
1318
+ application/json:
1319
+ schema:
1320
+ type: object
1321
+ required:
1322
+ - page
1323
+ - per_page
1324
+ - items
1325
+ - num_total
1326
+ properties:
1327
+ page:
1328
+ type: integer
1329
+ format: int64
1330
+ example: '1'
1331
+ per_page:
1332
+ type: integer
1333
+ format: int64
1334
+ example: '50'
1335
+ items:
1336
+ type: array
1337
+ items:
1338
+ type: object
1339
+ required:
1340
+ - id
1341
+ - created_at
1342
+ - domain_name
1343
+ - repo_name
1344
+ - kind
1345
+ - available
1346
+ - fa_icon
1347
+ properties:
1348
+ id:
1349
+ type: string
1350
+ format: uuid
1351
+ created_at:
1352
+ type: string
1353
+ format: date-time
1354
+ domain_name:
1355
+ type: string
1356
+ repo_name:
1357
+ type: string
1358
+ kind:
1359
+ type: string
1360
+ available:
1361
+ type: boolean
1362
+ fa_icon:
1363
+ type: string
1364
+ num_total:
1365
+ type: integer
1366
+ format: int64
1367
+ example: '1'
1368
+ security:
1369
+ - access_token: []
1370
+ - user_token: []
1371
+ /api/v2/helm-registries/{id}:
1372
+ get:
1373
+ tags:
1374
+ - Helm Registries
1375
+ operationId: getHelmRegistry
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/HelmRegistry'
1390
+ security:
1391
+ - access_token: []
1392
+ - user_token: []
1393
+ put:
1394
+ tags:
1395
+ - Helm Registries
1396
+ operationId: updateHelmRegistry
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/UpdateHelmRegistry'
1409
+ required: true
1410
+ responses:
1411
+ '200':
1412
+ description: ''
1413
+ content:
1414
+ application/json:
1415
+ schema:
1416
+ $ref: '#/components/schemas/HelmRegistry'
1417
+ security:
1418
+ - access_token: []
1419
+ - user_token: []
1420
+ /api/v2/helm-tag-formats:
1421
+ get:
1422
+ tags:
1423
+ - Helm Tag Formats
1424
+ operationId: allHelmTagFormats
1425
+ parameters:
1426
+ - name: pattern
1427
+ in: query
1428
+ required: false
1429
+ schema:
1430
+ type: string
1431
+ nullable: true
1432
+ - name: page
1433
+ in: query
1434
+ required: false
1435
+ schema:
1436
+ type: integer
1437
+ format: int64
1438
+ nullable: true
1439
+ - name: per_page
1440
+ in: query
1441
+ required: false
1442
+ schema:
1443
+ type: integer
1444
+ format: int64
1445
+ nullable: true
1446
+ responses:
1447
+ '200':
1448
+ description: ''
1449
+ content:
1450
+ application/json:
1451
+ schema:
1452
+ type: object
1453
+ required:
1454
+ - page
1455
+ - per_page
1456
+ - items
1457
+ - num_total
1458
+ properties:
1459
+ page:
1460
+ type: integer
1461
+ format: int64
1462
+ example: '1'
1463
+ per_page:
1464
+ type: integer
1465
+ format: int64
1466
+ example: '50'
1467
+ items:
1468
+ type: array
1469
+ items:
1470
+ type: object
1471
+ required:
1472
+ - id
1473
+ - created_at
1474
+ - pattern
1475
+ properties:
1476
+ id:
1477
+ type: string
1478
+ format: uuid
1479
+ created_at:
1480
+ type: string
1481
+ format: date-time
1482
+ pattern:
1483
+ type: string
1484
+ num_total:
1485
+ type: integer
1486
+ format: int64
1487
+ example: '1'
1488
+ security:
1489
+ - access_token: []
1490
+ - user_token: []
1491
+ post:
1492
+ tags:
1493
+ - Helm Tag Formats
1494
+ operationId: createHelmTagFormat
1495
+ requestBody:
1496
+ content:
1497
+ application/json:
1498
+ schema:
1499
+ $ref: '#/components/schemas/NewHelmTagFormat'
1500
+ required: true
1501
+ responses:
1502
+ '201':
1503
+ description: ''
1504
+ content:
1505
+ application/json:
1506
+ schema:
1507
+ $ref: '#/components/schemas/HelmTagFormat'
1508
+ security:
1509
+ - access_token: []
1510
+ - user_token: []
1511
+ /api/v2/helm-tag-formats/{id}:
1512
+ get:
1513
+ tags:
1514
+ - Helm Tag Formats
1515
+ operationId: getHelmTagFormat
1516
+ parameters:
1517
+ - name: id
1518
+ in: path
1519
+ required: true
1520
+ schema:
1521
+ type: string
1522
+ format: uuid
1523
+ responses:
1524
+ '200':
1525
+ description: ''
1526
+ content:
1527
+ application/json:
1528
+ schema:
1529
+ $ref: '#/components/schemas/HelmTagFormat'
1530
+ security:
1531
+ - access_token: []
1532
+ - user_token: []
1533
+ delete:
1534
+ tags:
1535
+ - Helm Tag Formats
1536
+ operationId: deleteHelmTagFormat
1537
+ parameters:
1538
+ - name: id
1539
+ in: path
1540
+ required: true
1541
+ schema:
1542
+ type: string
1543
+ format: uuid
1544
+ responses:
1545
+ '204':
1546
+ description: ''
1547
+ security:
1548
+ - access_token: []
1549
+ - user_token: []
1550
+ /api/v2/k8s-clusters:
1551
+ get:
1552
+ tags:
1553
+ - Kubernetes Clusters
1554
+ operationId: allK8sClusters
1555
+ parameters:
1556
+ - name: name
1557
+ in: query
1558
+ required: false
1559
+ schema:
1560
+ type: string
1561
+ nullable: true
1562
+ - name: page
1563
+ in: query
1564
+ required: false
1565
+ schema:
1566
+ type: integer
1567
+ format: int64
1568
+ nullable: true
1569
+ - name: per_page
1570
+ in: query
1571
+ required: false
1572
+ schema:
1573
+ type: integer
1574
+ format: int64
1575
+ nullable: true
1576
+ responses:
1577
+ '200':
1578
+ description: ''
1579
+ content:
1580
+ application/json:
1581
+ schema:
1582
+ type: object
1583
+ required:
1584
+ - page
1585
+ - per_page
1586
+ - items
1587
+ - num_total
1588
+ properties:
1589
+ page:
1590
+ type: integer
1591
+ format: int64
1592
+ example: '1'
1593
+ per_page:
1594
+ type: integer
1595
+ format: int64
1596
+ example: '50'
1597
+ items:
1598
+ type: array
1599
+ items:
1600
+ type: object
1601
+ required:
1602
+ - id
1603
+ - provider_id
1604
+ - created_at
1605
+ - last_seen_at
1606
+ - name
1607
+ - region_name
1608
+ - is_ok
1609
+ - ignore
1610
+ properties:
1611
+ id:
1612
+ type: string
1613
+ format: uuid
1614
+ env_id:
1615
+ type: string
1616
+ format: uuid
1617
+ nullable: true
1618
+ provider_id:
1619
+ type: string
1620
+ created_at:
1621
+ type: string
1622
+ format: date-time
1623
+ last_seen_at:
1624
+ type: string
1625
+ format: date-time
1626
+ name:
1627
+ type: string
1628
+ region_name:
1629
+ type: string
1630
+ is_ok:
1631
+ type: boolean
1632
+ not_ok_reason:
1633
+ type: string
1634
+ nullable: true
1635
+ ignore:
1636
+ type: boolean
1637
+ ingress_domain:
1638
+ type: string
1639
+ nullable: true
1640
+ ingress_class:
1641
+ type: string
1642
+ nullable: true
1643
+ ingress_tls_secret_name:
1644
+ type: string
1645
+ nullable: true
1646
+ grafana_url:
1647
+ type: string
1648
+ nullable: true
1649
+ grafana_datasource_name:
1650
+ type: string
1651
+ nullable: true
1652
+ num_total:
1653
+ type: integer
1654
+ format: int64
1655
+ example: '1'
1656
+ security:
1657
+ - access_token: []
1658
+ - user_token: []
1659
+ /api/v2/k8s-clusters/{id}:
1660
+ get:
1661
+ tags:
1662
+ - Kubernetes Clusters
1663
+ operationId: getK8sCluster
1664
+ parameters:
1665
+ - name: id
1666
+ in: path
1667
+ required: true
1668
+ schema:
1669
+ type: string
1670
+ format: uuid
1671
+ responses:
1672
+ '200':
1673
+ description: ''
1674
+ content:
1675
+ application/json:
1676
+ schema:
1677
+ $ref: '#/components/schemas/K8sCluster'
1678
+ security:
1679
+ - access_token: []
1680
+ - user_token: []
1681
+ put:
1682
+ tags:
1683
+ - Kubernetes Clusters
1684
+ operationId: updateK8sCluster
1685
+ parameters:
1686
+ - name: id
1687
+ in: path
1688
+ required: true
1689
+ schema:
1690
+ type: string
1691
+ format: uuid
1692
+ requestBody:
1693
+ content:
1694
+ application/json:
1695
+ schema:
1696
+ $ref: '#/components/schemas/UpdateK8sCluster'
1697
+ required: true
1698
+ responses:
1699
+ '200':
1700
+ description: ''
1701
+ content:
1702
+ application/json:
1703
+ schema:
1704
+ $ref: '#/components/schemas/K8sCluster'
1705
+ security:
1706
+ - access_token: []
1707
+ - user_token: []
1708
+ delete:
1709
+ tags:
1710
+ - Kubernetes Clusters
1711
+ operationId: deleteK8sCluster
1712
+ parameters:
1713
+ - name: id
1714
+ in: path
1715
+ required: true
1716
+ schema:
1717
+ type: string
1718
+ format: uuid
1719
+ responses:
1720
+ '204':
1721
+ description: ''
1722
+ security:
1723
+ - access_token: []
1724
+ - user_token: []
1725
+ /api/v2/k8s-resources:
1726
+ get:
1727
+ tags:
1728
+ - Kubernetes Resources
1729
+ operationId: allK8sResources
1730
+ parameters:
1731
+ - name: cluster_id
1732
+ in: query
1733
+ required: false
1734
+ schema:
1735
+ type: string
1736
+ format: uuid
1737
+ nullable: true
1738
+ - name: deployment_id
1739
+ in: query
1740
+ required: false
1741
+ schema:
1742
+ type: string
1743
+ format: uuid
1744
+ nullable: true
1745
+ - name: kind
1746
+ in: query
1747
+ required: false
1748
+ schema:
1749
+ type: string
1750
+ nullable: true
1751
+ - name: name
1752
+ in: query
1753
+ required: false
1754
+ schema:
1755
+ type: string
1756
+ nullable: true
1757
+ - name: page
1758
+ in: query
1759
+ required: false
1760
+ schema:
1761
+ type: integer
1762
+ format: int64
1763
+ nullable: true
1764
+ - name: per_page
1765
+ in: query
1766
+ required: false
1767
+ schema:
1768
+ type: integer
1769
+ format: int64
1770
+ nullable: true
1771
+ responses:
1772
+ '200':
1773
+ description: ''
1774
+ content:
1775
+ application/json:
1776
+ schema:
1777
+ type: object
1778
+ required:
1779
+ - page
1780
+ - per_page
1781
+ - items
1782
+ - num_total
1783
+ properties:
1784
+ page:
1785
+ type: integer
1786
+ format: int64
1787
+ example: '1'
1788
+ per_page:
1789
+ type: integer
1790
+ format: int64
1791
+ example: '50'
1792
+ items:
1793
+ type: array
1794
+ items:
1795
+ type: object
1796
+ required:
1797
+ - id
1798
+ - last_updated_at
1799
+ - cluster_id
1800
+ - deployment_id
1801
+ - kind
1802
+ - api_version
1803
+ - name
1804
+ - status_color
1805
+ - metadata
1806
+ properties:
1807
+ id:
1808
+ type: string
1809
+ format: uuid
1810
+ last_updated_at:
1811
+ type: string
1812
+ format: date-time
1813
+ cluster_id:
1814
+ type: string
1815
+ format: uuid
1816
+ deployment_id:
1817
+ type: string
1818
+ format: uuid
1819
+ kind:
1820
+ type: string
1821
+ api_version:
1822
+ type: string
1823
+ name:
1824
+ type: string
1825
+ status_color:
1826
+ type: array
1827
+ items:
1828
+ type: string
1829
+ metadata: {}
1830
+ num_total:
1831
+ type: integer
1832
+ format: int64
1833
+ example: '1'
1834
+ security:
1835
+ - access_token: []
1836
+ - user_token: []
1837
+ /api/v2/k8s-resources/{id}:
1838
+ get:
1839
+ tags:
1840
+ - Kubernetes Resources
1841
+ operationId: getK8sResource
1842
+ parameters:
1843
+ - name: id
1844
+ in: path
1845
+ required: true
1846
+ schema:
1847
+ type: string
1848
+ format: uuid
1849
+ responses:
1850
+ '200':
1851
+ description: ''
1852
+ content:
1853
+ application/json:
1854
+ schema:
1855
+ $ref: '#/components/schemas/K8sResource'
1856
+ security:
1857
+ - access_token: []
1858
+ - user_token: []
1859
+ /api/v2/secrets:
1860
+ get:
1861
+ tags:
1862
+ - Secrets
1863
+ operationId: allSecrets
1864
+ parameters:
1865
+ - name: env_id
1866
+ in: query
1867
+ required: false
1868
+ schema:
1869
+ type: string
1870
+ format: uuid
1871
+ nullable: true
1872
+ - name: collection
1873
+ in: query
1874
+ required: false
1875
+ schema:
1876
+ type: string
1877
+ nullable: true
1878
+ - name: name
1879
+ in: query
1880
+ required: false
1881
+ schema:
1882
+ type: string
1883
+ nullable: true
1884
+ - name: page
1885
+ in: query
1886
+ required: false
1887
+ schema:
1888
+ type: integer
1889
+ format: int64
1890
+ nullable: true
1891
+ - name: per_page
1892
+ in: query
1893
+ required: false
1894
+ schema:
1895
+ type: integer
1896
+ format: int64
1897
+ nullable: true
1898
+ responses:
1899
+ '200':
1900
+ description: ''
1901
+ content:
1902
+ application/json:
1903
+ schema:
1904
+ type: object
1905
+ required:
1906
+ - page
1907
+ - per_page
1908
+ - items
1909
+ - num_total
1910
+ properties:
1911
+ page:
1912
+ type: integer
1913
+ format: int64
1914
+ example: '1'
1915
+ per_page:
1916
+ type: integer
1917
+ format: int64
1918
+ example: '50'
1919
+ items:
1920
+ type: array
1921
+ items:
1922
+ type: object
1923
+ required:
1924
+ - id
1925
+ - created_at
1926
+ - updated_at
1927
+ - env_id
1928
+ - collection
1929
+ - name
1930
+ properties:
1931
+ id:
1932
+ type: string
1933
+ format: uuid
1934
+ created_at:
1935
+ type: string
1936
+ format: date-time
1937
+ updated_at:
1938
+ type: string
1939
+ format: date-time
1940
+ env_id:
1941
+ type: string
1942
+ format: uuid
1943
+ collection:
1944
+ type: string
1945
+ name:
1946
+ type: string
1947
+ num_total:
1948
+ type: integer
1949
+ format: int64
1950
+ example: '1'
1951
+ security:
1952
+ - access_token: []
1953
+ - user_token: []
1954
+ post:
1955
+ tags:
1956
+ - Secrets
1957
+ operationId: createSecret
1958
+ requestBody:
1959
+ content:
1960
+ application/json:
1961
+ schema:
1962
+ $ref: '#/components/schemas/NewSecret'
1963
+ required: true
1964
+ responses:
1965
+ '201':
1966
+ description: ''
1967
+ content:
1968
+ application/json:
1969
+ schema:
1970
+ $ref: '#/components/schemas/Secret'
1971
+ security:
1972
+ - access_token: []
1973
+ - user_token: []
1974
+ /api/v2/secrets/{id}:
1975
+ get:
1976
+ tags:
1977
+ - Secrets
1978
+ operationId: getSecret
1979
+ parameters:
1980
+ - name: id
1981
+ in: path
1982
+ required: true
1983
+ schema:
1984
+ type: string
1985
+ format: uuid
1986
+ responses:
1987
+ '200':
1988
+ description: ''
1989
+ content:
1990
+ application/json:
1991
+ schema:
1992
+ $ref: '#/components/schemas/Secret'
1993
+ security:
1994
+ - access_token: []
1995
+ - user_token: []
1996
+ put:
1997
+ tags:
1998
+ - Secrets
1999
+ operationId: updateSecret
2000
+ parameters:
2001
+ - name: id
2002
+ in: path
2003
+ required: true
2004
+ schema:
2005
+ type: string
2006
+ format: uuid
2007
+ requestBody:
2008
+ content:
2009
+ application/json:
2010
+ schema:
2011
+ $ref: '#/components/schemas/UpdateSecretApi'
2012
+ required: true
2013
+ responses:
2014
+ '200':
2015
+ description: ''
2016
+ content:
2017
+ application/json:
2018
+ schema:
2019
+ $ref: '#/components/schemas/Secret'
2020
+ security:
2021
+ - access_token: []
2022
+ - user_token: []
2023
+ delete:
2024
+ tags:
2025
+ - Secrets
2026
+ operationId: deleteSecret
2027
+ parameters:
2028
+ - name: id
2029
+ in: path
2030
+ required: true
2031
+ schema:
2032
+ type: string
2033
+ format: uuid
2034
+ responses:
2035
+ '204':
2036
+ description: ''
2037
+ security:
2038
+ - access_token: []
2039
+ - user_token: []
2040
+ /api/v2/server:
2041
+ get:
2042
+ tags:
2043
+ - Server
2044
+ operationId: getServerInfo
2045
+ responses:
2046
+ '200':
2047
+ description: ''
2048
+ content:
2049
+ application/json:
2050
+ schema:
2051
+ $ref: '#/components/schemas/ServerInfo'
2052
+ security:
2053
+ - access_token: []
2054
+ - user_token: []
2055
+ /api/v2/user-tokens:
2056
+ get:
2057
+ tags:
2058
+ - User Tokens
2059
+ operationId: allUserTokens
2060
+ parameters:
2061
+ - name: user_id
2062
+ in: query
2063
+ required: false
2064
+ schema:
2065
+ type: string
2066
+ format: uuid
2067
+ nullable: true
2068
+ - name: page
2069
+ in: query
2070
+ required: false
2071
+ schema:
2072
+ type: integer
2073
+ format: int64
2074
+ nullable: true
2075
+ - name: per_page
2076
+ in: query
2077
+ required: false
2078
+ schema:
2079
+ type: integer
2080
+ format: int64
2081
+ nullable: true
2082
+ responses:
2083
+ '200':
2084
+ description: ''
2085
+ content:
2086
+ application/json:
2087
+ schema:
2088
+ type: object
2089
+ required:
2090
+ - page
2091
+ - per_page
2092
+ - items
2093
+ - num_total
2094
+ properties:
2095
+ page:
2096
+ type: integer
2097
+ format: int64
2098
+ example: '1'
2099
+ per_page:
2100
+ type: integer
2101
+ format: int64
2102
+ example: '50'
2103
+ items:
2104
+ type: array
2105
+ items:
2106
+ type: object
2107
+ required:
2108
+ - id
2109
+ - user_id
2110
+ - created_at
2111
+ properties:
2112
+ id:
2113
+ type: string
2114
+ format: uuid
2115
+ user_id:
2116
+ type: string
2117
+ format: uuid
2118
+ created_at:
2119
+ type: string
2120
+ format: date-time
2121
+ num_total:
2122
+ type: integer
2123
+ format: int64
2124
+ example: '1'
2125
+ security:
2126
+ - access_token: []
2127
+ - user_token: []
2128
+ post:
2129
+ tags:
2130
+ - User Tokens
2131
+ operationId: createUserToken
2132
+ requestBody:
2133
+ content:
2134
+ application/json:
2135
+ schema:
2136
+ $ref: '#/components/schemas/CreateUserToken'
2137
+ required: true
2138
+ responses:
2139
+ '201':
2140
+ description: ''
2141
+ content:
2142
+ application/json:
2143
+ schema:
2144
+ $ref: '#/components/schemas/UserToken'
2145
+ security:
2146
+ - access_token: []
2147
+ - user_token: []
2148
+ /api/v2/user-tokens/{id}:
2149
+ get:
2150
+ tags:
2151
+ - User Tokens
2152
+ operationId: getUserToken
2153
+ parameters:
2154
+ - name: id
2155
+ in: path
2156
+ required: true
2157
+ schema:
2158
+ type: string
2159
+ format: uuid
2160
+ responses:
2161
+ '200':
2162
+ description: ''
2163
+ content:
2164
+ application/json:
2165
+ schema:
2166
+ $ref: '#/components/schemas/UserToken'
2167
+ security:
2168
+ - access_token: []
2169
+ - user_token: []
2170
+ delete:
2171
+ tags:
2172
+ - User Tokens
2173
+ operationId: deleteUserToken
2174
+ parameters:
2175
+ - name: id
2176
+ in: path
2177
+ required: true
2178
+ schema:
2179
+ type: string
2180
+ format: uuid
2181
+ responses:
2182
+ '204':
2183
+ description: ''
2184
+ security:
2185
+ - access_token: []
2186
+ - user_token: []
2187
+ /api/v2/users:
2188
+ get:
2189
+ tags:
2190
+ - Users
2191
+ operationId: allUsers
2192
+ parameters:
2193
+ - name: display_name
2194
+ in: query
2195
+ required: false
2196
+ schema:
2197
+ type: string
2198
+ nullable: true
2199
+ - name: email
2200
+ in: query
2201
+ required: false
2202
+ schema:
2203
+ type: string
2204
+ nullable: true
2205
+ - name: page
2206
+ in: query
2207
+ required: false
2208
+ schema:
2209
+ type: integer
2210
+ format: int64
2211
+ nullable: true
2212
+ - name: per_page
2213
+ in: query
2214
+ required: false
2215
+ schema:
2216
+ type: integer
2217
+ format: int64
2218
+ nullable: true
2219
+ responses:
2220
+ '200':
2221
+ description: ''
2222
+ content:
2223
+ application/json:
2224
+ schema:
2225
+ type: object
2226
+ required:
2227
+ - page
2228
+ - per_page
2229
+ - items
2230
+ - num_total
2231
+ properties:
2232
+ page:
2233
+ type: integer
2234
+ format: int64
2235
+ example: '1'
2236
+ per_page:
2237
+ type: integer
2238
+ format: int64
2239
+ example: '50'
2240
+ items:
2241
+ type: array
2242
+ items:
2243
+ type: object
2244
+ required:
2245
+ - id
2246
+ - created_at
2247
+ - display_name
2248
+ - email
2249
+ - is_admin
2250
+ properties:
2251
+ id:
2252
+ type: string
2253
+ format: uuid
2254
+ created_at:
2255
+ type: string
2256
+ format: date-time
2257
+ display_name:
2258
+ type: string
2259
+ email:
2260
+ type: string
2261
+ is_admin:
2262
+ type: boolean
2263
+ num_total:
2264
+ type: integer
2265
+ format: int64
2266
+ example: '1'
2267
+ security:
2268
+ - access_token: []
2269
+ - user_token: []
2270
+ /api/v2/users/{id}:
2271
+ get:
2272
+ tags:
2273
+ - Users
2274
+ operationId: getUser
2275
+ parameters:
2276
+ - name: id
2277
+ in: path
2278
+ required: true
2279
+ schema:
2280
+ type: string
2281
+ format: uuid
2282
+ responses:
2283
+ '200':
2284
+ description: ''
2285
+ content:
2286
+ application/json:
2287
+ schema:
2288
+ $ref: '#/components/schemas/User'
2289
+ security:
2290
+ - access_token: []
2291
+ - user_token: []
2292
+ put:
2293
+ tags:
2294
+ - Users
2295
+ operationId: updateUser
2296
+ parameters:
2297
+ - name: id
2298
+ in: path
2299
+ required: true
2300
+ schema:
2301
+ type: string
2302
+ format: uuid
2303
+ requestBody:
2304
+ content:
2305
+ application/json:
2306
+ schema:
2307
+ $ref: '#/components/schemas/UpdateUser'
2308
+ required: true
2309
+ responses:
2310
+ '200':
2311
+ description: ''
2312
+ content:
2313
+ application/json:
2314
+ schema:
2315
+ $ref: '#/components/schemas/User'
2316
+ security:
2317
+ - access_token: []
2318
+ - user_token: []
2319
+ components:
2320
+ schemas:
2321
+ CreateDeploymentTask:
2322
+ type: object
2323
+ required:
2324
+ - deployment_id
2325
+ - operation
2326
+ properties:
2327
+ deployment_id:
2328
+ type: string
2329
+ format: uuid
2330
+ operation:
2331
+ $ref: '#/components/schemas/DeploymentTaskOperation'
2332
+ CreateUserToken:
2333
+ type: object
2334
+ properties:
2335
+ user_id:
2336
+ type: string
2337
+ format: uuid
2338
+ nullable: true
2339
+ Deployment:
2340
+ type: object
2341
+ required:
2342
+ - id
2343
+ - created_at
2344
+ - name
2345
+ - kind
2346
+ - cluster_id
2347
+ - enabled
2348
+ - status
2349
+ - reported_status
2350
+ - helm_chart_id
2351
+ - config
2352
+ properties:
2353
+ id:
2354
+ type: string
2355
+ format: uuid
2356
+ created_at:
2357
+ type: string
2358
+ format: date-time
2359
+ name:
2360
+ type: string
2361
+ kind:
2362
+ type: string
2363
+ cluster_id:
2364
+ type: string
2365
+ format: uuid
2366
+ enabled:
2367
+ type: boolean
2368
+ status:
2369
+ $ref: '#/components/schemas/DeploymentStatus'
2370
+ description_md:
2371
+ type: string
2372
+ nullable: true
2373
+ reason:
2374
+ type: string
2375
+ nullable: true
2376
+ revision_id:
2377
+ type: string
2378
+ format: uuid
2379
+ nullable: true
2380
+ reported_status:
2381
+ $ref: '#/components/schemas/DeploymentReportedStatus'
2382
+ helm_chart_id:
2383
+ type: string
2384
+ format: uuid
2385
+ config: {}
2386
+ values_override:
2387
+ nullable: true
2388
+ DeploymentInstallTask:
2389
+ type: object
2390
+ required:
2391
+ - helm_chart_id
2392
+ - config_inputs
2393
+ properties:
2394
+ helm_chart_id:
2395
+ type: string
2396
+ format: uuid
2397
+ config_inputs: {}
2398
+ values_override:
2399
+ nullable: true
2400
+ DeploymentInvokeActionTask:
2401
+ type: object
2402
+ required:
2403
+ - helm_chart_id
2404
+ - action_id
2405
+ - body
2406
+ properties:
2407
+ helm_chart_id:
2408
+ type: string
2409
+ format: uuid
2410
+ action_id:
2411
+ type: string
2412
+ body: {}
2413
+ DeploymentPermission:
2414
+ type: object
2415
+ required:
2416
+ - id
2417
+ - created_at
2418
+ - env_id
2419
+ - user_id
2420
+ - kind
2421
+ - role
2422
+ properties:
2423
+ id:
2424
+ type: string
2425
+ format: uuid
2426
+ created_at:
2427
+ type: string
2428
+ format: date-time
2429
+ env_id:
2430
+ type: string
2431
+ format: uuid
2432
+ user_id:
2433
+ type: string
2434
+ format: uuid
2435
+ kind:
2436
+ type: string
2437
+ role:
2438
+ $ref: '#/components/schemas/UserDeploymentRole'
2439
+ DeploymentRecreaseTask:
2440
+ type: object
2441
+ required:
2442
+ - old_cluster_id
2443
+ - old_namespace
2444
+ - new_cluster_id
2445
+ - new_namespace
2446
+ properties:
2447
+ old_cluster_id:
2448
+ type: string
2449
+ format: uuid
2450
+ old_namespace:
2451
+ type: string
2452
+ new_cluster_id:
2453
+ type: string
2454
+ format: uuid
2455
+ new_namespace:
2456
+ type: string
2457
+ DeploymentReinstallTask:
2458
+ type: object
2459
+ required:
2460
+ - reason
2461
+ properties:
2462
+ reason:
2463
+ type: string
2464
+ DeploymentRepootedMetric:
2465
+ type: object
2466
+ required:
2467
+ - value
2468
+ - unit
2469
+ - short_description
2470
+ properties:
2471
+ value:
2472
+ type: string
2473
+ unit:
2474
+ type: string
2475
+ short_description:
2476
+ type: string
2477
+ color:
2478
+ allOf:
2479
+ - $ref: '#/components/schemas/DeploymentReportedStatusColor'
2480
+ nullable: true
2481
+ DeploymentReportedNotice:
2482
+ type: object
2483
+ required:
2484
+ - level
2485
+ - text
2486
+ properties:
2487
+ level:
2488
+ $ref: '#/components/schemas/DeploymentReportedNoticeLevel'
2489
+ text:
2490
+ type: string
2491
+ DeploymentReportedNoticeLevel:
2492
+ type: string
2493
+ enum:
2494
+ - Info
2495
+ - Warning
2496
+ - Danger
2497
+ DeploymentReportedStatus:
2498
+ type: object
2499
+ required:
2500
+ - timestamp
2501
+ - get_successful
2502
+ properties:
2503
+ timestamp:
2504
+ type: string
2505
+ format: date-time
2506
+ get_successful:
2507
+ type: boolean
2508
+ content:
2509
+ allOf:
2510
+ - $ref: '#/components/schemas/DeploymentReportedStatusContent'
2511
+ nullable: true
2512
+ error:
2513
+ type: string
2514
+ nullable: true
2515
+ DeploymentReportedStatusColor:
2516
+ type: string
2517
+ enum:
2518
+ - primary
2519
+ - success
2520
+ - danger
2521
+ - warning
2522
+ - secondary
2523
+ DeploymentReportedStatusContent:
2524
+ type: object
2525
+ required:
2526
+ - status
2527
+ - notices
2528
+ properties:
2529
+ status:
2530
+ $ref: '#/components/schemas/DeploymentReportedStatusSummary'
2531
+ primary_metric:
2532
+ allOf:
2533
+ - $ref: '#/components/schemas/DeploymentRepootedMetric'
2534
+ nullable: true
2535
+ metrics:
2536
+ type: array
2537
+ items:
2538
+ $ref: '#/components/schemas/DeploymentRepootedMetric'
2539
+ nullable: true
2540
+ notices:
2541
+ type: array
2542
+ items:
2543
+ $ref: '#/components/schemas/DeploymentReportedNotice'
2544
+ DeploymentReportedStatusSummary:
2545
+ type: object
2546
+ required:
2547
+ - name
2548
+ - color
2549
+ properties:
2550
+ name:
2551
+ type: string
2552
+ color:
2553
+ $ref: '#/components/schemas/DeploymentReportedStatusColor'
2554
+ DeploymentResource:
2555
+ type: object
2556
+ required:
2557
+ - id
2558
+ - created_at
2559
+ - type_id
2560
+ - name
2561
+ - exists
2562
+ - props
2563
+ - sync_status
2564
+ properties:
2565
+ id:
2566
+ type: string
2567
+ format: uuid
2568
+ created_at:
2569
+ type: string
2570
+ format: date-time
2571
+ type_id:
2572
+ type: string
2573
+ format: uuid
2574
+ deployment_id:
2575
+ type: string
2576
+ format: uuid
2577
+ nullable: true
2578
+ name:
2579
+ type: string
2580
+ exists:
2581
+ type: boolean
2582
+ props: {}
2583
+ sync_status:
2584
+ $ref: '#/components/schemas/DeploymentResourceSyncStatus'
2585
+ sync_reason:
2586
+ type: string
2587
+ nullable: true
2588
+ DeploymentResourceSyncStatus:
2589
+ type: string
2590
+ enum:
2591
+ - Creating
2592
+ - Updating
2593
+ - Deleting
2594
+ - Ready
2595
+ - Error
2596
+ DeploymentResourceType:
2597
+ type: object
2598
+ required:
2599
+ - id
2600
+ - created_at
2601
+ - deployment_kind
2602
+ - key
2603
+ - spec
2604
+ properties:
2605
+ id:
2606
+ type: string
2607
+ format: uuid
2608
+ created_at:
2609
+ type: string
2610
+ format: date-time
2611
+ env_id:
2612
+ type: string
2613
+ format: uuid
2614
+ nullable: true
2615
+ deployment_kind:
2616
+ type: string
2617
+ key:
2618
+ type: string
2619
+ spec: {}
2620
+ DeploymentRestartK8sResourceTask:
2621
+ type: object
2622
+ required:
2623
+ - resource_id
2624
+ - resource_name
2625
+ properties:
2626
+ resource_id:
2627
+ type: string
2628
+ format: uuid
2629
+ resource_name:
2630
+ type: string
2631
+ DeploymentStatus:
2632
+ type: string
2633
+ enum:
2634
+ - Unknown
2635
+ - Installing
2636
+ - Renaming
2637
+ - Upgrading
2638
+ - Running
2639
+ - Error
2640
+ - Uninstalling
2641
+ - Uninstalled
2642
+ - Deleting
2643
+ DeploymentTask:
2644
+ type: object
2645
+ required:
2646
+ - id
2647
+ - created_at
2648
+ - cluster_id
2649
+ - deployment_id
2650
+ - operation
2651
+ - status
2652
+ properties:
2653
+ id:
2654
+ type: string
2655
+ format: uuid
2656
+ created_at:
2657
+ type: string
2658
+ format: date-time
2659
+ first_attempted_at:
2660
+ type: string
2661
+ format: date-time
2662
+ nullable: true
2663
+ started_at:
2664
+ type: string
2665
+ format: date-time
2666
+ nullable: true
2667
+ finished_at:
2668
+ type: string
2669
+ format: date-time
2670
+ nullable: true
2671
+ cluster_id:
2672
+ type: string
2673
+ format: uuid
2674
+ deployment_id:
2675
+ type: string
2676
+ format: uuid
2677
+ acting_user_id:
2678
+ type: string
2679
+ format: uuid
2680
+ nullable: true
2681
+ acting_deployment_id:
2682
+ type: string
2683
+ format: uuid
2684
+ nullable: true
2685
+ operation:
2686
+ $ref: '#/components/schemas/DeploymentTaskOperation'
2687
+ status:
2688
+ $ref: '#/components/schemas/DeploymentTaskStatus'
2689
+ reason:
2690
+ type: string
2691
+ nullable: true
2692
+ DeploymentTaskOperation:
2693
+ oneOf:
2694
+ - type: object
2695
+ required:
2696
+ - Install
2697
+ properties:
2698
+ Install:
2699
+ $ref: '#/components/schemas/DeploymentInstallTask'
2700
+ - type: object
2701
+ required:
2702
+ - Upgrade
2703
+ properties:
2704
+ Upgrade:
2705
+ $ref: '#/components/schemas/DeploymentUpgradeTask'
2706
+ - type: object
2707
+ required:
2708
+ - Reinstall
2709
+ properties:
2710
+ Reinstall:
2711
+ $ref: '#/components/schemas/DeploymentReinstallTask'
2712
+ - type: object
2713
+ required:
2714
+ - Recreate
2715
+ properties:
2716
+ Recreate:
2717
+ $ref: '#/components/schemas/DeploymentRecreaseTask'
2718
+ - type: object
2719
+ required:
2720
+ - Uninstall
2721
+ properties:
2722
+ Uninstall:
2723
+ $ref: '#/components/schemas/DeploymentUninstallTask'
2724
+ - type: object
2725
+ required:
2726
+ - InvokeAction
2727
+ properties:
2728
+ InvokeAction:
2729
+ $ref: '#/components/schemas/DeploymentInvokeActionTask'
2730
+ - type: object
2731
+ required:
2732
+ - RestartK8sResource
2733
+ properties:
2734
+ RestartK8sResource:
2735
+ $ref: '#/components/schemas/DeploymentRestartK8sResourceTask'
2736
+ DeploymentTaskStatus:
2737
+ type: string
2738
+ enum:
2739
+ - Pending
2740
+ - Started
2741
+ - Failed
2742
+ - Done
2743
+ DeploymentUninstallTask:
2744
+ type: object
2745
+ DeploymentUpgradeTask:
2746
+ type: object
2747
+ required:
2748
+ - helm_chart_id
2749
+ - config_inputs
2750
+ - config_delta
2751
+ properties:
2752
+ helm_chart_id:
2753
+ type: string
2754
+ format: uuid
2755
+ prev_helm_chart_id:
2756
+ type: string
2757
+ format: uuid
2758
+ nullable: true
2759
+ config_inputs: {}
2760
+ config_delta:
2761
+ type: object
2762
+ values_override:
2763
+ nullable: true
2764
+ Env:
2765
+ type: object
2766
+ required:
2767
+ - id
2768
+ - created_at
2769
+ - name
2770
+ - node_selector
2771
+ - tolerations
2772
+ - auto_add_new_users
2773
+ properties:
2774
+ id:
2775
+ type: string
2776
+ format: uuid
2777
+ created_at:
2778
+ type: string
2779
+ format: date-time
2780
+ name:
2781
+ type: string
2782
+ node_selector: {}
2783
+ tolerations: {}
2784
+ auto_add_new_users:
2785
+ type: boolean
2786
+ EnvUserPermission:
2787
+ type: object
2788
+ required:
2789
+ - id
2790
+ - created_at
2791
+ - env_id
2792
+ - user_id
2793
+ - role
2794
+ properties:
2795
+ id:
2796
+ type: string
2797
+ format: uuid
2798
+ created_at:
2799
+ type: string
2800
+ format: date-time
2801
+ env_id:
2802
+ type: string
2803
+ format: uuid
2804
+ user_id:
2805
+ type: string
2806
+ format: uuid
2807
+ role:
2808
+ $ref: '#/components/schemas/EnvUserRole'
2809
+ EnvUserRole:
2810
+ type: string
2811
+ enum:
2812
+ - Admin
2813
+ - User
2814
+ FinishGoogleLoginResponse:
2815
+ type: object
2816
+ required:
2817
+ - access_token
2818
+ properties:
2819
+ access_token:
2820
+ type: string
2821
+ HelmChart:
2822
+ type: object
2823
+ required:
2824
+ - id
2825
+ - created_at
2826
+ - helm_registry_id
2827
+ - image_digest
2828
+ - image_tag
2829
+ - available
2830
+ properties:
2831
+ id:
2832
+ type: string
2833
+ format: uuid
2834
+ created_at:
2835
+ type: string
2836
+ format: date-time
2837
+ helm_registry_id:
2838
+ type: string
2839
+ format: uuid
2840
+ image_digest:
2841
+ type: string
2842
+ image_tag:
2843
+ type: string
2844
+ available:
2845
+ type: boolean
2846
+ values_ui:
2847
+ nullable: true
2848
+ actions_schema:
2849
+ nullable: true
2850
+ features:
2851
+ nullable: true
2852
+ resource_types:
2853
+ nullable: true
2854
+ error:
2855
+ type: string
2856
+ nullable: true
2857
+ tag_format_id:
2858
+ type: string
2859
+ format: uuid
2860
+ nullable: true
2861
+ parsed_version:
2862
+ type: string
2863
+ nullable: true
2864
+ parsed_revision:
2865
+ type: string
2866
+ nullable: true
2867
+ parsed_branch:
2868
+ type: string
2869
+ nullable: true
2870
+ parsed_commit:
2871
+ type: string
2872
+ nullable: true
2873
+ HelmRegistry:
2874
+ type: object
2875
+ required:
2876
+ - id
2877
+ - created_at
2878
+ - domain_name
2879
+ - repo_name
2880
+ - kind
2881
+ - available
2882
+ - fa_icon
2883
+ properties:
2884
+ id:
2885
+ type: string
2886
+ format: uuid
2887
+ created_at:
2888
+ type: string
2889
+ format: date-time
2890
+ domain_name:
2891
+ type: string
2892
+ repo_name:
2893
+ type: string
2894
+ kind:
2895
+ type: string
2896
+ available:
2897
+ type: boolean
2898
+ fa_icon:
2899
+ type: string
2900
+ HelmTagFormat:
2901
+ type: object
2902
+ required:
2903
+ - id
2904
+ - created_at
2905
+ - pattern
2906
+ properties:
2907
+ id:
2908
+ type: string
2909
+ format: uuid
2910
+ created_at:
2911
+ type: string
2912
+ format: date-time
2913
+ pattern:
2914
+ type: string
2915
+ K8sCluster:
2916
+ type: object
2917
+ required:
2918
+ - id
2919
+ - provider_id
2920
+ - created_at
2921
+ - last_seen_at
2922
+ - name
2923
+ - region_name
2924
+ - is_ok
2925
+ - ignore
2926
+ properties:
2927
+ id:
2928
+ type: string
2929
+ format: uuid
2930
+ env_id:
2931
+ type: string
2932
+ format: uuid
2933
+ nullable: true
2934
+ provider_id:
2935
+ type: string
2936
+ created_at:
2937
+ type: string
2938
+ format: date-time
2939
+ last_seen_at:
2940
+ type: string
2941
+ format: date-time
2942
+ name:
2943
+ type: string
2944
+ region_name:
2945
+ type: string
2946
+ is_ok:
2947
+ type: boolean
2948
+ not_ok_reason:
2949
+ type: string
2950
+ nullable: true
2951
+ ignore:
2952
+ type: boolean
2953
+ ingress_domain:
2954
+ type: string
2955
+ nullable: true
2956
+ ingress_class:
2957
+ type: string
2958
+ nullable: true
2959
+ ingress_tls_secret_name:
2960
+ type: string
2961
+ nullable: true
2962
+ grafana_url:
2963
+ type: string
2964
+ nullable: true
2965
+ grafana_datasource_name:
2966
+ type: string
2967
+ nullable: true
2968
+ K8sResource:
2969
+ type: object
2970
+ required:
2971
+ - id
2972
+ - last_updated_at
2973
+ - cluster_id
2974
+ - deployment_id
2975
+ - kind
2976
+ - api_version
2977
+ - name
2978
+ - status_color
2979
+ - metadata
2980
+ properties:
2981
+ id:
2982
+ type: string
2983
+ format: uuid
2984
+ last_updated_at:
2985
+ type: string
2986
+ format: date-time
2987
+ cluster_id:
2988
+ type: string
2989
+ format: uuid
2990
+ deployment_id:
2991
+ type: string
2992
+ format: uuid
2993
+ kind:
2994
+ type: string
2995
+ api_version:
2996
+ type: string
2997
+ name:
2998
+ type: string
2999
+ status_color:
3000
+ type: array
3001
+ items:
3002
+ type: string
3003
+ metadata: {}
3004
+ MeResponse:
3005
+ oneOf:
3006
+ - type: object
3007
+ required:
3008
+ - User
3009
+ properties:
3010
+ User:
3011
+ $ref: '#/components/schemas/User'
3012
+ - type: object
3013
+ required:
3014
+ - Deployment
3015
+ properties:
3016
+ Deployment:
3017
+ type: object
3018
+ required:
3019
+ - id
3020
+ - name
3021
+ properties:
3022
+ id:
3023
+ type: string
3024
+ format: uuid
3025
+ name:
3026
+ type: string
3027
+ NewDeployment:
3028
+ type: object
3029
+ required:
3030
+ - kind
3031
+ - cluster_id
3032
+ - helm_chart_id
3033
+ properties:
3034
+ name:
3035
+ type: string
3036
+ kind:
3037
+ type: string
3038
+ cluster_id:
3039
+ type: string
3040
+ format: uuid
3041
+ helm_chart_id:
3042
+ type: string
3043
+ format: uuid
3044
+ config:
3045
+ nullable: true
3046
+ values_override:
3047
+ nullable: true
3048
+ NewDeploymentPermission:
3049
+ type: object
3050
+ required:
3051
+ - env_id
3052
+ - user_id
3053
+ - kind
3054
+ - role
3055
+ properties:
3056
+ env_id:
3057
+ type: string
3058
+ format: uuid
3059
+ user_id:
3060
+ type: string
3061
+ format: uuid
3062
+ kind:
3063
+ type: string
3064
+ role:
3065
+ $ref: '#/components/schemas/UserDeploymentRole'
3066
+ NewDeploymentResource:
3067
+ type: object
3068
+ required:
3069
+ - type_id
3070
+ - deployment_id
3071
+ - name
3072
+ - props
3073
+ properties:
3074
+ id:
3075
+ type: string
3076
+ format: uuid
3077
+ nullable: true
3078
+ created_at:
3079
+ type: string
3080
+ format: date-time
3081
+ nullable: true
3082
+ type_id:
3083
+ type: string
3084
+ format: uuid
3085
+ deployment_id:
3086
+ type: string
3087
+ format: uuid
3088
+ name:
3089
+ type: string
3090
+ props: {}
3091
+ sync_status:
3092
+ allOf:
3093
+ - $ref: '#/components/schemas/DeploymentResourceSyncStatus'
3094
+ nullable: true
3095
+ NewEnv:
3096
+ type: object
3097
+ required:
3098
+ - name
3099
+ properties:
3100
+ name:
3101
+ type: string
3102
+ auto_add_new_users:
3103
+ type: boolean
3104
+ nullable: true
3105
+ NewEnvUserPermission:
3106
+ type: object
3107
+ required:
3108
+ - env_id
3109
+ - user_id
3110
+ - role
3111
+ properties:
3112
+ env_id:
3113
+ type: string
3114
+ format: uuid
3115
+ user_id:
3116
+ type: string
3117
+ format: uuid
3118
+ role:
3119
+ $ref: '#/components/schemas/EnvUserRole'
3120
+ NewHelmTagFormat:
3121
+ type: object
3122
+ required:
3123
+ - pattern
3124
+ properties:
3125
+ pattern:
3126
+ type: string
3127
+ NewSecret:
3128
+ type: object
3129
+ required:
3130
+ - env_id
3131
+ - collection
3132
+ - name
3133
+ - contents
3134
+ properties:
3135
+ env_id:
3136
+ type: string
3137
+ format: uuid
3138
+ collection:
3139
+ type: string
3140
+ name:
3141
+ type: string
3142
+ contents:
3143
+ type: string
3144
+ OAuth2Response:
3145
+ type: object
3146
+ required:
3147
+ - auth_code
3148
+ properties:
3149
+ auth_code:
3150
+ type: string
3151
+ Secret:
3152
+ type: object
3153
+ required:
3154
+ - id
3155
+ - created_at
3156
+ - updated_at
3157
+ - env_id
3158
+ - collection
3159
+ - name
3160
+ properties:
3161
+ id:
3162
+ type: string
3163
+ format: uuid
3164
+ created_at:
3165
+ type: string
3166
+ format: date-time
3167
+ updated_at:
3168
+ type: string
3169
+ format: date-time
3170
+ env_id:
3171
+ type: string
3172
+ format: uuid
3173
+ collection:
3174
+ type: string
3175
+ name:
3176
+ type: string
3177
+ ServerInfo:
3178
+ type: object
3179
+ required:
3180
+ - version
3181
+ properties:
3182
+ version:
3183
+ type: string
3184
+ StartGoogleLoginResponse:
3185
+ type: object
3186
+ required:
3187
+ - redirect_url
3188
+ properties:
3189
+ redirect_url:
3190
+ type: string
3191
+ UpdateDeployment:
3192
+ type: object
3193
+ properties:
3194
+ name:
3195
+ type: string
3196
+ nullable: true
3197
+ cluster_id:
3198
+ type: string
3199
+ format: uuid
3200
+ nullable: true
3201
+ helm_chart_id:
3202
+ type: string
3203
+ format: uuid
3204
+ nullable: true
3205
+ config:
3206
+ nullable: true
3207
+ values_override:
3208
+ nullable: true
3209
+ enabled:
3210
+ type: boolean
3211
+ nullable: true
3212
+ description_md:
3213
+ type: string
3214
+ nullable: true
3215
+ UpdateDeploymentResource:
3216
+ type: object
3217
+ properties:
3218
+ name:
3219
+ type: string
3220
+ nullable: true
3221
+ props:
3222
+ nullable: true
3223
+ UpdateEnv:
3224
+ type: object
3225
+ properties:
3226
+ name:
3227
+ type: string
3228
+ nullable: true
3229
+ node_selector:
3230
+ nullable: true
3231
+ tolerations:
3232
+ nullable: true
3233
+ auto_add_new_users:
3234
+ type: boolean
3235
+ nullable: true
3236
+ UpdateHelmRegistry:
3237
+ type: object
3238
+ properties:
3239
+ fa_icon:
3240
+ type: string
3241
+ nullable: true
3242
+ UpdateK8sCluster:
3243
+ type: object
3244
+ properties:
3245
+ env_id:
3246
+ type: string
3247
+ format: uuid
3248
+ nullable: true
3249
+ ignore:
3250
+ type: boolean
3251
+ nullable: true
3252
+ ingress_domain:
3253
+ type: string
3254
+ nullable: true
3255
+ ingress_class:
3256
+ type: string
3257
+ nullable: true
3258
+ ingress_tls_secret_name:
3259
+ type: string
3260
+ nullable: true
3261
+ grafana_url:
3262
+ type: string
3263
+ nullable: true
3264
+ grafana_datasource_name:
3265
+ type: string
3266
+ nullable: true
3267
+ UpdateSecretApi:
3268
+ type: object
3269
+ properties:
3270
+ name:
3271
+ type: string
3272
+ nullable: true
3273
+ contents:
3274
+ type: string
3275
+ nullable: true
3276
+ UpdateUser:
3277
+ type: object
3278
+ properties:
3279
+ is_admin:
3280
+ type: boolean
3281
+ nullable: true
3282
+ User:
3283
+ type: object
3284
+ required:
3285
+ - id
3286
+ - created_at
3287
+ - display_name
3288
+ - email
3289
+ - is_admin
3290
+ properties:
3291
+ id:
3292
+ type: string
3293
+ format: uuid
3294
+ created_at:
3295
+ type: string
3296
+ format: date-time
3297
+ display_name:
3298
+ type: string
3299
+ email:
3300
+ type: string
3301
+ is_admin:
3302
+ type: boolean
3303
+ UserDeploymentRole:
3304
+ type: string
3305
+ enum:
3306
+ - Owner
3307
+ - Maintainer
3308
+ UserToken:
3309
+ type: object
3310
+ required:
3311
+ - id
3312
+ - user_id
3313
+ - created_at
3314
+ properties:
3315
+ id:
3316
+ type: string
3317
+ format: uuid
3318
+ user_id:
3319
+ type: string
3320
+ format: uuid
3321
+ created_at:
3322
+ type: string
3323
+ format: date-time
3324
+ securitySchemes:
3325
+ access_token:
3326
+ type: http
3327
+ scheme: bearer
3328
+ bearerFormat: JWT
3329
+ user_token:
3330
+ type: apiKey
3331
+ in: header
3332
+ name: x-platz-token
3333
+ tags:
3334
+ - name: Authentication
3335
+ description: |
3336
+ APIs for logging into Platz and getting information about the current user.
3337
+ - name: Deployment Permissions
3338
+ description: "APIs for setting deployment permissions per user.\n\nSee UserDeploymentRole for more information.\n "
3339
+ - name: Deployment Resource Types
3340
+ description: "Deployment resource types are custom types defined in a chart's extensions\ncontained in the `platz` directory in the deployment Helm chart.\n "
3341
+ - name: Deployment Resources
3342
+ description: ''
3343
+ - name: Deployment Tasks
3344
+ description: "Deployment tasks are all operations performed on each deployment, along with\ntheir status.\n "
3345
+ - name: Deployments
3346
+ description: |
3347
+ This collection contains deployments of Helm chart into envs.
3348
+ - name: Env User Permissions
3349
+ description: "Controls which envs each user can see.\n "
3350
+ - name: Envs
3351
+ description: "Envs contain deployments and all related settings resources for those\ndeployments, such as deployment permissions.\n "
3352
+ - name: Helm Charts
3353
+ description: "This collection contains Helm charts detected by the chart-discovery service.\n "
3354
+ - name: Helm Registries
3355
+ 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 "
3356
+ - name: Helm Tag Formats
3357
+ 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 "
3358
+ - name: Kubernetes Clusters
3359
+ description: "This collection contains Kubernetes clusters detected by Plaz.\n "
3360
+ - name: Kubernetes Resources
3361
+ description: "This collection contains Kubernetes resources of Platz deployments.\n\nKubernetes resources are automatically tracked in every namespace created by\nPlatz.\n "
3362
+ - name: Secrets
3363
+ 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 "
3364
+ - name: Server
3365
+ description: Return information about the Platz server.
3366
+ - name: User Tokens
3367
+ description: |
3368
+ User tokens allow users to authenticate using a long-lived token that can be
3369
+ used in direct API calls, CLI, etc.
3370
+
3371
+ User tokens are passed in the `x-platz-token` header.
3372
+ - name: Users
3373
+ description: This collection contains all users in Platz.
3374
+