@cloudfleet/sdk 0.0.1-41d4ab0 → 0.0.1-43887de
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 +564 -528
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +622 -357
- 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 +1238 -118
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2279 -198
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +292 -189
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +444 -275
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1737 -728
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3631 -1141
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1417 -292
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
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,
|
|
@@ -84,12 +93,17 @@ export const BillingContactSchema = {
|
|
|
84
93
|
'at_vat',
|
|
85
94
|
'au_abn',
|
|
86
95
|
'au_arn',
|
|
96
|
+
'aw_tin',
|
|
97
|
+
'az_tin',
|
|
87
98
|
'ba_tin',
|
|
88
99
|
'bb_tin',
|
|
100
|
+
'bd_bin',
|
|
89
101
|
'be_vat',
|
|
102
|
+
'bf_ifu',
|
|
90
103
|
'bg_uic',
|
|
91
104
|
'bg_vat',
|
|
92
105
|
'bh_vat',
|
|
106
|
+
'bj_ifu',
|
|
93
107
|
'bo_tin',
|
|
94
108
|
'br_cnpj',
|
|
95
109
|
'br_cpf',
|
|
@@ -105,9 +119,11 @@ export const BillingContactSchema = {
|
|
|
105
119
|
'ch_uid',
|
|
106
120
|
'ch_vat',
|
|
107
121
|
'cl_tin',
|
|
122
|
+
'cm_niu',
|
|
108
123
|
'cn_tin',
|
|
109
124
|
'co_nit',
|
|
110
125
|
'cr_tin',
|
|
126
|
+
'cv_nif',
|
|
111
127
|
'cy_vat',
|
|
112
128
|
'cz_vat',
|
|
113
129
|
'de_stn',
|
|
@@ -119,6 +135,7 @@ export const BillingContactSchema = {
|
|
|
119
135
|
'eg_tin',
|
|
120
136
|
'es_cif',
|
|
121
137
|
'es_vat',
|
|
138
|
+
'et_tin',
|
|
122
139
|
'eu_oss_vat',
|
|
123
140
|
'fi_vat',
|
|
124
141
|
'fr_vat',
|
|
@@ -141,11 +158,14 @@ export const BillingContactSchema = {
|
|
|
141
158
|
'jp_rn',
|
|
142
159
|
'jp_trn',
|
|
143
160
|
'ke_pin',
|
|
161
|
+
'kg_tin',
|
|
144
162
|
'kh_tin',
|
|
145
163
|
'kr_brn',
|
|
146
164
|
'kz_bin',
|
|
165
|
+
'la_tin',
|
|
147
166
|
'li_uid',
|
|
148
167
|
'li_vat',
|
|
168
|
+
'lk_vat',
|
|
149
169
|
'lt_vat',
|
|
150
170
|
'lu_vat',
|
|
151
171
|
'lv_vat',
|
|
@@ -207,6 +227,7 @@ export const BillingContactSchema = {
|
|
|
207
227
|
}
|
|
208
228
|
},
|
|
209
229
|
required: [
|
|
230
|
+
'type',
|
|
210
231
|
'email',
|
|
211
232
|
'individual_name'
|
|
212
233
|
],
|
|
@@ -358,24 +379,8 @@ export const ChartSchema = {
|
|
|
358
379
|
},
|
|
359
380
|
status: {
|
|
360
381
|
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
|
-
]
|
|
382
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
383
|
+
example: 'InstallSucceeded'
|
|
379
384
|
},
|
|
380
385
|
version_current: {
|
|
381
386
|
type: 'string',
|
|
@@ -446,22 +451,12 @@ export const ClusterCreateInputSchema = {
|
|
|
446
451
|
tier: {
|
|
447
452
|
type: 'string',
|
|
448
453
|
description: 'Tier of the cluster.',
|
|
454
|
+
default: 'basic',
|
|
449
455
|
example: 'pro',
|
|
450
456
|
enum: [
|
|
451
457
|
'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'
|
|
458
|
+
'pro',
|
|
459
|
+
'enterprise'
|
|
465
460
|
]
|
|
466
461
|
},
|
|
467
462
|
version_channel: {
|
|
@@ -469,20 +464,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
464
|
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
465
|
description: 'Version of the kubernetes cluster.',
|
|
471
466
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
467
|
+
example: '1.x.x-cfke.x'
|
|
468
|
+
},
|
|
469
|
+
release_channel: {
|
|
470
|
+
type: 'string',
|
|
471
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
472
|
+
default: 'rapid',
|
|
473
|
+
example: 'rapid',
|
|
473
474
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
475
|
+
'rapid',
|
|
476
|
+
'stable',
|
|
477
|
+
'extended'
|
|
478
478
|
]
|
|
479
|
+
},
|
|
480
|
+
features: {
|
|
481
|
+
type: 'object',
|
|
482
|
+
properties: {
|
|
483
|
+
gpu_sharing_strategy: {
|
|
484
|
+
type: 'string',
|
|
485
|
+
description: 'GPU sharing strategy.',
|
|
486
|
+
default: 'none',
|
|
487
|
+
example: 'none',
|
|
488
|
+
enum: [
|
|
489
|
+
'none',
|
|
490
|
+
'mps',
|
|
491
|
+
'time_slicing'
|
|
492
|
+
]
|
|
493
|
+
},
|
|
494
|
+
gpu_max_shared_clients_per_gpu: {
|
|
495
|
+
type: 'integer',
|
|
496
|
+
minimum: 2,
|
|
497
|
+
maximum: 48,
|
|
498
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
499
|
+
default: 4,
|
|
500
|
+
example: 10
|
|
501
|
+
},
|
|
502
|
+
cilium_socket_lb_host_namespace_only: {
|
|
503
|
+
type: 'boolean',
|
|
504
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
505
|
+
example: false
|
|
506
|
+
}
|
|
507
|
+
},
|
|
508
|
+
additionalProperties: false,
|
|
509
|
+
description: 'Cluster feature toggles.',
|
|
510
|
+
default: {
|
|
511
|
+
gpu_sharing_strategy: 'none',
|
|
512
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
513
|
+
cilium_socket_lb_host_namespace_only: false
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
region: {
|
|
517
|
+
type: 'string',
|
|
518
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
519
|
+
example: 'europe-central-1a'
|
|
520
|
+
},
|
|
521
|
+
networking: {
|
|
522
|
+
type: 'object',
|
|
523
|
+
properties: {
|
|
524
|
+
pod_cidr: {
|
|
525
|
+
type: 'string',
|
|
526
|
+
description: 'CIDR block for pod IPs.',
|
|
527
|
+
default: '10.244.0.0/16'
|
|
528
|
+
},
|
|
529
|
+
service_cidr: {
|
|
530
|
+
type: 'string',
|
|
531
|
+
description: 'CIDR block for service IPs.',
|
|
532
|
+
default: '10.96.0.0/12'
|
|
533
|
+
},
|
|
534
|
+
dual_stack: {
|
|
535
|
+
type: 'boolean',
|
|
536
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
537
|
+
},
|
|
538
|
+
pod_cidr_v6: {
|
|
539
|
+
type: 'string',
|
|
540
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
541
|
+
default: '2001:db8:1:2::/48'
|
|
542
|
+
},
|
|
543
|
+
service_cidr_v6: {
|
|
544
|
+
type: 'string',
|
|
545
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
546
|
+
default: '2001:db8:1:1::/112'
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
additionalProperties: false,
|
|
550
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
551
|
+
default: {
|
|
552
|
+
pod_cidr: '10.244.0.0/16',
|
|
553
|
+
service_cidr: '10.96.0.0/12',
|
|
554
|
+
dual_stack: false,
|
|
555
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
556
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
557
|
+
}
|
|
479
558
|
}
|
|
480
559
|
},
|
|
481
560
|
required: [
|
|
482
561
|
'name',
|
|
483
|
-
'
|
|
562
|
+
'region'
|
|
484
563
|
],
|
|
485
|
-
additionalProperties: false
|
|
564
|
+
additionalProperties: false,
|
|
565
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
566
|
};
|
|
487
567
|
export const ClusterJoinInformationSchema = {
|
|
488
568
|
type: 'object',
|
|
@@ -503,11 +583,21 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
583
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
584
|
example: '10.96.0.10'
|
|
505
585
|
},
|
|
586
|
+
pod_cidr: {
|
|
587
|
+
type: 'string',
|
|
588
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
589
|
+
example: '10.244.0.0/16'
|
|
590
|
+
},
|
|
506
591
|
auth_key: {
|
|
507
592
|
type: 'string',
|
|
508
593
|
description: 'Authentication key for the cluster.',
|
|
509
594
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
510
595
|
},
|
|
596
|
+
login_server: {
|
|
597
|
+
type: 'string',
|
|
598
|
+
description: 'Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.',
|
|
599
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
600
|
+
},
|
|
511
601
|
bootstrap_token: {
|
|
512
602
|
type: 'string',
|
|
513
603
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -578,7 +668,9 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
668
|
'certificate_authority',
|
|
579
669
|
'endpoint',
|
|
580
670
|
'cluster_dns',
|
|
671
|
+
'pod_cidr',
|
|
581
672
|
'auth_key',
|
|
673
|
+
'login_server',
|
|
582
674
|
'bootstrap_token',
|
|
583
675
|
'versions',
|
|
584
676
|
'third_party_api_access_config'
|
|
@@ -599,24 +691,123 @@ export const ClusterSchema = {
|
|
|
599
691
|
tier: {
|
|
600
692
|
type: 'string',
|
|
601
693
|
description: 'Tier of the cluster.',
|
|
694
|
+
default: 'basic',
|
|
602
695
|
example: 'pro',
|
|
603
696
|
enum: [
|
|
604
697
|
'basic',
|
|
605
|
-
'pro'
|
|
698
|
+
'pro',
|
|
699
|
+
'enterprise'
|
|
606
700
|
]
|
|
607
701
|
},
|
|
608
|
-
|
|
702
|
+
version_channel: {
|
|
703
|
+
type: 'string',
|
|
704
|
+
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-]+)*))?$',
|
|
705
|
+
description: 'Version of the kubernetes cluster.',
|
|
706
|
+
default: '1.x.x-cfke.x',
|
|
707
|
+
example: '1.x.x-cfke.x'
|
|
708
|
+
},
|
|
709
|
+
release_channel: {
|
|
609
710
|
type: 'string',
|
|
610
|
-
description: '
|
|
611
|
-
default: '
|
|
612
|
-
example: '
|
|
711
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
712
|
+
default: 'rapid',
|
|
713
|
+
example: 'rapid',
|
|
613
714
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
715
|
+
'rapid',
|
|
716
|
+
'stable',
|
|
717
|
+
'extended'
|
|
618
718
|
]
|
|
619
719
|
},
|
|
720
|
+
features: {
|
|
721
|
+
type: 'object',
|
|
722
|
+
properties: {
|
|
723
|
+
gpu_sharing_strategy: {
|
|
724
|
+
type: 'string',
|
|
725
|
+
description: 'GPU sharing strategy.',
|
|
726
|
+
default: 'none',
|
|
727
|
+
example: 'none',
|
|
728
|
+
enum: [
|
|
729
|
+
'none',
|
|
730
|
+
'mps',
|
|
731
|
+
'time_slicing'
|
|
732
|
+
]
|
|
733
|
+
},
|
|
734
|
+
gpu_max_shared_clients_per_gpu: {
|
|
735
|
+
type: 'integer',
|
|
736
|
+
minimum: 2,
|
|
737
|
+
maximum: 48,
|
|
738
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
739
|
+
default: 4,
|
|
740
|
+
example: 10
|
|
741
|
+
},
|
|
742
|
+
cilium_socket_lb_host_namespace_only: {
|
|
743
|
+
type: 'boolean',
|
|
744
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
745
|
+
example: false
|
|
746
|
+
}
|
|
747
|
+
},
|
|
748
|
+
required: [
|
|
749
|
+
'gpu_sharing_strategy',
|
|
750
|
+
'gpu_max_shared_clients_per_gpu',
|
|
751
|
+
'cilium_socket_lb_host_namespace_only'
|
|
752
|
+
],
|
|
753
|
+
additionalProperties: false,
|
|
754
|
+
description: 'Cluster feature toggles.',
|
|
755
|
+
default: {
|
|
756
|
+
gpu_sharing_strategy: 'none',
|
|
757
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
758
|
+
cilium_socket_lb_host_namespace_only: false
|
|
759
|
+
}
|
|
760
|
+
},
|
|
761
|
+
region: {
|
|
762
|
+
type: 'string',
|
|
763
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
764
|
+
example: 'europe-central-1a'
|
|
765
|
+
},
|
|
766
|
+
networking: {
|
|
767
|
+
type: 'object',
|
|
768
|
+
properties: {
|
|
769
|
+
pod_cidr: {
|
|
770
|
+
type: 'string',
|
|
771
|
+
description: 'CIDR block for pod IPs.',
|
|
772
|
+
default: '10.244.0.0/16'
|
|
773
|
+
},
|
|
774
|
+
service_cidr: {
|
|
775
|
+
type: 'string',
|
|
776
|
+
description: 'CIDR block for service IPs.',
|
|
777
|
+
default: '10.96.0.0/12'
|
|
778
|
+
},
|
|
779
|
+
dual_stack: {
|
|
780
|
+
type: 'boolean',
|
|
781
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
782
|
+
},
|
|
783
|
+
pod_cidr_v6: {
|
|
784
|
+
type: 'string',
|
|
785
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
786
|
+
default: '2001:db8:1:2::/48'
|
|
787
|
+
},
|
|
788
|
+
service_cidr_v6: {
|
|
789
|
+
type: 'string',
|
|
790
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
791
|
+
default: '2001:db8:1:1::/112'
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
required: [
|
|
795
|
+
'pod_cidr',
|
|
796
|
+
'service_cidr',
|
|
797
|
+
'dual_stack',
|
|
798
|
+
'pod_cidr_v6',
|
|
799
|
+
'service_cidr_v6'
|
|
800
|
+
],
|
|
801
|
+
additionalProperties: false,
|
|
802
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
803
|
+
default: {
|
|
804
|
+
pod_cidr: '10.244.0.0/16',
|
|
805
|
+
service_cidr: '10.96.0.0/12',
|
|
806
|
+
dual_stack: false,
|
|
807
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
808
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
809
|
+
}
|
|
810
|
+
},
|
|
620
811
|
id: {
|
|
621
812
|
type: 'string',
|
|
622
813
|
format: 'uuid',
|
|
@@ -625,16 +816,13 @@ export const ClusterSchema = {
|
|
|
625
816
|
},
|
|
626
817
|
status: {
|
|
627
818
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
819
|
+
description: 'Status of the cluster.',
|
|
820
|
+
example: 'deployed',
|
|
630
821
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
822
|
'creating',
|
|
635
823
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
824
|
+
'updating',
|
|
825
|
+
'disabled'
|
|
638
826
|
]
|
|
639
827
|
},
|
|
640
828
|
endpoint: {
|
|
@@ -642,8 +830,24 @@ export const ClusterSchema = {
|
|
|
642
830
|
{
|
|
643
831
|
type: 'string',
|
|
644
832
|
format: 'uri',
|
|
645
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
833
|
+
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.',
|
|
834
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
type: 'string',
|
|
838
|
+
enum: [
|
|
839
|
+
''
|
|
840
|
+
]
|
|
841
|
+
}
|
|
842
|
+
]
|
|
843
|
+
},
|
|
844
|
+
endpoint_public: {
|
|
845
|
+
anyOf: [
|
|
846
|
+
{
|
|
847
|
+
type: 'string',
|
|
848
|
+
format: 'uri',
|
|
849
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
850
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
851
|
},
|
|
648
852
|
{
|
|
649
853
|
type: 'string',
|
|
@@ -677,21 +881,22 @@ export const ClusterSchema = {
|
|
|
677
881
|
type: 'boolean',
|
|
678
882
|
description: 'Indicates if the cluster is ready to be used.',
|
|
679
883
|
example: true
|
|
680
|
-
},
|
|
681
|
-
version_channel: {
|
|
682
|
-
type: 'string',
|
|
683
|
-
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-]+)*))?$',
|
|
684
|
-
description: 'Version of the kubernetes cluster.',
|
|
685
|
-
example: '1.x.x-cfke.x'
|
|
686
884
|
}
|
|
687
885
|
},
|
|
688
886
|
required: [
|
|
689
887
|
'name',
|
|
690
888
|
'tier',
|
|
889
|
+
'version_channel',
|
|
890
|
+
'release_channel',
|
|
891
|
+
'features',
|
|
892
|
+
'region',
|
|
893
|
+
'networking',
|
|
691
894
|
'id',
|
|
692
|
-
'status'
|
|
895
|
+
'status',
|
|
896
|
+
'ready'
|
|
693
897
|
],
|
|
694
|
-
additionalProperties: false
|
|
898
|
+
additionalProperties: false,
|
|
899
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
695
900
|
};
|
|
696
901
|
export const ClusterUpdateInputSchema = {
|
|
697
902
|
type: 'object',
|
|
@@ -707,21 +912,138 @@ export const ClusterUpdateInputSchema = {
|
|
|
707
912
|
tier: {
|
|
708
913
|
type: 'string',
|
|
709
914
|
description: 'Tier of the cluster.',
|
|
915
|
+
default: 'basic',
|
|
710
916
|
example: 'pro',
|
|
711
917
|
enum: [
|
|
712
918
|
'basic',
|
|
713
|
-
'pro'
|
|
919
|
+
'pro',
|
|
920
|
+
'enterprise'
|
|
714
921
|
]
|
|
715
922
|
},
|
|
716
923
|
version_channel: {
|
|
717
924
|
type: 'string',
|
|
718
925
|
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-]+)*))?$',
|
|
719
926
|
description: 'Version of the kubernetes cluster.',
|
|
927
|
+
default: '1.x.x-cfke.x',
|
|
720
928
|
example: '1.x.x-cfke.x'
|
|
929
|
+
},
|
|
930
|
+
release_channel: {
|
|
931
|
+
type: 'string',
|
|
932
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
933
|
+
default: 'rapid',
|
|
934
|
+
example: 'rapid',
|
|
935
|
+
enum: [
|
|
936
|
+
'rapid',
|
|
937
|
+
'stable',
|
|
938
|
+
'extended'
|
|
939
|
+
]
|
|
940
|
+
},
|
|
941
|
+
features: {
|
|
942
|
+
type: 'object',
|
|
943
|
+
properties: {
|
|
944
|
+
gpu_sharing_strategy: {
|
|
945
|
+
type: 'string',
|
|
946
|
+
description: 'GPU sharing strategy.',
|
|
947
|
+
default: 'none',
|
|
948
|
+
example: 'none',
|
|
949
|
+
enum: [
|
|
950
|
+
'none',
|
|
951
|
+
'mps',
|
|
952
|
+
'time_slicing'
|
|
953
|
+
]
|
|
954
|
+
},
|
|
955
|
+
gpu_max_shared_clients_per_gpu: {
|
|
956
|
+
type: 'integer',
|
|
957
|
+
minimum: 2,
|
|
958
|
+
maximum: 48,
|
|
959
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
960
|
+
default: 4,
|
|
961
|
+
example: 10
|
|
962
|
+
},
|
|
963
|
+
cilium_socket_lb_host_namespace_only: {
|
|
964
|
+
type: 'boolean',
|
|
965
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
966
|
+
example: false
|
|
967
|
+
}
|
|
968
|
+
},
|
|
969
|
+
additionalProperties: false,
|
|
970
|
+
description: 'Cluster feature toggles.',
|
|
971
|
+
default: {
|
|
972
|
+
gpu_sharing_strategy: 'none',
|
|
973
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
974
|
+
cilium_socket_lb_host_namespace_only: false
|
|
975
|
+
}
|
|
976
|
+
}
|
|
977
|
+
},
|
|
978
|
+
required: [
|
|
979
|
+
'name'
|
|
980
|
+
],
|
|
981
|
+
additionalProperties: false,
|
|
982
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
983
|
+
};
|
|
984
|
+
export const FeedbackCreateInputSchema = {
|
|
985
|
+
type: 'object',
|
|
986
|
+
properties: {
|
|
987
|
+
sentiment: {
|
|
988
|
+
type: 'string',
|
|
989
|
+
description: 'Overall sentiment: positive, neutral or negative.',
|
|
990
|
+
example: 'negative',
|
|
991
|
+
enum: [
|
|
992
|
+
'positive',
|
|
993
|
+
'neutral',
|
|
994
|
+
'negative'
|
|
995
|
+
]
|
|
996
|
+
},
|
|
997
|
+
message: {
|
|
998
|
+
type: 'string',
|
|
999
|
+
maxLength: 2000,
|
|
1000
|
+
minLength: 1,
|
|
1001
|
+
description: 'What was useful, confusing, wrong or missing.',
|
|
1002
|
+
example: 'The error for a missing kubeconfig does not say which path it looked in.'
|
|
1003
|
+
},
|
|
1004
|
+
context: {
|
|
1005
|
+
type: 'string',
|
|
1006
|
+
maxLength: 2000,
|
|
1007
|
+
description: 'What you were trying to do when it happened.',
|
|
1008
|
+
example: 'Connecting kubectl to a new cluster.'
|
|
1009
|
+
},
|
|
1010
|
+
source: {
|
|
1011
|
+
type: 'string',
|
|
1012
|
+
description: 'Where the feedback was sent from: cli, mcp, plugin, console or api. Defaults to api.',
|
|
1013
|
+
default: 'api',
|
|
1014
|
+
example: 'cli',
|
|
1015
|
+
enum: [
|
|
1016
|
+
'cli',
|
|
1017
|
+
'mcp',
|
|
1018
|
+
'plugin',
|
|
1019
|
+
'console',
|
|
1020
|
+
'api'
|
|
1021
|
+
]
|
|
1022
|
+
},
|
|
1023
|
+
client: {
|
|
1024
|
+
type: 'string',
|
|
1025
|
+
maxLength: 100,
|
|
1026
|
+
description: 'Name and version of the sending client.',
|
|
1027
|
+
example: 'cloudfleet-plugin-claude/0.5.0'
|
|
1028
|
+
}
|
|
1029
|
+
},
|
|
1030
|
+
required: [
|
|
1031
|
+
'sentiment',
|
|
1032
|
+
'message'
|
|
1033
|
+
],
|
|
1034
|
+
additionalProperties: false
|
|
1035
|
+
};
|
|
1036
|
+
export const FeedbackSchema = {
|
|
1037
|
+
type: 'object',
|
|
1038
|
+
properties: {
|
|
1039
|
+
id: {
|
|
1040
|
+
type: 'string',
|
|
1041
|
+
description: 'Unique identifier of the feedback entry (Mongo ObjectId).',
|
|
1042
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
721
1043
|
}
|
|
722
1044
|
},
|
|
723
1045
|
required: [
|
|
724
|
-
'
|
|
1046
|
+
'id'
|
|
725
1047
|
],
|
|
726
1048
|
additionalProperties: false
|
|
727
1049
|
};
|
|
@@ -732,15 +1054,12 @@ export const FleetCreateInputSchema = {
|
|
|
732
1054
|
type: 'object',
|
|
733
1055
|
properties: {
|
|
734
1056
|
cpu: {
|
|
735
|
-
type: '
|
|
736
|
-
format: 'float',
|
|
1057
|
+
type: 'integer',
|
|
737
1058
|
minimum: 0,
|
|
738
|
-
|
|
1059
|
+
maximum: 100000,
|
|
1060
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
739
1061
|
}
|
|
740
1062
|
},
|
|
741
|
-
required: [
|
|
742
|
-
'cpu'
|
|
743
|
-
],
|
|
744
1063
|
additionalProperties: false,
|
|
745
1064
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
746
1065
|
},
|
|
@@ -748,16 +1067,17 @@ export const FleetCreateInputSchema = {
|
|
|
748
1067
|
type: 'object',
|
|
749
1068
|
properties: {
|
|
750
1069
|
enabled: {
|
|
751
|
-
type: 'boolean'
|
|
752
|
-
default: true
|
|
1070
|
+
type: 'boolean'
|
|
753
1071
|
},
|
|
754
1072
|
project: {
|
|
755
1073
|
type: 'string',
|
|
756
|
-
|
|
1074
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1075
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1076
|
+
example: 'my-cloudfleet-project'
|
|
757
1077
|
}
|
|
758
1078
|
},
|
|
759
1079
|
required: [
|
|
760
|
-
'
|
|
1080
|
+
'enabled'
|
|
761
1081
|
],
|
|
762
1082
|
additionalProperties: false
|
|
763
1083
|
},
|
|
@@ -765,16 +1085,18 @@ export const FleetCreateInputSchema = {
|
|
|
765
1085
|
type: 'object',
|
|
766
1086
|
properties: {
|
|
767
1087
|
enabled: {
|
|
768
|
-
type: 'boolean'
|
|
769
|
-
default: true
|
|
1088
|
+
type: 'boolean'
|
|
770
1089
|
},
|
|
771
1090
|
apiKey: {
|
|
772
1091
|
type: 'string',
|
|
773
|
-
|
|
1092
|
+
maxLength: 64,
|
|
1093
|
+
minLength: 64,
|
|
1094
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1095
|
+
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.'
|
|
774
1096
|
}
|
|
775
1097
|
},
|
|
776
1098
|
required: [
|
|
777
|
-
'
|
|
1099
|
+
'enabled'
|
|
778
1100
|
],
|
|
779
1101
|
additionalProperties: false
|
|
780
1102
|
},
|
|
@@ -782,19 +1104,359 @@ export const FleetCreateInputSchema = {
|
|
|
782
1104
|
type: 'object',
|
|
783
1105
|
properties: {
|
|
784
1106
|
enabled: {
|
|
785
|
-
type: 'boolean'
|
|
786
|
-
default: true
|
|
1107
|
+
type: 'boolean'
|
|
787
1108
|
},
|
|
788
1109
|
controllerRoleArn: {
|
|
789
1110
|
type: 'string',
|
|
790
|
-
|
|
1111
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1112
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1113
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
791
1114
|
}
|
|
792
1115
|
},
|
|
793
1116
|
required: [
|
|
794
|
-
'
|
|
1117
|
+
'enabled'
|
|
795
1118
|
],
|
|
796
1119
|
additionalProperties: false
|
|
797
1120
|
},
|
|
1121
|
+
constraints: {
|
|
1122
|
+
type: 'object',
|
|
1123
|
+
properties: {
|
|
1124
|
+
'karpenter.sh/capacity-type': {
|
|
1125
|
+
type: 'array',
|
|
1126
|
+
items: {
|
|
1127
|
+
type: 'string',
|
|
1128
|
+
enum: [
|
|
1129
|
+
'on-demand',
|
|
1130
|
+
'spot'
|
|
1131
|
+
]
|
|
1132
|
+
},
|
|
1133
|
+
minItems: 1,
|
|
1134
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1135
|
+
default: [
|
|
1136
|
+
'on-demand',
|
|
1137
|
+
'spot'
|
|
1138
|
+
]
|
|
1139
|
+
},
|
|
1140
|
+
'kubernetes.io/arch': {
|
|
1141
|
+
type: 'array',
|
|
1142
|
+
items: {
|
|
1143
|
+
type: 'string',
|
|
1144
|
+
enum: [
|
|
1145
|
+
'amd64',
|
|
1146
|
+
'arm64'
|
|
1147
|
+
]
|
|
1148
|
+
},
|
|
1149
|
+
minItems: 1,
|
|
1150
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1151
|
+
default: [
|
|
1152
|
+
'amd64'
|
|
1153
|
+
]
|
|
1154
|
+
},
|
|
1155
|
+
'cfke.io/instance-family': {
|
|
1156
|
+
type: 'array',
|
|
1157
|
+
items: {
|
|
1158
|
+
type: 'string',
|
|
1159
|
+
enum: [
|
|
1160
|
+
'a1',
|
|
1161
|
+
'a2',
|
|
1162
|
+
'a3',
|
|
1163
|
+
'a4',
|
|
1164
|
+
'c1',
|
|
1165
|
+
'c2',
|
|
1166
|
+
'c2d',
|
|
1167
|
+
'c3',
|
|
1168
|
+
'c3d',
|
|
1169
|
+
'c4',
|
|
1170
|
+
'c4a',
|
|
1171
|
+
'c4d',
|
|
1172
|
+
'c5',
|
|
1173
|
+
'c5a',
|
|
1174
|
+
'c5ad',
|
|
1175
|
+
'c5d',
|
|
1176
|
+
'c5n',
|
|
1177
|
+
'c6a',
|
|
1178
|
+
'c6g',
|
|
1179
|
+
'c6gd',
|
|
1180
|
+
'c6gn',
|
|
1181
|
+
'c6i',
|
|
1182
|
+
'c6id',
|
|
1183
|
+
'c6in',
|
|
1184
|
+
'c7a',
|
|
1185
|
+
'c7g',
|
|
1186
|
+
'c7gd',
|
|
1187
|
+
'c7gn',
|
|
1188
|
+
'c7i',
|
|
1189
|
+
'c7i-flex',
|
|
1190
|
+
'c8g',
|
|
1191
|
+
'c8gd',
|
|
1192
|
+
'cax',
|
|
1193
|
+
'ccx',
|
|
1194
|
+
'cpx',
|
|
1195
|
+
'cx',
|
|
1196
|
+
'd2',
|
|
1197
|
+
'd3',
|
|
1198
|
+
'd3en',
|
|
1199
|
+
'dl1',
|
|
1200
|
+
'dl2q',
|
|
1201
|
+
'e2',
|
|
1202
|
+
'f1',
|
|
1203
|
+
'f2',
|
|
1204
|
+
'g1',
|
|
1205
|
+
'g2',
|
|
1206
|
+
'g4ad',
|
|
1207
|
+
'g4dn',
|
|
1208
|
+
'g5',
|
|
1209
|
+
'g5g',
|
|
1210
|
+
'g6',
|
|
1211
|
+
'g6e',
|
|
1212
|
+
'gr6',
|
|
1213
|
+
'h1',
|
|
1214
|
+
'h3',
|
|
1215
|
+
'hpc6a',
|
|
1216
|
+
'hpc6id',
|
|
1217
|
+
'hpc7a',
|
|
1218
|
+
'hpc7g',
|
|
1219
|
+
'i2',
|
|
1220
|
+
'i3',
|
|
1221
|
+
'i3en',
|
|
1222
|
+
'i4g',
|
|
1223
|
+
'i4i',
|
|
1224
|
+
'i7i',
|
|
1225
|
+
'i7ie',
|
|
1226
|
+
'i8g',
|
|
1227
|
+
'im4gn',
|
|
1228
|
+
'inf1',
|
|
1229
|
+
'inf2',
|
|
1230
|
+
'is4gen',
|
|
1231
|
+
'm1',
|
|
1232
|
+
'm2',
|
|
1233
|
+
'm3',
|
|
1234
|
+
'm4',
|
|
1235
|
+
'm5',
|
|
1236
|
+
'm5a',
|
|
1237
|
+
'm5ad',
|
|
1238
|
+
'm5d',
|
|
1239
|
+
'm5dn',
|
|
1240
|
+
'm5n',
|
|
1241
|
+
'm5zn',
|
|
1242
|
+
'm6a',
|
|
1243
|
+
'm6g',
|
|
1244
|
+
'm6gd',
|
|
1245
|
+
'm6i',
|
|
1246
|
+
'm6id',
|
|
1247
|
+
'm6idn',
|
|
1248
|
+
'm6in',
|
|
1249
|
+
'm7a',
|
|
1250
|
+
'm7g',
|
|
1251
|
+
'm7gd',
|
|
1252
|
+
'm7i',
|
|
1253
|
+
'm7i-flex',
|
|
1254
|
+
'm8g',
|
|
1255
|
+
'm8gd',
|
|
1256
|
+
'n1',
|
|
1257
|
+
'n2',
|
|
1258
|
+
'n2d',
|
|
1259
|
+
'n4',
|
|
1260
|
+
'p3',
|
|
1261
|
+
'p3dn',
|
|
1262
|
+
'p4d',
|
|
1263
|
+
'p4de',
|
|
1264
|
+
'p5',
|
|
1265
|
+
'p5e',
|
|
1266
|
+
'p5en',
|
|
1267
|
+
'p6-b200',
|
|
1268
|
+
'r3',
|
|
1269
|
+
'r4',
|
|
1270
|
+
'r5',
|
|
1271
|
+
'r5a',
|
|
1272
|
+
'r5ad',
|
|
1273
|
+
'r5b',
|
|
1274
|
+
'r5d',
|
|
1275
|
+
'r5dn',
|
|
1276
|
+
'r5n',
|
|
1277
|
+
'r6a',
|
|
1278
|
+
'r6g',
|
|
1279
|
+
'r6gd',
|
|
1280
|
+
'r6i',
|
|
1281
|
+
'r6id',
|
|
1282
|
+
'r6idn',
|
|
1283
|
+
'r6in',
|
|
1284
|
+
'r7a',
|
|
1285
|
+
'r7g',
|
|
1286
|
+
'r7gd',
|
|
1287
|
+
'r7i',
|
|
1288
|
+
'r7iz',
|
|
1289
|
+
'r8g',
|
|
1290
|
+
'r8gd',
|
|
1291
|
+
't2',
|
|
1292
|
+
't2a',
|
|
1293
|
+
't2d',
|
|
1294
|
+
't3',
|
|
1295
|
+
't3a',
|
|
1296
|
+
't4g',
|
|
1297
|
+
'trn1',
|
|
1298
|
+
'trn1n',
|
|
1299
|
+
'u-3tb1',
|
|
1300
|
+
'u-6tb1',
|
|
1301
|
+
'u7i-12tb',
|
|
1302
|
+
'u7i-6tb',
|
|
1303
|
+
'u7i-8tb',
|
|
1304
|
+
'u7in-16tb',
|
|
1305
|
+
'u7in-24tb',
|
|
1306
|
+
'u7in-32tb',
|
|
1307
|
+
'vt1',
|
|
1308
|
+
'x1',
|
|
1309
|
+
'x1e',
|
|
1310
|
+
'x2gd',
|
|
1311
|
+
'x2idn',
|
|
1312
|
+
'x2iedn',
|
|
1313
|
+
'x2iezn',
|
|
1314
|
+
'x4',
|
|
1315
|
+
'x8g',
|
|
1316
|
+
'z1d',
|
|
1317
|
+
'z3'
|
|
1318
|
+
]
|
|
1319
|
+
},
|
|
1320
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1321
|
+
default: []
|
|
1322
|
+
},
|
|
1323
|
+
'topology.kubernetes.io/region': {
|
|
1324
|
+
type: 'array',
|
|
1325
|
+
items: {
|
|
1326
|
+
type: 'string',
|
|
1327
|
+
enum: [
|
|
1328
|
+
'africa-south1',
|
|
1329
|
+
'ap-northeast-1',
|
|
1330
|
+
'ap-northeast-2',
|
|
1331
|
+
'ap-northeast-3',
|
|
1332
|
+
'ap-south-1',
|
|
1333
|
+
'ap-southeast-1',
|
|
1334
|
+
'ap-southeast-2',
|
|
1335
|
+
'ash',
|
|
1336
|
+
'asia-east1',
|
|
1337
|
+
'asia-east2',
|
|
1338
|
+
'asia-northeast1',
|
|
1339
|
+
'asia-northeast2',
|
|
1340
|
+
'asia-northeast3',
|
|
1341
|
+
'asia-south1',
|
|
1342
|
+
'asia-south2',
|
|
1343
|
+
'asia-southeast1',
|
|
1344
|
+
'asia-southeast2',
|
|
1345
|
+
'australia-southeast1',
|
|
1346
|
+
'australia-southeast2',
|
|
1347
|
+
'ca-central-1',
|
|
1348
|
+
'eu-central-1',
|
|
1349
|
+
'eu-central-2',
|
|
1350
|
+
'eu-north-1',
|
|
1351
|
+
'eu-west-1',
|
|
1352
|
+
'eu-west-2',
|
|
1353
|
+
'eu-west-3',
|
|
1354
|
+
'europe-central2',
|
|
1355
|
+
'europe-north1',
|
|
1356
|
+
'europe-southwest1',
|
|
1357
|
+
'europe-west1',
|
|
1358
|
+
'europe-west10',
|
|
1359
|
+
'europe-west12',
|
|
1360
|
+
'europe-west2',
|
|
1361
|
+
'europe-west3',
|
|
1362
|
+
'europe-west4',
|
|
1363
|
+
'europe-west6',
|
|
1364
|
+
'europe-west8',
|
|
1365
|
+
'europe-west9',
|
|
1366
|
+
'fsn1',
|
|
1367
|
+
'hel1',
|
|
1368
|
+
'hil',
|
|
1369
|
+
'me-central1',
|
|
1370
|
+
'me-central2',
|
|
1371
|
+
'me-west1',
|
|
1372
|
+
'nbg1',
|
|
1373
|
+
'northamerica-northeast1',
|
|
1374
|
+
'northamerica-northeast2',
|
|
1375
|
+
'sa-east-1',
|
|
1376
|
+
'sin',
|
|
1377
|
+
'southamerica-east1',
|
|
1378
|
+
'southamerica-west1',
|
|
1379
|
+
'us-central1',
|
|
1380
|
+
'us-east-1',
|
|
1381
|
+
'us-east-2',
|
|
1382
|
+
'us-east1',
|
|
1383
|
+
'us-east4',
|
|
1384
|
+
'us-east5',
|
|
1385
|
+
'us-south1',
|
|
1386
|
+
'us-west-1',
|
|
1387
|
+
'us-west-2',
|
|
1388
|
+
'us-west1',
|
|
1389
|
+
'us-west2',
|
|
1390
|
+
'us-west3',
|
|
1391
|
+
'us-west4'
|
|
1392
|
+
]
|
|
1393
|
+
},
|
|
1394
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1395
|
+
default: []
|
|
1396
|
+
}
|
|
1397
|
+
},
|
|
1398
|
+
additionalProperties: false,
|
|
1399
|
+
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.',
|
|
1400
|
+
default: {
|
|
1401
|
+
'karpenter.sh/capacity-type': [
|
|
1402
|
+
'on-demand',
|
|
1403
|
+
'spot'
|
|
1404
|
+
],
|
|
1405
|
+
'kubernetes.io/arch': [
|
|
1406
|
+
'amd64'
|
|
1407
|
+
],
|
|
1408
|
+
'cfke.io/instance-family': [],
|
|
1409
|
+
'topology.kubernetes.io/region': []
|
|
1410
|
+
}
|
|
1411
|
+
},
|
|
1412
|
+
scalingProfile: {
|
|
1413
|
+
type: 'string',
|
|
1414
|
+
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`).',
|
|
1415
|
+
default: 'conservative',
|
|
1416
|
+
example: 'conservative',
|
|
1417
|
+
enum: [
|
|
1418
|
+
'aggressive',
|
|
1419
|
+
'conservative'
|
|
1420
|
+
]
|
|
1421
|
+
},
|
|
1422
|
+
taints: {
|
|
1423
|
+
type: 'array',
|
|
1424
|
+
items: {
|
|
1425
|
+
type: 'object',
|
|
1426
|
+
properties: {
|
|
1427
|
+
key: {
|
|
1428
|
+
type: 'string',
|
|
1429
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1430
|
+
example: 'dedicated'
|
|
1431
|
+
},
|
|
1432
|
+
value: {
|
|
1433
|
+
type: 'string',
|
|
1434
|
+
maxLength: 63,
|
|
1435
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1436
|
+
description: 'Taint value. Optional.',
|
|
1437
|
+
example: 'ci'
|
|
1438
|
+
},
|
|
1439
|
+
effect: {
|
|
1440
|
+
type: 'string',
|
|
1441
|
+
description: 'Taint effect.',
|
|
1442
|
+
example: 'NoSchedule',
|
|
1443
|
+
enum: [
|
|
1444
|
+
'NoSchedule',
|
|
1445
|
+
'PreferNoSchedule',
|
|
1446
|
+
'NoExecute'
|
|
1447
|
+
]
|
|
1448
|
+
}
|
|
1449
|
+
},
|
|
1450
|
+
required: [
|
|
1451
|
+
'key',
|
|
1452
|
+
'effect'
|
|
1453
|
+
],
|
|
1454
|
+
additionalProperties: false
|
|
1455
|
+
},
|
|
1456
|
+
maxItems: 50,
|
|
1457
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1458
|
+
default: []
|
|
1459
|
+
},
|
|
798
1460
|
id: {
|
|
799
1461
|
type: 'string',
|
|
800
1462
|
maxLength: 63,
|
|
@@ -807,7 +1469,8 @@ export const FleetCreateInputSchema = {
|
|
|
807
1469
|
required: [
|
|
808
1470
|
'id'
|
|
809
1471
|
],
|
|
810
|
-
additionalProperties: false
|
|
1472
|
+
additionalProperties: false,
|
|
1473
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
811
1474
|
};
|
|
812
1475
|
export const FleetSchema = {
|
|
813
1476
|
type: 'object',
|
|
@@ -816,15 +1479,12 @@ export const FleetSchema = {
|
|
|
816
1479
|
type: 'object',
|
|
817
1480
|
properties: {
|
|
818
1481
|
cpu: {
|
|
819
|
-
type: '
|
|
820
|
-
format: 'float',
|
|
1482
|
+
type: 'integer',
|
|
821
1483
|
minimum: 0,
|
|
822
|
-
|
|
1484
|
+
maximum: 100000,
|
|
1485
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
823
1486
|
}
|
|
824
1487
|
},
|
|
825
|
-
required: [
|
|
826
|
-
'cpu'
|
|
827
|
-
],
|
|
828
1488
|
additionalProperties: false,
|
|
829
1489
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
830
1490
|
},
|
|
@@ -832,16 +1492,17 @@ export const FleetSchema = {
|
|
|
832
1492
|
type: 'object',
|
|
833
1493
|
properties: {
|
|
834
1494
|
enabled: {
|
|
835
|
-
type: 'boolean'
|
|
836
|
-
default: true
|
|
1495
|
+
type: 'boolean'
|
|
837
1496
|
},
|
|
838
1497
|
project: {
|
|
839
1498
|
type: 'string',
|
|
840
|
-
|
|
1499
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1500
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1501
|
+
example: 'my-cloudfleet-project'
|
|
841
1502
|
}
|
|
842
1503
|
},
|
|
843
1504
|
required: [
|
|
844
|
-
'
|
|
1505
|
+
'enabled'
|
|
845
1506
|
],
|
|
846
1507
|
additionalProperties: false
|
|
847
1508
|
},
|
|
@@ -849,16 +1510,16 @@ export const FleetSchema = {
|
|
|
849
1510
|
type: 'object',
|
|
850
1511
|
properties: {
|
|
851
1512
|
enabled: {
|
|
852
|
-
type: 'boolean'
|
|
853
|
-
default: true
|
|
1513
|
+
type: 'boolean'
|
|
854
1514
|
},
|
|
855
1515
|
apiKey: {
|
|
856
1516
|
type: 'string',
|
|
857
|
-
|
|
1517
|
+
pattern: '^\\*{64}$',
|
|
1518
|
+
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.'
|
|
858
1519
|
}
|
|
859
1520
|
},
|
|
860
1521
|
required: [
|
|
861
|
-
'
|
|
1522
|
+
'enabled'
|
|
862
1523
|
],
|
|
863
1524
|
additionalProperties: false
|
|
864
1525
|
},
|
|
@@ -866,32 +1527,403 @@ export const FleetSchema = {
|
|
|
866
1527
|
type: 'object',
|
|
867
1528
|
properties: {
|
|
868
1529
|
enabled: {
|
|
869
|
-
type: 'boolean'
|
|
870
|
-
default: true
|
|
1530
|
+
type: 'boolean'
|
|
871
1531
|
},
|
|
872
1532
|
controllerRoleArn: {
|
|
873
1533
|
type: 'string',
|
|
874
|
-
|
|
1534
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1535
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1536
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
875
1537
|
}
|
|
876
1538
|
},
|
|
877
1539
|
required: [
|
|
878
|
-
'
|
|
1540
|
+
'enabled'
|
|
879
1541
|
],
|
|
880
1542
|
additionalProperties: false
|
|
881
1543
|
},
|
|
882
|
-
|
|
883
|
-
type: '
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
1544
|
+
constraints: {
|
|
1545
|
+
type: 'object',
|
|
1546
|
+
properties: {
|
|
1547
|
+
'karpenter.sh/capacity-type': {
|
|
1548
|
+
type: 'array',
|
|
1549
|
+
items: {
|
|
1550
|
+
type: 'string',
|
|
1551
|
+
enum: [
|
|
1552
|
+
'on-demand',
|
|
1553
|
+
'spot'
|
|
1554
|
+
]
|
|
1555
|
+
},
|
|
1556
|
+
minItems: 1,
|
|
1557
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1558
|
+
default: [
|
|
1559
|
+
'on-demand',
|
|
1560
|
+
'spot'
|
|
1561
|
+
]
|
|
1562
|
+
},
|
|
1563
|
+
'kubernetes.io/arch': {
|
|
1564
|
+
type: 'array',
|
|
1565
|
+
items: {
|
|
1566
|
+
type: 'string',
|
|
1567
|
+
enum: [
|
|
1568
|
+
'amd64',
|
|
1569
|
+
'arm64'
|
|
1570
|
+
]
|
|
1571
|
+
},
|
|
1572
|
+
minItems: 1,
|
|
1573
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1574
|
+
default: [
|
|
1575
|
+
'amd64'
|
|
1576
|
+
]
|
|
1577
|
+
},
|
|
1578
|
+
'cfke.io/instance-family': {
|
|
1579
|
+
type: 'array',
|
|
1580
|
+
items: {
|
|
1581
|
+
type: 'string',
|
|
1582
|
+
enum: [
|
|
1583
|
+
'a1',
|
|
1584
|
+
'a2',
|
|
1585
|
+
'a3',
|
|
1586
|
+
'a4',
|
|
1587
|
+
'c1',
|
|
1588
|
+
'c2',
|
|
1589
|
+
'c2d',
|
|
1590
|
+
'c3',
|
|
1591
|
+
'c3d',
|
|
1592
|
+
'c4',
|
|
1593
|
+
'c4a',
|
|
1594
|
+
'c4d',
|
|
1595
|
+
'c5',
|
|
1596
|
+
'c5a',
|
|
1597
|
+
'c5ad',
|
|
1598
|
+
'c5d',
|
|
1599
|
+
'c5n',
|
|
1600
|
+
'c6a',
|
|
1601
|
+
'c6g',
|
|
1602
|
+
'c6gd',
|
|
1603
|
+
'c6gn',
|
|
1604
|
+
'c6i',
|
|
1605
|
+
'c6id',
|
|
1606
|
+
'c6in',
|
|
1607
|
+
'c7a',
|
|
1608
|
+
'c7g',
|
|
1609
|
+
'c7gd',
|
|
1610
|
+
'c7gn',
|
|
1611
|
+
'c7i',
|
|
1612
|
+
'c7i-flex',
|
|
1613
|
+
'c8g',
|
|
1614
|
+
'c8gd',
|
|
1615
|
+
'cax',
|
|
1616
|
+
'ccx',
|
|
1617
|
+
'cpx',
|
|
1618
|
+
'cx',
|
|
1619
|
+
'd2',
|
|
1620
|
+
'd3',
|
|
1621
|
+
'd3en',
|
|
1622
|
+
'dl1',
|
|
1623
|
+
'dl2q',
|
|
1624
|
+
'e2',
|
|
1625
|
+
'f1',
|
|
1626
|
+
'f2',
|
|
1627
|
+
'g1',
|
|
1628
|
+
'g2',
|
|
1629
|
+
'g4ad',
|
|
1630
|
+
'g4dn',
|
|
1631
|
+
'g5',
|
|
1632
|
+
'g5g',
|
|
1633
|
+
'g6',
|
|
1634
|
+
'g6e',
|
|
1635
|
+
'gr6',
|
|
1636
|
+
'h1',
|
|
1637
|
+
'h3',
|
|
1638
|
+
'hpc6a',
|
|
1639
|
+
'hpc6id',
|
|
1640
|
+
'hpc7a',
|
|
1641
|
+
'hpc7g',
|
|
1642
|
+
'i2',
|
|
1643
|
+
'i3',
|
|
1644
|
+
'i3en',
|
|
1645
|
+
'i4g',
|
|
1646
|
+
'i4i',
|
|
1647
|
+
'i7i',
|
|
1648
|
+
'i7ie',
|
|
1649
|
+
'i8g',
|
|
1650
|
+
'im4gn',
|
|
1651
|
+
'inf1',
|
|
1652
|
+
'inf2',
|
|
1653
|
+
'is4gen',
|
|
1654
|
+
'm1',
|
|
1655
|
+
'm2',
|
|
1656
|
+
'm3',
|
|
1657
|
+
'm4',
|
|
1658
|
+
'm5',
|
|
1659
|
+
'm5a',
|
|
1660
|
+
'm5ad',
|
|
1661
|
+
'm5d',
|
|
1662
|
+
'm5dn',
|
|
1663
|
+
'm5n',
|
|
1664
|
+
'm5zn',
|
|
1665
|
+
'm6a',
|
|
1666
|
+
'm6g',
|
|
1667
|
+
'm6gd',
|
|
1668
|
+
'm6i',
|
|
1669
|
+
'm6id',
|
|
1670
|
+
'm6idn',
|
|
1671
|
+
'm6in',
|
|
1672
|
+
'm7a',
|
|
1673
|
+
'm7g',
|
|
1674
|
+
'm7gd',
|
|
1675
|
+
'm7i',
|
|
1676
|
+
'm7i-flex',
|
|
1677
|
+
'm8g',
|
|
1678
|
+
'm8gd',
|
|
1679
|
+
'n1',
|
|
1680
|
+
'n2',
|
|
1681
|
+
'n2d',
|
|
1682
|
+
'n4',
|
|
1683
|
+
'p3',
|
|
1684
|
+
'p3dn',
|
|
1685
|
+
'p4d',
|
|
1686
|
+
'p4de',
|
|
1687
|
+
'p5',
|
|
1688
|
+
'p5e',
|
|
1689
|
+
'p5en',
|
|
1690
|
+
'p6-b200',
|
|
1691
|
+
'r3',
|
|
1692
|
+
'r4',
|
|
1693
|
+
'r5',
|
|
1694
|
+
'r5a',
|
|
1695
|
+
'r5ad',
|
|
1696
|
+
'r5b',
|
|
1697
|
+
'r5d',
|
|
1698
|
+
'r5dn',
|
|
1699
|
+
'r5n',
|
|
1700
|
+
'r6a',
|
|
1701
|
+
'r6g',
|
|
1702
|
+
'r6gd',
|
|
1703
|
+
'r6i',
|
|
1704
|
+
'r6id',
|
|
1705
|
+
'r6idn',
|
|
1706
|
+
'r6in',
|
|
1707
|
+
'r7a',
|
|
1708
|
+
'r7g',
|
|
1709
|
+
'r7gd',
|
|
1710
|
+
'r7i',
|
|
1711
|
+
'r7iz',
|
|
1712
|
+
'r8g',
|
|
1713
|
+
'r8gd',
|
|
1714
|
+
't2',
|
|
1715
|
+
't2a',
|
|
1716
|
+
't2d',
|
|
1717
|
+
't3',
|
|
1718
|
+
't3a',
|
|
1719
|
+
't4g',
|
|
1720
|
+
'trn1',
|
|
1721
|
+
'trn1n',
|
|
1722
|
+
'u-3tb1',
|
|
1723
|
+
'u-6tb1',
|
|
1724
|
+
'u7i-12tb',
|
|
1725
|
+
'u7i-6tb',
|
|
1726
|
+
'u7i-8tb',
|
|
1727
|
+
'u7in-16tb',
|
|
1728
|
+
'u7in-24tb',
|
|
1729
|
+
'u7in-32tb',
|
|
1730
|
+
'vt1',
|
|
1731
|
+
'x1',
|
|
1732
|
+
'x1e',
|
|
1733
|
+
'x2gd',
|
|
1734
|
+
'x2idn',
|
|
1735
|
+
'x2iedn',
|
|
1736
|
+
'x2iezn',
|
|
1737
|
+
'x4',
|
|
1738
|
+
'x8g',
|
|
1739
|
+
'z1d',
|
|
1740
|
+
'z3'
|
|
1741
|
+
]
|
|
1742
|
+
},
|
|
1743
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1744
|
+
default: []
|
|
1745
|
+
},
|
|
1746
|
+
'topology.kubernetes.io/region': {
|
|
1747
|
+
type: 'array',
|
|
1748
|
+
items: {
|
|
1749
|
+
type: 'string',
|
|
1750
|
+
enum: [
|
|
1751
|
+
'africa-south1',
|
|
1752
|
+
'ap-northeast-1',
|
|
1753
|
+
'ap-northeast-2',
|
|
1754
|
+
'ap-northeast-3',
|
|
1755
|
+
'ap-south-1',
|
|
1756
|
+
'ap-southeast-1',
|
|
1757
|
+
'ap-southeast-2',
|
|
1758
|
+
'ash',
|
|
1759
|
+
'asia-east1',
|
|
1760
|
+
'asia-east2',
|
|
1761
|
+
'asia-northeast1',
|
|
1762
|
+
'asia-northeast2',
|
|
1763
|
+
'asia-northeast3',
|
|
1764
|
+
'asia-south1',
|
|
1765
|
+
'asia-south2',
|
|
1766
|
+
'asia-southeast1',
|
|
1767
|
+
'asia-southeast2',
|
|
1768
|
+
'australia-southeast1',
|
|
1769
|
+
'australia-southeast2',
|
|
1770
|
+
'ca-central-1',
|
|
1771
|
+
'eu-central-1',
|
|
1772
|
+
'eu-central-2',
|
|
1773
|
+
'eu-north-1',
|
|
1774
|
+
'eu-west-1',
|
|
1775
|
+
'eu-west-2',
|
|
1776
|
+
'eu-west-3',
|
|
1777
|
+
'europe-central2',
|
|
1778
|
+
'europe-north1',
|
|
1779
|
+
'europe-southwest1',
|
|
1780
|
+
'europe-west1',
|
|
1781
|
+
'europe-west10',
|
|
1782
|
+
'europe-west12',
|
|
1783
|
+
'europe-west2',
|
|
1784
|
+
'europe-west3',
|
|
1785
|
+
'europe-west4',
|
|
1786
|
+
'europe-west6',
|
|
1787
|
+
'europe-west8',
|
|
1788
|
+
'europe-west9',
|
|
1789
|
+
'fsn1',
|
|
1790
|
+
'hel1',
|
|
1791
|
+
'hil',
|
|
1792
|
+
'me-central1',
|
|
1793
|
+
'me-central2',
|
|
1794
|
+
'me-west1',
|
|
1795
|
+
'nbg1',
|
|
1796
|
+
'northamerica-northeast1',
|
|
1797
|
+
'northamerica-northeast2',
|
|
1798
|
+
'sa-east-1',
|
|
1799
|
+
'sin',
|
|
1800
|
+
'southamerica-east1',
|
|
1801
|
+
'southamerica-west1',
|
|
1802
|
+
'us-central1',
|
|
1803
|
+
'us-east-1',
|
|
1804
|
+
'us-east-2',
|
|
1805
|
+
'us-east1',
|
|
1806
|
+
'us-east4',
|
|
1807
|
+
'us-east5',
|
|
1808
|
+
'us-south1',
|
|
1809
|
+
'us-west-1',
|
|
1810
|
+
'us-west-2',
|
|
1811
|
+
'us-west1',
|
|
1812
|
+
'us-west2',
|
|
1813
|
+
'us-west3',
|
|
1814
|
+
'us-west4'
|
|
1815
|
+
]
|
|
1816
|
+
},
|
|
1817
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1818
|
+
default: []
|
|
1819
|
+
}
|
|
1820
|
+
},
|
|
1821
|
+
required: [
|
|
1822
|
+
'karpenter.sh/capacity-type',
|
|
1823
|
+
'kubernetes.io/arch'
|
|
1824
|
+
],
|
|
1825
|
+
additionalProperties: false,
|
|
1826
|
+
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.',
|
|
1827
|
+
default: {
|
|
1828
|
+
'karpenter.sh/capacity-type': [
|
|
1829
|
+
'on-demand',
|
|
1830
|
+
'spot'
|
|
1831
|
+
],
|
|
1832
|
+
'kubernetes.io/arch': [
|
|
1833
|
+
'amd64'
|
|
1834
|
+
],
|
|
1835
|
+
'cfke.io/instance-family': [],
|
|
1836
|
+
'topology.kubernetes.io/region': []
|
|
1837
|
+
}
|
|
1838
|
+
},
|
|
1839
|
+
scalingProfile: {
|
|
1840
|
+
type: 'string',
|
|
1841
|
+
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`).',
|
|
1842
|
+
default: 'conservative',
|
|
1843
|
+
example: 'conservative',
|
|
1844
|
+
enum: [
|
|
1845
|
+
'aggressive',
|
|
1846
|
+
'conservative'
|
|
1847
|
+
]
|
|
1848
|
+
},
|
|
1849
|
+
taints: {
|
|
1850
|
+
type: 'array',
|
|
1851
|
+
items: {
|
|
1852
|
+
type: 'object',
|
|
1853
|
+
properties: {
|
|
1854
|
+
key: {
|
|
1855
|
+
type: 'string',
|
|
1856
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
1857
|
+
example: 'dedicated'
|
|
1858
|
+
},
|
|
1859
|
+
value: {
|
|
1860
|
+
type: 'string',
|
|
1861
|
+
maxLength: 63,
|
|
1862
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1863
|
+
description: 'Taint value. Optional.',
|
|
1864
|
+
example: 'ci'
|
|
1865
|
+
},
|
|
1866
|
+
effect: {
|
|
1867
|
+
type: 'string',
|
|
1868
|
+
description: 'Taint effect.',
|
|
1869
|
+
example: 'NoSchedule',
|
|
1870
|
+
enum: [
|
|
1871
|
+
'NoSchedule',
|
|
1872
|
+
'PreferNoSchedule',
|
|
1873
|
+
'NoExecute'
|
|
1874
|
+
]
|
|
1875
|
+
}
|
|
1876
|
+
},
|
|
1877
|
+
required: [
|
|
1878
|
+
'key',
|
|
1879
|
+
'effect'
|
|
1880
|
+
],
|
|
1881
|
+
additionalProperties: false
|
|
1882
|
+
},
|
|
1883
|
+
maxItems: 50,
|
|
1884
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
1885
|
+
default: []
|
|
1886
|
+
},
|
|
1887
|
+
id: {
|
|
1888
|
+
type: 'string',
|
|
1889
|
+
maxLength: 63,
|
|
1890
|
+
minLength: 1,
|
|
1891
|
+
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1892
|
+
description: 'Unique identifier of the kubernetes fleet.',
|
|
1893
|
+
example: 'new-clouds-fleet'
|
|
1894
|
+
},
|
|
1895
|
+
ready: {
|
|
1896
|
+
type: 'boolean',
|
|
1897
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1898
|
+
example: true
|
|
1899
|
+
},
|
|
1900
|
+
status_message: {
|
|
1901
|
+
type: 'string',
|
|
1902
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1903
|
+
example: 'Invalid provider permissions.'
|
|
1904
|
+
},
|
|
1905
|
+
created_at: {
|
|
1906
|
+
type: 'string',
|
|
1907
|
+
description: 'Creation date and time of the fleet.',
|
|
1908
|
+
example: '2024-09-12T09:11:27Z'
|
|
1909
|
+
},
|
|
1910
|
+
updated_at: {
|
|
1911
|
+
type: 'string',
|
|
1912
|
+
description: 'Date and time the fleet was last updated.',
|
|
1913
|
+
example: '2024-09-12T09:11:27Z'
|
|
1914
|
+
}
|
|
1915
|
+
},
|
|
891
1916
|
required: [
|
|
892
|
-
'
|
|
1917
|
+
'constraints',
|
|
1918
|
+
'scalingProfile',
|
|
1919
|
+
'taints',
|
|
1920
|
+
'id',
|
|
1921
|
+
'ready',
|
|
1922
|
+
'created_at',
|
|
1923
|
+
'updated_at'
|
|
893
1924
|
],
|
|
894
|
-
additionalProperties: false
|
|
1925
|
+
additionalProperties: false,
|
|
1926
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
895
1927
|
};
|
|
896
1928
|
export const FleetUpdateInputSchema = {
|
|
897
1929
|
type: 'object',
|
|
@@ -900,15 +1932,12 @@ export const FleetUpdateInputSchema = {
|
|
|
900
1932
|
type: 'object',
|
|
901
1933
|
properties: {
|
|
902
1934
|
cpu: {
|
|
903
|
-
type: '
|
|
904
|
-
format: 'float',
|
|
1935
|
+
type: 'integer',
|
|
905
1936
|
minimum: 0,
|
|
906
|
-
|
|
1937
|
+
maximum: 100000,
|
|
1938
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
907
1939
|
}
|
|
908
1940
|
},
|
|
909
|
-
required: [
|
|
910
|
-
'cpu'
|
|
911
|
-
],
|
|
912
1941
|
additionalProperties: false,
|
|
913
1942
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
914
1943
|
},
|
|
@@ -916,16 +1945,17 @@ export const FleetUpdateInputSchema = {
|
|
|
916
1945
|
type: 'object',
|
|
917
1946
|
properties: {
|
|
918
1947
|
enabled: {
|
|
919
|
-
type: 'boolean'
|
|
920
|
-
default: true
|
|
1948
|
+
type: 'boolean'
|
|
921
1949
|
},
|
|
922
1950
|
project: {
|
|
923
1951
|
type: 'string',
|
|
924
|
-
|
|
1952
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1953
|
+
description: 'GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.',
|
|
1954
|
+
example: 'my-cloudfleet-project'
|
|
925
1955
|
}
|
|
926
1956
|
},
|
|
927
1957
|
required: [
|
|
928
|
-
'
|
|
1958
|
+
'enabled'
|
|
929
1959
|
],
|
|
930
1960
|
additionalProperties: false
|
|
931
1961
|
},
|
|
@@ -933,16 +1963,18 @@ export const FleetUpdateInputSchema = {
|
|
|
933
1963
|
type: 'object',
|
|
934
1964
|
properties: {
|
|
935
1965
|
enabled: {
|
|
936
|
-
type: 'boolean'
|
|
937
|
-
default: true
|
|
1966
|
+
type: 'boolean'
|
|
938
1967
|
},
|
|
939
1968
|
apiKey: {
|
|
940
1969
|
type: 'string',
|
|
941
|
-
|
|
1970
|
+
maxLength: 64,
|
|
1971
|
+
minLength: 64,
|
|
1972
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1973
|
+
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.'
|
|
942
1974
|
}
|
|
943
1975
|
},
|
|
944
1976
|
required: [
|
|
945
|
-
'
|
|
1977
|
+
'enabled'
|
|
946
1978
|
],
|
|
947
1979
|
additionalProperties: false
|
|
948
1980
|
},
|
|
@@ -950,20 +1982,386 @@ export const FleetUpdateInputSchema = {
|
|
|
950
1982
|
type: 'object',
|
|
951
1983
|
properties: {
|
|
952
1984
|
enabled: {
|
|
953
|
-
type: 'boolean'
|
|
954
|
-
default: true
|
|
1985
|
+
type: 'boolean'
|
|
955
1986
|
},
|
|
956
1987
|
controllerRoleArn: {
|
|
957
1988
|
type: 'string',
|
|
958
|
-
|
|
1989
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1990
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1991
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
959
1992
|
}
|
|
960
1993
|
},
|
|
961
1994
|
required: [
|
|
962
|
-
'
|
|
1995
|
+
'enabled'
|
|
963
1996
|
],
|
|
964
1997
|
additionalProperties: false
|
|
1998
|
+
},
|
|
1999
|
+
constraints: {
|
|
2000
|
+
type: 'object',
|
|
2001
|
+
properties: {
|
|
2002
|
+
'karpenter.sh/capacity-type': {
|
|
2003
|
+
type: 'array',
|
|
2004
|
+
items: {
|
|
2005
|
+
type: 'string',
|
|
2006
|
+
enum: [
|
|
2007
|
+
'on-demand',
|
|
2008
|
+
'spot'
|
|
2009
|
+
]
|
|
2010
|
+
},
|
|
2011
|
+
minItems: 1,
|
|
2012
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
2013
|
+
default: [
|
|
2014
|
+
'on-demand',
|
|
2015
|
+
'spot'
|
|
2016
|
+
]
|
|
2017
|
+
},
|
|
2018
|
+
'kubernetes.io/arch': {
|
|
2019
|
+
type: 'array',
|
|
2020
|
+
items: {
|
|
2021
|
+
type: 'string',
|
|
2022
|
+
enum: [
|
|
2023
|
+
'amd64',
|
|
2024
|
+
'arm64'
|
|
2025
|
+
]
|
|
2026
|
+
},
|
|
2027
|
+
minItems: 1,
|
|
2028
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
2029
|
+
default: [
|
|
2030
|
+
'amd64'
|
|
2031
|
+
]
|
|
2032
|
+
},
|
|
2033
|
+
'cfke.io/instance-family': {
|
|
2034
|
+
type: 'array',
|
|
2035
|
+
items: {
|
|
2036
|
+
type: 'string',
|
|
2037
|
+
enum: [
|
|
2038
|
+
'a1',
|
|
2039
|
+
'a2',
|
|
2040
|
+
'a3',
|
|
2041
|
+
'a4',
|
|
2042
|
+
'c1',
|
|
2043
|
+
'c2',
|
|
2044
|
+
'c2d',
|
|
2045
|
+
'c3',
|
|
2046
|
+
'c3d',
|
|
2047
|
+
'c4',
|
|
2048
|
+
'c4a',
|
|
2049
|
+
'c4d',
|
|
2050
|
+
'c5',
|
|
2051
|
+
'c5a',
|
|
2052
|
+
'c5ad',
|
|
2053
|
+
'c5d',
|
|
2054
|
+
'c5n',
|
|
2055
|
+
'c6a',
|
|
2056
|
+
'c6g',
|
|
2057
|
+
'c6gd',
|
|
2058
|
+
'c6gn',
|
|
2059
|
+
'c6i',
|
|
2060
|
+
'c6id',
|
|
2061
|
+
'c6in',
|
|
2062
|
+
'c7a',
|
|
2063
|
+
'c7g',
|
|
2064
|
+
'c7gd',
|
|
2065
|
+
'c7gn',
|
|
2066
|
+
'c7i',
|
|
2067
|
+
'c7i-flex',
|
|
2068
|
+
'c8g',
|
|
2069
|
+
'c8gd',
|
|
2070
|
+
'cax',
|
|
2071
|
+
'ccx',
|
|
2072
|
+
'cpx',
|
|
2073
|
+
'cx',
|
|
2074
|
+
'd2',
|
|
2075
|
+
'd3',
|
|
2076
|
+
'd3en',
|
|
2077
|
+
'dl1',
|
|
2078
|
+
'dl2q',
|
|
2079
|
+
'e2',
|
|
2080
|
+
'f1',
|
|
2081
|
+
'f2',
|
|
2082
|
+
'g1',
|
|
2083
|
+
'g2',
|
|
2084
|
+
'g4ad',
|
|
2085
|
+
'g4dn',
|
|
2086
|
+
'g5',
|
|
2087
|
+
'g5g',
|
|
2088
|
+
'g6',
|
|
2089
|
+
'g6e',
|
|
2090
|
+
'gr6',
|
|
2091
|
+
'h1',
|
|
2092
|
+
'h3',
|
|
2093
|
+
'hpc6a',
|
|
2094
|
+
'hpc6id',
|
|
2095
|
+
'hpc7a',
|
|
2096
|
+
'hpc7g',
|
|
2097
|
+
'i2',
|
|
2098
|
+
'i3',
|
|
2099
|
+
'i3en',
|
|
2100
|
+
'i4g',
|
|
2101
|
+
'i4i',
|
|
2102
|
+
'i7i',
|
|
2103
|
+
'i7ie',
|
|
2104
|
+
'i8g',
|
|
2105
|
+
'im4gn',
|
|
2106
|
+
'inf1',
|
|
2107
|
+
'inf2',
|
|
2108
|
+
'is4gen',
|
|
2109
|
+
'm1',
|
|
2110
|
+
'm2',
|
|
2111
|
+
'm3',
|
|
2112
|
+
'm4',
|
|
2113
|
+
'm5',
|
|
2114
|
+
'm5a',
|
|
2115
|
+
'm5ad',
|
|
2116
|
+
'm5d',
|
|
2117
|
+
'm5dn',
|
|
2118
|
+
'm5n',
|
|
2119
|
+
'm5zn',
|
|
2120
|
+
'm6a',
|
|
2121
|
+
'm6g',
|
|
2122
|
+
'm6gd',
|
|
2123
|
+
'm6i',
|
|
2124
|
+
'm6id',
|
|
2125
|
+
'm6idn',
|
|
2126
|
+
'm6in',
|
|
2127
|
+
'm7a',
|
|
2128
|
+
'm7g',
|
|
2129
|
+
'm7gd',
|
|
2130
|
+
'm7i',
|
|
2131
|
+
'm7i-flex',
|
|
2132
|
+
'm8g',
|
|
2133
|
+
'm8gd',
|
|
2134
|
+
'n1',
|
|
2135
|
+
'n2',
|
|
2136
|
+
'n2d',
|
|
2137
|
+
'n4',
|
|
2138
|
+
'p3',
|
|
2139
|
+
'p3dn',
|
|
2140
|
+
'p4d',
|
|
2141
|
+
'p4de',
|
|
2142
|
+
'p5',
|
|
2143
|
+
'p5e',
|
|
2144
|
+
'p5en',
|
|
2145
|
+
'p6-b200',
|
|
2146
|
+
'r3',
|
|
2147
|
+
'r4',
|
|
2148
|
+
'r5',
|
|
2149
|
+
'r5a',
|
|
2150
|
+
'r5ad',
|
|
2151
|
+
'r5b',
|
|
2152
|
+
'r5d',
|
|
2153
|
+
'r5dn',
|
|
2154
|
+
'r5n',
|
|
2155
|
+
'r6a',
|
|
2156
|
+
'r6g',
|
|
2157
|
+
'r6gd',
|
|
2158
|
+
'r6i',
|
|
2159
|
+
'r6id',
|
|
2160
|
+
'r6idn',
|
|
2161
|
+
'r6in',
|
|
2162
|
+
'r7a',
|
|
2163
|
+
'r7g',
|
|
2164
|
+
'r7gd',
|
|
2165
|
+
'r7i',
|
|
2166
|
+
'r7iz',
|
|
2167
|
+
'r8g',
|
|
2168
|
+
'r8gd',
|
|
2169
|
+
't2',
|
|
2170
|
+
't2a',
|
|
2171
|
+
't2d',
|
|
2172
|
+
't3',
|
|
2173
|
+
't3a',
|
|
2174
|
+
't4g',
|
|
2175
|
+
'trn1',
|
|
2176
|
+
'trn1n',
|
|
2177
|
+
'u-3tb1',
|
|
2178
|
+
'u-6tb1',
|
|
2179
|
+
'u7i-12tb',
|
|
2180
|
+
'u7i-6tb',
|
|
2181
|
+
'u7i-8tb',
|
|
2182
|
+
'u7in-16tb',
|
|
2183
|
+
'u7in-24tb',
|
|
2184
|
+
'u7in-32tb',
|
|
2185
|
+
'vt1',
|
|
2186
|
+
'x1',
|
|
2187
|
+
'x1e',
|
|
2188
|
+
'x2gd',
|
|
2189
|
+
'x2idn',
|
|
2190
|
+
'x2iedn',
|
|
2191
|
+
'x2iezn',
|
|
2192
|
+
'x4',
|
|
2193
|
+
'x8g',
|
|
2194
|
+
'z1d',
|
|
2195
|
+
'z3'
|
|
2196
|
+
]
|
|
2197
|
+
},
|
|
2198
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2199
|
+
default: []
|
|
2200
|
+
},
|
|
2201
|
+
'topology.kubernetes.io/region': {
|
|
2202
|
+
type: 'array',
|
|
2203
|
+
items: {
|
|
2204
|
+
type: 'string',
|
|
2205
|
+
enum: [
|
|
2206
|
+
'africa-south1',
|
|
2207
|
+
'ap-northeast-1',
|
|
2208
|
+
'ap-northeast-2',
|
|
2209
|
+
'ap-northeast-3',
|
|
2210
|
+
'ap-south-1',
|
|
2211
|
+
'ap-southeast-1',
|
|
2212
|
+
'ap-southeast-2',
|
|
2213
|
+
'ash',
|
|
2214
|
+
'asia-east1',
|
|
2215
|
+
'asia-east2',
|
|
2216
|
+
'asia-northeast1',
|
|
2217
|
+
'asia-northeast2',
|
|
2218
|
+
'asia-northeast3',
|
|
2219
|
+
'asia-south1',
|
|
2220
|
+
'asia-south2',
|
|
2221
|
+
'asia-southeast1',
|
|
2222
|
+
'asia-southeast2',
|
|
2223
|
+
'australia-southeast1',
|
|
2224
|
+
'australia-southeast2',
|
|
2225
|
+
'ca-central-1',
|
|
2226
|
+
'eu-central-1',
|
|
2227
|
+
'eu-central-2',
|
|
2228
|
+
'eu-north-1',
|
|
2229
|
+
'eu-west-1',
|
|
2230
|
+
'eu-west-2',
|
|
2231
|
+
'eu-west-3',
|
|
2232
|
+
'europe-central2',
|
|
2233
|
+
'europe-north1',
|
|
2234
|
+
'europe-southwest1',
|
|
2235
|
+
'europe-west1',
|
|
2236
|
+
'europe-west10',
|
|
2237
|
+
'europe-west12',
|
|
2238
|
+
'europe-west2',
|
|
2239
|
+
'europe-west3',
|
|
2240
|
+
'europe-west4',
|
|
2241
|
+
'europe-west6',
|
|
2242
|
+
'europe-west8',
|
|
2243
|
+
'europe-west9',
|
|
2244
|
+
'fsn1',
|
|
2245
|
+
'hel1',
|
|
2246
|
+
'hil',
|
|
2247
|
+
'me-central1',
|
|
2248
|
+
'me-central2',
|
|
2249
|
+
'me-west1',
|
|
2250
|
+
'nbg1',
|
|
2251
|
+
'northamerica-northeast1',
|
|
2252
|
+
'northamerica-northeast2',
|
|
2253
|
+
'sa-east-1',
|
|
2254
|
+
'sin',
|
|
2255
|
+
'southamerica-east1',
|
|
2256
|
+
'southamerica-west1',
|
|
2257
|
+
'us-central1',
|
|
2258
|
+
'us-east-1',
|
|
2259
|
+
'us-east-2',
|
|
2260
|
+
'us-east1',
|
|
2261
|
+
'us-east4',
|
|
2262
|
+
'us-east5',
|
|
2263
|
+
'us-south1',
|
|
2264
|
+
'us-west-1',
|
|
2265
|
+
'us-west-2',
|
|
2266
|
+
'us-west1',
|
|
2267
|
+
'us-west2',
|
|
2268
|
+
'us-west3',
|
|
2269
|
+
'us-west4'
|
|
2270
|
+
]
|
|
2271
|
+
},
|
|
2272
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2273
|
+
default: []
|
|
2274
|
+
}
|
|
2275
|
+
},
|
|
2276
|
+
additionalProperties: false,
|
|
2277
|
+
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.',
|
|
2278
|
+
default: {
|
|
2279
|
+
'karpenter.sh/capacity-type': [
|
|
2280
|
+
'on-demand',
|
|
2281
|
+
'spot'
|
|
2282
|
+
],
|
|
2283
|
+
'kubernetes.io/arch': [
|
|
2284
|
+
'amd64'
|
|
2285
|
+
],
|
|
2286
|
+
'cfke.io/instance-family': [],
|
|
2287
|
+
'topology.kubernetes.io/region': []
|
|
2288
|
+
}
|
|
2289
|
+
},
|
|
2290
|
+
scalingProfile: {
|
|
2291
|
+
type: 'string',
|
|
2292
|
+
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`).',
|
|
2293
|
+
default: 'conservative',
|
|
2294
|
+
example: 'conservative',
|
|
2295
|
+
enum: [
|
|
2296
|
+
'aggressive',
|
|
2297
|
+
'conservative'
|
|
2298
|
+
]
|
|
2299
|
+
},
|
|
2300
|
+
taints: {
|
|
2301
|
+
type: 'array',
|
|
2302
|
+
items: {
|
|
2303
|
+
type: 'object',
|
|
2304
|
+
properties: {
|
|
2305
|
+
key: {
|
|
2306
|
+
type: 'string',
|
|
2307
|
+
description: 'Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.',
|
|
2308
|
+
example: 'dedicated'
|
|
2309
|
+
},
|
|
2310
|
+
value: {
|
|
2311
|
+
type: 'string',
|
|
2312
|
+
maxLength: 63,
|
|
2313
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
2314
|
+
description: 'Taint value. Optional.',
|
|
2315
|
+
example: 'ci'
|
|
2316
|
+
},
|
|
2317
|
+
effect: {
|
|
2318
|
+
type: 'string',
|
|
2319
|
+
description: 'Taint effect.',
|
|
2320
|
+
example: 'NoSchedule',
|
|
2321
|
+
enum: [
|
|
2322
|
+
'NoSchedule',
|
|
2323
|
+
'PreferNoSchedule',
|
|
2324
|
+
'NoExecute'
|
|
2325
|
+
]
|
|
2326
|
+
}
|
|
2327
|
+
},
|
|
2328
|
+
required: [
|
|
2329
|
+
'key',
|
|
2330
|
+
'effect'
|
|
2331
|
+
],
|
|
2332
|
+
additionalProperties: false
|
|
2333
|
+
},
|
|
2334
|
+
maxItems: 50,
|
|
2335
|
+
description: 'Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.',
|
|
2336
|
+
default: []
|
|
965
2337
|
}
|
|
966
2338
|
},
|
|
2339
|
+
additionalProperties: false,
|
|
2340
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2341
|
+
};
|
|
2342
|
+
export const InviteCreateInputSchema = {
|
|
2343
|
+
type: 'object',
|
|
2344
|
+
properties: {
|
|
2345
|
+
email: {
|
|
2346
|
+
type: 'string',
|
|
2347
|
+
format: 'email',
|
|
2348
|
+
description: 'Email address of the user to invite.',
|
|
2349
|
+
example: 'email@example.com'
|
|
2350
|
+
},
|
|
2351
|
+
role: {
|
|
2352
|
+
type: 'string',
|
|
2353
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2354
|
+
default: 'User',
|
|
2355
|
+
example: 'User',
|
|
2356
|
+
enum: [
|
|
2357
|
+
'Administrator',
|
|
2358
|
+
'User'
|
|
2359
|
+
]
|
|
2360
|
+
}
|
|
2361
|
+
},
|
|
2362
|
+
required: [
|
|
2363
|
+
'email'
|
|
2364
|
+
],
|
|
967
2365
|
additionalProperties: false
|
|
968
2366
|
};
|
|
969
2367
|
export const InviteSchema = {
|
|
@@ -996,6 +2394,16 @@ export const InviteSchema = {
|
|
|
996
2394
|
type: 'string',
|
|
997
2395
|
description: 'Generated unique invite code.',
|
|
998
2396
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2397
|
+
},
|
|
2398
|
+
role: {
|
|
2399
|
+
type: 'string',
|
|
2400
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2401
|
+
default: 'User',
|
|
2402
|
+
example: 'User',
|
|
2403
|
+
enum: [
|
|
2404
|
+
'Administrator',
|
|
2405
|
+
'User'
|
|
2406
|
+
]
|
|
999
2407
|
}
|
|
1000
2408
|
},
|
|
1001
2409
|
required: [
|
|
@@ -1003,6 +2411,170 @@ export const InviteSchema = {
|
|
|
1003
2411
|
],
|
|
1004
2412
|
additionalProperties: false
|
|
1005
2413
|
};
|
|
2414
|
+
export const InvoicePaymentAttemptSchema = {
|
|
2415
|
+
type: 'object',
|
|
2416
|
+
properties: {
|
|
2417
|
+
invoice_id: {
|
|
2418
|
+
type: 'string',
|
|
2419
|
+
description: 'Identifier of the invoice.',
|
|
2420
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2421
|
+
},
|
|
2422
|
+
number: {
|
|
2423
|
+
type: 'string',
|
|
2424
|
+
nullable: true,
|
|
2425
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2426
|
+
example: 'CF-0042'
|
|
2427
|
+
},
|
|
2428
|
+
amount: {
|
|
2429
|
+
type: 'number',
|
|
2430
|
+
format: 'float',
|
|
2431
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2432
|
+
example: 4200
|
|
2433
|
+
},
|
|
2434
|
+
currency: {
|
|
2435
|
+
type: 'string',
|
|
2436
|
+
description: 'Currency of the invoice.',
|
|
2437
|
+
example: 'eur'
|
|
2438
|
+
},
|
|
2439
|
+
status: {
|
|
2440
|
+
type: 'string',
|
|
2441
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2442
|
+
example: 'paid',
|
|
2443
|
+
enum: [
|
|
2444
|
+
'paid',
|
|
2445
|
+
'processing',
|
|
2446
|
+
'requires_action',
|
|
2447
|
+
'failed'
|
|
2448
|
+
]
|
|
2449
|
+
},
|
|
2450
|
+
client_secret: {
|
|
2451
|
+
type: 'string',
|
|
2452
|
+
nullable: true,
|
|
2453
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2454
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2455
|
+
},
|
|
2456
|
+
failure_code: {
|
|
2457
|
+
type: 'string',
|
|
2458
|
+
nullable: true,
|
|
2459
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2460
|
+
example: 'insufficient_funds'
|
|
2461
|
+
},
|
|
2462
|
+
failure_message: {
|
|
2463
|
+
type: 'string',
|
|
2464
|
+
nullable: true,
|
|
2465
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2466
|
+
example: 'Your card has insufficient funds.'
|
|
2467
|
+
}
|
|
2468
|
+
},
|
|
2469
|
+
required: [
|
|
2470
|
+
'invoice_id',
|
|
2471
|
+
'number',
|
|
2472
|
+
'amount',
|
|
2473
|
+
'currency',
|
|
2474
|
+
'status',
|
|
2475
|
+
'client_secret',
|
|
2476
|
+
'failure_code',
|
|
2477
|
+
'failure_message'
|
|
2478
|
+
],
|
|
2479
|
+
additionalProperties: false
|
|
2480
|
+
};
|
|
2481
|
+
export const InvoicePaymentResultSchema = {
|
|
2482
|
+
type: 'object',
|
|
2483
|
+
properties: {
|
|
2484
|
+
code: {
|
|
2485
|
+
type: 'string',
|
|
2486
|
+
description: 'Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).',
|
|
2487
|
+
example: 'partially_paid',
|
|
2488
|
+
enum: [
|
|
2489
|
+
'paid',
|
|
2490
|
+
'processing',
|
|
2491
|
+
'action_required',
|
|
2492
|
+
'partially_paid',
|
|
2493
|
+
'failed',
|
|
2494
|
+
'nothing_due',
|
|
2495
|
+
'bank_transfer_due'
|
|
2496
|
+
]
|
|
2497
|
+
},
|
|
2498
|
+
message: {
|
|
2499
|
+
type: 'string',
|
|
2500
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2501
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
2502
|
+
},
|
|
2503
|
+
results: {
|
|
2504
|
+
type: 'array',
|
|
2505
|
+
items: {
|
|
2506
|
+
type: 'object',
|
|
2507
|
+
properties: {
|
|
2508
|
+
invoice_id: {
|
|
2509
|
+
type: 'string',
|
|
2510
|
+
description: 'Identifier of the invoice.',
|
|
2511
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2512
|
+
},
|
|
2513
|
+
number: {
|
|
2514
|
+
type: 'string',
|
|
2515
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2516
|
+
example: 'CF-0042'
|
|
2517
|
+
},
|
|
2518
|
+
amount: {
|
|
2519
|
+
type: 'number',
|
|
2520
|
+
format: 'float',
|
|
2521
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2522
|
+
example: 4200
|
|
2523
|
+
},
|
|
2524
|
+
currency: {
|
|
2525
|
+
type: 'string',
|
|
2526
|
+
description: 'Currency of the invoice.',
|
|
2527
|
+
example: 'eur'
|
|
2528
|
+
},
|
|
2529
|
+
status: {
|
|
2530
|
+
type: 'string',
|
|
2531
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2532
|
+
example: 'paid',
|
|
2533
|
+
enum: [
|
|
2534
|
+
'paid',
|
|
2535
|
+
'processing',
|
|
2536
|
+
'requires_action',
|
|
2537
|
+
'failed'
|
|
2538
|
+
]
|
|
2539
|
+
},
|
|
2540
|
+
client_secret: {
|
|
2541
|
+
type: 'string',
|
|
2542
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2543
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2544
|
+
},
|
|
2545
|
+
failure_code: {
|
|
2546
|
+
type: 'string',
|
|
2547
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2548
|
+
example: 'insufficient_funds'
|
|
2549
|
+
},
|
|
2550
|
+
failure_message: {
|
|
2551
|
+
type: 'string',
|
|
2552
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2553
|
+
example: 'Your card has insufficient funds.'
|
|
2554
|
+
}
|
|
2555
|
+
},
|
|
2556
|
+
required: [
|
|
2557
|
+
'invoice_id',
|
|
2558
|
+
'number',
|
|
2559
|
+
'amount',
|
|
2560
|
+
'currency',
|
|
2561
|
+
'status',
|
|
2562
|
+
'client_secret',
|
|
2563
|
+
'failure_code',
|
|
2564
|
+
'failure_message'
|
|
2565
|
+
],
|
|
2566
|
+
additionalProperties: false
|
|
2567
|
+
},
|
|
2568
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
2569
|
+
}
|
|
2570
|
+
},
|
|
2571
|
+
required: [
|
|
2572
|
+
'code',
|
|
2573
|
+
'message',
|
|
2574
|
+
'results'
|
|
2575
|
+
],
|
|
2576
|
+
additionalProperties: false
|
|
2577
|
+
};
|
|
1006
2578
|
export const InvoiceSchema = {
|
|
1007
2579
|
type: 'object',
|
|
1008
2580
|
properties: {
|
|
@@ -1216,6 +2788,15 @@ export const MarketplaceListingSchema = {
|
|
|
1216
2788
|
export const OrganizationCreateInputSchema = {
|
|
1217
2789
|
type: 'object',
|
|
1218
2790
|
properties: {
|
|
2791
|
+
type: {
|
|
2792
|
+
type: 'string',
|
|
2793
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2794
|
+
example: 'business',
|
|
2795
|
+
enum: [
|
|
2796
|
+
'business',
|
|
2797
|
+
'personal'
|
|
2798
|
+
]
|
|
2799
|
+
},
|
|
1219
2800
|
email: {
|
|
1220
2801
|
type: 'string',
|
|
1221
2802
|
format: 'email',
|
|
@@ -1224,11 +2805,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1224
2805
|
},
|
|
1225
2806
|
first_name: {
|
|
1226
2807
|
type: 'string',
|
|
2808
|
+
minLength: 1,
|
|
1227
2809
|
description: 'First name of the billing contact person.',
|
|
1228
2810
|
example: 'John'
|
|
1229
2811
|
},
|
|
1230
2812
|
last_name: {
|
|
1231
2813
|
type: 'string',
|
|
2814
|
+
minLength: 1,
|
|
1232
2815
|
description: 'Last name of the billing contact person.',
|
|
1233
2816
|
example: 'Doe'
|
|
1234
2817
|
},
|
|
@@ -1247,6 +2830,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
1247
2830
|
}
|
|
1248
2831
|
},
|
|
1249
2832
|
required: [
|
|
2833
|
+
'type',
|
|
1250
2834
|
'email',
|
|
1251
2835
|
'first_name',
|
|
1252
2836
|
'last_name',
|
|
@@ -1255,6 +2839,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
1255
2839
|
],
|
|
1256
2840
|
additionalProperties: false
|
|
1257
2841
|
};
|
|
2842
|
+
export const OrganizationCreateOutputSchema = {
|
|
2843
|
+
type: 'object',
|
|
2844
|
+
properties: {
|
|
2845
|
+
id: {
|
|
2846
|
+
type: 'string',
|
|
2847
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2848
|
+
example: 'organization-id'
|
|
2849
|
+
}
|
|
2850
|
+
},
|
|
2851
|
+
required: [
|
|
2852
|
+
'id'
|
|
2853
|
+
],
|
|
2854
|
+
additionalProperties: false
|
|
2855
|
+
};
|
|
1258
2856
|
export const OrganizationSchema = {
|
|
1259
2857
|
type: 'object',
|
|
1260
2858
|
properties: {
|
|
@@ -1271,6 +2869,15 @@ export const OrganizationSchema = {
|
|
|
1271
2869
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
1272
2870
|
example: 'ACME Corp.'
|
|
1273
2871
|
},
|
|
2872
|
+
type: {
|
|
2873
|
+
type: 'string',
|
|
2874
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2875
|
+
example: 'business',
|
|
2876
|
+
enum: [
|
|
2877
|
+
'business',
|
|
2878
|
+
'personal'
|
|
2879
|
+
]
|
|
2880
|
+
},
|
|
1274
2881
|
date_created: {
|
|
1275
2882
|
type: 'string',
|
|
1276
2883
|
format: 'date-time',
|
|
@@ -1302,6 +2909,17 @@ export const OrganizationSchema = {
|
|
|
1302
2909
|
description: 'Available number of Pro clusters that can be created.',
|
|
1303
2910
|
example: 999
|
|
1304
2911
|
},
|
|
2912
|
+
enterprise_clusters_max: {
|
|
2913
|
+
type: 'integer',
|
|
2914
|
+
minimum: 0,
|
|
2915
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2916
|
+
example: 999
|
|
2917
|
+
},
|
|
2918
|
+
enterprise_clusters_available: {
|
|
2919
|
+
type: 'integer',
|
|
2920
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2921
|
+
example: 999
|
|
2922
|
+
},
|
|
1305
2923
|
fleets_max: {
|
|
1306
2924
|
type: 'integer',
|
|
1307
2925
|
minimum: 0,
|
|
@@ -1321,7 +2939,7 @@ export const OrganizationSchema = {
|
|
|
1321
2939
|
type: 'array',
|
|
1322
2940
|
items: {
|
|
1323
2941
|
type: 'string',
|
|
1324
|
-
example: 'northamerica-central-
|
|
2942
|
+
example: 'northamerica-central-1a'
|
|
1325
2943
|
},
|
|
1326
2944
|
minItems: 1,
|
|
1327
2945
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1363,6 +2981,8 @@ export const OrganizationSchema = {
|
|
|
1363
2981
|
'basic_clusters_available',
|
|
1364
2982
|
'pro_clusters_max',
|
|
1365
2983
|
'pro_clusters_available',
|
|
2984
|
+
'enterprise_clusters_max',
|
|
2985
|
+
'enterprise_clusters_available',
|
|
1366
2986
|
'fleets_max',
|
|
1367
2987
|
'cluster_tiers',
|
|
1368
2988
|
'regions',
|
|
@@ -1380,13 +3000,25 @@ export const OrganizationSchema = {
|
|
|
1380
3000
|
'closed',
|
|
1381
3001
|
'suspended'
|
|
1382
3002
|
]
|
|
3003
|
+
},
|
|
3004
|
+
verification: {
|
|
3005
|
+
type: 'string',
|
|
3006
|
+
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.',
|
|
3007
|
+
example: 'verified',
|
|
3008
|
+
enum: [
|
|
3009
|
+
'none',
|
|
3010
|
+
'submitted',
|
|
3011
|
+
'verified'
|
|
3012
|
+
]
|
|
1383
3013
|
}
|
|
1384
3014
|
},
|
|
1385
3015
|
required: [
|
|
1386
3016
|
'id',
|
|
3017
|
+
'type',
|
|
1387
3018
|
'date_created',
|
|
1388
3019
|
'quota',
|
|
1389
|
-
'status'
|
|
3020
|
+
'status',
|
|
3021
|
+
'verification'
|
|
1390
3022
|
],
|
|
1391
3023
|
additionalProperties: false
|
|
1392
3024
|
};
|
|
@@ -1395,28 +3027,23 @@ export const PaymentMethodSchema = {
|
|
|
1395
3027
|
properties: {
|
|
1396
3028
|
id: {
|
|
1397
3029
|
type: 'string',
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
1401
|
-
},
|
|
1402
|
-
setup: {
|
|
1403
|
-
type: 'boolean',
|
|
1404
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
1405
|
-
example: true
|
|
3030
|
+
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.',
|
|
3031
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
1406
3032
|
},
|
|
1407
3033
|
type: {
|
|
1408
3034
|
type: 'string',
|
|
1409
|
-
|
|
1410
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
3035
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
1411
3036
|
example: 'card',
|
|
1412
3037
|
enum: [
|
|
1413
|
-
'card'
|
|
3038
|
+
'card',
|
|
3039
|
+
'sepa_debit',
|
|
3040
|
+
'bank_transfer'
|
|
1414
3041
|
]
|
|
1415
3042
|
},
|
|
1416
3043
|
last4: {
|
|
1417
3044
|
type: 'string',
|
|
1418
3045
|
nullable: true,
|
|
1419
|
-
description: 'Last 4 digits of the payment card number.',
|
|
3046
|
+
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.',
|
|
1420
3047
|
example: '4242'
|
|
1421
3048
|
},
|
|
1422
3049
|
exp_month: {
|
|
@@ -1424,42 +3051,56 @@ export const PaymentMethodSchema = {
|
|
|
1424
3051
|
minimum: 1,
|
|
1425
3052
|
maximum: 12,
|
|
1426
3053
|
nullable: true,
|
|
1427
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
1428
|
-
example:
|
|
3054
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
3055
|
+
example: 12
|
|
1429
3056
|
},
|
|
1430
3057
|
exp_year: {
|
|
1431
3058
|
type: 'integer',
|
|
1432
|
-
minimum: 2024,
|
|
1433
3059
|
nullable: true,
|
|
1434
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
1435
|
-
example:
|
|
3060
|
+
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.',
|
|
3061
|
+
example: 2028
|
|
1436
3062
|
},
|
|
1437
3063
|
brand: {
|
|
1438
3064
|
type: 'string',
|
|
1439
3065
|
nullable: true,
|
|
1440
|
-
description: 'Payment card brand
|
|
1441
|
-
example: 'visa'
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
3066
|
+
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.',
|
|
3067
|
+
example: 'visa'
|
|
3068
|
+
},
|
|
3069
|
+
iban: {
|
|
3070
|
+
type: 'string',
|
|
3071
|
+
nullable: true,
|
|
3072
|
+
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.',
|
|
3073
|
+
example: 'DE11243015658023127510'
|
|
3074
|
+
},
|
|
3075
|
+
bic: {
|
|
3076
|
+
type: 'string',
|
|
3077
|
+
nullable: true,
|
|
3078
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3079
|
+
example: 'SOGEDEFFXXX'
|
|
3080
|
+
},
|
|
3081
|
+
account_holder_name: {
|
|
3082
|
+
type: 'string',
|
|
3083
|
+
nullable: true,
|
|
3084
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
3085
|
+
example: 'Cloudfleet GmbH'
|
|
3086
|
+
},
|
|
3087
|
+
is_default: {
|
|
3088
|
+
type: 'boolean',
|
|
3089
|
+
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).',
|
|
3090
|
+
example: true
|
|
1453
3091
|
}
|
|
1454
3092
|
},
|
|
1455
3093
|
required: [
|
|
1456
3094
|
'id',
|
|
1457
|
-
'setup',
|
|
1458
3095
|
'type',
|
|
1459
3096
|
'last4',
|
|
1460
3097
|
'exp_month',
|
|
1461
3098
|
'exp_year',
|
|
1462
|
-
'brand'
|
|
3099
|
+
'brand',
|
|
3100
|
+
'iban',
|
|
3101
|
+
'bic',
|
|
3102
|
+
'account_holder_name',
|
|
3103
|
+
'is_default'
|
|
1463
3104
|
],
|
|
1464
3105
|
additionalProperties: false
|
|
1465
3106
|
};
|
|
@@ -1474,18 +3115,29 @@ export const PlatformQuotaSchema = {
|
|
|
1474
3115
|
},
|
|
1475
3116
|
basic_clusters_available: {
|
|
1476
3117
|
type: 'integer',
|
|
1477
|
-
description: 'Available number of Basic clusters that can be created.',
|
|
3118
|
+
description: 'Available number of Basic clusters that can be created.',
|
|
3119
|
+
example: 999
|
|
3120
|
+
},
|
|
3121
|
+
pro_clusters_max: {
|
|
3122
|
+
type: 'integer',
|
|
3123
|
+
minimum: 0,
|
|
3124
|
+
description: 'Maximum number of Pro clusters that can be created.',
|
|
3125
|
+
example: 999
|
|
3126
|
+
},
|
|
3127
|
+
pro_clusters_available: {
|
|
3128
|
+
type: 'integer',
|
|
3129
|
+
description: 'Available number of Pro clusters that can be created.',
|
|
1478
3130
|
example: 999
|
|
1479
3131
|
},
|
|
1480
|
-
|
|
3132
|
+
enterprise_clusters_max: {
|
|
1481
3133
|
type: 'integer',
|
|
1482
3134
|
minimum: 0,
|
|
1483
|
-
description: 'Maximum number of
|
|
3135
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
1484
3136
|
example: 999
|
|
1485
3137
|
},
|
|
1486
|
-
|
|
3138
|
+
enterprise_clusters_available: {
|
|
1487
3139
|
type: 'integer',
|
|
1488
|
-
description: 'Available number of
|
|
3140
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
1489
3141
|
example: 999
|
|
1490
3142
|
},
|
|
1491
3143
|
fleets_max: {
|
|
@@ -1507,7 +3159,7 @@ export const PlatformQuotaSchema = {
|
|
|
1507
3159
|
type: 'array',
|
|
1508
3160
|
items: {
|
|
1509
3161
|
type: 'string',
|
|
1510
|
-
example: 'northamerica-central-
|
|
3162
|
+
example: 'northamerica-central-1a'
|
|
1511
3163
|
},
|
|
1512
3164
|
minItems: 1,
|
|
1513
3165
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -1549,6 +3201,8 @@ export const PlatformQuotaSchema = {
|
|
|
1549
3201
|
'basic_clusters_available',
|
|
1550
3202
|
'pro_clusters_max',
|
|
1551
3203
|
'pro_clusters_available',
|
|
3204
|
+
'enterprise_clusters_max',
|
|
3205
|
+
'enterprise_clusters_available',
|
|
1552
3206
|
'fleets_max',
|
|
1553
3207
|
'cluster_tiers',
|
|
1554
3208
|
'regions',
|
|
@@ -1822,6 +3476,415 @@ export const RegistryTagSchema = {
|
|
|
1822
3476
|
],
|
|
1823
3477
|
additionalProperties: false
|
|
1824
3478
|
};
|
|
3479
|
+
export const RoadmapItemCreateInputSchema = {
|
|
3480
|
+
type: 'object',
|
|
3481
|
+
properties: {
|
|
3482
|
+
text: {
|
|
3483
|
+
type: 'string',
|
|
3484
|
+
maxLength: 500,
|
|
3485
|
+
minLength: 1,
|
|
3486
|
+
description: 'Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.',
|
|
3487
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3488
|
+
}
|
|
3489
|
+
},
|
|
3490
|
+
required: [
|
|
3491
|
+
'text'
|
|
3492
|
+
],
|
|
3493
|
+
additionalProperties: false
|
|
3494
|
+
};
|
|
3495
|
+
export const RoadmapItemSchema = {
|
|
3496
|
+
type: 'object',
|
|
3497
|
+
properties: {
|
|
3498
|
+
id: {
|
|
3499
|
+
type: 'string',
|
|
3500
|
+
description: 'Unique identifier of the roadmap item (Mongo ObjectId).',
|
|
3501
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3502
|
+
},
|
|
3503
|
+
text: {
|
|
3504
|
+
type: 'string',
|
|
3505
|
+
description: 'Short description of the roadmap item.',
|
|
3506
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3507
|
+
},
|
|
3508
|
+
vote: {
|
|
3509
|
+
type: 'integer',
|
|
3510
|
+
nullable: true,
|
|
3511
|
+
description: 'The caller\'s vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.',
|
|
3512
|
+
example: 1,
|
|
3513
|
+
enum: [
|
|
3514
|
+
-1,
|
|
3515
|
+
1,
|
|
3516
|
+
2
|
|
3517
|
+
]
|
|
3518
|
+
}
|
|
3519
|
+
},
|
|
3520
|
+
required: [
|
|
3521
|
+
'id',
|
|
3522
|
+
'text',
|
|
3523
|
+
'vote'
|
|
3524
|
+
],
|
|
3525
|
+
additionalProperties: false
|
|
3526
|
+
};
|
|
3527
|
+
export const RoadmapVoteInputSchema = {
|
|
3528
|
+
type: 'object',
|
|
3529
|
+
properties: {
|
|
3530
|
+
value: {
|
|
3531
|
+
type: 'integer',
|
|
3532
|
+
description: 'Vote value: -1 (down), 1 (up), or 2 (double up).',
|
|
3533
|
+
example: 1,
|
|
3534
|
+
enum: [
|
|
3535
|
+
-1,
|
|
3536
|
+
1,
|
|
3537
|
+
2
|
|
3538
|
+
]
|
|
3539
|
+
}
|
|
3540
|
+
},
|
|
3541
|
+
required: [
|
|
3542
|
+
'value'
|
|
3543
|
+
],
|
|
3544
|
+
additionalProperties: false
|
|
3545
|
+
};
|
|
3546
|
+
export const TicketAttachmentSchema = {
|
|
3547
|
+
type: 'object',
|
|
3548
|
+
properties: {
|
|
3549
|
+
id: {
|
|
3550
|
+
type: 'string',
|
|
3551
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3552
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3553
|
+
},
|
|
3554
|
+
filename: {
|
|
3555
|
+
type: 'string',
|
|
3556
|
+
description: 'Original filename as uploaded.',
|
|
3557
|
+
example: 'debug.log'
|
|
3558
|
+
},
|
|
3559
|
+
content_type: {
|
|
3560
|
+
type: 'string',
|
|
3561
|
+
description: 'MIME content type of the attachment.',
|
|
3562
|
+
example: 'text/plain'
|
|
3563
|
+
},
|
|
3564
|
+
size: {
|
|
3565
|
+
type: 'integer',
|
|
3566
|
+
description: 'Size of the attachment in bytes.',
|
|
3567
|
+
example: 12345
|
|
3568
|
+
}
|
|
3569
|
+
},
|
|
3570
|
+
required: [
|
|
3571
|
+
'id',
|
|
3572
|
+
'filename',
|
|
3573
|
+
'content_type',
|
|
3574
|
+
'size'
|
|
3575
|
+
],
|
|
3576
|
+
additionalProperties: false
|
|
3577
|
+
};
|
|
3578
|
+
export const TicketCreateInputSchema = {
|
|
3579
|
+
type: 'object',
|
|
3580
|
+
properties: {
|
|
3581
|
+
category: {
|
|
3582
|
+
type: 'string',
|
|
3583
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
3584
|
+
example: 'technical',
|
|
3585
|
+
enum: [
|
|
3586
|
+
'billing',
|
|
3587
|
+
'technical',
|
|
3588
|
+
'general'
|
|
3589
|
+
]
|
|
3590
|
+
},
|
|
3591
|
+
body: {
|
|
3592
|
+
type: 'string',
|
|
3593
|
+
maxLength: 50000,
|
|
3594
|
+
minLength: 1,
|
|
3595
|
+
pattern: '\\S',
|
|
3596
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
3597
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3598
|
+
},
|
|
3599
|
+
properties: {
|
|
3600
|
+
type: 'object',
|
|
3601
|
+
additionalProperties: true,
|
|
3602
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
3603
|
+
example: {
|
|
3604
|
+
subcategory: 'cluster-question',
|
|
3605
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
3606
|
+
}
|
|
3607
|
+
},
|
|
3608
|
+
grant_support_access: {
|
|
3609
|
+
type: 'boolean',
|
|
3610
|
+
description: 'Grant Cloudfleet support staff access to the organization\'s resources while the ticket is open. Access cannot be revoked; it ends when the ticket is closed.',
|
|
3611
|
+
example: true
|
|
3612
|
+
}
|
|
3613
|
+
},
|
|
3614
|
+
required: [
|
|
3615
|
+
'category',
|
|
3616
|
+
'body'
|
|
3617
|
+
],
|
|
3618
|
+
additionalProperties: false
|
|
3619
|
+
};
|
|
3620
|
+
export const TicketMessageInputSchema = {
|
|
3621
|
+
type: 'object',
|
|
3622
|
+
properties: {
|
|
3623
|
+
body: {
|
|
3624
|
+
type: 'string',
|
|
3625
|
+
maxLength: 50000,
|
|
3626
|
+
minLength: 1,
|
|
3627
|
+
pattern: '\\S',
|
|
3628
|
+
description: 'Reply body in markdown.',
|
|
3629
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3630
|
+
}
|
|
3631
|
+
},
|
|
3632
|
+
required: [
|
|
3633
|
+
'body'
|
|
3634
|
+
],
|
|
3635
|
+
additionalProperties: false
|
|
3636
|
+
};
|
|
3637
|
+
export const TicketMessageSchema = {
|
|
3638
|
+
type: 'object',
|
|
3639
|
+
properties: {
|
|
3640
|
+
id: {
|
|
3641
|
+
type: 'string',
|
|
3642
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3643
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3644
|
+
},
|
|
3645
|
+
type: {
|
|
3646
|
+
type: 'string',
|
|
3647
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3648
|
+
example: 'customer_reply',
|
|
3649
|
+
enum: [
|
|
3650
|
+
'customer_reply',
|
|
3651
|
+
'agent_reply'
|
|
3652
|
+
]
|
|
3653
|
+
},
|
|
3654
|
+
body: {
|
|
3655
|
+
type: 'string',
|
|
3656
|
+
description: 'Message body in markdown.',
|
|
3657
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3658
|
+
},
|
|
3659
|
+
author_first_name: {
|
|
3660
|
+
type: 'string',
|
|
3661
|
+
nullable: true,
|
|
3662
|
+
description: 'First name of the author. Null when not provided.',
|
|
3663
|
+
example: 'Jane'
|
|
3664
|
+
},
|
|
3665
|
+
author_last_name: {
|
|
3666
|
+
type: 'string',
|
|
3667
|
+
nullable: true,
|
|
3668
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3669
|
+
example: 'Doe'
|
|
3670
|
+
},
|
|
3671
|
+
attachments: {
|
|
3672
|
+
type: 'array',
|
|
3673
|
+
items: {
|
|
3674
|
+
type: 'object',
|
|
3675
|
+
properties: {
|
|
3676
|
+
id: {
|
|
3677
|
+
type: 'string',
|
|
3678
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3679
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3680
|
+
},
|
|
3681
|
+
filename: {
|
|
3682
|
+
type: 'string',
|
|
3683
|
+
description: 'Original filename as uploaded.',
|
|
3684
|
+
example: 'debug.log'
|
|
3685
|
+
},
|
|
3686
|
+
content_type: {
|
|
3687
|
+
type: 'string',
|
|
3688
|
+
description: 'MIME content type of the attachment.',
|
|
3689
|
+
example: 'text/plain'
|
|
3690
|
+
},
|
|
3691
|
+
size: {
|
|
3692
|
+
type: 'integer',
|
|
3693
|
+
description: 'Size of the attachment in bytes.',
|
|
3694
|
+
example: 12345
|
|
3695
|
+
}
|
|
3696
|
+
},
|
|
3697
|
+
required: [
|
|
3698
|
+
'id',
|
|
3699
|
+
'filename',
|
|
3700
|
+
'content_type',
|
|
3701
|
+
'size'
|
|
3702
|
+
],
|
|
3703
|
+
additionalProperties: false
|
|
3704
|
+
},
|
|
3705
|
+
description: 'Attachments associated with this message.',
|
|
3706
|
+
example: []
|
|
3707
|
+
},
|
|
3708
|
+
date_created: {
|
|
3709
|
+
type: 'string',
|
|
3710
|
+
format: 'date-time',
|
|
3711
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3712
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3713
|
+
}
|
|
3714
|
+
},
|
|
3715
|
+
required: [
|
|
3716
|
+
'id',
|
|
3717
|
+
'type',
|
|
3718
|
+
'body',
|
|
3719
|
+
'date_created'
|
|
3720
|
+
],
|
|
3721
|
+
additionalProperties: false
|
|
3722
|
+
};
|
|
3723
|
+
export const TicketSchema = {
|
|
3724
|
+
type: 'object',
|
|
3725
|
+
properties: {
|
|
3726
|
+
id: {
|
|
3727
|
+
type: 'string',
|
|
3728
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
3729
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3730
|
+
},
|
|
3731
|
+
status: {
|
|
3732
|
+
type: 'string',
|
|
3733
|
+
description: 'Current state of the ticket.',
|
|
3734
|
+
example: 'waiting_on_us',
|
|
3735
|
+
enum: [
|
|
3736
|
+
'waiting_on_us',
|
|
3737
|
+
'waiting_on_user',
|
|
3738
|
+
'closed'
|
|
3739
|
+
]
|
|
3740
|
+
},
|
|
3741
|
+
category: {
|
|
3742
|
+
type: 'string',
|
|
3743
|
+
description: 'Ticket category.',
|
|
3744
|
+
example: 'technical',
|
|
3745
|
+
enum: [
|
|
3746
|
+
'billing',
|
|
3747
|
+
'technical',
|
|
3748
|
+
'general'
|
|
3749
|
+
]
|
|
3750
|
+
},
|
|
3751
|
+
summary: {
|
|
3752
|
+
type: 'string',
|
|
3753
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3754
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3755
|
+
},
|
|
3756
|
+
support_access_granted: {
|
|
3757
|
+
type: 'boolean',
|
|
3758
|
+
description: 'Whether Cloudfleet support staff currently have access to the organization\'s resources. True once access is granted and until the ticket is closed.',
|
|
3759
|
+
example: true
|
|
3760
|
+
},
|
|
3761
|
+
support_access_granted_at: {
|
|
3762
|
+
type: 'string',
|
|
3763
|
+
format: 'date-time',
|
|
3764
|
+
nullable: true,
|
|
3765
|
+
description: 'When support access was granted. Null if it never was. Kept after the ticket is closed.',
|
|
3766
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3767
|
+
},
|
|
3768
|
+
closed_at: {
|
|
3769
|
+
type: 'string',
|
|
3770
|
+
format: 'date-time',
|
|
3771
|
+
nullable: true,
|
|
3772
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3773
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
3774
|
+
},
|
|
3775
|
+
date_created: {
|
|
3776
|
+
type: 'string',
|
|
3777
|
+
format: 'date-time',
|
|
3778
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
3779
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3780
|
+
},
|
|
3781
|
+
date_updated: {
|
|
3782
|
+
type: 'string',
|
|
3783
|
+
format: 'date-time',
|
|
3784
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
3785
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3786
|
+
},
|
|
3787
|
+
messages: {
|
|
3788
|
+
type: 'array',
|
|
3789
|
+
items: {
|
|
3790
|
+
type: 'object',
|
|
3791
|
+
properties: {
|
|
3792
|
+
id: {
|
|
3793
|
+
type: 'string',
|
|
3794
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3795
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3796
|
+
},
|
|
3797
|
+
type: {
|
|
3798
|
+
type: 'string',
|
|
3799
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3800
|
+
example: 'customer_reply',
|
|
3801
|
+
enum: [
|
|
3802
|
+
'customer_reply',
|
|
3803
|
+
'agent_reply'
|
|
3804
|
+
]
|
|
3805
|
+
},
|
|
3806
|
+
body: {
|
|
3807
|
+
type: 'string',
|
|
3808
|
+
description: 'Message body in markdown.',
|
|
3809
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3810
|
+
},
|
|
3811
|
+
author_first_name: {
|
|
3812
|
+
type: 'string',
|
|
3813
|
+
description: 'First name of the author. Null when not provided.',
|
|
3814
|
+
example: 'Jane'
|
|
3815
|
+
},
|
|
3816
|
+
author_last_name: {
|
|
3817
|
+
type: 'string',
|
|
3818
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3819
|
+
example: 'Doe'
|
|
3820
|
+
},
|
|
3821
|
+
attachments: {
|
|
3822
|
+
type: 'array',
|
|
3823
|
+
items: {
|
|
3824
|
+
type: 'object',
|
|
3825
|
+
properties: {
|
|
3826
|
+
id: {
|
|
3827
|
+
type: 'string',
|
|
3828
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3829
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3830
|
+
},
|
|
3831
|
+
filename: {
|
|
3832
|
+
type: 'string',
|
|
3833
|
+
description: 'Original filename as uploaded.',
|
|
3834
|
+
example: 'debug.log'
|
|
3835
|
+
},
|
|
3836
|
+
content_type: {
|
|
3837
|
+
type: 'string',
|
|
3838
|
+
description: 'MIME content type of the attachment.',
|
|
3839
|
+
example: 'text/plain'
|
|
3840
|
+
},
|
|
3841
|
+
size: {
|
|
3842
|
+
type: 'integer',
|
|
3843
|
+
description: 'Size of the attachment in bytes.',
|
|
3844
|
+
example: 12345
|
|
3845
|
+
}
|
|
3846
|
+
},
|
|
3847
|
+
required: [
|
|
3848
|
+
'id',
|
|
3849
|
+
'filename',
|
|
3850
|
+
'content_type',
|
|
3851
|
+
'size'
|
|
3852
|
+
],
|
|
3853
|
+
additionalProperties: false
|
|
3854
|
+
},
|
|
3855
|
+
description: 'Attachments associated with this message.',
|
|
3856
|
+
example: []
|
|
3857
|
+
},
|
|
3858
|
+
date_created: {
|
|
3859
|
+
type: 'string',
|
|
3860
|
+
format: 'date-time',
|
|
3861
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3862
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3863
|
+
}
|
|
3864
|
+
},
|
|
3865
|
+
required: [
|
|
3866
|
+
'id',
|
|
3867
|
+
'type',
|
|
3868
|
+
'body',
|
|
3869
|
+
'date_created'
|
|
3870
|
+
],
|
|
3871
|
+
additionalProperties: false
|
|
3872
|
+
},
|
|
3873
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
3874
|
+
}
|
|
3875
|
+
},
|
|
3876
|
+
required: [
|
|
3877
|
+
'id',
|
|
3878
|
+
'status',
|
|
3879
|
+
'category',
|
|
3880
|
+
'summary',
|
|
3881
|
+
'support_access_granted',
|
|
3882
|
+
'support_access_granted_at',
|
|
3883
|
+
'date_created',
|
|
3884
|
+
'date_updated'
|
|
3885
|
+
],
|
|
3886
|
+
additionalProperties: false
|
|
3887
|
+
};
|
|
1825
3888
|
export const TokenCreateInputSchema = {
|
|
1826
3889
|
type: 'object',
|
|
1827
3890
|
properties: {
|
|
@@ -1932,12 +3995,21 @@ export const UsageFacetsSchema = {
|
|
|
1932
3995
|
product: {
|
|
1933
3996
|
type: 'array',
|
|
1934
3997
|
items: {
|
|
1935
|
-
type: 'string'
|
|
3998
|
+
type: 'string',
|
|
3999
|
+
enum: [
|
|
4000
|
+
'cfke_controlplane_basic',
|
|
4001
|
+
'cfke_controlplane_pro',
|
|
4002
|
+
'cfke_controlplane_enterprise',
|
|
4003
|
+
'cfke_connected_nodes_basic',
|
|
4004
|
+
'cfke_connected_nodes_pro',
|
|
4005
|
+
'cfke_connected_nodes_enterprise',
|
|
4006
|
+
'cfcr_storage'
|
|
4007
|
+
]
|
|
1936
4008
|
},
|
|
1937
4009
|
description: 'List of unique products',
|
|
1938
4010
|
example: [
|
|
1939
|
-
'
|
|
1940
|
-
'
|
|
4011
|
+
'cfke_controlplane_pro',
|
|
4012
|
+
'cfke_connected_nodes_pro'
|
|
1941
4013
|
]
|
|
1942
4014
|
}
|
|
1943
4015
|
},
|
|
@@ -1964,7 +4036,16 @@ export const UsageResponseSchema = {
|
|
|
1964
4036
|
product: {
|
|
1965
4037
|
type: 'string',
|
|
1966
4038
|
description: 'The product the usage is associated with',
|
|
1967
|
-
example: '
|
|
4039
|
+
example: 'cfke_controlplane_pro',
|
|
4040
|
+
enum: [
|
|
4041
|
+
'cfke_controlplane_basic',
|
|
4042
|
+
'cfke_controlplane_pro',
|
|
4043
|
+
'cfke_controlplane_enterprise',
|
|
4044
|
+
'cfke_connected_nodes_basic',
|
|
4045
|
+
'cfke_connected_nodes_pro',
|
|
4046
|
+
'cfke_connected_nodes_enterprise',
|
|
4047
|
+
'cfcr_storage'
|
|
4048
|
+
]
|
|
1968
4049
|
},
|
|
1969
4050
|
value: {
|
|
1970
4051
|
type: 'number',
|
|
@@ -2012,12 +4093,21 @@ export const UsageResponseSchema = {
|
|
|
2012
4093
|
product: {
|
|
2013
4094
|
type: 'array',
|
|
2014
4095
|
items: {
|
|
2015
|
-
type: 'string'
|
|
4096
|
+
type: 'string',
|
|
4097
|
+
enum: [
|
|
4098
|
+
'cfke_controlplane_basic',
|
|
4099
|
+
'cfke_controlplane_pro',
|
|
4100
|
+
'cfke_controlplane_enterprise',
|
|
4101
|
+
'cfke_connected_nodes_basic',
|
|
4102
|
+
'cfke_connected_nodes_pro',
|
|
4103
|
+
'cfke_connected_nodes_enterprise',
|
|
4104
|
+
'cfcr_storage'
|
|
4105
|
+
]
|
|
2016
4106
|
},
|
|
2017
4107
|
description: 'List of unique products',
|
|
2018
4108
|
example: [
|
|
2019
|
-
'
|
|
2020
|
-
'
|
|
4109
|
+
'cfke_controlplane_pro',
|
|
4110
|
+
'cfke_connected_nodes_pro'
|
|
2021
4111
|
]
|
|
2022
4112
|
}
|
|
2023
4113
|
},
|
|
@@ -2047,7 +4137,16 @@ export const UsageSchema = {
|
|
|
2047
4137
|
product: {
|
|
2048
4138
|
type: 'string',
|
|
2049
4139
|
description: 'The product the usage is associated with',
|
|
2050
|
-
example: '
|
|
4140
|
+
example: 'cfke_controlplane_pro',
|
|
4141
|
+
enum: [
|
|
4142
|
+
'cfke_controlplane_basic',
|
|
4143
|
+
'cfke_controlplane_pro',
|
|
4144
|
+
'cfke_controlplane_enterprise',
|
|
4145
|
+
'cfke_connected_nodes_basic',
|
|
4146
|
+
'cfke_connected_nodes_pro',
|
|
4147
|
+
'cfke_connected_nodes_enterprise',
|
|
4148
|
+
'cfcr_storage'
|
|
4149
|
+
]
|
|
2051
4150
|
},
|
|
2052
4151
|
value: {
|
|
2053
4152
|
type: 'number',
|
|
@@ -2110,24 +4209,6 @@ export const UserCreateInputSchema = {
|
|
|
2110
4209
|
type: 'string',
|
|
2111
4210
|
minLength: 8,
|
|
2112
4211
|
description: 'User password. Must be at least 8 characters long.'
|
|
2113
|
-
},
|
|
2114
|
-
status: {
|
|
2115
|
-
type: 'string',
|
|
2116
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
2117
|
-
example: 'active',
|
|
2118
|
-
enum: [
|
|
2119
|
-
'active',
|
|
2120
|
-
'inactive'
|
|
2121
|
-
]
|
|
2122
|
-
},
|
|
2123
|
-
role: {
|
|
2124
|
-
type: 'string',
|
|
2125
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
2126
|
-
example: 'User',
|
|
2127
|
-
enum: [
|
|
2128
|
-
'Administrator',
|
|
2129
|
-
'User'
|
|
2130
|
-
]
|
|
2131
4212
|
}
|
|
2132
4213
|
},
|
|
2133
4214
|
required: [
|