@cloudfleet/sdk 0.0.1-6244af0 → 0.0.1-62b9986
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/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +420 -386
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +428 -382
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +455 -97
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +649 -172
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +237 -215
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +338 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1056 -712
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1681 -1470
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +494 -330
- package/dist/zod.gen.js.map +1 -1
- package/package.json +8 -11
package/dist/schemas.gen.js
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
export const BillingContactSchema = {
|
|
3
3
|
type: 'object',
|
|
4
4
|
properties: {
|
|
5
|
+
type: {
|
|
6
|
+
type: 'string',
|
|
7
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
8
|
+
example: 'business',
|
|
9
|
+
enum: [
|
|
10
|
+
'business',
|
|
11
|
+
'personal'
|
|
12
|
+
]
|
|
13
|
+
},
|
|
5
14
|
company: {
|
|
6
15
|
type: 'string',
|
|
7
16
|
maxLength: 120,
|
|
@@ -207,6 +216,7 @@ export const BillingContactSchema = {
|
|
|
207
216
|
}
|
|
208
217
|
},
|
|
209
218
|
required: [
|
|
219
|
+
'type',
|
|
210
220
|
'email',
|
|
211
221
|
'individual_name'
|
|
212
222
|
],
|
|
@@ -358,24 +368,8 @@ export const ChartSchema = {
|
|
|
358
368
|
},
|
|
359
369
|
status: {
|
|
360
370
|
type: 'string',
|
|
361
|
-
description: 'Status of the chart deployment.',
|
|
362
|
-
example: '
|
|
363
|
-
enum: [
|
|
364
|
-
'InstallSucceeded',
|
|
365
|
-
'InstallFailed',
|
|
366
|
-
'UpgradeSucceeded',
|
|
367
|
-
'UpgradeFailed',
|
|
368
|
-
'TestSucceeded',
|
|
369
|
-
'TestFailed',
|
|
370
|
-
'RollbackSucceeded',
|
|
371
|
-
'RollbackFailed',
|
|
372
|
-
'UninstallSucceeded',
|
|
373
|
-
'UninstallFailed',
|
|
374
|
-
'ArtifactFailed',
|
|
375
|
-
'DependencyNotReady',
|
|
376
|
-
'Progressing',
|
|
377
|
-
'SourceNotReady'
|
|
378
|
-
]
|
|
371
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
372
|
+
example: 'InstallSucceeded'
|
|
379
373
|
},
|
|
380
374
|
version_current: {
|
|
381
375
|
type: 'string',
|
|
@@ -446,22 +440,12 @@ export const ClusterCreateInputSchema = {
|
|
|
446
440
|
tier: {
|
|
447
441
|
type: 'string',
|
|
448
442
|
description: 'Tier of the cluster.',
|
|
443
|
+
default: 'basic',
|
|
449
444
|
example: 'pro',
|
|
450
445
|
enum: [
|
|
451
446
|
'basic',
|
|
452
|
-
'pro'
|
|
453
|
-
|
|
454
|
-
},
|
|
455
|
-
region: {
|
|
456
|
-
type: 'string',
|
|
457
|
-
description: 'Cloudfleet control plane region. One of "staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a". This field can not be updated after creation.',
|
|
458
|
-
default: 'staging-1a',
|
|
459
|
-
example: 'northamerica-central-1a',
|
|
460
|
-
enum: [
|
|
461
|
-
'staging-1a',
|
|
462
|
-
'northamerica-central-1',
|
|
463
|
-
'europe-central-1a',
|
|
464
|
-
'northamerica-central-1a'
|
|
447
|
+
'pro',
|
|
448
|
+
'enterprise'
|
|
465
449
|
]
|
|
466
450
|
},
|
|
467
451
|
version_channel: {
|
|
@@ -469,20 +453,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
453
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
470
454
|
description: 'Version of the kubernetes cluster.',
|
|
471
455
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
456
|
+
example: '1.x.x-cfke.x'
|
|
457
|
+
},
|
|
458
|
+
release_channel: {
|
|
459
|
+
type: 'string',
|
|
460
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
461
|
+
default: 'rapid',
|
|
462
|
+
example: 'rapid',
|
|
473
463
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
464
|
+
'rapid',
|
|
465
|
+
'stable',
|
|
466
|
+
'extended'
|
|
478
467
|
]
|
|
468
|
+
},
|
|
469
|
+
features: {
|
|
470
|
+
type: 'object',
|
|
471
|
+
properties: {
|
|
472
|
+
gpu_sharing_strategy: {
|
|
473
|
+
type: 'string',
|
|
474
|
+
description: 'GPU sharing strategy.',
|
|
475
|
+
default: 'none',
|
|
476
|
+
example: 'none',
|
|
477
|
+
enum: [
|
|
478
|
+
'none',
|
|
479
|
+
'mps',
|
|
480
|
+
'time_slicing'
|
|
481
|
+
]
|
|
482
|
+
},
|
|
483
|
+
gpu_max_shared_clients_per_gpu: {
|
|
484
|
+
type: 'integer',
|
|
485
|
+
minimum: 2,
|
|
486
|
+
maximum: 48,
|
|
487
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
488
|
+
default: 4,
|
|
489
|
+
example: 10
|
|
490
|
+
},
|
|
491
|
+
cilium_socket_lb_host_namespace_only: {
|
|
492
|
+
type: 'boolean',
|
|
493
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
494
|
+
example: false
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
additionalProperties: false,
|
|
498
|
+
description: 'Cluster feature toggles.',
|
|
499
|
+
default: {
|
|
500
|
+
gpu_sharing_strategy: 'none',
|
|
501
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
502
|
+
cilium_socket_lb_host_namespace_only: false
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
region: {
|
|
506
|
+
type: 'string',
|
|
507
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
508
|
+
example: 'europe-central-1a'
|
|
509
|
+
},
|
|
510
|
+
networking: {
|
|
511
|
+
type: 'object',
|
|
512
|
+
properties: {
|
|
513
|
+
pod_cidr: {
|
|
514
|
+
type: 'string',
|
|
515
|
+
description: 'CIDR block for pod IPs.',
|
|
516
|
+
default: '10.244.0.0/16'
|
|
517
|
+
},
|
|
518
|
+
service_cidr: {
|
|
519
|
+
type: 'string',
|
|
520
|
+
description: 'CIDR block for service IPs.',
|
|
521
|
+
default: '10.96.0.0/12'
|
|
522
|
+
},
|
|
523
|
+
dual_stack: {
|
|
524
|
+
type: 'boolean',
|
|
525
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
526
|
+
},
|
|
527
|
+
pod_cidr_v6: {
|
|
528
|
+
type: 'string',
|
|
529
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
530
|
+
default: '2001:db8:1:2::/48'
|
|
531
|
+
},
|
|
532
|
+
service_cidr_v6: {
|
|
533
|
+
type: 'string',
|
|
534
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
535
|
+
default: '2001:db8:1:1::/112'
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
additionalProperties: false,
|
|
539
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
540
|
+
default: {
|
|
541
|
+
pod_cidr: '10.244.0.0/16',
|
|
542
|
+
service_cidr: '10.96.0.0/12',
|
|
543
|
+
dual_stack: false,
|
|
544
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
545
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
546
|
+
}
|
|
479
547
|
}
|
|
480
548
|
},
|
|
481
549
|
required: [
|
|
482
550
|
'name',
|
|
483
|
-
'
|
|
551
|
+
'region'
|
|
484
552
|
],
|
|
485
|
-
additionalProperties: false
|
|
553
|
+
additionalProperties: false,
|
|
554
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
555
|
};
|
|
487
556
|
export const ClusterJoinInformationSchema = {
|
|
488
557
|
type: 'object',
|
|
@@ -503,6 +572,11 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
572
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
573
|
example: '10.96.0.10'
|
|
505
574
|
},
|
|
575
|
+
pod_cidr: {
|
|
576
|
+
type: 'string',
|
|
577
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
578
|
+
example: '10.244.0.0/16'
|
|
579
|
+
},
|
|
506
580
|
auth_key: {
|
|
507
581
|
type: 'string',
|
|
508
582
|
description: 'Authentication key for the cluster.',
|
|
@@ -578,6 +652,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
652
|
'certificate_authority',
|
|
579
653
|
'endpoint',
|
|
580
654
|
'cluster_dns',
|
|
655
|
+
'pod_cidr',
|
|
581
656
|
'auth_key',
|
|
582
657
|
'bootstrap_token',
|
|
583
658
|
'versions',
|
|
@@ -599,24 +674,123 @@ export const ClusterSchema = {
|
|
|
599
674
|
tier: {
|
|
600
675
|
type: 'string',
|
|
601
676
|
description: 'Tier of the cluster.',
|
|
677
|
+
default: 'basic',
|
|
602
678
|
example: 'pro',
|
|
603
679
|
enum: [
|
|
604
680
|
'basic',
|
|
605
|
-
'pro'
|
|
681
|
+
'pro',
|
|
682
|
+
'enterprise'
|
|
606
683
|
]
|
|
607
684
|
},
|
|
608
|
-
|
|
685
|
+
version_channel: {
|
|
686
|
+
type: 'string',
|
|
687
|
+
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
688
|
+
description: 'Version of the kubernetes cluster.',
|
|
689
|
+
default: '1.x.x-cfke.x',
|
|
690
|
+
example: '1.x.x-cfke.x'
|
|
691
|
+
},
|
|
692
|
+
release_channel: {
|
|
609
693
|
type: 'string',
|
|
610
|
-
description: '
|
|
611
|
-
default: '
|
|
612
|
-
example: '
|
|
694
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
695
|
+
default: 'rapid',
|
|
696
|
+
example: 'rapid',
|
|
613
697
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
698
|
+
'rapid',
|
|
699
|
+
'stable',
|
|
700
|
+
'extended'
|
|
618
701
|
]
|
|
619
702
|
},
|
|
703
|
+
features: {
|
|
704
|
+
type: 'object',
|
|
705
|
+
properties: {
|
|
706
|
+
gpu_sharing_strategy: {
|
|
707
|
+
type: 'string',
|
|
708
|
+
description: 'GPU sharing strategy.',
|
|
709
|
+
default: 'none',
|
|
710
|
+
example: 'none',
|
|
711
|
+
enum: [
|
|
712
|
+
'none',
|
|
713
|
+
'mps',
|
|
714
|
+
'time_slicing'
|
|
715
|
+
]
|
|
716
|
+
},
|
|
717
|
+
gpu_max_shared_clients_per_gpu: {
|
|
718
|
+
type: 'integer',
|
|
719
|
+
minimum: 2,
|
|
720
|
+
maximum: 48,
|
|
721
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
722
|
+
default: 4,
|
|
723
|
+
example: 10
|
|
724
|
+
},
|
|
725
|
+
cilium_socket_lb_host_namespace_only: {
|
|
726
|
+
type: 'boolean',
|
|
727
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
728
|
+
example: false
|
|
729
|
+
}
|
|
730
|
+
},
|
|
731
|
+
required: [
|
|
732
|
+
'gpu_sharing_strategy',
|
|
733
|
+
'gpu_max_shared_clients_per_gpu',
|
|
734
|
+
'cilium_socket_lb_host_namespace_only'
|
|
735
|
+
],
|
|
736
|
+
additionalProperties: false,
|
|
737
|
+
description: 'Cluster feature toggles.',
|
|
738
|
+
default: {
|
|
739
|
+
gpu_sharing_strategy: 'none',
|
|
740
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
741
|
+
cilium_socket_lb_host_namespace_only: false
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
region: {
|
|
745
|
+
type: 'string',
|
|
746
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
747
|
+
example: 'europe-central-1a'
|
|
748
|
+
},
|
|
749
|
+
networking: {
|
|
750
|
+
type: 'object',
|
|
751
|
+
properties: {
|
|
752
|
+
pod_cidr: {
|
|
753
|
+
type: 'string',
|
|
754
|
+
description: 'CIDR block for pod IPs.',
|
|
755
|
+
default: '10.244.0.0/16'
|
|
756
|
+
},
|
|
757
|
+
service_cidr: {
|
|
758
|
+
type: 'string',
|
|
759
|
+
description: 'CIDR block for service IPs.',
|
|
760
|
+
default: '10.96.0.0/12'
|
|
761
|
+
},
|
|
762
|
+
dual_stack: {
|
|
763
|
+
type: 'boolean',
|
|
764
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
765
|
+
},
|
|
766
|
+
pod_cidr_v6: {
|
|
767
|
+
type: 'string',
|
|
768
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
769
|
+
default: '2001:db8:1:2::/48'
|
|
770
|
+
},
|
|
771
|
+
service_cidr_v6: {
|
|
772
|
+
type: 'string',
|
|
773
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
774
|
+
default: '2001:db8:1:1::/112'
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
required: [
|
|
778
|
+
'pod_cidr',
|
|
779
|
+
'service_cidr',
|
|
780
|
+
'dual_stack',
|
|
781
|
+
'pod_cidr_v6',
|
|
782
|
+
'service_cidr_v6'
|
|
783
|
+
],
|
|
784
|
+
additionalProperties: false,
|
|
785
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
786
|
+
default: {
|
|
787
|
+
pod_cidr: '10.244.0.0/16',
|
|
788
|
+
service_cidr: '10.96.0.0/12',
|
|
789
|
+
dual_stack: false,
|
|
790
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
791
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
792
|
+
}
|
|
793
|
+
},
|
|
620
794
|
id: {
|
|
621
795
|
type: 'string',
|
|
622
796
|
format: 'uuid',
|
|
@@ -625,16 +799,13 @@ export const ClusterSchema = {
|
|
|
625
799
|
},
|
|
626
800
|
status: {
|
|
627
801
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
802
|
+
description: 'Status of the cluster.',
|
|
803
|
+
example: 'deployed',
|
|
630
804
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
805
|
'creating',
|
|
635
806
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
807
|
+
'updating',
|
|
808
|
+
'disabled'
|
|
638
809
|
]
|
|
639
810
|
},
|
|
640
811
|
endpoint: {
|
|
@@ -642,8 +813,8 @@ export const ClusterSchema = {
|
|
|
642
813
|
{
|
|
643
814
|
type: 'string',
|
|
644
815
|
format: 'uri',
|
|
645
|
-
description: 'URL signed by
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
816
|
+
description: 'URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
817
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
818
|
},
|
|
648
819
|
{
|
|
649
820
|
type: 'string',
|
|
@@ -658,7 +829,7 @@ export const ClusterSchema = {
|
|
|
658
829
|
{
|
|
659
830
|
type: 'string',
|
|
660
831
|
format: 'uri',
|
|
661
|
-
description: '
|
|
832
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
662
833
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
834
|
},
|
|
664
835
|
{
|
|
@@ -693,21 +864,22 @@ export const ClusterSchema = {
|
|
|
693
864
|
type: 'boolean',
|
|
694
865
|
description: 'Indicates if the cluster is ready to be used.',
|
|
695
866
|
example: true
|
|
696
|
-
},
|
|
697
|
-
version_channel: {
|
|
698
|
-
type: 'string',
|
|
699
|
-
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
700
|
-
description: 'Version of the kubernetes cluster.',
|
|
701
|
-
example: '1.x.x-cfke.x'
|
|
702
867
|
}
|
|
703
868
|
},
|
|
704
869
|
required: [
|
|
705
870
|
'name',
|
|
706
871
|
'tier',
|
|
872
|
+
'version_channel',
|
|
873
|
+
'release_channel',
|
|
874
|
+
'features',
|
|
875
|
+
'region',
|
|
876
|
+
'networking',
|
|
707
877
|
'id',
|
|
708
|
-
'status'
|
|
878
|
+
'status',
|
|
879
|
+
'ready'
|
|
709
880
|
],
|
|
710
|
-
additionalProperties: false
|
|
881
|
+
additionalProperties: false,
|
|
882
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
711
883
|
};
|
|
712
884
|
export const ClusterUpdateInputSchema = {
|
|
713
885
|
type: 'object',
|
|
@@ -723,23 +895,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
723
895
|
tier: {
|
|
724
896
|
type: 'string',
|
|
725
897
|
description: 'Tier of the cluster.',
|
|
898
|
+
default: 'basic',
|
|
726
899
|
example: 'pro',
|
|
727
900
|
enum: [
|
|
728
901
|
'basic',
|
|
729
|
-
'pro'
|
|
902
|
+
'pro',
|
|
903
|
+
'enterprise'
|
|
730
904
|
]
|
|
731
905
|
},
|
|
732
906
|
version_channel: {
|
|
733
907
|
type: 'string',
|
|
734
908
|
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
735
909
|
description: 'Version of the kubernetes cluster.',
|
|
910
|
+
default: '1.x.x-cfke.x',
|
|
736
911
|
example: '1.x.x-cfke.x'
|
|
912
|
+
},
|
|
913
|
+
release_channel: {
|
|
914
|
+
type: 'string',
|
|
915
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
916
|
+
default: 'rapid',
|
|
917
|
+
example: 'rapid',
|
|
918
|
+
enum: [
|
|
919
|
+
'rapid',
|
|
920
|
+
'stable',
|
|
921
|
+
'extended'
|
|
922
|
+
]
|
|
923
|
+
},
|
|
924
|
+
features: {
|
|
925
|
+
type: 'object',
|
|
926
|
+
properties: {
|
|
927
|
+
gpu_sharing_strategy: {
|
|
928
|
+
type: 'string',
|
|
929
|
+
description: 'GPU sharing strategy.',
|
|
930
|
+
default: 'none',
|
|
931
|
+
example: 'none',
|
|
932
|
+
enum: [
|
|
933
|
+
'none',
|
|
934
|
+
'mps',
|
|
935
|
+
'time_slicing'
|
|
936
|
+
]
|
|
937
|
+
},
|
|
938
|
+
gpu_max_shared_clients_per_gpu: {
|
|
939
|
+
type: 'integer',
|
|
940
|
+
minimum: 2,
|
|
941
|
+
maximum: 48,
|
|
942
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
943
|
+
default: 4,
|
|
944
|
+
example: 10
|
|
945
|
+
},
|
|
946
|
+
cilium_socket_lb_host_namespace_only: {
|
|
947
|
+
type: 'boolean',
|
|
948
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
949
|
+
example: false
|
|
950
|
+
}
|
|
951
|
+
},
|
|
952
|
+
additionalProperties: false,
|
|
953
|
+
description: 'Cluster feature toggles.',
|
|
954
|
+
default: {
|
|
955
|
+
gpu_sharing_strategy: 'none',
|
|
956
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
957
|
+
cilium_socket_lb_host_namespace_only: false
|
|
958
|
+
}
|
|
737
959
|
}
|
|
738
960
|
},
|
|
739
961
|
required: [
|
|
740
|
-
'
|
|
962
|
+
'name'
|
|
741
963
|
],
|
|
742
|
-
additionalProperties: false
|
|
964
|
+
additionalProperties: false,
|
|
965
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
743
966
|
};
|
|
744
967
|
export const FleetCreateInputSchema = {
|
|
745
968
|
type: 'object',
|
|
@@ -761,8 +984,7 @@ export const FleetCreateInputSchema = {
|
|
|
761
984
|
type: 'object',
|
|
762
985
|
properties: {
|
|
763
986
|
enabled: {
|
|
764
|
-
type: 'boolean'
|
|
765
|
-
default: true
|
|
987
|
+
type: 'boolean'
|
|
766
988
|
},
|
|
767
989
|
project: {
|
|
768
990
|
type: 'string',
|
|
@@ -771,31 +993,35 @@ export const FleetCreateInputSchema = {
|
|
|
771
993
|
example: 'my-cloudfleet-project'
|
|
772
994
|
}
|
|
773
995
|
},
|
|
996
|
+
required: [
|
|
997
|
+
'enabled'
|
|
998
|
+
],
|
|
774
999
|
additionalProperties: false
|
|
775
1000
|
},
|
|
776
1001
|
hetzner: {
|
|
777
1002
|
type: 'object',
|
|
778
1003
|
properties: {
|
|
779
1004
|
enabled: {
|
|
780
|
-
type: 'boolean'
|
|
781
|
-
default: true
|
|
1005
|
+
type: 'boolean'
|
|
782
1006
|
},
|
|
783
1007
|
apiKey: {
|
|
784
1008
|
type: 'string',
|
|
785
1009
|
maxLength: 64,
|
|
786
1010
|
minLength: 64,
|
|
787
|
-
pattern: '^[A-Za-z0-9]
|
|
788
|
-
description: 'Hetzner Cloud API token with read
|
|
1011
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1012
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
789
1013
|
}
|
|
790
1014
|
},
|
|
1015
|
+
required: [
|
|
1016
|
+
'enabled'
|
|
1017
|
+
],
|
|
791
1018
|
additionalProperties: false
|
|
792
1019
|
},
|
|
793
1020
|
aws: {
|
|
794
1021
|
type: 'object',
|
|
795
1022
|
properties: {
|
|
796
1023
|
enabled: {
|
|
797
|
-
type: 'boolean'
|
|
798
|
-
default: true
|
|
1024
|
+
type: 'boolean'
|
|
799
1025
|
},
|
|
800
1026
|
controllerRoleArn: {
|
|
801
1027
|
type: 'string',
|
|
@@ -804,6 +1030,9 @@ export const FleetCreateInputSchema = {
|
|
|
804
1030
|
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
805
1031
|
}
|
|
806
1032
|
},
|
|
1033
|
+
required: [
|
|
1034
|
+
'enabled'
|
|
1035
|
+
],
|
|
807
1036
|
additionalProperties: false
|
|
808
1037
|
},
|
|
809
1038
|
constraints: {
|
|
@@ -818,7 +1047,12 @@ export const FleetCreateInputSchema = {
|
|
|
818
1047
|
'spot'
|
|
819
1048
|
]
|
|
820
1049
|
},
|
|
821
|
-
|
|
1050
|
+
minItems: 1,
|
|
1051
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1052
|
+
default: [
|
|
1053
|
+
'on-demand',
|
|
1054
|
+
'spot'
|
|
1055
|
+
]
|
|
822
1056
|
},
|
|
823
1057
|
'kubernetes.io/arch': {
|
|
824
1058
|
type: 'array',
|
|
@@ -829,7 +1063,11 @@ export const FleetCreateInputSchema = {
|
|
|
829
1063
|
'arm64'
|
|
830
1064
|
]
|
|
831
1065
|
},
|
|
832
|
-
|
|
1066
|
+
minItems: 1,
|
|
1067
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1068
|
+
default: [
|
|
1069
|
+
'amd64'
|
|
1070
|
+
]
|
|
833
1071
|
},
|
|
834
1072
|
'cfke.io/instance-family': {
|
|
835
1073
|
type: 'array',
|
|
@@ -996,7 +1234,8 @@ export const FleetCreateInputSchema = {
|
|
|
996
1234
|
'z3'
|
|
997
1235
|
]
|
|
998
1236
|
},
|
|
999
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1237
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1238
|
+
default: []
|
|
1000
1239
|
},
|
|
1001
1240
|
'topology.kubernetes.io/region': {
|
|
1002
1241
|
type: 'array',
|
|
@@ -1069,15 +1308,28 @@ export const FleetCreateInputSchema = {
|
|
|
1069
1308
|
'us-west4'
|
|
1070
1309
|
]
|
|
1071
1310
|
},
|
|
1072
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1311
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1312
|
+
default: []
|
|
1073
1313
|
}
|
|
1074
1314
|
},
|
|
1075
1315
|
additionalProperties: false,
|
|
1076
|
-
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
1316
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1317
|
+
default: {
|
|
1318
|
+
'karpenter.sh/capacity-type': [
|
|
1319
|
+
'on-demand',
|
|
1320
|
+
'spot'
|
|
1321
|
+
],
|
|
1322
|
+
'kubernetes.io/arch': [
|
|
1323
|
+
'amd64'
|
|
1324
|
+
],
|
|
1325
|
+
'cfke.io/instance-family': [],
|
|
1326
|
+
'topology.kubernetes.io/region': []
|
|
1327
|
+
}
|
|
1077
1328
|
},
|
|
1078
1329
|
scalingProfile: {
|
|
1079
1330
|
type: 'string',
|
|
1080
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1331
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1332
|
+
default: 'conservative',
|
|
1081
1333
|
example: 'conservative',
|
|
1082
1334
|
enum: [
|
|
1083
1335
|
'aggressive',
|
|
@@ -1096,7 +1348,8 @@ export const FleetCreateInputSchema = {
|
|
|
1096
1348
|
required: [
|
|
1097
1349
|
'id'
|
|
1098
1350
|
],
|
|
1099
|
-
additionalProperties: false
|
|
1351
|
+
additionalProperties: false,
|
|
1352
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1100
1353
|
};
|
|
1101
1354
|
export const FleetSchema = {
|
|
1102
1355
|
type: 'object',
|
|
@@ -1118,8 +1371,7 @@ export const FleetSchema = {
|
|
|
1118
1371
|
type: 'object',
|
|
1119
1372
|
properties: {
|
|
1120
1373
|
enabled: {
|
|
1121
|
-
type: 'boolean'
|
|
1122
|
-
default: true
|
|
1374
|
+
type: 'boolean'
|
|
1123
1375
|
},
|
|
1124
1376
|
project: {
|
|
1125
1377
|
type: 'string',
|
|
@@ -1128,14 +1380,16 @@ export const FleetSchema = {
|
|
|
1128
1380
|
example: 'my-cloudfleet-project'
|
|
1129
1381
|
}
|
|
1130
1382
|
},
|
|
1383
|
+
required: [
|
|
1384
|
+
'enabled'
|
|
1385
|
+
],
|
|
1131
1386
|
additionalProperties: false
|
|
1132
1387
|
},
|
|
1133
1388
|
hetzner: {
|
|
1134
1389
|
type: 'object',
|
|
1135
1390
|
properties: {
|
|
1136
1391
|
enabled: {
|
|
1137
|
-
type: 'boolean'
|
|
1138
|
-
default: true
|
|
1392
|
+
type: 'boolean'
|
|
1139
1393
|
},
|
|
1140
1394
|
apiKey: {
|
|
1141
1395
|
type: 'string',
|
|
@@ -1143,14 +1397,16 @@ export const FleetSchema = {
|
|
|
1143
1397
|
description: 'Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.'
|
|
1144
1398
|
}
|
|
1145
1399
|
},
|
|
1400
|
+
required: [
|
|
1401
|
+
'enabled'
|
|
1402
|
+
],
|
|
1146
1403
|
additionalProperties: false
|
|
1147
1404
|
},
|
|
1148
1405
|
aws: {
|
|
1149
1406
|
type: 'object',
|
|
1150
1407
|
properties: {
|
|
1151
1408
|
enabled: {
|
|
1152
|
-
type: 'boolean'
|
|
1153
|
-
default: true
|
|
1409
|
+
type: 'boolean'
|
|
1154
1410
|
},
|
|
1155
1411
|
controllerRoleArn: {
|
|
1156
1412
|
type: 'string',
|
|
@@ -1159,6 +1415,9 @@ export const FleetSchema = {
|
|
|
1159
1415
|
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
1160
1416
|
}
|
|
1161
1417
|
},
|
|
1418
|
+
required: [
|
|
1419
|
+
'enabled'
|
|
1420
|
+
],
|
|
1162
1421
|
additionalProperties: false
|
|
1163
1422
|
},
|
|
1164
1423
|
constraints: {
|
|
@@ -1173,7 +1432,12 @@ export const FleetSchema = {
|
|
|
1173
1432
|
'spot'
|
|
1174
1433
|
]
|
|
1175
1434
|
},
|
|
1176
|
-
|
|
1435
|
+
minItems: 1,
|
|
1436
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1437
|
+
default: [
|
|
1438
|
+
'on-demand',
|
|
1439
|
+
'spot'
|
|
1440
|
+
]
|
|
1177
1441
|
},
|
|
1178
1442
|
'kubernetes.io/arch': {
|
|
1179
1443
|
type: 'array',
|
|
@@ -1184,7 +1448,11 @@ export const FleetSchema = {
|
|
|
1184
1448
|
'arm64'
|
|
1185
1449
|
]
|
|
1186
1450
|
},
|
|
1187
|
-
|
|
1451
|
+
minItems: 1,
|
|
1452
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1453
|
+
default: [
|
|
1454
|
+
'amd64'
|
|
1455
|
+
]
|
|
1188
1456
|
},
|
|
1189
1457
|
'cfke.io/instance-family': {
|
|
1190
1458
|
type: 'array',
|
|
@@ -1351,7 +1619,8 @@ export const FleetSchema = {
|
|
|
1351
1619
|
'z3'
|
|
1352
1620
|
]
|
|
1353
1621
|
},
|
|
1354
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1622
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1623
|
+
default: []
|
|
1355
1624
|
},
|
|
1356
1625
|
'topology.kubernetes.io/region': {
|
|
1357
1626
|
type: 'array',
|
|
@@ -1424,15 +1693,32 @@ export const FleetSchema = {
|
|
|
1424
1693
|
'us-west4'
|
|
1425
1694
|
]
|
|
1426
1695
|
},
|
|
1427
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1696
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1697
|
+
default: []
|
|
1428
1698
|
}
|
|
1429
1699
|
},
|
|
1700
|
+
required: [
|
|
1701
|
+
'karpenter.sh/capacity-type',
|
|
1702
|
+
'kubernetes.io/arch'
|
|
1703
|
+
],
|
|
1430
1704
|
additionalProperties: false,
|
|
1431
|
-
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
1705
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
1706
|
+
default: {
|
|
1707
|
+
'karpenter.sh/capacity-type': [
|
|
1708
|
+
'on-demand',
|
|
1709
|
+
'spot'
|
|
1710
|
+
],
|
|
1711
|
+
'kubernetes.io/arch': [
|
|
1712
|
+
'amd64'
|
|
1713
|
+
],
|
|
1714
|
+
'cfke.io/instance-family': [],
|
|
1715
|
+
'topology.kubernetes.io/region': []
|
|
1716
|
+
}
|
|
1432
1717
|
},
|
|
1433
1718
|
scalingProfile: {
|
|
1434
1719
|
type: 'string',
|
|
1435
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1720
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
1721
|
+
default: 'conservative',
|
|
1436
1722
|
example: 'conservative',
|
|
1437
1723
|
enum: [
|
|
1438
1724
|
'aggressive',
|
|
@@ -1446,12 +1732,38 @@ export const FleetSchema = {
|
|
|
1446
1732
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1447
1733
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1448
1734
|
example: 'new-clouds-fleet'
|
|
1735
|
+
},
|
|
1736
|
+
ready: {
|
|
1737
|
+
type: 'boolean',
|
|
1738
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1739
|
+
example: true
|
|
1740
|
+
},
|
|
1741
|
+
status_message: {
|
|
1742
|
+
type: 'string',
|
|
1743
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1744
|
+
example: 'Invalid provider permissions.'
|
|
1745
|
+
},
|
|
1746
|
+
created_at: {
|
|
1747
|
+
type: 'string',
|
|
1748
|
+
description: 'Creation date and time of the fleet.',
|
|
1749
|
+
example: '2024-09-12T09:11:27Z'
|
|
1750
|
+
},
|
|
1751
|
+
updated_at: {
|
|
1752
|
+
type: 'string',
|
|
1753
|
+
description: 'Date and time the fleet was last updated.',
|
|
1754
|
+
example: '2024-09-12T09:11:27Z'
|
|
1449
1755
|
}
|
|
1450
1756
|
},
|
|
1451
1757
|
required: [
|
|
1452
|
-
'
|
|
1758
|
+
'constraints',
|
|
1759
|
+
'scalingProfile',
|
|
1760
|
+
'id',
|
|
1761
|
+
'ready',
|
|
1762
|
+
'created_at',
|
|
1763
|
+
'updated_at'
|
|
1453
1764
|
],
|
|
1454
|
-
additionalProperties: false
|
|
1765
|
+
additionalProperties: false,
|
|
1766
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1455
1767
|
};
|
|
1456
1768
|
export const FleetUpdateInputSchema = {
|
|
1457
1769
|
type: 'object',
|
|
@@ -1473,8 +1785,7 @@ export const FleetUpdateInputSchema = {
|
|
|
1473
1785
|
type: 'object',
|
|
1474
1786
|
properties: {
|
|
1475
1787
|
enabled: {
|
|
1476
|
-
type: 'boolean'
|
|
1477
|
-
default: true
|
|
1788
|
+
type: 'boolean'
|
|
1478
1789
|
},
|
|
1479
1790
|
project: {
|
|
1480
1791
|
type: 'string',
|
|
@@ -1483,31 +1794,35 @@ export const FleetUpdateInputSchema = {
|
|
|
1483
1794
|
example: 'my-cloudfleet-project'
|
|
1484
1795
|
}
|
|
1485
1796
|
},
|
|
1797
|
+
required: [
|
|
1798
|
+
'enabled'
|
|
1799
|
+
],
|
|
1486
1800
|
additionalProperties: false
|
|
1487
1801
|
},
|
|
1488
1802
|
hetzner: {
|
|
1489
1803
|
type: 'object',
|
|
1490
1804
|
properties: {
|
|
1491
1805
|
enabled: {
|
|
1492
|
-
type: 'boolean'
|
|
1493
|
-
default: true
|
|
1806
|
+
type: 'boolean'
|
|
1494
1807
|
},
|
|
1495
1808
|
apiKey: {
|
|
1496
1809
|
type: 'string',
|
|
1497
1810
|
maxLength: 64,
|
|
1498
1811
|
minLength: 64,
|
|
1499
|
-
pattern: '^[A-Za-z0-9]
|
|
1500
|
-
description: 'Hetzner Cloud API token with read
|
|
1812
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1813
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
1501
1814
|
}
|
|
1502
1815
|
},
|
|
1816
|
+
required: [
|
|
1817
|
+
'enabled'
|
|
1818
|
+
],
|
|
1503
1819
|
additionalProperties: false
|
|
1504
1820
|
},
|
|
1505
1821
|
aws: {
|
|
1506
1822
|
type: 'object',
|
|
1507
1823
|
properties: {
|
|
1508
1824
|
enabled: {
|
|
1509
|
-
type: 'boolean'
|
|
1510
|
-
default: true
|
|
1825
|
+
type: 'boolean'
|
|
1511
1826
|
},
|
|
1512
1827
|
controllerRoleArn: {
|
|
1513
1828
|
type: 'string',
|
|
@@ -1516,6 +1831,9 @@ export const FleetUpdateInputSchema = {
|
|
|
1516
1831
|
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
1517
1832
|
}
|
|
1518
1833
|
},
|
|
1834
|
+
required: [
|
|
1835
|
+
'enabled'
|
|
1836
|
+
],
|
|
1519
1837
|
additionalProperties: false
|
|
1520
1838
|
},
|
|
1521
1839
|
constraints: {
|
|
@@ -1530,7 +1848,12 @@ export const FleetUpdateInputSchema = {
|
|
|
1530
1848
|
'spot'
|
|
1531
1849
|
]
|
|
1532
1850
|
},
|
|
1533
|
-
|
|
1851
|
+
minItems: 1,
|
|
1852
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1853
|
+
default: [
|
|
1854
|
+
'on-demand',
|
|
1855
|
+
'spot'
|
|
1856
|
+
]
|
|
1534
1857
|
},
|
|
1535
1858
|
'kubernetes.io/arch': {
|
|
1536
1859
|
type: 'array',
|
|
@@ -1541,7 +1864,11 @@ export const FleetUpdateInputSchema = {
|
|
|
1541
1864
|
'arm64'
|
|
1542
1865
|
]
|
|
1543
1866
|
},
|
|
1544
|
-
|
|
1867
|
+
minItems: 1,
|
|
1868
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1869
|
+
default: [
|
|
1870
|
+
'amd64'
|
|
1871
|
+
]
|
|
1545
1872
|
},
|
|
1546
1873
|
'cfke.io/instance-family': {
|
|
1547
1874
|
type: 'array',
|
|
@@ -1708,7 +2035,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1708
2035
|
'z3'
|
|
1709
2036
|
]
|
|
1710
2037
|
},
|
|
1711
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
2038
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2039
|
+
default: []
|
|
1712
2040
|
},
|
|
1713
2041
|
'topology.kubernetes.io/region': {
|
|
1714
2042
|
type: 'array',
|
|
@@ -1781,15 +2109,28 @@ export const FleetUpdateInputSchema = {
|
|
|
1781
2109
|
'us-west4'
|
|
1782
2110
|
]
|
|
1783
2111
|
},
|
|
1784
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
2112
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2113
|
+
default: []
|
|
1785
2114
|
}
|
|
1786
2115
|
},
|
|
1787
2116
|
additionalProperties: false,
|
|
1788
|
-
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
2117
|
+
description: 'Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.',
|
|
2118
|
+
default: {
|
|
2119
|
+
'karpenter.sh/capacity-type': [
|
|
2120
|
+
'on-demand',
|
|
2121
|
+
'spot'
|
|
2122
|
+
],
|
|
2123
|
+
'kubernetes.io/arch': [
|
|
2124
|
+
'amd64'
|
|
2125
|
+
],
|
|
2126
|
+
'cfke.io/instance-family': [],
|
|
2127
|
+
'topology.kubernetes.io/region': []
|
|
2128
|
+
}
|
|
1789
2129
|
},
|
|
1790
2130
|
scalingProfile: {
|
|
1791
2131
|
type: 'string',
|
|
1792
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
2132
|
+
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).',
|
|
2133
|
+
default: 'conservative',
|
|
1793
2134
|
example: 'conservative',
|
|
1794
2135
|
enum: [
|
|
1795
2136
|
'aggressive',
|
|
@@ -1797,6 +2138,32 @@ export const FleetUpdateInputSchema = {
|
|
|
1797
2138
|
]
|
|
1798
2139
|
}
|
|
1799
2140
|
},
|
|
2141
|
+
additionalProperties: false,
|
|
2142
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2143
|
+
};
|
|
2144
|
+
export const InviteCreateInputSchema = {
|
|
2145
|
+
type: 'object',
|
|
2146
|
+
properties: {
|
|
2147
|
+
email: {
|
|
2148
|
+
type: 'string',
|
|
2149
|
+
format: 'email',
|
|
2150
|
+
description: 'Email address of the user to invite.',
|
|
2151
|
+
example: 'email@example.com'
|
|
2152
|
+
},
|
|
2153
|
+
role: {
|
|
2154
|
+
type: 'string',
|
|
2155
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2156
|
+
default: 'User',
|
|
2157
|
+
example: 'User',
|
|
2158
|
+
enum: [
|
|
2159
|
+
'Administrator',
|
|
2160
|
+
'User'
|
|
2161
|
+
]
|
|
2162
|
+
}
|
|
2163
|
+
},
|
|
2164
|
+
required: [
|
|
2165
|
+
'email'
|
|
2166
|
+
],
|
|
1800
2167
|
additionalProperties: false
|
|
1801
2168
|
};
|
|
1802
2169
|
export const InviteSchema = {
|
|
@@ -1829,6 +2196,16 @@ export const InviteSchema = {
|
|
|
1829
2196
|
type: 'string',
|
|
1830
2197
|
description: 'Generated unique invite code.',
|
|
1831
2198
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2199
|
+
},
|
|
2200
|
+
role: {
|
|
2201
|
+
type: 'string',
|
|
2202
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2203
|
+
default: 'User',
|
|
2204
|
+
example: 'User',
|
|
2205
|
+
enum: [
|
|
2206
|
+
'Administrator',
|
|
2207
|
+
'User'
|
|
2208
|
+
]
|
|
1832
2209
|
}
|
|
1833
2210
|
},
|
|
1834
2211
|
required: [
|
|
@@ -2049,6 +2426,15 @@ export const MarketplaceListingSchema = {
|
|
|
2049
2426
|
export const OrganizationCreateInputSchema = {
|
|
2050
2427
|
type: 'object',
|
|
2051
2428
|
properties: {
|
|
2429
|
+
type: {
|
|
2430
|
+
type: 'string',
|
|
2431
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2432
|
+
example: 'business',
|
|
2433
|
+
enum: [
|
|
2434
|
+
'business',
|
|
2435
|
+
'personal'
|
|
2436
|
+
]
|
|
2437
|
+
},
|
|
2052
2438
|
email: {
|
|
2053
2439
|
type: 'string',
|
|
2054
2440
|
format: 'email',
|
|
@@ -2057,11 +2443,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2057
2443
|
},
|
|
2058
2444
|
first_name: {
|
|
2059
2445
|
type: 'string',
|
|
2446
|
+
minLength: 1,
|
|
2060
2447
|
description: 'First name of the billing contact person.',
|
|
2061
2448
|
example: 'John'
|
|
2062
2449
|
},
|
|
2063
2450
|
last_name: {
|
|
2064
2451
|
type: 'string',
|
|
2452
|
+
minLength: 1,
|
|
2065
2453
|
description: 'Last name of the billing contact person.',
|
|
2066
2454
|
example: 'Doe'
|
|
2067
2455
|
},
|
|
@@ -2080,6 +2468,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2080
2468
|
}
|
|
2081
2469
|
},
|
|
2082
2470
|
required: [
|
|
2471
|
+
'type',
|
|
2083
2472
|
'email',
|
|
2084
2473
|
'first_name',
|
|
2085
2474
|
'last_name',
|
|
@@ -2088,6 +2477,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2088
2477
|
],
|
|
2089
2478
|
additionalProperties: false
|
|
2090
2479
|
};
|
|
2480
|
+
export const OrganizationCreateOutputSchema = {
|
|
2481
|
+
type: 'object',
|
|
2482
|
+
properties: {
|
|
2483
|
+
id: {
|
|
2484
|
+
type: 'string',
|
|
2485
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2486
|
+
example: 'organization-id'
|
|
2487
|
+
}
|
|
2488
|
+
},
|
|
2489
|
+
required: [
|
|
2490
|
+
'id'
|
|
2491
|
+
],
|
|
2492
|
+
additionalProperties: false
|
|
2493
|
+
};
|
|
2091
2494
|
export const OrganizationSchema = {
|
|
2092
2495
|
type: 'object',
|
|
2093
2496
|
properties: {
|
|
@@ -2104,6 +2507,15 @@ export const OrganizationSchema = {
|
|
|
2104
2507
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2105
2508
|
example: 'ACME Corp.'
|
|
2106
2509
|
},
|
|
2510
|
+
type: {
|
|
2511
|
+
type: 'string',
|
|
2512
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2513
|
+
example: 'business',
|
|
2514
|
+
enum: [
|
|
2515
|
+
'business',
|
|
2516
|
+
'personal'
|
|
2517
|
+
]
|
|
2518
|
+
},
|
|
2107
2519
|
date_created: {
|
|
2108
2520
|
type: 'string',
|
|
2109
2521
|
format: 'date-time',
|
|
@@ -2135,6 +2547,17 @@ export const OrganizationSchema = {
|
|
|
2135
2547
|
description: 'Available number of Pro clusters that can be created.',
|
|
2136
2548
|
example: 999
|
|
2137
2549
|
},
|
|
2550
|
+
enterprise_clusters_max: {
|
|
2551
|
+
type: 'integer',
|
|
2552
|
+
minimum: 0,
|
|
2553
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2554
|
+
example: 999
|
|
2555
|
+
},
|
|
2556
|
+
enterprise_clusters_available: {
|
|
2557
|
+
type: 'integer',
|
|
2558
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2559
|
+
example: 999
|
|
2560
|
+
},
|
|
2138
2561
|
fleets_max: {
|
|
2139
2562
|
type: 'integer',
|
|
2140
2563
|
minimum: 0,
|
|
@@ -2154,7 +2577,7 @@ export const OrganizationSchema = {
|
|
|
2154
2577
|
type: 'array',
|
|
2155
2578
|
items: {
|
|
2156
2579
|
type: 'string',
|
|
2157
|
-
example: 'northamerica-central-
|
|
2580
|
+
example: 'northamerica-central-1a'
|
|
2158
2581
|
},
|
|
2159
2582
|
minItems: 1,
|
|
2160
2583
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2196,6 +2619,8 @@ export const OrganizationSchema = {
|
|
|
2196
2619
|
'basic_clusters_available',
|
|
2197
2620
|
'pro_clusters_max',
|
|
2198
2621
|
'pro_clusters_available',
|
|
2622
|
+
'enterprise_clusters_max',
|
|
2623
|
+
'enterprise_clusters_available',
|
|
2199
2624
|
'fleets_max',
|
|
2200
2625
|
'cluster_tiers',
|
|
2201
2626
|
'regions',
|
|
@@ -2213,13 +2638,25 @@ export const OrganizationSchema = {
|
|
|
2213
2638
|
'closed',
|
|
2214
2639
|
'suspended'
|
|
2215
2640
|
]
|
|
2641
|
+
},
|
|
2642
|
+
verification: {
|
|
2643
|
+
type: 'string',
|
|
2644
|
+
description: 'Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.',
|
|
2645
|
+
example: 'verified',
|
|
2646
|
+
enum: [
|
|
2647
|
+
'none',
|
|
2648
|
+
'submitted',
|
|
2649
|
+
'verified'
|
|
2650
|
+
]
|
|
2216
2651
|
}
|
|
2217
2652
|
},
|
|
2218
2653
|
required: [
|
|
2219
2654
|
'id',
|
|
2655
|
+
'type',
|
|
2220
2656
|
'date_created',
|
|
2221
2657
|
'quota',
|
|
2222
|
-
'status'
|
|
2658
|
+
'status',
|
|
2659
|
+
'verification'
|
|
2223
2660
|
],
|
|
2224
2661
|
additionalProperties: false
|
|
2225
2662
|
};
|
|
@@ -2228,28 +2665,23 @@ export const PaymentMethodSchema = {
|
|
|
2228
2665
|
properties: {
|
|
2229
2666
|
id: {
|
|
2230
2667
|
type: 'string',
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
2234
|
-
},
|
|
2235
|
-
setup: {
|
|
2236
|
-
type: 'boolean',
|
|
2237
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
2238
|
-
example: true
|
|
2668
|
+
description: 'Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.',
|
|
2669
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2239
2670
|
},
|
|
2240
2671
|
type: {
|
|
2241
2672
|
type: 'string',
|
|
2242
|
-
|
|
2243
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2673
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2244
2674
|
example: 'card',
|
|
2245
2675
|
enum: [
|
|
2246
|
-
'card'
|
|
2676
|
+
'card',
|
|
2677
|
+
'sepa_debit',
|
|
2678
|
+
'bank_transfer'
|
|
2247
2679
|
]
|
|
2248
2680
|
},
|
|
2249
2681
|
last4: {
|
|
2250
2682
|
type: 'string',
|
|
2251
2683
|
nullable: true,
|
|
2252
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2684
|
+
description: 'Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.',
|
|
2253
2685
|
example: '4242'
|
|
2254
2686
|
},
|
|
2255
2687
|
exp_month: {
|
|
@@ -2257,42 +2689,56 @@ export const PaymentMethodSchema = {
|
|
|
2257
2689
|
minimum: 1,
|
|
2258
2690
|
maximum: 12,
|
|
2259
2691
|
nullable: true,
|
|
2260
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2261
|
-
example:
|
|
2692
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2693
|
+
example: 12
|
|
2262
2694
|
},
|
|
2263
2695
|
exp_year: {
|
|
2264
2696
|
type: 'integer',
|
|
2265
|
-
minimum: 2024,
|
|
2266
2697
|
nullable: true,
|
|
2267
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2268
|
-
example:
|
|
2698
|
+
description: 'Four-digit number representing the card\'s expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.',
|
|
2699
|
+
example: 2028
|
|
2269
2700
|
},
|
|
2270
2701
|
brand: {
|
|
2271
2702
|
type: 'string',
|
|
2272
2703
|
nullable: true,
|
|
2273
|
-
description: 'Payment card brand
|
|
2274
|
-
example: 'visa'
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2704
|
+
description: 'Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.',
|
|
2705
|
+
example: 'visa'
|
|
2706
|
+
},
|
|
2707
|
+
iban: {
|
|
2708
|
+
type: 'string',
|
|
2709
|
+
nullable: true,
|
|
2710
|
+
description: 'Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet\'s virtual receiving account, shown in full so the customer can pay into it.',
|
|
2711
|
+
example: 'DE11243015658023127510'
|
|
2712
|
+
},
|
|
2713
|
+
bic: {
|
|
2714
|
+
type: 'string',
|
|
2715
|
+
nullable: true,
|
|
2716
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2717
|
+
example: 'SOGEDEFFXXX'
|
|
2718
|
+
},
|
|
2719
|
+
account_holder_name: {
|
|
2720
|
+
type: 'string',
|
|
2721
|
+
nullable: true,
|
|
2722
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2723
|
+
example: 'Cloudfleet GmbH'
|
|
2724
|
+
},
|
|
2725
|
+
is_default: {
|
|
2726
|
+
type: 'boolean',
|
|
2727
|
+
description: 'Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).',
|
|
2728
|
+
example: true
|
|
2286
2729
|
}
|
|
2287
2730
|
},
|
|
2288
2731
|
required: [
|
|
2289
2732
|
'id',
|
|
2290
|
-
'setup',
|
|
2291
2733
|
'type',
|
|
2292
2734
|
'last4',
|
|
2293
2735
|
'exp_month',
|
|
2294
2736
|
'exp_year',
|
|
2295
|
-
'brand'
|
|
2737
|
+
'brand',
|
|
2738
|
+
'iban',
|
|
2739
|
+
'bic',
|
|
2740
|
+
'account_holder_name',
|
|
2741
|
+
'is_default'
|
|
2296
2742
|
],
|
|
2297
2743
|
additionalProperties: false
|
|
2298
2744
|
};
|
|
@@ -2321,6 +2767,17 @@ export const PlatformQuotaSchema = {
|
|
|
2321
2767
|
description: 'Available number of Pro clusters that can be created.',
|
|
2322
2768
|
example: 999
|
|
2323
2769
|
},
|
|
2770
|
+
enterprise_clusters_max: {
|
|
2771
|
+
type: 'integer',
|
|
2772
|
+
minimum: 0,
|
|
2773
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2774
|
+
example: 999
|
|
2775
|
+
},
|
|
2776
|
+
enterprise_clusters_available: {
|
|
2777
|
+
type: 'integer',
|
|
2778
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2779
|
+
example: 999
|
|
2780
|
+
},
|
|
2324
2781
|
fleets_max: {
|
|
2325
2782
|
type: 'integer',
|
|
2326
2783
|
minimum: 0,
|
|
@@ -2340,7 +2797,7 @@ export const PlatformQuotaSchema = {
|
|
|
2340
2797
|
type: 'array',
|
|
2341
2798
|
items: {
|
|
2342
2799
|
type: 'string',
|
|
2343
|
-
example: 'northamerica-central-
|
|
2800
|
+
example: 'northamerica-central-1a'
|
|
2344
2801
|
},
|
|
2345
2802
|
minItems: 1,
|
|
2346
2803
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2382,6 +2839,8 @@ export const PlatformQuotaSchema = {
|
|
|
2382
2839
|
'basic_clusters_available',
|
|
2383
2840
|
'pro_clusters_max',
|
|
2384
2841
|
'pro_clusters_available',
|
|
2842
|
+
'enterprise_clusters_max',
|
|
2843
|
+
'enterprise_clusters_available',
|
|
2385
2844
|
'fleets_max',
|
|
2386
2845
|
'cluster_tiers',
|
|
2387
2846
|
'regions',
|
|
@@ -3251,12 +3710,21 @@ export const UsageFacetsSchema = {
|
|
|
3251
3710
|
product: {
|
|
3252
3711
|
type: 'array',
|
|
3253
3712
|
items: {
|
|
3254
|
-
type: 'string'
|
|
3713
|
+
type: 'string',
|
|
3714
|
+
enum: [
|
|
3715
|
+
'cfke_controlplane_basic',
|
|
3716
|
+
'cfke_controlplane_pro',
|
|
3717
|
+
'cfke_controlplane_enterprise',
|
|
3718
|
+
'cfke_connected_nodes_basic',
|
|
3719
|
+
'cfke_connected_nodes_pro',
|
|
3720
|
+
'cfke_connected_nodes_enterprise',
|
|
3721
|
+
'cfcr_storage'
|
|
3722
|
+
]
|
|
3255
3723
|
},
|
|
3256
3724
|
description: 'List of unique products',
|
|
3257
3725
|
example: [
|
|
3258
|
-
'
|
|
3259
|
-
'
|
|
3726
|
+
'cfke_controlplane_pro',
|
|
3727
|
+
'cfke_connected_nodes_pro'
|
|
3260
3728
|
]
|
|
3261
3729
|
}
|
|
3262
3730
|
},
|
|
@@ -3283,7 +3751,16 @@ export const UsageResponseSchema = {
|
|
|
3283
3751
|
product: {
|
|
3284
3752
|
type: 'string',
|
|
3285
3753
|
description: 'The product the usage is associated with',
|
|
3286
|
-
example: '
|
|
3754
|
+
example: 'cfke_controlplane_pro',
|
|
3755
|
+
enum: [
|
|
3756
|
+
'cfke_controlplane_basic',
|
|
3757
|
+
'cfke_controlplane_pro',
|
|
3758
|
+
'cfke_controlplane_enterprise',
|
|
3759
|
+
'cfke_connected_nodes_basic',
|
|
3760
|
+
'cfke_connected_nodes_pro',
|
|
3761
|
+
'cfke_connected_nodes_enterprise',
|
|
3762
|
+
'cfcr_storage'
|
|
3763
|
+
]
|
|
3287
3764
|
},
|
|
3288
3765
|
value: {
|
|
3289
3766
|
type: 'number',
|
|
@@ -3331,12 +3808,21 @@ export const UsageResponseSchema = {
|
|
|
3331
3808
|
product: {
|
|
3332
3809
|
type: 'array',
|
|
3333
3810
|
items: {
|
|
3334
|
-
type: 'string'
|
|
3811
|
+
type: 'string',
|
|
3812
|
+
enum: [
|
|
3813
|
+
'cfke_controlplane_basic',
|
|
3814
|
+
'cfke_controlplane_pro',
|
|
3815
|
+
'cfke_controlplane_enterprise',
|
|
3816
|
+
'cfke_connected_nodes_basic',
|
|
3817
|
+
'cfke_connected_nodes_pro',
|
|
3818
|
+
'cfke_connected_nodes_enterprise',
|
|
3819
|
+
'cfcr_storage'
|
|
3820
|
+
]
|
|
3335
3821
|
},
|
|
3336
3822
|
description: 'List of unique products',
|
|
3337
3823
|
example: [
|
|
3338
|
-
'
|
|
3339
|
-
'
|
|
3824
|
+
'cfke_controlplane_pro',
|
|
3825
|
+
'cfke_connected_nodes_pro'
|
|
3340
3826
|
]
|
|
3341
3827
|
}
|
|
3342
3828
|
},
|
|
@@ -3366,7 +3852,16 @@ export const UsageSchema = {
|
|
|
3366
3852
|
product: {
|
|
3367
3853
|
type: 'string',
|
|
3368
3854
|
description: 'The product the usage is associated with',
|
|
3369
|
-
example: '
|
|
3855
|
+
example: 'cfke_controlplane_pro',
|
|
3856
|
+
enum: [
|
|
3857
|
+
'cfke_controlplane_basic',
|
|
3858
|
+
'cfke_controlplane_pro',
|
|
3859
|
+
'cfke_controlplane_enterprise',
|
|
3860
|
+
'cfke_connected_nodes_basic',
|
|
3861
|
+
'cfke_connected_nodes_pro',
|
|
3862
|
+
'cfke_connected_nodes_enterprise',
|
|
3863
|
+
'cfcr_storage'
|
|
3864
|
+
]
|
|
3370
3865
|
},
|
|
3371
3866
|
value: {
|
|
3372
3867
|
type: 'number',
|
|
@@ -3429,24 +3924,6 @@ export const UserCreateInputSchema = {
|
|
|
3429
3924
|
type: 'string',
|
|
3430
3925
|
minLength: 8,
|
|
3431
3926
|
description: 'User password. Must be at least 8 characters long.'
|
|
3432
|
-
},
|
|
3433
|
-
status: {
|
|
3434
|
-
type: 'string',
|
|
3435
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
3436
|
-
example: 'active',
|
|
3437
|
-
enum: [
|
|
3438
|
-
'active',
|
|
3439
|
-
'inactive'
|
|
3440
|
-
]
|
|
3441
|
-
},
|
|
3442
|
-
role: {
|
|
3443
|
-
type: 'string',
|
|
3444
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
3445
|
-
example: 'User',
|
|
3446
|
-
enum: [
|
|
3447
|
-
'Administrator',
|
|
3448
|
-
'User'
|
|
3449
|
-
]
|
|
3450
3927
|
}
|
|
3451
3928
|
},
|
|
3452
3929
|
required: [
|