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

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,3282 @@
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
+ - helm_chart_id
722
+ - config
723
+ properties:
724
+ id:
725
+ type: string
726
+ format: uuid
727
+ created_at:
728
+ type: string
729
+ format: date-time
730
+ name:
731
+ type: string
732
+ kind:
733
+ type: string
734
+ cluster_id:
735
+ type: string
736
+ format: uuid
737
+ enabled:
738
+ type: boolean
739
+ status:
740
+ $ref: '#/components/schemas/DeploymentStatus'
741
+ description_md:
742
+ type: string
743
+ nullable: true
744
+ reason:
745
+ type: string
746
+ nullable: true
747
+ revision_id:
748
+ type: string
749
+ format: uuid
750
+ nullable: true
751
+ reported_status:
752
+ nullable: true
753
+ helm_chart_id:
754
+ type: string
755
+ format: uuid
756
+ config: {}
757
+ values_override:
758
+ nullable: true
759
+ num_total:
760
+ type: integer
761
+ format: int64
762
+ example: '1'
763
+ security:
764
+ - access_token: []
765
+ - user_token: []
766
+ post:
767
+ tags:
768
+ - Deployments
769
+ operationId: createDeployment
770
+ requestBody:
771
+ content:
772
+ application/json:
773
+ schema:
774
+ $ref: '#/components/schemas/NewDeployment'
775
+ required: true
776
+ responses:
777
+ '201':
778
+ description: ''
779
+ content:
780
+ application/json:
781
+ schema:
782
+ $ref: '#/components/schemas/Deployment'
783
+ security:
784
+ - access_token: []
785
+ - user_token: []
786
+ /api/v2/deployments/{id}:
787
+ get:
788
+ tags:
789
+ - Deployments
790
+ operationId: getDeployment
791
+ parameters:
792
+ - name: id
793
+ in: path
794
+ required: true
795
+ schema:
796
+ type: string
797
+ format: uuid
798
+ responses:
799
+ '200':
800
+ description: ''
801
+ content:
802
+ application/json:
803
+ schema:
804
+ $ref: '#/components/schemas/Deployment'
805
+ security:
806
+ - access_token: []
807
+ - user_token: []
808
+ put:
809
+ tags:
810
+ - Deployments
811
+ operationId: updateDeployment
812
+ parameters:
813
+ - name: id
814
+ in: path
815
+ required: true
816
+ schema:
817
+ type: string
818
+ format: uuid
819
+ requestBody:
820
+ content:
821
+ application/json:
822
+ schema:
823
+ $ref: '#/components/schemas/UpdateDeployment'
824
+ required: true
825
+ responses:
826
+ '200':
827
+ description: ''
828
+ content:
829
+ application/json:
830
+ schema:
831
+ $ref: '#/components/schemas/Deployment'
832
+ security:
833
+ - access_token: []
834
+ - user_token: []
835
+ delete:
836
+ tags:
837
+ - Deployments
838
+ operationId: deleteDeployment
839
+ parameters:
840
+ - name: id
841
+ in: path
842
+ required: true
843
+ schema:
844
+ type: string
845
+ format: uuid
846
+ responses:
847
+ '204':
848
+ description: ''
849
+ security:
850
+ - access_token: []
851
+ - user_token: []
852
+ /api/v2/env-user-permissions:
853
+ get:
854
+ tags:
855
+ - Env User Permissions
856
+ operationId: allEnvUserPermissions
857
+ parameters:
858
+ - name: env_id
859
+ in: query
860
+ required: false
861
+ schema:
862
+ type: string
863
+ format: uuid
864
+ nullable: true
865
+ - name: page
866
+ in: query
867
+ required: false
868
+ schema:
869
+ type: integer
870
+ format: int64
871
+ nullable: true
872
+ - name: per_page
873
+ in: query
874
+ required: false
875
+ schema:
876
+ type: integer
877
+ format: int64
878
+ nullable: true
879
+ responses:
880
+ '200':
881
+ description: ''
882
+ content:
883
+ application/json:
884
+ schema:
885
+ type: object
886
+ required:
887
+ - page
888
+ - per_page
889
+ - items
890
+ - num_total
891
+ properties:
892
+ page:
893
+ type: integer
894
+ format: int64
895
+ example: '1'
896
+ per_page:
897
+ type: integer
898
+ format: int64
899
+ example: '50'
900
+ items:
901
+ type: array
902
+ items:
903
+ type: object
904
+ required:
905
+ - id
906
+ - created_at
907
+ - env_id
908
+ - user_id
909
+ - role
910
+ properties:
911
+ id:
912
+ type: string
913
+ format: uuid
914
+ created_at:
915
+ type: string
916
+ format: date-time
917
+ env_id:
918
+ type: string
919
+ format: uuid
920
+ user_id:
921
+ type: string
922
+ format: uuid
923
+ role:
924
+ $ref: '#/components/schemas/EnvUserRole'
925
+ num_total:
926
+ type: integer
927
+ format: int64
928
+ example: '1'
929
+ security:
930
+ - access_token: []
931
+ - user_token: []
932
+ post:
933
+ tags:
934
+ - Env User Permissions
935
+ operationId: createEnvUserPermission
936
+ requestBody:
937
+ content:
938
+ application/json:
939
+ schema:
940
+ $ref: '#/components/schemas/NewEnvUserPermission'
941
+ required: true
942
+ responses:
943
+ '201':
944
+ description: ''
945
+ content:
946
+ application/json:
947
+ schema:
948
+ $ref: '#/components/schemas/EnvUserPermission'
949
+ security:
950
+ - access_token: []
951
+ - user_token: []
952
+ /api/v2/env-user-permissions/{id}:
953
+ get:
954
+ tags:
955
+ - Env User Permissions
956
+ operationId: getEnvUserPermission
957
+ parameters:
958
+ - name: id
959
+ in: path
960
+ required: true
961
+ schema:
962
+ type: string
963
+ format: uuid
964
+ responses:
965
+ '200':
966
+ description: ''
967
+ content:
968
+ application/json:
969
+ schema:
970
+ $ref: '#/components/schemas/EnvUserPermission'
971
+ security:
972
+ - access_token: []
973
+ - user_token: []
974
+ delete:
975
+ tags:
976
+ - Env User Permissions
977
+ operationId: deleteEnvUserPermission
978
+ parameters:
979
+ - name: id
980
+ in: path
981
+ required: true
982
+ schema:
983
+ type: string
984
+ format: uuid
985
+ responses:
986
+ '204':
987
+ description: ''
988
+ security:
989
+ - access_token: []
990
+ - user_token: []
991
+ /api/v2/envs:
992
+ get:
993
+ tags:
994
+ - Envs
995
+ operationId: allEnvs
996
+ parameters:
997
+ - name: name
998
+ in: query
999
+ required: false
1000
+ schema:
1001
+ type: string
1002
+ nullable: true
1003
+ - name: auto_add_new_users
1004
+ in: query
1005
+ required: false
1006
+ schema:
1007
+ type: boolean
1008
+ nullable: true
1009
+ - name: page
1010
+ in: query
1011
+ required: false
1012
+ schema:
1013
+ type: integer
1014
+ format: int64
1015
+ nullable: true
1016
+ - name: per_page
1017
+ in: query
1018
+ required: false
1019
+ schema:
1020
+ type: integer
1021
+ format: int64
1022
+ nullable: true
1023
+ responses:
1024
+ '200':
1025
+ description: ''
1026
+ content:
1027
+ application/json:
1028
+ schema:
1029
+ type: object
1030
+ required:
1031
+ - page
1032
+ - per_page
1033
+ - items
1034
+ - num_total
1035
+ properties:
1036
+ page:
1037
+ type: integer
1038
+ format: int64
1039
+ example: '1'
1040
+ per_page:
1041
+ type: integer
1042
+ format: int64
1043
+ example: '50'
1044
+ items:
1045
+ type: array
1046
+ items:
1047
+ type: object
1048
+ required:
1049
+ - id
1050
+ - created_at
1051
+ - name
1052
+ - node_selector
1053
+ - tolerations
1054
+ - auto_add_new_users
1055
+ properties:
1056
+ id:
1057
+ type: string
1058
+ format: uuid
1059
+ created_at:
1060
+ type: string
1061
+ format: date-time
1062
+ name:
1063
+ type: string
1064
+ node_selector: {}
1065
+ tolerations: {}
1066
+ auto_add_new_users:
1067
+ type: boolean
1068
+ num_total:
1069
+ type: integer
1070
+ format: int64
1071
+ example: '1'
1072
+ security:
1073
+ - access_token: []
1074
+ - user_token: []
1075
+ post:
1076
+ tags:
1077
+ - Envs
1078
+ operationId: createEnv
1079
+ requestBody:
1080
+ content:
1081
+ application/json:
1082
+ schema:
1083
+ $ref: '#/components/schemas/NewEnv'
1084
+ required: true
1085
+ responses:
1086
+ '201':
1087
+ description: ''
1088
+ content:
1089
+ application/json:
1090
+ schema:
1091
+ $ref: '#/components/schemas/Env'
1092
+ security:
1093
+ - access_token: []
1094
+ - user_token: []
1095
+ /api/v2/envs/{id}:
1096
+ get:
1097
+ tags:
1098
+ - Envs
1099
+ operationId: getEnv
1100
+ parameters:
1101
+ - name: id
1102
+ in: path
1103
+ required: true
1104
+ schema:
1105
+ type: string
1106
+ format: uuid
1107
+ responses:
1108
+ '200':
1109
+ description: ''
1110
+ content:
1111
+ application/json:
1112
+ schema:
1113
+ $ref: '#/components/schemas/Env'
1114
+ security:
1115
+ - access_token: []
1116
+ - user_token: []
1117
+ put:
1118
+ tags:
1119
+ - Envs
1120
+ operationId: updateEnv
1121
+ parameters:
1122
+ - name: id
1123
+ in: path
1124
+ required: true
1125
+ schema:
1126
+ type: string
1127
+ format: uuid
1128
+ requestBody:
1129
+ content:
1130
+ application/json:
1131
+ schema:
1132
+ $ref: '#/components/schemas/UpdateEnv'
1133
+ required: true
1134
+ responses:
1135
+ '200':
1136
+ description: ''
1137
+ content:
1138
+ application/json:
1139
+ schema:
1140
+ $ref: '#/components/schemas/Env'
1141
+ security:
1142
+ - access_token: []
1143
+ - user_token: []
1144
+ /api/v2/helm-charts:
1145
+ get:
1146
+ tags:
1147
+ - Helm Charts
1148
+ operationId: allHelmCharts
1149
+ parameters:
1150
+ - name: helm_registry_id
1151
+ in: query
1152
+ required: false
1153
+ schema:
1154
+ type: string
1155
+ format: uuid
1156
+ nullable: true
1157
+ - name: parsed_branch
1158
+ in: query
1159
+ required: false
1160
+ schema:
1161
+ type: string
1162
+ nullable: true
1163
+ - name: page
1164
+ in: query
1165
+ required: false
1166
+ schema:
1167
+ type: integer
1168
+ format: int64
1169
+ nullable: true
1170
+ - name: per_page
1171
+ in: query
1172
+ required: false
1173
+ schema:
1174
+ type: integer
1175
+ format: int64
1176
+ nullable: true
1177
+ responses:
1178
+ '200':
1179
+ description: ''
1180
+ content:
1181
+ application/json:
1182
+ schema:
1183
+ type: object
1184
+ required:
1185
+ - page
1186
+ - per_page
1187
+ - items
1188
+ - num_total
1189
+ properties:
1190
+ page:
1191
+ type: integer
1192
+ format: int64
1193
+ example: '1'
1194
+ per_page:
1195
+ type: integer
1196
+ format: int64
1197
+ example: '50'
1198
+ items:
1199
+ type: array
1200
+ items:
1201
+ type: object
1202
+ required:
1203
+ - id
1204
+ - created_at
1205
+ - helm_registry_id
1206
+ - image_digest
1207
+ - image_tag
1208
+ - available
1209
+ properties:
1210
+ id:
1211
+ type: string
1212
+ format: uuid
1213
+ created_at:
1214
+ type: string
1215
+ format: date-time
1216
+ helm_registry_id:
1217
+ type: string
1218
+ format: uuid
1219
+ image_digest:
1220
+ type: string
1221
+ image_tag:
1222
+ type: string
1223
+ available:
1224
+ type: boolean
1225
+ values_ui:
1226
+ nullable: true
1227
+ actions_schema:
1228
+ nullable: true
1229
+ features:
1230
+ nullable: true
1231
+ resource_types:
1232
+ nullable: true
1233
+ error:
1234
+ type: string
1235
+ nullable: true
1236
+ tag_format_id:
1237
+ type: string
1238
+ format: uuid
1239
+ nullable: true
1240
+ parsed_version:
1241
+ type: string
1242
+ nullable: true
1243
+ parsed_revision:
1244
+ type: string
1245
+ nullable: true
1246
+ parsed_branch:
1247
+ type: string
1248
+ nullable: true
1249
+ parsed_commit:
1250
+ type: string
1251
+ nullable: true
1252
+ num_total:
1253
+ type: integer
1254
+ format: int64
1255
+ example: '1'
1256
+ security:
1257
+ - access_token: []
1258
+ - user_token: []
1259
+ /api/v2/helm-charts/{id}:
1260
+ get:
1261
+ tags:
1262
+ - Helm Charts
1263
+ operationId: getHelmChart
1264
+ parameters:
1265
+ - name: id
1266
+ in: path
1267
+ required: true
1268
+ schema:
1269
+ type: string
1270
+ format: uuid
1271
+ responses:
1272
+ '200':
1273
+ description: ''
1274
+ content:
1275
+ application/json:
1276
+ schema:
1277
+ $ref: '#/components/schemas/HelmChart'
1278
+ security:
1279
+ - access_token: []
1280
+ - user_token: []
1281
+ /api/v2/helm-registries:
1282
+ get:
1283
+ tags:
1284
+ - Helm Registries
1285
+ operationId: allHelmRegistries
1286
+ parameters:
1287
+ - name: repo_name
1288
+ in: query
1289
+ required: false
1290
+ schema:
1291
+ type: string
1292
+ nullable: true
1293
+ - name: kind
1294
+ in: query
1295
+ required: false
1296
+ schema:
1297
+ type: string
1298
+ nullable: true
1299
+ - name: page
1300
+ in: query
1301
+ required: false
1302
+ schema:
1303
+ type: integer
1304
+ format: int64
1305
+ nullable: true
1306
+ - name: per_page
1307
+ in: query
1308
+ required: false
1309
+ schema:
1310
+ type: integer
1311
+ format: int64
1312
+ nullable: true
1313
+ responses:
1314
+ '200':
1315
+ description: ''
1316
+ content:
1317
+ application/json:
1318
+ schema:
1319
+ type: object
1320
+ required:
1321
+ - page
1322
+ - per_page
1323
+ - items
1324
+ - num_total
1325
+ properties:
1326
+ page:
1327
+ type: integer
1328
+ format: int64
1329
+ example: '1'
1330
+ per_page:
1331
+ type: integer
1332
+ format: int64
1333
+ example: '50'
1334
+ items:
1335
+ type: array
1336
+ items:
1337
+ type: object
1338
+ required:
1339
+ - id
1340
+ - created_at
1341
+ - domain_name
1342
+ - repo_name
1343
+ - kind
1344
+ - available
1345
+ - fa_icon
1346
+ properties:
1347
+ id:
1348
+ type: string
1349
+ format: uuid
1350
+ created_at:
1351
+ type: string
1352
+ format: date-time
1353
+ domain_name:
1354
+ type: string
1355
+ repo_name:
1356
+ type: string
1357
+ kind:
1358
+ type: string
1359
+ available:
1360
+ type: boolean
1361
+ fa_icon:
1362
+ type: string
1363
+ num_total:
1364
+ type: integer
1365
+ format: int64
1366
+ example: '1'
1367
+ security:
1368
+ - access_token: []
1369
+ - user_token: []
1370
+ /api/v2/helm-registries/{id}:
1371
+ get:
1372
+ tags:
1373
+ - Helm Registries
1374
+ operationId: getHelmRegistry
1375
+ parameters:
1376
+ - name: id
1377
+ in: path
1378
+ required: true
1379
+ schema:
1380
+ type: string
1381
+ format: uuid
1382
+ responses:
1383
+ '200':
1384
+ description: ''
1385
+ content:
1386
+ application/json:
1387
+ schema:
1388
+ $ref: '#/components/schemas/HelmRegistry'
1389
+ security:
1390
+ - access_token: []
1391
+ - user_token: []
1392
+ put:
1393
+ tags:
1394
+ - Helm Registries
1395
+ operationId: updateHelmRegistry
1396
+ parameters:
1397
+ - name: id
1398
+ in: path
1399
+ required: true
1400
+ schema:
1401
+ type: string
1402
+ format: uuid
1403
+ requestBody:
1404
+ content:
1405
+ application/json:
1406
+ schema:
1407
+ $ref: '#/components/schemas/UpdateHelmRegistry'
1408
+ required: true
1409
+ responses:
1410
+ '200':
1411
+ description: ''
1412
+ content:
1413
+ application/json:
1414
+ schema:
1415
+ $ref: '#/components/schemas/HelmRegistry'
1416
+ security:
1417
+ - access_token: []
1418
+ - user_token: []
1419
+ /api/v2/helm-tag-formats:
1420
+ get:
1421
+ tags:
1422
+ - Helm Tag Formats
1423
+ operationId: allHelmTagFormats
1424
+ parameters:
1425
+ - name: pattern
1426
+ in: query
1427
+ required: false
1428
+ schema:
1429
+ type: string
1430
+ nullable: true
1431
+ - name: page
1432
+ in: query
1433
+ required: false
1434
+ schema:
1435
+ type: integer
1436
+ format: int64
1437
+ nullable: true
1438
+ - name: per_page
1439
+ in: query
1440
+ required: false
1441
+ schema:
1442
+ type: integer
1443
+ format: int64
1444
+ nullable: true
1445
+ responses:
1446
+ '200':
1447
+ description: ''
1448
+ content:
1449
+ application/json:
1450
+ schema:
1451
+ type: object
1452
+ required:
1453
+ - page
1454
+ - per_page
1455
+ - items
1456
+ - num_total
1457
+ properties:
1458
+ page:
1459
+ type: integer
1460
+ format: int64
1461
+ example: '1'
1462
+ per_page:
1463
+ type: integer
1464
+ format: int64
1465
+ example: '50'
1466
+ items:
1467
+ type: array
1468
+ items:
1469
+ type: object
1470
+ required:
1471
+ - id
1472
+ - created_at
1473
+ - pattern
1474
+ properties:
1475
+ id:
1476
+ type: string
1477
+ format: uuid
1478
+ created_at:
1479
+ type: string
1480
+ format: date-time
1481
+ pattern:
1482
+ type: string
1483
+ num_total:
1484
+ type: integer
1485
+ format: int64
1486
+ example: '1'
1487
+ security:
1488
+ - access_token: []
1489
+ - user_token: []
1490
+ post:
1491
+ tags:
1492
+ - Helm Tag Formats
1493
+ operationId: createHelmTagFormat
1494
+ requestBody:
1495
+ content:
1496
+ application/json:
1497
+ schema:
1498
+ $ref: '#/components/schemas/NewHelmTagFormat'
1499
+ required: true
1500
+ responses:
1501
+ '201':
1502
+ description: ''
1503
+ content:
1504
+ application/json:
1505
+ schema:
1506
+ $ref: '#/components/schemas/HelmTagFormat'
1507
+ security:
1508
+ - access_token: []
1509
+ - user_token: []
1510
+ /api/v2/helm-tag-formats/{id}:
1511
+ get:
1512
+ tags:
1513
+ - Helm Tag Formats
1514
+ operationId: getHelmTagFormat
1515
+ parameters:
1516
+ - name: id
1517
+ in: path
1518
+ required: true
1519
+ schema:
1520
+ type: string
1521
+ format: uuid
1522
+ responses:
1523
+ '200':
1524
+ description: ''
1525
+ content:
1526
+ application/json:
1527
+ schema:
1528
+ $ref: '#/components/schemas/HelmTagFormat'
1529
+ security:
1530
+ - access_token: []
1531
+ - user_token: []
1532
+ delete:
1533
+ tags:
1534
+ - Helm Tag Formats
1535
+ operationId: deleteHelmTagFormat
1536
+ parameters:
1537
+ - name: id
1538
+ in: path
1539
+ required: true
1540
+ schema:
1541
+ type: string
1542
+ format: uuid
1543
+ responses:
1544
+ '204':
1545
+ description: ''
1546
+ security:
1547
+ - access_token: []
1548
+ - user_token: []
1549
+ /api/v2/k8s-clusters:
1550
+ get:
1551
+ tags:
1552
+ - Kubernetes Clusters
1553
+ operationId: allK8sClusters
1554
+ parameters:
1555
+ - name: name
1556
+ in: query
1557
+ required: false
1558
+ schema:
1559
+ type: string
1560
+ nullable: true
1561
+ - name: page
1562
+ in: query
1563
+ required: false
1564
+ schema:
1565
+ type: integer
1566
+ format: int64
1567
+ nullable: true
1568
+ - name: per_page
1569
+ in: query
1570
+ required: false
1571
+ schema:
1572
+ type: integer
1573
+ format: int64
1574
+ nullable: true
1575
+ responses:
1576
+ '200':
1577
+ description: ''
1578
+ content:
1579
+ application/json:
1580
+ schema:
1581
+ type: object
1582
+ required:
1583
+ - page
1584
+ - per_page
1585
+ - items
1586
+ - num_total
1587
+ properties:
1588
+ page:
1589
+ type: integer
1590
+ format: int64
1591
+ example: '1'
1592
+ per_page:
1593
+ type: integer
1594
+ format: int64
1595
+ example: '50'
1596
+ items:
1597
+ type: array
1598
+ items:
1599
+ type: object
1600
+ required:
1601
+ - id
1602
+ - provider_id
1603
+ - created_at
1604
+ - last_seen_at
1605
+ - name
1606
+ - region_name
1607
+ - is_ok
1608
+ - ignore
1609
+ properties:
1610
+ id:
1611
+ type: string
1612
+ format: uuid
1613
+ env_id:
1614
+ type: string
1615
+ format: uuid
1616
+ nullable: true
1617
+ provider_id:
1618
+ type: string
1619
+ created_at:
1620
+ type: string
1621
+ format: date-time
1622
+ last_seen_at:
1623
+ type: string
1624
+ format: date-time
1625
+ name:
1626
+ type: string
1627
+ region_name:
1628
+ type: string
1629
+ is_ok:
1630
+ type: boolean
1631
+ not_ok_reason:
1632
+ type: string
1633
+ nullable: true
1634
+ ignore:
1635
+ type: boolean
1636
+ ingress_domain:
1637
+ type: string
1638
+ nullable: true
1639
+ ingress_class:
1640
+ type: string
1641
+ nullable: true
1642
+ ingress_tls_secret_name:
1643
+ type: string
1644
+ nullable: true
1645
+ grafana_url:
1646
+ type: string
1647
+ nullable: true
1648
+ grafana_datasource_name:
1649
+ type: string
1650
+ nullable: true
1651
+ num_total:
1652
+ type: integer
1653
+ format: int64
1654
+ example: '1'
1655
+ security:
1656
+ - access_token: []
1657
+ - user_token: []
1658
+ /api/v2/k8s-clusters/{id}:
1659
+ get:
1660
+ tags:
1661
+ - Kubernetes Clusters
1662
+ operationId: getK8sCluster
1663
+ parameters:
1664
+ - name: id
1665
+ in: path
1666
+ required: true
1667
+ schema:
1668
+ type: string
1669
+ format: uuid
1670
+ responses:
1671
+ '200':
1672
+ description: ''
1673
+ content:
1674
+ application/json:
1675
+ schema:
1676
+ $ref: '#/components/schemas/K8sCluster'
1677
+ security:
1678
+ - access_token: []
1679
+ - user_token: []
1680
+ put:
1681
+ tags:
1682
+ - Kubernetes Clusters
1683
+ operationId: updateK8sCluster
1684
+ parameters:
1685
+ - name: id
1686
+ in: path
1687
+ required: true
1688
+ schema:
1689
+ type: string
1690
+ format: uuid
1691
+ requestBody:
1692
+ content:
1693
+ application/json:
1694
+ schema:
1695
+ $ref: '#/components/schemas/UpdateK8sCluster'
1696
+ required: true
1697
+ responses:
1698
+ '200':
1699
+ description: ''
1700
+ content:
1701
+ application/json:
1702
+ schema:
1703
+ $ref: '#/components/schemas/K8sCluster'
1704
+ security:
1705
+ - access_token: []
1706
+ - user_token: []
1707
+ delete:
1708
+ tags:
1709
+ - Kubernetes Clusters
1710
+ operationId: deleteK8sCluster
1711
+ parameters:
1712
+ - name: id
1713
+ in: path
1714
+ required: true
1715
+ schema:
1716
+ type: string
1717
+ format: uuid
1718
+ responses:
1719
+ '204':
1720
+ description: ''
1721
+ security:
1722
+ - access_token: []
1723
+ - user_token: []
1724
+ /api/v2/k8s-resources:
1725
+ get:
1726
+ tags:
1727
+ - Kubernetes Resources
1728
+ operationId: allK8sResources
1729
+ parameters:
1730
+ - name: cluster_id
1731
+ in: query
1732
+ required: false
1733
+ schema:
1734
+ type: string
1735
+ format: uuid
1736
+ nullable: true
1737
+ - name: deployment_id
1738
+ in: query
1739
+ required: false
1740
+ schema:
1741
+ type: string
1742
+ format: uuid
1743
+ nullable: true
1744
+ - name: kind
1745
+ in: query
1746
+ required: false
1747
+ schema:
1748
+ type: string
1749
+ nullable: true
1750
+ - name: name
1751
+ in: query
1752
+ required: false
1753
+ schema:
1754
+ type: string
1755
+ nullable: true
1756
+ - name: page
1757
+ in: query
1758
+ required: false
1759
+ schema:
1760
+ type: integer
1761
+ format: int64
1762
+ nullable: true
1763
+ - name: per_page
1764
+ in: query
1765
+ required: false
1766
+ schema:
1767
+ type: integer
1768
+ format: int64
1769
+ nullable: true
1770
+ responses:
1771
+ '200':
1772
+ description: ''
1773
+ content:
1774
+ application/json:
1775
+ schema:
1776
+ type: object
1777
+ required:
1778
+ - page
1779
+ - per_page
1780
+ - items
1781
+ - num_total
1782
+ properties:
1783
+ page:
1784
+ type: integer
1785
+ format: int64
1786
+ example: '1'
1787
+ per_page:
1788
+ type: integer
1789
+ format: int64
1790
+ example: '50'
1791
+ items:
1792
+ type: array
1793
+ items:
1794
+ type: object
1795
+ required:
1796
+ - id
1797
+ - last_updated_at
1798
+ - cluster_id
1799
+ - deployment_id
1800
+ - kind
1801
+ - api_version
1802
+ - name
1803
+ - status_color
1804
+ - metadata
1805
+ properties:
1806
+ id:
1807
+ type: string
1808
+ format: uuid
1809
+ last_updated_at:
1810
+ type: string
1811
+ format: date-time
1812
+ cluster_id:
1813
+ type: string
1814
+ format: uuid
1815
+ deployment_id:
1816
+ type: string
1817
+ format: uuid
1818
+ kind:
1819
+ type: string
1820
+ api_version:
1821
+ type: string
1822
+ name:
1823
+ type: string
1824
+ status_color:
1825
+ type: array
1826
+ items:
1827
+ type: string
1828
+ metadata: {}
1829
+ num_total:
1830
+ type: integer
1831
+ format: int64
1832
+ example: '1'
1833
+ security:
1834
+ - access_token: []
1835
+ - user_token: []
1836
+ /api/v2/k8s-resources/{id}:
1837
+ get:
1838
+ tags:
1839
+ - Kubernetes Resources
1840
+ operationId: getK8sResource
1841
+ parameters:
1842
+ - name: id
1843
+ in: path
1844
+ required: true
1845
+ schema:
1846
+ type: string
1847
+ format: uuid
1848
+ responses:
1849
+ '200':
1850
+ description: ''
1851
+ content:
1852
+ application/json:
1853
+ schema:
1854
+ $ref: '#/components/schemas/K8sResource'
1855
+ security:
1856
+ - access_token: []
1857
+ - user_token: []
1858
+ /api/v2/secrets:
1859
+ get:
1860
+ tags:
1861
+ - Secrets
1862
+ operationId: allSecrets
1863
+ parameters:
1864
+ - name: env_id
1865
+ in: query
1866
+ required: false
1867
+ schema:
1868
+ type: string
1869
+ format: uuid
1870
+ nullable: true
1871
+ - name: collection
1872
+ in: query
1873
+ required: false
1874
+ schema:
1875
+ type: string
1876
+ nullable: true
1877
+ - name: name
1878
+ in: query
1879
+ required: false
1880
+ schema:
1881
+ type: string
1882
+ nullable: true
1883
+ - name: page
1884
+ in: query
1885
+ required: false
1886
+ schema:
1887
+ type: integer
1888
+ format: int64
1889
+ nullable: true
1890
+ - name: per_page
1891
+ in: query
1892
+ required: false
1893
+ schema:
1894
+ type: integer
1895
+ format: int64
1896
+ nullable: true
1897
+ responses:
1898
+ '200':
1899
+ description: ''
1900
+ content:
1901
+ application/json:
1902
+ schema:
1903
+ type: object
1904
+ required:
1905
+ - page
1906
+ - per_page
1907
+ - items
1908
+ - num_total
1909
+ properties:
1910
+ page:
1911
+ type: integer
1912
+ format: int64
1913
+ example: '1'
1914
+ per_page:
1915
+ type: integer
1916
+ format: int64
1917
+ example: '50'
1918
+ items:
1919
+ type: array
1920
+ items:
1921
+ type: object
1922
+ required:
1923
+ - id
1924
+ - created_at
1925
+ - updated_at
1926
+ - env_id
1927
+ - collection
1928
+ - name
1929
+ properties:
1930
+ id:
1931
+ type: string
1932
+ format: uuid
1933
+ created_at:
1934
+ type: string
1935
+ format: date-time
1936
+ updated_at:
1937
+ type: string
1938
+ format: date-time
1939
+ env_id:
1940
+ type: string
1941
+ format: uuid
1942
+ collection:
1943
+ type: string
1944
+ name:
1945
+ type: string
1946
+ num_total:
1947
+ type: integer
1948
+ format: int64
1949
+ example: '1'
1950
+ security:
1951
+ - access_token: []
1952
+ - user_token: []
1953
+ post:
1954
+ tags:
1955
+ - Secrets
1956
+ operationId: createSecret
1957
+ requestBody:
1958
+ content:
1959
+ application/json:
1960
+ schema:
1961
+ $ref: '#/components/schemas/NewSecret'
1962
+ required: true
1963
+ responses:
1964
+ '201':
1965
+ description: ''
1966
+ content:
1967
+ application/json:
1968
+ schema:
1969
+ $ref: '#/components/schemas/Secret'
1970
+ security:
1971
+ - access_token: []
1972
+ - user_token: []
1973
+ /api/v2/secrets/{id}:
1974
+ get:
1975
+ tags:
1976
+ - Secrets
1977
+ operationId: getSecret
1978
+ parameters:
1979
+ - name: id
1980
+ in: path
1981
+ required: true
1982
+ schema:
1983
+ type: string
1984
+ format: uuid
1985
+ responses:
1986
+ '200':
1987
+ description: ''
1988
+ content:
1989
+ application/json:
1990
+ schema:
1991
+ $ref: '#/components/schemas/Secret'
1992
+ security:
1993
+ - access_token: []
1994
+ - user_token: []
1995
+ put:
1996
+ tags:
1997
+ - Secrets
1998
+ operationId: updateSecret
1999
+ parameters:
2000
+ - name: id
2001
+ in: path
2002
+ required: true
2003
+ schema:
2004
+ type: string
2005
+ format: uuid
2006
+ requestBody:
2007
+ content:
2008
+ application/json:
2009
+ schema:
2010
+ $ref: '#/components/schemas/UpdateSecretApi'
2011
+ required: true
2012
+ responses:
2013
+ '200':
2014
+ description: ''
2015
+ content:
2016
+ application/json:
2017
+ schema:
2018
+ $ref: '#/components/schemas/Secret'
2019
+ security:
2020
+ - access_token: []
2021
+ - user_token: []
2022
+ delete:
2023
+ tags:
2024
+ - Secrets
2025
+ operationId: deleteSecret
2026
+ parameters:
2027
+ - name: id
2028
+ in: path
2029
+ required: true
2030
+ schema:
2031
+ type: string
2032
+ format: uuid
2033
+ responses:
2034
+ '204':
2035
+ description: ''
2036
+ security:
2037
+ - access_token: []
2038
+ - user_token: []
2039
+ /api/v2/server:
2040
+ get:
2041
+ tags:
2042
+ - Server
2043
+ operationId: getServerInfo
2044
+ responses:
2045
+ '200':
2046
+ description: ''
2047
+ content:
2048
+ application/json:
2049
+ schema:
2050
+ $ref: '#/components/schemas/ServerInfo'
2051
+ security:
2052
+ - access_token: []
2053
+ - user_token: []
2054
+ /api/v2/user-tokens:
2055
+ get:
2056
+ tags:
2057
+ - User Tokens
2058
+ operationId: allUserTokens
2059
+ parameters:
2060
+ - name: user_id
2061
+ in: query
2062
+ required: false
2063
+ schema:
2064
+ type: string
2065
+ format: uuid
2066
+ nullable: true
2067
+ - name: page
2068
+ in: query
2069
+ required: false
2070
+ schema:
2071
+ type: integer
2072
+ format: int64
2073
+ nullable: true
2074
+ - name: per_page
2075
+ in: query
2076
+ required: false
2077
+ schema:
2078
+ type: integer
2079
+ format: int64
2080
+ nullable: true
2081
+ responses:
2082
+ '200':
2083
+ description: ''
2084
+ content:
2085
+ application/json:
2086
+ schema:
2087
+ type: object
2088
+ required:
2089
+ - page
2090
+ - per_page
2091
+ - items
2092
+ - num_total
2093
+ properties:
2094
+ page:
2095
+ type: integer
2096
+ format: int64
2097
+ example: '1'
2098
+ per_page:
2099
+ type: integer
2100
+ format: int64
2101
+ example: '50'
2102
+ items:
2103
+ type: array
2104
+ items:
2105
+ type: object
2106
+ required:
2107
+ - id
2108
+ - user_id
2109
+ - created_at
2110
+ properties:
2111
+ id:
2112
+ type: string
2113
+ format: uuid
2114
+ user_id:
2115
+ type: string
2116
+ format: uuid
2117
+ created_at:
2118
+ type: string
2119
+ format: date-time
2120
+ num_total:
2121
+ type: integer
2122
+ format: int64
2123
+ example: '1'
2124
+ security:
2125
+ - access_token: []
2126
+ - user_token: []
2127
+ post:
2128
+ tags:
2129
+ - User Tokens
2130
+ operationId: createUserToken
2131
+ requestBody:
2132
+ content:
2133
+ application/json:
2134
+ schema:
2135
+ $ref: '#/components/schemas/CreateUserToken'
2136
+ required: true
2137
+ responses:
2138
+ '201':
2139
+ description: ''
2140
+ content:
2141
+ application/json:
2142
+ schema:
2143
+ $ref: '#/components/schemas/UserToken'
2144
+ security:
2145
+ - access_token: []
2146
+ - user_token: []
2147
+ /api/v2/user-tokens/{id}:
2148
+ get:
2149
+ tags:
2150
+ - User Tokens
2151
+ operationId: getUserToken
2152
+ parameters:
2153
+ - name: id
2154
+ in: path
2155
+ required: true
2156
+ schema:
2157
+ type: string
2158
+ format: uuid
2159
+ responses:
2160
+ '200':
2161
+ description: ''
2162
+ content:
2163
+ application/json:
2164
+ schema:
2165
+ $ref: '#/components/schemas/UserToken'
2166
+ security:
2167
+ - access_token: []
2168
+ - user_token: []
2169
+ delete:
2170
+ tags:
2171
+ - User Tokens
2172
+ operationId: deleteUserToken
2173
+ parameters:
2174
+ - name: id
2175
+ in: path
2176
+ required: true
2177
+ schema:
2178
+ type: string
2179
+ format: uuid
2180
+ responses:
2181
+ '204':
2182
+ description: ''
2183
+ security:
2184
+ - access_token: []
2185
+ - user_token: []
2186
+ /api/v2/users:
2187
+ get:
2188
+ tags:
2189
+ - Users
2190
+ operationId: allUsers
2191
+ parameters:
2192
+ - name: display_name
2193
+ in: query
2194
+ required: false
2195
+ schema:
2196
+ type: string
2197
+ nullable: true
2198
+ - name: email
2199
+ in: query
2200
+ required: false
2201
+ schema:
2202
+ type: string
2203
+ nullable: true
2204
+ - name: page
2205
+ in: query
2206
+ required: false
2207
+ schema:
2208
+ type: integer
2209
+ format: int64
2210
+ nullable: true
2211
+ - name: per_page
2212
+ in: query
2213
+ required: false
2214
+ schema:
2215
+ type: integer
2216
+ format: int64
2217
+ nullable: true
2218
+ responses:
2219
+ '200':
2220
+ description: ''
2221
+ content:
2222
+ application/json:
2223
+ schema:
2224
+ type: object
2225
+ required:
2226
+ - page
2227
+ - per_page
2228
+ - items
2229
+ - num_total
2230
+ properties:
2231
+ page:
2232
+ type: integer
2233
+ format: int64
2234
+ example: '1'
2235
+ per_page:
2236
+ type: integer
2237
+ format: int64
2238
+ example: '50'
2239
+ items:
2240
+ type: array
2241
+ items:
2242
+ type: object
2243
+ required:
2244
+ - id
2245
+ - created_at
2246
+ - display_name
2247
+ - email
2248
+ - is_admin
2249
+ properties:
2250
+ id:
2251
+ type: string
2252
+ format: uuid
2253
+ created_at:
2254
+ type: string
2255
+ format: date-time
2256
+ display_name:
2257
+ type: string
2258
+ email:
2259
+ type: string
2260
+ is_admin:
2261
+ type: boolean
2262
+ num_total:
2263
+ type: integer
2264
+ format: int64
2265
+ example: '1'
2266
+ security:
2267
+ - access_token: []
2268
+ - user_token: []
2269
+ /api/v2/users/{id}:
2270
+ get:
2271
+ tags:
2272
+ - Users
2273
+ operationId: getUser
2274
+ parameters:
2275
+ - name: id
2276
+ in: path
2277
+ required: true
2278
+ schema:
2279
+ type: string
2280
+ format: uuid
2281
+ responses:
2282
+ '200':
2283
+ description: ''
2284
+ content:
2285
+ application/json:
2286
+ schema:
2287
+ $ref: '#/components/schemas/User'
2288
+ security:
2289
+ - access_token: []
2290
+ - user_token: []
2291
+ put:
2292
+ tags:
2293
+ - Users
2294
+ operationId: updateUser
2295
+ parameters:
2296
+ - name: id
2297
+ in: path
2298
+ required: true
2299
+ schema:
2300
+ type: string
2301
+ format: uuid
2302
+ requestBody:
2303
+ content:
2304
+ application/json:
2305
+ schema:
2306
+ $ref: '#/components/schemas/UpdateUser'
2307
+ required: true
2308
+ responses:
2309
+ '200':
2310
+ description: ''
2311
+ content:
2312
+ application/json:
2313
+ schema:
2314
+ $ref: '#/components/schemas/User'
2315
+ security:
2316
+ - access_token: []
2317
+ - user_token: []
2318
+ components:
2319
+ schemas:
2320
+ CreateDeploymentTask:
2321
+ type: object
2322
+ required:
2323
+ - deployment_id
2324
+ - operation
2325
+ properties:
2326
+ deployment_id:
2327
+ type: string
2328
+ format: uuid
2329
+ operation:
2330
+ $ref: '#/components/schemas/DeploymentTaskOperation'
2331
+ CreateUserToken:
2332
+ type: object
2333
+ properties:
2334
+ user_id:
2335
+ type: string
2336
+ format: uuid
2337
+ nullable: true
2338
+ Deployment:
2339
+ type: object
2340
+ required:
2341
+ - id
2342
+ - created_at
2343
+ - name
2344
+ - kind
2345
+ - cluster_id
2346
+ - enabled
2347
+ - status
2348
+ - helm_chart_id
2349
+ - config
2350
+ properties:
2351
+ id:
2352
+ type: string
2353
+ format: uuid
2354
+ created_at:
2355
+ type: string
2356
+ format: date-time
2357
+ name:
2358
+ type: string
2359
+ kind:
2360
+ type: string
2361
+ cluster_id:
2362
+ type: string
2363
+ format: uuid
2364
+ enabled:
2365
+ type: boolean
2366
+ status:
2367
+ $ref: '#/components/schemas/DeploymentStatus'
2368
+ description_md:
2369
+ type: string
2370
+ nullable: true
2371
+ reason:
2372
+ type: string
2373
+ nullable: true
2374
+ revision_id:
2375
+ type: string
2376
+ format: uuid
2377
+ nullable: true
2378
+ reported_status:
2379
+ nullable: true
2380
+ helm_chart_id:
2381
+ type: string
2382
+ format: uuid
2383
+ config: {}
2384
+ values_override:
2385
+ nullable: true
2386
+ DeploymentInstallTask:
2387
+ type: object
2388
+ required:
2389
+ - helm_chart_id
2390
+ - config_inputs
2391
+ properties:
2392
+ helm_chart_id:
2393
+ type: string
2394
+ format: uuid
2395
+ config_inputs: {}
2396
+ values_override:
2397
+ nullable: true
2398
+ DeploymentInvokeActionTask:
2399
+ type: object
2400
+ required:
2401
+ - helm_chart_id
2402
+ - action_id
2403
+ - body
2404
+ properties:
2405
+ helm_chart_id:
2406
+ type: string
2407
+ format: uuid
2408
+ action_id:
2409
+ type: string
2410
+ body: {}
2411
+ DeploymentPermission:
2412
+ type: object
2413
+ required:
2414
+ - id
2415
+ - created_at
2416
+ - env_id
2417
+ - user_id
2418
+ - kind
2419
+ - role
2420
+ properties:
2421
+ id:
2422
+ type: string
2423
+ format: uuid
2424
+ created_at:
2425
+ type: string
2426
+ format: date-time
2427
+ env_id:
2428
+ type: string
2429
+ format: uuid
2430
+ user_id:
2431
+ type: string
2432
+ format: uuid
2433
+ kind:
2434
+ type: string
2435
+ role:
2436
+ $ref: '#/components/schemas/UserDeploymentRole'
2437
+ DeploymentRecreaseTask:
2438
+ type: object
2439
+ required:
2440
+ - old_cluster_id
2441
+ - old_namespace
2442
+ - new_cluster_id
2443
+ - new_namespace
2444
+ properties:
2445
+ old_cluster_id:
2446
+ type: string
2447
+ format: uuid
2448
+ old_namespace:
2449
+ type: string
2450
+ new_cluster_id:
2451
+ type: string
2452
+ format: uuid
2453
+ new_namespace:
2454
+ type: string
2455
+ DeploymentReinstallTask:
2456
+ type: object
2457
+ required:
2458
+ - reason
2459
+ properties:
2460
+ reason:
2461
+ type: string
2462
+ DeploymentResource:
2463
+ type: object
2464
+ required:
2465
+ - id
2466
+ - created_at
2467
+ - type_id
2468
+ - name
2469
+ - exists
2470
+ - props
2471
+ - sync_status
2472
+ properties:
2473
+ id:
2474
+ type: string
2475
+ format: uuid
2476
+ created_at:
2477
+ type: string
2478
+ format: date-time
2479
+ type_id:
2480
+ type: string
2481
+ format: uuid
2482
+ deployment_id:
2483
+ type: string
2484
+ format: uuid
2485
+ nullable: true
2486
+ name:
2487
+ type: string
2488
+ exists:
2489
+ type: boolean
2490
+ props: {}
2491
+ sync_status:
2492
+ $ref: '#/components/schemas/DeploymentResourceSyncStatus'
2493
+ sync_reason:
2494
+ type: string
2495
+ nullable: true
2496
+ DeploymentResourceSyncStatus:
2497
+ type: string
2498
+ enum:
2499
+ - Creating
2500
+ - Updating
2501
+ - Deleting
2502
+ - Ready
2503
+ - Error
2504
+ DeploymentResourceType:
2505
+ type: object
2506
+ required:
2507
+ - id
2508
+ - created_at
2509
+ - deployment_kind
2510
+ - key
2511
+ - spec
2512
+ properties:
2513
+ id:
2514
+ type: string
2515
+ format: uuid
2516
+ created_at:
2517
+ type: string
2518
+ format: date-time
2519
+ env_id:
2520
+ type: string
2521
+ format: uuid
2522
+ nullable: true
2523
+ deployment_kind:
2524
+ type: string
2525
+ key:
2526
+ type: string
2527
+ spec: {}
2528
+ DeploymentRestartK8sResourceTask:
2529
+ type: object
2530
+ required:
2531
+ - resource_id
2532
+ - resource_name
2533
+ properties:
2534
+ resource_id:
2535
+ type: string
2536
+ format: uuid
2537
+ resource_name:
2538
+ type: string
2539
+ DeploymentStatus:
2540
+ type: string
2541
+ enum:
2542
+ - Unknown
2543
+ - Installing
2544
+ - Renaming
2545
+ - Upgrading
2546
+ - Running
2547
+ - Error
2548
+ - Uninstalling
2549
+ - Uninstalled
2550
+ - Deleting
2551
+ DeploymentTask:
2552
+ type: object
2553
+ required:
2554
+ - id
2555
+ - created_at
2556
+ - cluster_id
2557
+ - deployment_id
2558
+ - operation
2559
+ - status
2560
+ properties:
2561
+ id:
2562
+ type: string
2563
+ format: uuid
2564
+ created_at:
2565
+ type: string
2566
+ format: date-time
2567
+ first_attempted_at:
2568
+ type: string
2569
+ format: date-time
2570
+ nullable: true
2571
+ started_at:
2572
+ type: string
2573
+ format: date-time
2574
+ nullable: true
2575
+ finished_at:
2576
+ type: string
2577
+ format: date-time
2578
+ nullable: true
2579
+ cluster_id:
2580
+ type: string
2581
+ format: uuid
2582
+ deployment_id:
2583
+ type: string
2584
+ format: uuid
2585
+ acting_user_id:
2586
+ type: string
2587
+ format: uuid
2588
+ nullable: true
2589
+ acting_deployment_id:
2590
+ type: string
2591
+ format: uuid
2592
+ nullable: true
2593
+ operation:
2594
+ $ref: '#/components/schemas/DeploymentTaskOperation'
2595
+ status:
2596
+ $ref: '#/components/schemas/DeploymentTaskStatus'
2597
+ reason:
2598
+ type: string
2599
+ nullable: true
2600
+ DeploymentTaskOperation:
2601
+ oneOf:
2602
+ - type: object
2603
+ required:
2604
+ - Install
2605
+ properties:
2606
+ Install:
2607
+ $ref: '#/components/schemas/DeploymentInstallTask'
2608
+ - type: object
2609
+ required:
2610
+ - Upgrade
2611
+ properties:
2612
+ Upgrade:
2613
+ $ref: '#/components/schemas/DeploymentUpgradeTask'
2614
+ - type: object
2615
+ required:
2616
+ - Reinstall
2617
+ properties:
2618
+ Reinstall:
2619
+ $ref: '#/components/schemas/DeploymentReinstallTask'
2620
+ - type: object
2621
+ required:
2622
+ - Recreate
2623
+ properties:
2624
+ Recreate:
2625
+ $ref: '#/components/schemas/DeploymentRecreaseTask'
2626
+ - type: object
2627
+ required:
2628
+ - Uninstall
2629
+ properties:
2630
+ Uninstall:
2631
+ $ref: '#/components/schemas/DeploymentUninstallTask'
2632
+ - type: object
2633
+ required:
2634
+ - InvokeAction
2635
+ properties:
2636
+ InvokeAction:
2637
+ $ref: '#/components/schemas/DeploymentInvokeActionTask'
2638
+ - type: object
2639
+ required:
2640
+ - RestartK8sResource
2641
+ properties:
2642
+ RestartK8sResource:
2643
+ $ref: '#/components/schemas/DeploymentRestartK8sResourceTask'
2644
+ DeploymentTaskStatus:
2645
+ type: string
2646
+ enum:
2647
+ - Pending
2648
+ - Started
2649
+ - Failed
2650
+ - Done
2651
+ DeploymentUninstallTask:
2652
+ type: object
2653
+ DeploymentUpgradeTask:
2654
+ type: object
2655
+ required:
2656
+ - helm_chart_id
2657
+ - config_inputs
2658
+ - config_delta
2659
+ properties:
2660
+ helm_chart_id:
2661
+ type: string
2662
+ format: uuid
2663
+ prev_helm_chart_id:
2664
+ type: string
2665
+ format: uuid
2666
+ nullable: true
2667
+ config_inputs: {}
2668
+ config_delta:
2669
+ type: object
2670
+ values_override:
2671
+ nullable: true
2672
+ Env:
2673
+ type: object
2674
+ required:
2675
+ - id
2676
+ - created_at
2677
+ - name
2678
+ - node_selector
2679
+ - tolerations
2680
+ - auto_add_new_users
2681
+ properties:
2682
+ id:
2683
+ type: string
2684
+ format: uuid
2685
+ created_at:
2686
+ type: string
2687
+ format: date-time
2688
+ name:
2689
+ type: string
2690
+ node_selector: {}
2691
+ tolerations: {}
2692
+ auto_add_new_users:
2693
+ type: boolean
2694
+ EnvUserPermission:
2695
+ type: object
2696
+ required:
2697
+ - id
2698
+ - created_at
2699
+ - env_id
2700
+ - user_id
2701
+ - role
2702
+ properties:
2703
+ id:
2704
+ type: string
2705
+ format: uuid
2706
+ created_at:
2707
+ type: string
2708
+ format: date-time
2709
+ env_id:
2710
+ type: string
2711
+ format: uuid
2712
+ user_id:
2713
+ type: string
2714
+ format: uuid
2715
+ role:
2716
+ $ref: '#/components/schemas/EnvUserRole'
2717
+ EnvUserRole:
2718
+ type: string
2719
+ enum:
2720
+ - Admin
2721
+ - User
2722
+ FinishGoogleLoginResponse:
2723
+ type: object
2724
+ required:
2725
+ - access_token
2726
+ properties:
2727
+ access_token:
2728
+ type: string
2729
+ HelmChart:
2730
+ type: object
2731
+ required:
2732
+ - id
2733
+ - created_at
2734
+ - helm_registry_id
2735
+ - image_digest
2736
+ - image_tag
2737
+ - available
2738
+ properties:
2739
+ id:
2740
+ type: string
2741
+ format: uuid
2742
+ created_at:
2743
+ type: string
2744
+ format: date-time
2745
+ helm_registry_id:
2746
+ type: string
2747
+ format: uuid
2748
+ image_digest:
2749
+ type: string
2750
+ image_tag:
2751
+ type: string
2752
+ available:
2753
+ type: boolean
2754
+ values_ui:
2755
+ nullable: true
2756
+ actions_schema:
2757
+ nullable: true
2758
+ features:
2759
+ nullable: true
2760
+ resource_types:
2761
+ nullable: true
2762
+ error:
2763
+ type: string
2764
+ nullable: true
2765
+ tag_format_id:
2766
+ type: string
2767
+ format: uuid
2768
+ nullable: true
2769
+ parsed_version:
2770
+ type: string
2771
+ nullable: true
2772
+ parsed_revision:
2773
+ type: string
2774
+ nullable: true
2775
+ parsed_branch:
2776
+ type: string
2777
+ nullable: true
2778
+ parsed_commit:
2779
+ type: string
2780
+ nullable: true
2781
+ HelmRegistry:
2782
+ type: object
2783
+ required:
2784
+ - id
2785
+ - created_at
2786
+ - domain_name
2787
+ - repo_name
2788
+ - kind
2789
+ - available
2790
+ - fa_icon
2791
+ properties:
2792
+ id:
2793
+ type: string
2794
+ format: uuid
2795
+ created_at:
2796
+ type: string
2797
+ format: date-time
2798
+ domain_name:
2799
+ type: string
2800
+ repo_name:
2801
+ type: string
2802
+ kind:
2803
+ type: string
2804
+ available:
2805
+ type: boolean
2806
+ fa_icon:
2807
+ type: string
2808
+ HelmTagFormat:
2809
+ type: object
2810
+ required:
2811
+ - id
2812
+ - created_at
2813
+ - pattern
2814
+ properties:
2815
+ id:
2816
+ type: string
2817
+ format: uuid
2818
+ created_at:
2819
+ type: string
2820
+ format: date-time
2821
+ pattern:
2822
+ type: string
2823
+ K8sCluster:
2824
+ type: object
2825
+ required:
2826
+ - id
2827
+ - provider_id
2828
+ - created_at
2829
+ - last_seen_at
2830
+ - name
2831
+ - region_name
2832
+ - is_ok
2833
+ - ignore
2834
+ properties:
2835
+ id:
2836
+ type: string
2837
+ format: uuid
2838
+ env_id:
2839
+ type: string
2840
+ format: uuid
2841
+ nullable: true
2842
+ provider_id:
2843
+ type: string
2844
+ created_at:
2845
+ type: string
2846
+ format: date-time
2847
+ last_seen_at:
2848
+ type: string
2849
+ format: date-time
2850
+ name:
2851
+ type: string
2852
+ region_name:
2853
+ type: string
2854
+ is_ok:
2855
+ type: boolean
2856
+ not_ok_reason:
2857
+ type: string
2858
+ nullable: true
2859
+ ignore:
2860
+ type: boolean
2861
+ ingress_domain:
2862
+ type: string
2863
+ nullable: true
2864
+ ingress_class:
2865
+ type: string
2866
+ nullable: true
2867
+ ingress_tls_secret_name:
2868
+ type: string
2869
+ nullable: true
2870
+ grafana_url:
2871
+ type: string
2872
+ nullable: true
2873
+ grafana_datasource_name:
2874
+ type: string
2875
+ nullable: true
2876
+ K8sResource:
2877
+ type: object
2878
+ required:
2879
+ - id
2880
+ - last_updated_at
2881
+ - cluster_id
2882
+ - deployment_id
2883
+ - kind
2884
+ - api_version
2885
+ - name
2886
+ - status_color
2887
+ - metadata
2888
+ properties:
2889
+ id:
2890
+ type: string
2891
+ format: uuid
2892
+ last_updated_at:
2893
+ type: string
2894
+ format: date-time
2895
+ cluster_id:
2896
+ type: string
2897
+ format: uuid
2898
+ deployment_id:
2899
+ type: string
2900
+ format: uuid
2901
+ kind:
2902
+ type: string
2903
+ api_version:
2904
+ type: string
2905
+ name:
2906
+ type: string
2907
+ status_color:
2908
+ type: array
2909
+ items:
2910
+ type: string
2911
+ metadata: {}
2912
+ MeResponse:
2913
+ oneOf:
2914
+ - type: object
2915
+ required:
2916
+ - User
2917
+ properties:
2918
+ User:
2919
+ $ref: '#/components/schemas/User'
2920
+ - type: object
2921
+ required:
2922
+ - Deployment
2923
+ properties:
2924
+ Deployment:
2925
+ type: object
2926
+ required:
2927
+ - id
2928
+ - name
2929
+ properties:
2930
+ id:
2931
+ type: string
2932
+ format: uuid
2933
+ name:
2934
+ type: string
2935
+ NewDeployment:
2936
+ type: object
2937
+ required:
2938
+ - kind
2939
+ - cluster_id
2940
+ - helm_chart_id
2941
+ properties:
2942
+ name:
2943
+ type: string
2944
+ kind:
2945
+ type: string
2946
+ cluster_id:
2947
+ type: string
2948
+ format: uuid
2949
+ helm_chart_id:
2950
+ type: string
2951
+ format: uuid
2952
+ config:
2953
+ nullable: true
2954
+ values_override:
2955
+ nullable: true
2956
+ NewDeploymentPermission:
2957
+ type: object
2958
+ required:
2959
+ - env_id
2960
+ - user_id
2961
+ - kind
2962
+ - role
2963
+ properties:
2964
+ env_id:
2965
+ type: string
2966
+ format: uuid
2967
+ user_id:
2968
+ type: string
2969
+ format: uuid
2970
+ kind:
2971
+ type: string
2972
+ role:
2973
+ $ref: '#/components/schemas/UserDeploymentRole'
2974
+ NewDeploymentResource:
2975
+ type: object
2976
+ required:
2977
+ - type_id
2978
+ - deployment_id
2979
+ - name
2980
+ - props
2981
+ properties:
2982
+ id:
2983
+ type: string
2984
+ format: uuid
2985
+ nullable: true
2986
+ created_at:
2987
+ type: string
2988
+ format: date-time
2989
+ nullable: true
2990
+ type_id:
2991
+ type: string
2992
+ format: uuid
2993
+ deployment_id:
2994
+ type: string
2995
+ format: uuid
2996
+ name:
2997
+ type: string
2998
+ props: {}
2999
+ sync_status:
3000
+ allOf:
3001
+ - $ref: '#/components/schemas/DeploymentResourceSyncStatus'
3002
+ nullable: true
3003
+ NewEnv:
3004
+ type: object
3005
+ required:
3006
+ - name
3007
+ properties:
3008
+ name:
3009
+ type: string
3010
+ auto_add_new_users:
3011
+ type: boolean
3012
+ nullable: true
3013
+ NewEnvUserPermission:
3014
+ type: object
3015
+ required:
3016
+ - env_id
3017
+ - user_id
3018
+ - role
3019
+ properties:
3020
+ env_id:
3021
+ type: string
3022
+ format: uuid
3023
+ user_id:
3024
+ type: string
3025
+ format: uuid
3026
+ role:
3027
+ $ref: '#/components/schemas/EnvUserRole'
3028
+ NewHelmTagFormat:
3029
+ type: object
3030
+ required:
3031
+ - pattern
3032
+ properties:
3033
+ pattern:
3034
+ type: string
3035
+ NewSecret:
3036
+ type: object
3037
+ required:
3038
+ - env_id
3039
+ - collection
3040
+ - name
3041
+ - contents
3042
+ properties:
3043
+ env_id:
3044
+ type: string
3045
+ format: uuid
3046
+ collection:
3047
+ type: string
3048
+ name:
3049
+ type: string
3050
+ contents:
3051
+ type: string
3052
+ OAuth2Response:
3053
+ type: object
3054
+ required:
3055
+ - auth_code
3056
+ properties:
3057
+ auth_code:
3058
+ type: string
3059
+ Secret:
3060
+ type: object
3061
+ required:
3062
+ - id
3063
+ - created_at
3064
+ - updated_at
3065
+ - env_id
3066
+ - collection
3067
+ - name
3068
+ properties:
3069
+ id:
3070
+ type: string
3071
+ format: uuid
3072
+ created_at:
3073
+ type: string
3074
+ format: date-time
3075
+ updated_at:
3076
+ type: string
3077
+ format: date-time
3078
+ env_id:
3079
+ type: string
3080
+ format: uuid
3081
+ collection:
3082
+ type: string
3083
+ name:
3084
+ type: string
3085
+ ServerInfo:
3086
+ type: object
3087
+ required:
3088
+ - version
3089
+ properties:
3090
+ version:
3091
+ type: string
3092
+ StartGoogleLoginResponse:
3093
+ type: object
3094
+ required:
3095
+ - redirect_url
3096
+ properties:
3097
+ redirect_url:
3098
+ type: string
3099
+ UpdateDeployment:
3100
+ type: object
3101
+ properties:
3102
+ name:
3103
+ type: string
3104
+ nullable: true
3105
+ cluster_id:
3106
+ type: string
3107
+ format: uuid
3108
+ nullable: true
3109
+ helm_chart_id:
3110
+ type: string
3111
+ format: uuid
3112
+ nullable: true
3113
+ config:
3114
+ nullable: true
3115
+ values_override:
3116
+ nullable: true
3117
+ enabled:
3118
+ type: boolean
3119
+ nullable: true
3120
+ description_md:
3121
+ type: string
3122
+ nullable: true
3123
+ UpdateDeploymentResource:
3124
+ type: object
3125
+ properties:
3126
+ name:
3127
+ type: string
3128
+ nullable: true
3129
+ props:
3130
+ nullable: true
3131
+ UpdateEnv:
3132
+ type: object
3133
+ properties:
3134
+ name:
3135
+ type: string
3136
+ nullable: true
3137
+ node_selector:
3138
+ nullable: true
3139
+ tolerations:
3140
+ nullable: true
3141
+ auto_add_new_users:
3142
+ type: boolean
3143
+ nullable: true
3144
+ UpdateHelmRegistry:
3145
+ type: object
3146
+ properties:
3147
+ fa_icon:
3148
+ type: string
3149
+ nullable: true
3150
+ UpdateK8sCluster:
3151
+ type: object
3152
+ properties:
3153
+ env_id:
3154
+ type: string
3155
+ format: uuid
3156
+ nullable: true
3157
+ ignore:
3158
+ type: boolean
3159
+ nullable: true
3160
+ ingress_domain:
3161
+ type: string
3162
+ nullable: true
3163
+ ingress_class:
3164
+ type: string
3165
+ nullable: true
3166
+ ingress_tls_secret_name:
3167
+ type: string
3168
+ nullable: true
3169
+ grafana_url:
3170
+ type: string
3171
+ nullable: true
3172
+ grafana_datasource_name:
3173
+ type: string
3174
+ nullable: true
3175
+ UpdateSecretApi:
3176
+ type: object
3177
+ properties:
3178
+ name:
3179
+ type: string
3180
+ nullable: true
3181
+ contents:
3182
+ type: string
3183
+ nullable: true
3184
+ UpdateUser:
3185
+ type: object
3186
+ properties:
3187
+ is_admin:
3188
+ type: boolean
3189
+ nullable: true
3190
+ User:
3191
+ type: object
3192
+ required:
3193
+ - id
3194
+ - created_at
3195
+ - display_name
3196
+ - email
3197
+ - is_admin
3198
+ properties:
3199
+ id:
3200
+ type: string
3201
+ format: uuid
3202
+ created_at:
3203
+ type: string
3204
+ format: date-time
3205
+ display_name:
3206
+ type: string
3207
+ email:
3208
+ type: string
3209
+ is_admin:
3210
+ type: boolean
3211
+ UserDeploymentRole:
3212
+ type: string
3213
+ enum:
3214
+ - Owner
3215
+ - Maintainer
3216
+ UserToken:
3217
+ type: object
3218
+ required:
3219
+ - id
3220
+ - user_id
3221
+ - created_at
3222
+ properties:
3223
+ id:
3224
+ type: string
3225
+ format: uuid
3226
+ user_id:
3227
+ type: string
3228
+ format: uuid
3229
+ created_at:
3230
+ type: string
3231
+ format: date-time
3232
+ securitySchemes:
3233
+ access_token:
3234
+ type: http
3235
+ scheme: bearer
3236
+ bearerFormat: JWT
3237
+ user_token:
3238
+ type: apiKey
3239
+ in: header
3240
+ name: x-platz-token
3241
+ tags:
3242
+ - name: Authentication
3243
+ description: |
3244
+ APIs for logging into Platz and getting information about the current user.
3245
+ - name: Deployment Permissions
3246
+ description: "APIs for setting deployment permissions per user.\n\nSee UserDeploymentRole for more information.\n "
3247
+ - name: Deployment Resource Types
3248
+ description: "Deployment resource types are custom types defined in a chart's extensions\ncontained in the `platz` directory in the deployment Helm chart.\n "
3249
+ - name: Deployment Resources
3250
+ description: ''
3251
+ - name: Deployment Tasks
3252
+ description: "Deployment tasks are all operations performed on each deployment, along with\ntheir status.\n "
3253
+ - name: Deployments
3254
+ description: |
3255
+ This collection contains deployments of Helm chart into envs.
3256
+ - name: Env User Permissions
3257
+ description: "Controls which envs each user can see.\n "
3258
+ - name: Envs
3259
+ description: "Envs contain deployments and all related settings resources for those\ndeployments, such as deployment permissions.\n "
3260
+ - name: Helm Charts
3261
+ description: "This collection contains Helm charts detected by the chart-discovery service.\n "
3262
+ - name: Helm Registries
3263
+ 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 "
3264
+ - name: Helm Tag Formats
3265
+ 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 "
3266
+ - name: Kubernetes Clusters
3267
+ description: "This collection contains Kubernetes clusters detected by Plaz.\n "
3268
+ - name: Kubernetes Resources
3269
+ description: "This collection contains Kubernetes resources of Platz deployments.\n\nKubernetes resources are automatically tracked in every namespace created by\nPlatz.\n "
3270
+ - name: Secrets
3271
+ 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 "
3272
+ - name: Server
3273
+ description: Return information about the Platz server.
3274
+ - name: User Tokens
3275
+ description: |
3276
+ User tokens allow users to authenticate using a long-lived token that can be
3277
+ used in direct API calls, CLI, etc.
3278
+
3279
+ User tokens are passed in the `x-platz-token` header.
3280
+ - name: Users
3281
+ description: This collection contains all users in Platz.
3282
+