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

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