@cloudfleet/sdk 0.0.1-0010e2d → 0.0.1-019156c
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 +56 -2
- package/dist/@tanstack/react-query.gen.d.ts +943 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1156 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +8 -7
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +6 -4
- package/dist/client/index.js.map +1 -1
- package/dist/client/{types.d.ts → types.gen.d.ts} +23 -22
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/{utils.d.ts → utils.gen.d.ts} +17 -25
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/{utils.js → utils.gen.js} +66 -122
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +3 -3
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/{auth.d.ts → auth.gen.d.ts} +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/{auth.js → auth.gen.js} +2 -1
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/{bodySerializer.js → bodySerializer.gen.js} +6 -2
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/{params.d.ts → params.gen.d.ts} +11 -1
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/{params.js → params.gen.js} +24 -11
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/{pathSerializer.d.ts → pathSerializer.gen.d.ts} +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/{pathSerializer.js → pathSerializer.gen.js} +5 -12
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/{types.d.ts → types.gen.d.ts} +16 -16
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/errors.d.ts +42 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +83 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -1
- package/dist/schemas.gen.d.ts +1730 -748
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3153 -817
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +279 -164
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +403 -334
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +10 -47
- package/dist/services/kubernetes/api.d.ts.map +1 -1
- package/dist/services/kubernetes/api.js +36 -75
- package/dist/services/kubernetes/api.js.map +1 -1
- package/dist/services/kubernetes/index.d.ts.map +1 -1
- package/dist/services/kubernetes/index.js +36 -37
- package/dist/services/kubernetes/index.js.map +1 -1
- package/dist/types.gen.d.ts +1883 -947
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +4008 -3773
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1493 -1178
- package/dist/zod.gen.js.map +1 -1
- package/package.json +27 -9
- package/dist/client/client.d.ts +0 -3
- package/dist/client/client.d.ts.map +0 -1
- package/dist/client/client.js +0 -146
- package/dist/client/client.js.map +0 -1
- package/dist/client/types.d.ts.map +0 -1
- package/dist/client/types.js +0 -2
- package/dist/client/types.js.map +0 -1
- package/dist/client/utils.d.ts.map +0 -1
- package/dist/client/utils.js.map +0 -1
- package/dist/core/auth.d.ts.map +0 -1
- package/dist/core/auth.js.map +0 -1
- package/dist/core/bodySerializer.d.ts +0 -18
- package/dist/core/bodySerializer.d.ts.map +0 -1
- package/dist/core/bodySerializer.js.map +0 -1
- package/dist/core/params.d.ts.map +0 -1
- package/dist/core/params.js.map +0 -1
- package/dist/core/pathSerializer.d.ts.map +0 -1
- package/dist/core/pathSerializer.js.map +0 -1
- package/dist/core/types.d.ts.map +0 -1
- package/dist/core/types.js +0 -2
- package/dist/core/types.js.map +0 -1
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,
|
|
@@ -58,15 +67,10 @@ export const BillingContactSchema = {
|
|
|
58
67
|
description: 'Email address used for billing as a string.',
|
|
59
68
|
example: 'email@example.com'
|
|
60
69
|
},
|
|
61
|
-
|
|
62
|
-
type: 'string',
|
|
63
|
-
description: 'First name of the billing contact person.',
|
|
64
|
-
example: 'John'
|
|
65
|
-
},
|
|
66
|
-
last_name: {
|
|
70
|
+
individual_name: {
|
|
67
71
|
type: 'string',
|
|
68
|
-
description: '
|
|
69
|
-
example: 'Doe'
|
|
72
|
+
description: 'Name of the billing contact person.',
|
|
73
|
+
example: 'John Doe'
|
|
70
74
|
},
|
|
71
75
|
tax_id: {
|
|
72
76
|
type: 'string',
|
|
@@ -79,10 +83,154 @@ export const BillingContactSchema = {
|
|
|
79
83
|
nullable: true,
|
|
80
84
|
description: 'Type of the tax ID.',
|
|
81
85
|
example: 'de_vat',
|
|
82
|
-
enum: [
|
|
86
|
+
enum: [
|
|
87
|
+
'ad_nrt',
|
|
88
|
+
'ae_trn',
|
|
89
|
+
'al_tin',
|
|
90
|
+
'am_tin',
|
|
91
|
+
'ao_tin',
|
|
92
|
+
'ar_cuit',
|
|
93
|
+
'at_vat',
|
|
94
|
+
'au_abn',
|
|
95
|
+
'au_arn',
|
|
96
|
+
'aw_tin',
|
|
97
|
+
'az_tin',
|
|
98
|
+
'ba_tin',
|
|
99
|
+
'bb_tin',
|
|
100
|
+
'bd_bin',
|
|
101
|
+
'be_vat',
|
|
102
|
+
'bf_ifu',
|
|
103
|
+
'bg_uic',
|
|
104
|
+
'bg_vat',
|
|
105
|
+
'bh_vat',
|
|
106
|
+
'bj_ifu',
|
|
107
|
+
'bo_tin',
|
|
108
|
+
'br_cnpj',
|
|
109
|
+
'br_cpf',
|
|
110
|
+
'bs_tin',
|
|
111
|
+
'by_tin',
|
|
112
|
+
'ca_bn',
|
|
113
|
+
'ca_gst_hst',
|
|
114
|
+
'ca_pst_bc',
|
|
115
|
+
'ca_pst_mb',
|
|
116
|
+
'ca_pst_sk',
|
|
117
|
+
'ca_qst',
|
|
118
|
+
'cd_nif',
|
|
119
|
+
'ch_uid',
|
|
120
|
+
'ch_vat',
|
|
121
|
+
'cl_tin',
|
|
122
|
+
'cm_niu',
|
|
123
|
+
'cn_tin',
|
|
124
|
+
'co_nit',
|
|
125
|
+
'cr_tin',
|
|
126
|
+
'cv_nif',
|
|
127
|
+
'cy_vat',
|
|
128
|
+
'cz_vat',
|
|
129
|
+
'de_stn',
|
|
130
|
+
'de_vat',
|
|
131
|
+
'dk_vat',
|
|
132
|
+
'do_rcn',
|
|
133
|
+
'ec_ruc',
|
|
134
|
+
'ee_vat',
|
|
135
|
+
'eg_tin',
|
|
136
|
+
'es_cif',
|
|
137
|
+
'es_vat',
|
|
138
|
+
'et_tin',
|
|
139
|
+
'eu_oss_vat',
|
|
140
|
+
'fi_vat',
|
|
141
|
+
'fr_vat',
|
|
142
|
+
'gb_vat',
|
|
143
|
+
'ge_vat',
|
|
144
|
+
'gn_nif',
|
|
145
|
+
'gr_vat',
|
|
146
|
+
'hk_br',
|
|
147
|
+
'hr_oib',
|
|
148
|
+
'hr_vat',
|
|
149
|
+
'hu_tin',
|
|
150
|
+
'hu_vat',
|
|
151
|
+
'id_npwp',
|
|
152
|
+
'ie_vat',
|
|
153
|
+
'il_vat',
|
|
154
|
+
'in_gst',
|
|
155
|
+
'is_vat',
|
|
156
|
+
'it_vat',
|
|
157
|
+
'jp_cn',
|
|
158
|
+
'jp_rn',
|
|
159
|
+
'jp_trn',
|
|
160
|
+
'ke_pin',
|
|
161
|
+
'kg_tin',
|
|
162
|
+
'kh_tin',
|
|
163
|
+
'kr_brn',
|
|
164
|
+
'kz_bin',
|
|
165
|
+
'la_tin',
|
|
166
|
+
'li_uid',
|
|
167
|
+
'li_vat',
|
|
168
|
+
'lk_vat',
|
|
169
|
+
'lt_vat',
|
|
170
|
+
'lu_vat',
|
|
171
|
+
'lv_vat',
|
|
172
|
+
'ma_vat',
|
|
173
|
+
'md_vat',
|
|
174
|
+
'me_pib',
|
|
175
|
+
'mk_vat',
|
|
176
|
+
'mr_nif',
|
|
177
|
+
'mt_vat',
|
|
178
|
+
'mx_rfc',
|
|
179
|
+
'my_frp',
|
|
180
|
+
'my_itn',
|
|
181
|
+
'my_sst',
|
|
182
|
+
'ng_tin',
|
|
183
|
+
'nl_vat',
|
|
184
|
+
'no_vat',
|
|
185
|
+
'no_voec',
|
|
186
|
+
'np_pan',
|
|
187
|
+
'nz_gst',
|
|
188
|
+
'om_vat',
|
|
189
|
+
'pe_ruc',
|
|
190
|
+
'ph_tin',
|
|
191
|
+
'pl_vat',
|
|
192
|
+
'pt_vat',
|
|
193
|
+
'ro_tin',
|
|
194
|
+
'ro_vat',
|
|
195
|
+
'rs_pib',
|
|
196
|
+
'ru_inn',
|
|
197
|
+
'ru_kpp',
|
|
198
|
+
'sa_vat',
|
|
199
|
+
'se_vat',
|
|
200
|
+
'sg_gst',
|
|
201
|
+
'sg_uen',
|
|
202
|
+
'si_tin',
|
|
203
|
+
'si_vat',
|
|
204
|
+
'sk_vat',
|
|
205
|
+
'sn_ninea',
|
|
206
|
+
'sr_fin',
|
|
207
|
+
'sv_nit',
|
|
208
|
+
'th_vat',
|
|
209
|
+
'tj_tin',
|
|
210
|
+
'tr_tin',
|
|
211
|
+
'tw_vat',
|
|
212
|
+
'tz_vat',
|
|
213
|
+
'ua_vat',
|
|
214
|
+
'ug_tin',
|
|
215
|
+
'us_ein',
|
|
216
|
+
'uy_ruc',
|
|
217
|
+
'uz_tin',
|
|
218
|
+
'uz_vat',
|
|
219
|
+
've_rif',
|
|
220
|
+
'vn_tin',
|
|
221
|
+
'xi_vat',
|
|
222
|
+
'za_vat',
|
|
223
|
+
'zm_tin',
|
|
224
|
+
'zw_tin',
|
|
225
|
+
''
|
|
226
|
+
]
|
|
83
227
|
}
|
|
84
228
|
},
|
|
85
|
-
required: [
|
|
229
|
+
required: [
|
|
230
|
+
'type',
|
|
231
|
+
'email',
|
|
232
|
+
'individual_name'
|
|
233
|
+
],
|
|
86
234
|
additionalProperties: false
|
|
87
235
|
};
|
|
88
236
|
export const BillingCreditsSchema = {
|
|
@@ -93,10 +241,25 @@ export const BillingCreditsSchema = {
|
|
|
93
241
|
description: 'Generated unique identifier of the promotional code.',
|
|
94
242
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
95
243
|
},
|
|
96
|
-
|
|
244
|
+
type: {
|
|
245
|
+
type: 'string',
|
|
246
|
+
description: 'Type of the promotional code.',
|
|
247
|
+
example: 'credit',
|
|
248
|
+
enum: [
|
|
249
|
+
'credit',
|
|
250
|
+
'discount'
|
|
251
|
+
]
|
|
252
|
+
},
|
|
253
|
+
date_start: {
|
|
254
|
+
type: 'string',
|
|
255
|
+
format: 'date-time',
|
|
256
|
+
description: 'Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.',
|
|
257
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
258
|
+
},
|
|
259
|
+
date_end: {
|
|
97
260
|
type: 'string',
|
|
98
261
|
format: 'date-time',
|
|
99
|
-
description: '
|
|
262
|
+
description: 'Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.',
|
|
100
263
|
example: '2023-12-20T13:53:32.000Z'
|
|
101
264
|
},
|
|
102
265
|
code: {
|
|
@@ -109,165 +272,25 @@ export const BillingCreditsSchema = {
|
|
|
109
272
|
description: 'Description of the promotional code.',
|
|
110
273
|
example: '10% off on all products'
|
|
111
274
|
},
|
|
112
|
-
|
|
113
|
-
type: 'array',
|
|
114
|
-
items: {
|
|
115
|
-
type: 'string'
|
|
116
|
-
},
|
|
117
|
-
description: 'List of product SKUs that the promotional code can be used on.',
|
|
118
|
-
example: ['cfke_controlplane', 'cfke_connected_nodes', 'infra_compute', 'infra_storage', 'infra_loadbalancing', 'infra_traffic', 'cfcr_storage']
|
|
119
|
-
},
|
|
120
|
-
type: {
|
|
121
|
-
type: 'string',
|
|
122
|
-
description: 'Type of the promotional code.',
|
|
123
|
-
example: 'credit',
|
|
124
|
-
enum: ['credit', 'discount']
|
|
125
|
-
},
|
|
126
|
-
value: {
|
|
275
|
+
value_total: {
|
|
127
276
|
type: 'number',
|
|
128
277
|
format: 'float',
|
|
129
|
-
description: '
|
|
278
|
+
description: 'Total value of the promotional code.',
|
|
130
279
|
example: 10
|
|
131
280
|
},
|
|
132
|
-
billing_period: {
|
|
133
|
-
type: 'string',
|
|
134
|
-
format: 'date-time',
|
|
135
|
-
description: 'Date of the billing cycle. An ISO 8601 date string in the UTC timezone.',
|
|
136
|
-
example: '2023-12-20T13:53:32.000Z'
|
|
137
|
-
},
|
|
138
281
|
value_remaining: {
|
|
139
282
|
type: 'number',
|
|
140
283
|
format: 'float',
|
|
141
|
-
description: '
|
|
142
|
-
example:
|
|
143
|
-
}
|
|
144
|
-
},
|
|
145
|
-
required: ['date_created', 'code', 'type', 'value', 'billing_period'],
|
|
146
|
-
additionalProperties: false
|
|
147
|
-
};
|
|
148
|
-
export const ChartCreateInputSchema = {
|
|
149
|
-
type: 'object',
|
|
150
|
-
properties: {
|
|
151
|
-
values: {
|
|
152
|
-
type: 'string',
|
|
153
|
-
description: 'Values to be used in the chart encoded as a JSON string.'
|
|
154
|
-
},
|
|
155
|
-
version_channel: {
|
|
156
|
-
type: 'string',
|
|
157
|
-
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-]+)*))?$',
|
|
158
|
-
description: 'Desired version range or channel for the chart.',
|
|
159
|
-
example: '2.x.x-cfke.x'
|
|
160
|
-
},
|
|
161
|
-
name: {
|
|
162
|
-
type: 'string',
|
|
163
|
-
maxLength: 63,
|
|
164
|
-
minLength: 1,
|
|
165
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
166
|
-
description: 'Unique identifier of the chart deployment aka name of the helm release.',
|
|
167
|
-
example: 'postgresql-0'
|
|
168
|
-
},
|
|
169
|
-
namespace: {
|
|
170
|
-
type: 'string',
|
|
171
|
-
maxLength: 63,
|
|
172
|
-
minLength: 1,
|
|
173
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
174
|
-
description: 'Namespace of the chart deployment',
|
|
175
|
-
example: 'default'
|
|
176
|
-
},
|
|
177
|
-
chart: {
|
|
178
|
-
type: 'string',
|
|
179
|
-
maxLength: 63,
|
|
180
|
-
minLength: 1,
|
|
181
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
182
|
-
description: 'Name of the chart listing',
|
|
183
|
-
example: 'postgresql'
|
|
184
|
-
}
|
|
185
|
-
},
|
|
186
|
-
required: ['values', 'version_channel', 'name', 'namespace', 'chart'],
|
|
187
|
-
additionalProperties: false
|
|
188
|
-
};
|
|
189
|
-
export const ChartSchema = {
|
|
190
|
-
type: 'object',
|
|
191
|
-
properties: {
|
|
192
|
-
values: {
|
|
193
|
-
type: 'string',
|
|
194
|
-
description: 'Values to be used in the chart encoded as a JSON string.'
|
|
195
|
-
},
|
|
196
|
-
version_channel: {
|
|
197
|
-
type: 'string',
|
|
198
|
-
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-]+)*))?$',
|
|
199
|
-
description: 'Desired version range or channel for the chart.',
|
|
200
|
-
example: '2.x.x-cfke.x'
|
|
201
|
-
},
|
|
202
|
-
name: {
|
|
203
|
-
type: 'string',
|
|
204
|
-
maxLength: 63,
|
|
205
|
-
minLength: 1,
|
|
206
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
207
|
-
description: 'Unique identifier of the chart deployment aka name of the helm release.',
|
|
208
|
-
example: 'postgresql-0'
|
|
209
|
-
},
|
|
210
|
-
namespace: {
|
|
211
|
-
type: 'string',
|
|
212
|
-
maxLength: 63,
|
|
213
|
-
minLength: 1,
|
|
214
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
215
|
-
description: 'Namespace of the chart deployment',
|
|
216
|
-
example: 'default'
|
|
217
|
-
},
|
|
218
|
-
chart: {
|
|
219
|
-
type: 'string',
|
|
220
|
-
maxLength: 63,
|
|
221
|
-
minLength: 1,
|
|
222
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
223
|
-
description: 'Name of the chart listing',
|
|
224
|
-
example: 'postgresql'
|
|
225
|
-
},
|
|
226
|
-
status: {
|
|
227
|
-
type: 'string',
|
|
228
|
-
description: 'Status of the chart deployment.',
|
|
229
|
-
example: 'active',
|
|
230
|
-
enum: ['InstallSucceeded', 'InstallFailed', 'UpgradeSucceeded', 'UpgradeFailed', 'TestSucceeded', 'TestFailed', 'RollbackSucceeded', 'RollbackFailed', 'UninstallSucceeded', 'UninstallFailed', 'ArtifactFailed', 'DependencyNotReady', 'Progressing', 'SourceNotReady']
|
|
231
|
-
},
|
|
232
|
-
version_current: {
|
|
233
|
-
type: 'string',
|
|
234
|
-
description: 'Current version of the chart deployment.',
|
|
235
|
-
example: '2.1.33-cfke.11'
|
|
236
|
-
},
|
|
237
|
-
created_at: {
|
|
238
|
-
type: 'string',
|
|
239
|
-
description: 'Creation date and time of the chart deployment.',
|
|
240
|
-
example: '2024-09-12T09:11:27Z'
|
|
241
|
-
},
|
|
242
|
-
updated_at: {
|
|
243
|
-
type: 'string',
|
|
244
|
-
description: 'Last update date and time of the chart deployment.',
|
|
245
|
-
example: '2024-09-12T09:11:27Z'
|
|
246
|
-
},
|
|
247
|
-
ready: {
|
|
248
|
-
type: 'boolean',
|
|
249
|
-
description: 'Indicates if the chart deployment is ready to be used.',
|
|
250
|
-
example: true
|
|
251
|
-
}
|
|
252
|
-
},
|
|
253
|
-
required: ['values', 'version_channel', 'name', 'namespace', 'chart', 'status', 'version_current', 'created_at', 'updated_at', 'ready'],
|
|
254
|
-
additionalProperties: false
|
|
255
|
-
};
|
|
256
|
-
export const ChartUpdateInputSchema = {
|
|
257
|
-
type: 'object',
|
|
258
|
-
properties: {
|
|
259
|
-
values: {
|
|
260
|
-
type: 'string',
|
|
261
|
-
description: 'Values to be used in the chart encoded as a JSON string.'
|
|
262
|
-
},
|
|
263
|
-
version_channel: {
|
|
264
|
-
type: 'string',
|
|
265
|
-
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-]+)*))?$',
|
|
266
|
-
description: 'Desired version range or channel for the chart.',
|
|
267
|
-
example: '2.x.x-cfke.x'
|
|
284
|
+
description: 'Remaining value of the promotional code.',
|
|
285
|
+
example: 8
|
|
268
286
|
}
|
|
269
287
|
},
|
|
270
|
-
required: [
|
|
288
|
+
required: [
|
|
289
|
+
'type',
|
|
290
|
+
'date_start',
|
|
291
|
+
'code',
|
|
292
|
+
'value_total'
|
|
293
|
+
],
|
|
271
294
|
additionalProperties: false
|
|
272
295
|
};
|
|
273
296
|
export const ClusterCreateInputSchema = {
|
|
@@ -284,26 +307,118 @@ export const ClusterCreateInputSchema = {
|
|
|
284
307
|
tier: {
|
|
285
308
|
type: 'string',
|
|
286
309
|
description: 'Tier of the cluster.',
|
|
310
|
+
default: 'basic',
|
|
287
311
|
example: 'pro',
|
|
288
|
-
enum: [
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
default: 'staging',
|
|
294
|
-
example: 'northamerica-central-1',
|
|
295
|
-
enum: ['staging', 'northamerica-central-1', 'europe-central-1a']
|
|
312
|
+
enum: [
|
|
313
|
+
'basic',
|
|
314
|
+
'pro',
|
|
315
|
+
'enterprise'
|
|
316
|
+
]
|
|
296
317
|
},
|
|
297
318
|
version_channel: {
|
|
298
319
|
type: 'string',
|
|
299
320
|
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-]+)*))?$',
|
|
300
321
|
description: 'Version of the kubernetes cluster.',
|
|
301
322
|
default: '1.x.x-cfke.x',
|
|
302
|
-
example: '1.
|
|
323
|
+
example: '1.x.x-cfke.x'
|
|
324
|
+
},
|
|
325
|
+
release_channel: {
|
|
326
|
+
type: 'string',
|
|
327
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
328
|
+
default: 'rapid',
|
|
329
|
+
example: 'rapid',
|
|
330
|
+
enum: [
|
|
331
|
+
'rapid',
|
|
332
|
+
'stable',
|
|
333
|
+
'extended'
|
|
334
|
+
]
|
|
335
|
+
},
|
|
336
|
+
features: {
|
|
337
|
+
type: 'object',
|
|
338
|
+
properties: {
|
|
339
|
+
gpu_sharing_strategy: {
|
|
340
|
+
type: 'string',
|
|
341
|
+
description: 'GPU sharing strategy.',
|
|
342
|
+
default: 'none',
|
|
343
|
+
example: 'none',
|
|
344
|
+
enum: [
|
|
345
|
+
'none',
|
|
346
|
+
'mps',
|
|
347
|
+
'time_slicing'
|
|
348
|
+
]
|
|
349
|
+
},
|
|
350
|
+
gpu_max_shared_clients_per_gpu: {
|
|
351
|
+
type: 'integer',
|
|
352
|
+
minimum: 2,
|
|
353
|
+
maximum: 48,
|
|
354
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
355
|
+
default: 4,
|
|
356
|
+
example: 10
|
|
357
|
+
},
|
|
358
|
+
cilium_socket_lb_host_namespace_only: {
|
|
359
|
+
type: 'boolean',
|
|
360
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
361
|
+
example: false
|
|
362
|
+
}
|
|
363
|
+
},
|
|
364
|
+
additionalProperties: false,
|
|
365
|
+
description: 'Cluster feature toggles.',
|
|
366
|
+
default: {
|
|
367
|
+
gpu_sharing_strategy: 'none',
|
|
368
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
369
|
+
cilium_socket_lb_host_namespace_only: false
|
|
370
|
+
}
|
|
371
|
+
},
|
|
372
|
+
region: {
|
|
373
|
+
type: 'string',
|
|
374
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
375
|
+
example: 'europe-central-1a'
|
|
376
|
+
},
|
|
377
|
+
networking: {
|
|
378
|
+
type: 'object',
|
|
379
|
+
properties: {
|
|
380
|
+
pod_cidr: {
|
|
381
|
+
type: 'string',
|
|
382
|
+
description: 'CIDR block for pod IPs.',
|
|
383
|
+
default: '10.244.0.0/16'
|
|
384
|
+
},
|
|
385
|
+
service_cidr: {
|
|
386
|
+
type: 'string',
|
|
387
|
+
description: 'CIDR block for service IPs.',
|
|
388
|
+
default: '10.96.0.0/12'
|
|
389
|
+
},
|
|
390
|
+
dual_stack: {
|
|
391
|
+
type: 'boolean',
|
|
392
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
393
|
+
},
|
|
394
|
+
pod_cidr_v6: {
|
|
395
|
+
type: 'string',
|
|
396
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
397
|
+
default: '2001:db8:1:2::/48'
|
|
398
|
+
},
|
|
399
|
+
service_cidr_v6: {
|
|
400
|
+
type: 'string',
|
|
401
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
402
|
+
default: '2001:db8:1:1::/112'
|
|
403
|
+
}
|
|
404
|
+
},
|
|
405
|
+
additionalProperties: false,
|
|
406
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
407
|
+
default: {
|
|
408
|
+
pod_cidr: '10.244.0.0/16',
|
|
409
|
+
service_cidr: '10.96.0.0/12',
|
|
410
|
+
dual_stack: false,
|
|
411
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
412
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
413
|
+
}
|
|
303
414
|
}
|
|
304
415
|
},
|
|
305
|
-
required: [
|
|
306
|
-
|
|
416
|
+
required: [
|
|
417
|
+
'name',
|
|
418
|
+
'region'
|
|
419
|
+
],
|
|
420
|
+
additionalProperties: false,
|
|
421
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
307
422
|
};
|
|
308
423
|
export const ClusterJoinInformationSchema = {
|
|
309
424
|
type: 'object',
|
|
@@ -311,8 +426,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
311
426
|
certificate_authority: {
|
|
312
427
|
type: 'string',
|
|
313
428
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
314
|
-
example:
|
|
315
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
429
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
316
430
|
},
|
|
317
431
|
endpoint: {
|
|
318
432
|
type: 'string',
|
|
@@ -320,11 +434,26 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
320
434
|
description: 'Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.',
|
|
321
435
|
example: 'https://10.31.64.7:6443'
|
|
322
436
|
},
|
|
437
|
+
cluster_dns: {
|
|
438
|
+
type: 'string',
|
|
439
|
+
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
440
|
+
example: '10.96.0.10'
|
|
441
|
+
},
|
|
442
|
+
pod_cidr: {
|
|
443
|
+
type: 'string',
|
|
444
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
445
|
+
example: '10.244.0.0/16'
|
|
446
|
+
},
|
|
323
447
|
auth_key: {
|
|
324
448
|
type: 'string',
|
|
325
449
|
description: 'Authentication key for the cluster.',
|
|
326
450
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
327
451
|
},
|
|
452
|
+
login_server: {
|
|
453
|
+
type: 'string',
|
|
454
|
+
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.',
|
|
455
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
456
|
+
},
|
|
328
457
|
bootstrap_token: {
|
|
329
458
|
type: 'string',
|
|
330
459
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -336,7 +465,7 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
336
465
|
kubernetes: {
|
|
337
466
|
type: 'string',
|
|
338
467
|
description: 'Kubernetes version of the cluster.',
|
|
339
|
-
example: '1.
|
|
468
|
+
example: '1.33.7'
|
|
340
469
|
},
|
|
341
470
|
tailscale: {
|
|
342
471
|
type: 'string',
|
|
@@ -354,7 +483,12 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
354
483
|
example: '565.0.0'
|
|
355
484
|
}
|
|
356
485
|
},
|
|
357
|
-
required: [
|
|
486
|
+
required: [
|
|
487
|
+
'kubernetes',
|
|
488
|
+
'tailscale',
|
|
489
|
+
'containerd',
|
|
490
|
+
'nvidia_driver'
|
|
491
|
+
],
|
|
358
492
|
additionalProperties: false,
|
|
359
493
|
description: 'Versions of the different components of the cluster.'
|
|
360
494
|
},
|
|
@@ -377,12 +511,26 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
377
511
|
example: '//iam.googleapis.com/projects/89014267864/locations/global/workloadIdentityPools/cfke/providers/oidc'
|
|
378
512
|
}
|
|
379
513
|
},
|
|
380
|
-
required: [
|
|
514
|
+
required: [
|
|
515
|
+
'metadata_url',
|
|
516
|
+
'aws_role_arn',
|
|
517
|
+
'gcp_workload_identity_provider'
|
|
518
|
+
],
|
|
381
519
|
additionalProperties: false,
|
|
382
|
-
description:
|
|
520
|
+
description: 'OIDC Information for hosts to access to third party API\'s.'
|
|
383
521
|
}
|
|
384
522
|
},
|
|
385
|
-
required: [
|
|
523
|
+
required: [
|
|
524
|
+
'certificate_authority',
|
|
525
|
+
'endpoint',
|
|
526
|
+
'cluster_dns',
|
|
527
|
+
'pod_cidr',
|
|
528
|
+
'auth_key',
|
|
529
|
+
'login_server',
|
|
530
|
+
'bootstrap_token',
|
|
531
|
+
'versions',
|
|
532
|
+
'third_party_api_access_config'
|
|
533
|
+
],
|
|
386
534
|
additionalProperties: false
|
|
387
535
|
};
|
|
388
536
|
export const ClusterSchema = {
|
|
@@ -399,22 +547,122 @@ export const ClusterSchema = {
|
|
|
399
547
|
tier: {
|
|
400
548
|
type: 'string',
|
|
401
549
|
description: 'Tier of the cluster.',
|
|
550
|
+
default: 'basic',
|
|
402
551
|
example: 'pro',
|
|
403
|
-
enum: [
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
default: 'staging',
|
|
409
|
-
example: 'northamerica-central-1',
|
|
410
|
-
enum: ['staging', 'northamerica-central-1', 'europe-central-1a']
|
|
552
|
+
enum: [
|
|
553
|
+
'basic',
|
|
554
|
+
'pro',
|
|
555
|
+
'enterprise'
|
|
556
|
+
]
|
|
411
557
|
},
|
|
412
558
|
version_channel: {
|
|
413
559
|
type: 'string',
|
|
414
560
|
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-]+)*))?$',
|
|
415
561
|
description: 'Version of the kubernetes cluster.',
|
|
416
562
|
default: '1.x.x-cfke.x',
|
|
417
|
-
example: '1.
|
|
563
|
+
example: '1.x.x-cfke.x'
|
|
564
|
+
},
|
|
565
|
+
release_channel: {
|
|
566
|
+
type: 'string',
|
|
567
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
568
|
+
default: 'rapid',
|
|
569
|
+
example: 'rapid',
|
|
570
|
+
enum: [
|
|
571
|
+
'rapid',
|
|
572
|
+
'stable',
|
|
573
|
+
'extended'
|
|
574
|
+
]
|
|
575
|
+
},
|
|
576
|
+
features: {
|
|
577
|
+
type: 'object',
|
|
578
|
+
properties: {
|
|
579
|
+
gpu_sharing_strategy: {
|
|
580
|
+
type: 'string',
|
|
581
|
+
description: 'GPU sharing strategy.',
|
|
582
|
+
default: 'none',
|
|
583
|
+
example: 'none',
|
|
584
|
+
enum: [
|
|
585
|
+
'none',
|
|
586
|
+
'mps',
|
|
587
|
+
'time_slicing'
|
|
588
|
+
]
|
|
589
|
+
},
|
|
590
|
+
gpu_max_shared_clients_per_gpu: {
|
|
591
|
+
type: 'integer',
|
|
592
|
+
minimum: 2,
|
|
593
|
+
maximum: 48,
|
|
594
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
595
|
+
default: 4,
|
|
596
|
+
example: 10
|
|
597
|
+
},
|
|
598
|
+
cilium_socket_lb_host_namespace_only: {
|
|
599
|
+
type: 'boolean',
|
|
600
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
601
|
+
example: false
|
|
602
|
+
}
|
|
603
|
+
},
|
|
604
|
+
required: [
|
|
605
|
+
'gpu_sharing_strategy',
|
|
606
|
+
'gpu_max_shared_clients_per_gpu',
|
|
607
|
+
'cilium_socket_lb_host_namespace_only'
|
|
608
|
+
],
|
|
609
|
+
additionalProperties: false,
|
|
610
|
+
description: 'Cluster feature toggles.',
|
|
611
|
+
default: {
|
|
612
|
+
gpu_sharing_strategy: 'none',
|
|
613
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
614
|
+
cilium_socket_lb_host_namespace_only: false
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
region: {
|
|
618
|
+
type: 'string',
|
|
619
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
620
|
+
example: 'europe-central-1a'
|
|
621
|
+
},
|
|
622
|
+
networking: {
|
|
623
|
+
type: 'object',
|
|
624
|
+
properties: {
|
|
625
|
+
pod_cidr: {
|
|
626
|
+
type: 'string',
|
|
627
|
+
description: 'CIDR block for pod IPs.',
|
|
628
|
+
default: '10.244.0.0/16'
|
|
629
|
+
},
|
|
630
|
+
service_cidr: {
|
|
631
|
+
type: 'string',
|
|
632
|
+
description: 'CIDR block for service IPs.',
|
|
633
|
+
default: '10.96.0.0/12'
|
|
634
|
+
},
|
|
635
|
+
dual_stack: {
|
|
636
|
+
type: 'boolean',
|
|
637
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
638
|
+
},
|
|
639
|
+
pod_cidr_v6: {
|
|
640
|
+
type: 'string',
|
|
641
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
642
|
+
default: '2001:db8:1:2::/48'
|
|
643
|
+
},
|
|
644
|
+
service_cidr_v6: {
|
|
645
|
+
type: 'string',
|
|
646
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
647
|
+
default: '2001:db8:1:1::/112'
|
|
648
|
+
}
|
|
649
|
+
},
|
|
650
|
+
required: [
|
|
651
|
+
'pod_cidr',
|
|
652
|
+
'service_cidr',
|
|
653
|
+
'dual_stack',
|
|
654
|
+
'pod_cidr_v6',
|
|
655
|
+
'service_cidr_v6'
|
|
656
|
+
],
|
|
657
|
+
additionalProperties: false,
|
|
658
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
659
|
+
default: {
|
|
660
|
+
pod_cidr: '10.244.0.0/16',
|
|
661
|
+
service_cidr: '10.96.0.0/12',
|
|
662
|
+
dual_stack: false,
|
|
663
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
664
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
665
|
+
}
|
|
418
666
|
},
|
|
419
667
|
id: {
|
|
420
668
|
type: 'string',
|
|
@@ -424,34 +672,56 @@ export const ClusterSchema = {
|
|
|
424
672
|
},
|
|
425
673
|
status: {
|
|
426
674
|
type: 'string',
|
|
427
|
-
description: 'Status of the cluster.
|
|
428
|
-
example: '
|
|
429
|
-
enum: [
|
|
675
|
+
description: 'Status of the cluster.',
|
|
676
|
+
example: 'deployed',
|
|
677
|
+
enum: [
|
|
678
|
+
'creating',
|
|
679
|
+
'deployed',
|
|
680
|
+
'updating',
|
|
681
|
+
'disabled'
|
|
682
|
+
]
|
|
430
683
|
},
|
|
431
684
|
endpoint: {
|
|
432
685
|
anyOf: [
|
|
433
686
|
{
|
|
434
687
|
type: 'string',
|
|
435
688
|
format: 'uri',
|
|
436
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
437
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
689
|
+
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.',
|
|
690
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
691
|
+
},
|
|
692
|
+
{
|
|
693
|
+
type: 'string',
|
|
694
|
+
enum: [
|
|
695
|
+
''
|
|
696
|
+
]
|
|
697
|
+
}
|
|
698
|
+
]
|
|
699
|
+
},
|
|
700
|
+
endpoint_public: {
|
|
701
|
+
anyOf: [
|
|
702
|
+
{
|
|
703
|
+
type: 'string',
|
|
704
|
+
format: 'uri',
|
|
705
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
706
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
438
707
|
},
|
|
439
708
|
{
|
|
440
709
|
type: 'string',
|
|
441
|
-
enum: [
|
|
710
|
+
enum: [
|
|
711
|
+
''
|
|
712
|
+
]
|
|
442
713
|
}
|
|
443
714
|
]
|
|
444
715
|
},
|
|
445
716
|
certificate_ca: {
|
|
446
717
|
type: 'string',
|
|
447
718
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
448
|
-
example:
|
|
449
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
719
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
450
720
|
},
|
|
451
721
|
version_current: {
|
|
452
722
|
type: 'string',
|
|
453
723
|
description: 'Current version of the cluster.',
|
|
454
|
-
example: '1.
|
|
724
|
+
example: '1.33.7-cfke.264'
|
|
455
725
|
},
|
|
456
726
|
created_at: {
|
|
457
727
|
type: 'string',
|
|
@@ -469,8 +739,20 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
469
739
|
example: true
|
|
470
740
|
}
|
|
471
741
|
},
|
|
472
|
-
required: [
|
|
473
|
-
|
|
742
|
+
required: [
|
|
743
|
+
'name',
|
|
744
|
+
'tier',
|
|
745
|
+
'version_channel',
|
|
746
|
+
'release_channel',
|
|
747
|
+
'features',
|
|
748
|
+
'region',
|
|
749
|
+
'networking',
|
|
750
|
+
'id',
|
|
751
|
+
'status',
|
|
752
|
+
'ready'
|
|
753
|
+
],
|
|
754
|
+
additionalProperties: false,
|
|
755
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
474
756
|
};
|
|
475
757
|
export const ClusterUpdateInputSchema = {
|
|
476
758
|
type: 'object',
|
|
@@ -486,81 +768,551 @@ export const ClusterUpdateInputSchema = {
|
|
|
486
768
|
tier: {
|
|
487
769
|
type: 'string',
|
|
488
770
|
description: 'Tier of the cluster.',
|
|
771
|
+
default: 'basic',
|
|
489
772
|
example: 'pro',
|
|
490
|
-
enum: [
|
|
773
|
+
enum: [
|
|
774
|
+
'basic',
|
|
775
|
+
'pro',
|
|
776
|
+
'enterprise'
|
|
777
|
+
]
|
|
491
778
|
},
|
|
492
779
|
version_channel: {
|
|
493
780
|
type: 'string',
|
|
494
781
|
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-]+)*))?$',
|
|
495
782
|
description: 'Version of the kubernetes cluster.',
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
},
|
|
499
|
-
required: ['tier'],
|
|
500
|
-
additionalProperties: false
|
|
501
|
-
};
|
|
502
|
-
export const FleetCreateInputSchema = {
|
|
503
|
-
type: 'object',
|
|
504
|
-
properties: {
|
|
505
|
-
limits: {
|
|
506
|
-
type: 'object',
|
|
507
|
-
properties: {
|
|
508
|
-
cpu: {
|
|
509
|
-
type: 'number',
|
|
510
|
-
format: 'float',
|
|
511
|
-
minimum: 0,
|
|
512
|
-
description: 'CPU limit in cores.'
|
|
513
|
-
}
|
|
514
|
-
},
|
|
515
|
-
required: ['cpu'],
|
|
516
|
-
additionalProperties: false,
|
|
517
|
-
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
783
|
+
default: '1.x.x-cfke.x',
|
|
784
|
+
example: '1.x.x-cfke.x'
|
|
518
785
|
},
|
|
519
|
-
|
|
786
|
+
release_channel: {
|
|
787
|
+
type: 'string',
|
|
788
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
789
|
+
default: 'rapid',
|
|
790
|
+
example: 'rapid',
|
|
791
|
+
enum: [
|
|
792
|
+
'rapid',
|
|
793
|
+
'stable',
|
|
794
|
+
'extended'
|
|
795
|
+
]
|
|
796
|
+
},
|
|
797
|
+
features: {
|
|
520
798
|
type: 'object',
|
|
521
799
|
properties: {
|
|
522
|
-
|
|
523
|
-
type: 'boolean',
|
|
524
|
-
default: true
|
|
525
|
-
},
|
|
526
|
-
project: {
|
|
800
|
+
gpu_sharing_strategy: {
|
|
527
801
|
type: 'string',
|
|
528
|
-
description: '
|
|
802
|
+
description: 'GPU sharing strategy.',
|
|
803
|
+
default: 'none',
|
|
804
|
+
example: 'none',
|
|
805
|
+
enum: [
|
|
806
|
+
'none',
|
|
807
|
+
'mps',
|
|
808
|
+
'time_slicing'
|
|
809
|
+
]
|
|
810
|
+
},
|
|
811
|
+
gpu_max_shared_clients_per_gpu: {
|
|
812
|
+
type: 'integer',
|
|
813
|
+
minimum: 2,
|
|
814
|
+
maximum: 48,
|
|
815
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
816
|
+
default: 4,
|
|
817
|
+
example: 10
|
|
818
|
+
},
|
|
819
|
+
cilium_socket_lb_host_namespace_only: {
|
|
820
|
+
type: 'boolean',
|
|
821
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
822
|
+
example: false
|
|
529
823
|
}
|
|
530
824
|
},
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
825
|
+
additionalProperties: false,
|
|
826
|
+
description: 'Cluster feature toggles.',
|
|
827
|
+
default: {
|
|
828
|
+
gpu_sharing_strategy: 'none',
|
|
829
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
830
|
+
cilium_socket_lb_host_namespace_only: false
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
},
|
|
834
|
+
required: [
|
|
835
|
+
'name'
|
|
836
|
+
],
|
|
837
|
+
additionalProperties: false,
|
|
838
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
839
|
+
};
|
|
840
|
+
export const FeedbackCreateInputSchema = {
|
|
841
|
+
type: 'object',
|
|
842
|
+
properties: {
|
|
843
|
+
sentiment: {
|
|
844
|
+
type: 'string',
|
|
845
|
+
description: 'Overall sentiment: positive, neutral or negative.',
|
|
846
|
+
example: 'negative',
|
|
847
|
+
enum: [
|
|
848
|
+
'positive',
|
|
849
|
+
'neutral',
|
|
850
|
+
'negative'
|
|
851
|
+
]
|
|
852
|
+
},
|
|
853
|
+
message: {
|
|
854
|
+
type: 'string',
|
|
855
|
+
maxLength: 2000,
|
|
856
|
+
minLength: 1,
|
|
857
|
+
description: 'What was useful, confusing, wrong or missing.',
|
|
858
|
+
example: 'The error for a missing kubeconfig does not say which path it looked in.'
|
|
859
|
+
},
|
|
860
|
+
context: {
|
|
861
|
+
type: 'string',
|
|
862
|
+
maxLength: 2000,
|
|
863
|
+
description: 'What you were trying to do when it happened.',
|
|
864
|
+
example: 'Connecting kubectl to a new cluster.'
|
|
865
|
+
},
|
|
866
|
+
source: {
|
|
867
|
+
type: 'string',
|
|
868
|
+
description: 'Where the feedback was sent from: cli, mcp, plugin, console or api. Defaults to api.',
|
|
869
|
+
default: 'api',
|
|
870
|
+
example: 'cli',
|
|
871
|
+
enum: [
|
|
872
|
+
'cli',
|
|
873
|
+
'mcp',
|
|
874
|
+
'plugin',
|
|
875
|
+
'console',
|
|
876
|
+
'api'
|
|
877
|
+
]
|
|
878
|
+
},
|
|
879
|
+
client: {
|
|
880
|
+
type: 'string',
|
|
881
|
+
maxLength: 100,
|
|
882
|
+
description: 'Name and version of the sending client.',
|
|
883
|
+
example: 'cloudfleet-plugin-claude/0.5.0'
|
|
884
|
+
}
|
|
885
|
+
},
|
|
886
|
+
required: [
|
|
887
|
+
'sentiment',
|
|
888
|
+
'message'
|
|
889
|
+
],
|
|
890
|
+
additionalProperties: false
|
|
891
|
+
};
|
|
892
|
+
export const FeedbackSchema = {
|
|
893
|
+
type: 'object',
|
|
894
|
+
properties: {
|
|
895
|
+
id: {
|
|
896
|
+
type: 'string',
|
|
897
|
+
description: 'Unique identifier of the feedback entry (Mongo ObjectId).',
|
|
898
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
899
|
+
}
|
|
900
|
+
},
|
|
901
|
+
required: [
|
|
902
|
+
'id'
|
|
903
|
+
],
|
|
904
|
+
additionalProperties: false
|
|
905
|
+
};
|
|
906
|
+
export const FleetCreateInputSchema = {
|
|
907
|
+
type: 'object',
|
|
908
|
+
properties: {
|
|
909
|
+
limits: {
|
|
910
|
+
type: 'object',
|
|
911
|
+
properties: {
|
|
912
|
+
cpu: {
|
|
913
|
+
type: 'integer',
|
|
914
|
+
minimum: 0,
|
|
915
|
+
maximum: 100000,
|
|
916
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
917
|
+
}
|
|
918
|
+
},
|
|
919
|
+
additionalProperties: false,
|
|
920
|
+
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
921
|
+
},
|
|
922
|
+
gcp: {
|
|
923
|
+
type: 'object',
|
|
536
924
|
properties: {
|
|
537
925
|
enabled: {
|
|
538
|
-
type: 'boolean'
|
|
539
|
-
|
|
926
|
+
type: 'boolean'
|
|
927
|
+
},
|
|
928
|
+
project: {
|
|
929
|
+
type: 'string',
|
|
930
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
931
|
+
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.',
|
|
932
|
+
example: 'my-cloudfleet-project'
|
|
933
|
+
}
|
|
934
|
+
},
|
|
935
|
+
required: [
|
|
936
|
+
'enabled'
|
|
937
|
+
],
|
|
938
|
+
additionalProperties: false
|
|
939
|
+
},
|
|
940
|
+
hetzner: {
|
|
941
|
+
type: 'object',
|
|
942
|
+
properties: {
|
|
943
|
+
enabled: {
|
|
944
|
+
type: 'boolean'
|
|
540
945
|
},
|
|
541
946
|
apiKey: {
|
|
542
947
|
type: 'string',
|
|
543
|
-
|
|
948
|
+
maxLength: 64,
|
|
949
|
+
minLength: 64,
|
|
950
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
951
|
+
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.'
|
|
544
952
|
}
|
|
545
953
|
},
|
|
546
|
-
required: [
|
|
954
|
+
required: [
|
|
955
|
+
'enabled'
|
|
956
|
+
],
|
|
547
957
|
additionalProperties: false
|
|
548
958
|
},
|
|
549
959
|
aws: {
|
|
550
960
|
type: 'object',
|
|
551
961
|
properties: {
|
|
552
962
|
enabled: {
|
|
553
|
-
type: 'boolean'
|
|
554
|
-
default: true
|
|
963
|
+
type: 'boolean'
|
|
555
964
|
},
|
|
556
965
|
controllerRoleArn: {
|
|
557
966
|
type: 'string',
|
|
558
|
-
|
|
967
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
968
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
969
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
559
970
|
}
|
|
560
971
|
},
|
|
561
|
-
required: [
|
|
972
|
+
required: [
|
|
973
|
+
'enabled'
|
|
974
|
+
],
|
|
562
975
|
additionalProperties: false
|
|
563
976
|
},
|
|
977
|
+
constraints: {
|
|
978
|
+
type: 'object',
|
|
979
|
+
properties: {
|
|
980
|
+
'karpenter.sh/capacity-type': {
|
|
981
|
+
type: 'array',
|
|
982
|
+
items: {
|
|
983
|
+
type: 'string',
|
|
984
|
+
enum: [
|
|
985
|
+
'on-demand',
|
|
986
|
+
'spot'
|
|
987
|
+
]
|
|
988
|
+
},
|
|
989
|
+
minItems: 1,
|
|
990
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
991
|
+
default: [
|
|
992
|
+
'on-demand',
|
|
993
|
+
'spot'
|
|
994
|
+
]
|
|
995
|
+
},
|
|
996
|
+
'kubernetes.io/arch': {
|
|
997
|
+
type: 'array',
|
|
998
|
+
items: {
|
|
999
|
+
type: 'string',
|
|
1000
|
+
enum: [
|
|
1001
|
+
'amd64',
|
|
1002
|
+
'arm64'
|
|
1003
|
+
]
|
|
1004
|
+
},
|
|
1005
|
+
minItems: 1,
|
|
1006
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1007
|
+
default: [
|
|
1008
|
+
'amd64'
|
|
1009
|
+
]
|
|
1010
|
+
},
|
|
1011
|
+
'cfke.io/instance-family': {
|
|
1012
|
+
type: 'array',
|
|
1013
|
+
items: {
|
|
1014
|
+
type: 'string',
|
|
1015
|
+
enum: [
|
|
1016
|
+
'a1',
|
|
1017
|
+
'a2',
|
|
1018
|
+
'a3',
|
|
1019
|
+
'a4',
|
|
1020
|
+
'c1',
|
|
1021
|
+
'c2',
|
|
1022
|
+
'c2d',
|
|
1023
|
+
'c3',
|
|
1024
|
+
'c3d',
|
|
1025
|
+
'c4',
|
|
1026
|
+
'c4a',
|
|
1027
|
+
'c4d',
|
|
1028
|
+
'c5',
|
|
1029
|
+
'c5a',
|
|
1030
|
+
'c5ad',
|
|
1031
|
+
'c5d',
|
|
1032
|
+
'c5n',
|
|
1033
|
+
'c6a',
|
|
1034
|
+
'c6g',
|
|
1035
|
+
'c6gd',
|
|
1036
|
+
'c6gn',
|
|
1037
|
+
'c6i',
|
|
1038
|
+
'c6id',
|
|
1039
|
+
'c6in',
|
|
1040
|
+
'c7a',
|
|
1041
|
+
'c7g',
|
|
1042
|
+
'c7gd',
|
|
1043
|
+
'c7gn',
|
|
1044
|
+
'c7i',
|
|
1045
|
+
'c7i-flex',
|
|
1046
|
+
'c8g',
|
|
1047
|
+
'c8gd',
|
|
1048
|
+
'cax',
|
|
1049
|
+
'ccx',
|
|
1050
|
+
'cpx',
|
|
1051
|
+
'cx',
|
|
1052
|
+
'd2',
|
|
1053
|
+
'd3',
|
|
1054
|
+
'd3en',
|
|
1055
|
+
'dl1',
|
|
1056
|
+
'dl2q',
|
|
1057
|
+
'e2',
|
|
1058
|
+
'f1',
|
|
1059
|
+
'f2',
|
|
1060
|
+
'g1',
|
|
1061
|
+
'g2',
|
|
1062
|
+
'g4ad',
|
|
1063
|
+
'g4dn',
|
|
1064
|
+
'g5',
|
|
1065
|
+
'g5g',
|
|
1066
|
+
'g6',
|
|
1067
|
+
'g6e',
|
|
1068
|
+
'gr6',
|
|
1069
|
+
'h1',
|
|
1070
|
+
'h3',
|
|
1071
|
+
'hpc6a',
|
|
1072
|
+
'hpc6id',
|
|
1073
|
+
'hpc7a',
|
|
1074
|
+
'hpc7g',
|
|
1075
|
+
'i2',
|
|
1076
|
+
'i3',
|
|
1077
|
+
'i3en',
|
|
1078
|
+
'i4g',
|
|
1079
|
+
'i4i',
|
|
1080
|
+
'i7i',
|
|
1081
|
+
'i7ie',
|
|
1082
|
+
'i8g',
|
|
1083
|
+
'im4gn',
|
|
1084
|
+
'inf1',
|
|
1085
|
+
'inf2',
|
|
1086
|
+
'is4gen',
|
|
1087
|
+
'm1',
|
|
1088
|
+
'm2',
|
|
1089
|
+
'm3',
|
|
1090
|
+
'm4',
|
|
1091
|
+
'm5',
|
|
1092
|
+
'm5a',
|
|
1093
|
+
'm5ad',
|
|
1094
|
+
'm5d',
|
|
1095
|
+
'm5dn',
|
|
1096
|
+
'm5n',
|
|
1097
|
+
'm5zn',
|
|
1098
|
+
'm6a',
|
|
1099
|
+
'm6g',
|
|
1100
|
+
'm6gd',
|
|
1101
|
+
'm6i',
|
|
1102
|
+
'm6id',
|
|
1103
|
+
'm6idn',
|
|
1104
|
+
'm6in',
|
|
1105
|
+
'm7a',
|
|
1106
|
+
'm7g',
|
|
1107
|
+
'm7gd',
|
|
1108
|
+
'm7i',
|
|
1109
|
+
'm7i-flex',
|
|
1110
|
+
'm8g',
|
|
1111
|
+
'm8gd',
|
|
1112
|
+
'n1',
|
|
1113
|
+
'n2',
|
|
1114
|
+
'n2d',
|
|
1115
|
+
'n4',
|
|
1116
|
+
'p3',
|
|
1117
|
+
'p3dn',
|
|
1118
|
+
'p4d',
|
|
1119
|
+
'p4de',
|
|
1120
|
+
'p5',
|
|
1121
|
+
'p5e',
|
|
1122
|
+
'p5en',
|
|
1123
|
+
'p6-b200',
|
|
1124
|
+
'r3',
|
|
1125
|
+
'r4',
|
|
1126
|
+
'r5',
|
|
1127
|
+
'r5a',
|
|
1128
|
+
'r5ad',
|
|
1129
|
+
'r5b',
|
|
1130
|
+
'r5d',
|
|
1131
|
+
'r5dn',
|
|
1132
|
+
'r5n',
|
|
1133
|
+
'r6a',
|
|
1134
|
+
'r6g',
|
|
1135
|
+
'r6gd',
|
|
1136
|
+
'r6i',
|
|
1137
|
+
'r6id',
|
|
1138
|
+
'r6idn',
|
|
1139
|
+
'r6in',
|
|
1140
|
+
'r7a',
|
|
1141
|
+
'r7g',
|
|
1142
|
+
'r7gd',
|
|
1143
|
+
'r7i',
|
|
1144
|
+
'r7iz',
|
|
1145
|
+
'r8g',
|
|
1146
|
+
'r8gd',
|
|
1147
|
+
't2',
|
|
1148
|
+
't2a',
|
|
1149
|
+
't2d',
|
|
1150
|
+
't3',
|
|
1151
|
+
't3a',
|
|
1152
|
+
't4g',
|
|
1153
|
+
'trn1',
|
|
1154
|
+
'trn1n',
|
|
1155
|
+
'u-3tb1',
|
|
1156
|
+
'u-6tb1',
|
|
1157
|
+
'u7i-12tb',
|
|
1158
|
+
'u7i-6tb',
|
|
1159
|
+
'u7i-8tb',
|
|
1160
|
+
'u7in-16tb',
|
|
1161
|
+
'u7in-24tb',
|
|
1162
|
+
'u7in-32tb',
|
|
1163
|
+
'vt1',
|
|
1164
|
+
'x1',
|
|
1165
|
+
'x1e',
|
|
1166
|
+
'x2gd',
|
|
1167
|
+
'x2idn',
|
|
1168
|
+
'x2iedn',
|
|
1169
|
+
'x2iezn',
|
|
1170
|
+
'x4',
|
|
1171
|
+
'x8g',
|
|
1172
|
+
'z1d',
|
|
1173
|
+
'z3'
|
|
1174
|
+
]
|
|
1175
|
+
},
|
|
1176
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1177
|
+
default: []
|
|
1178
|
+
},
|
|
1179
|
+
'topology.kubernetes.io/region': {
|
|
1180
|
+
type: 'array',
|
|
1181
|
+
items: {
|
|
1182
|
+
type: 'string',
|
|
1183
|
+
enum: [
|
|
1184
|
+
'africa-south1',
|
|
1185
|
+
'ap-northeast-1',
|
|
1186
|
+
'ap-northeast-2',
|
|
1187
|
+
'ap-northeast-3',
|
|
1188
|
+
'ap-south-1',
|
|
1189
|
+
'ap-southeast-1',
|
|
1190
|
+
'ap-southeast-2',
|
|
1191
|
+
'ash',
|
|
1192
|
+
'asia-east1',
|
|
1193
|
+
'asia-east2',
|
|
1194
|
+
'asia-northeast1',
|
|
1195
|
+
'asia-northeast2',
|
|
1196
|
+
'asia-northeast3',
|
|
1197
|
+
'asia-south1',
|
|
1198
|
+
'asia-south2',
|
|
1199
|
+
'asia-southeast1',
|
|
1200
|
+
'asia-southeast2',
|
|
1201
|
+
'australia-southeast1',
|
|
1202
|
+
'australia-southeast2',
|
|
1203
|
+
'ca-central-1',
|
|
1204
|
+
'eu-central-1',
|
|
1205
|
+
'eu-central-2',
|
|
1206
|
+
'eu-north-1',
|
|
1207
|
+
'eu-west-1',
|
|
1208
|
+
'eu-west-2',
|
|
1209
|
+
'eu-west-3',
|
|
1210
|
+
'europe-central2',
|
|
1211
|
+
'europe-north1',
|
|
1212
|
+
'europe-southwest1',
|
|
1213
|
+
'europe-west1',
|
|
1214
|
+
'europe-west10',
|
|
1215
|
+
'europe-west12',
|
|
1216
|
+
'europe-west2',
|
|
1217
|
+
'europe-west3',
|
|
1218
|
+
'europe-west4',
|
|
1219
|
+
'europe-west6',
|
|
1220
|
+
'europe-west8',
|
|
1221
|
+
'europe-west9',
|
|
1222
|
+
'fsn1',
|
|
1223
|
+
'hel1',
|
|
1224
|
+
'hil',
|
|
1225
|
+
'me-central1',
|
|
1226
|
+
'me-central2',
|
|
1227
|
+
'me-west1',
|
|
1228
|
+
'nbg1',
|
|
1229
|
+
'northamerica-northeast1',
|
|
1230
|
+
'northamerica-northeast2',
|
|
1231
|
+
'sa-east-1',
|
|
1232
|
+
'sin',
|
|
1233
|
+
'southamerica-east1',
|
|
1234
|
+
'southamerica-west1',
|
|
1235
|
+
'us-central1',
|
|
1236
|
+
'us-east-1',
|
|
1237
|
+
'us-east-2',
|
|
1238
|
+
'us-east1',
|
|
1239
|
+
'us-east4',
|
|
1240
|
+
'us-east5',
|
|
1241
|
+
'us-south1',
|
|
1242
|
+
'us-west-1',
|
|
1243
|
+
'us-west-2',
|
|
1244
|
+
'us-west1',
|
|
1245
|
+
'us-west2',
|
|
1246
|
+
'us-west3',
|
|
1247
|
+
'us-west4'
|
|
1248
|
+
]
|
|
1249
|
+
},
|
|
1250
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1251
|
+
default: []
|
|
1252
|
+
}
|
|
1253
|
+
},
|
|
1254
|
+
additionalProperties: false,
|
|
1255
|
+
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.',
|
|
1256
|
+
default: {
|
|
1257
|
+
'karpenter.sh/capacity-type': [
|
|
1258
|
+
'on-demand',
|
|
1259
|
+
'spot'
|
|
1260
|
+
],
|
|
1261
|
+
'kubernetes.io/arch': [
|
|
1262
|
+
'amd64'
|
|
1263
|
+
],
|
|
1264
|
+
'cfke.io/instance-family': [],
|
|
1265
|
+
'topology.kubernetes.io/region': []
|
|
1266
|
+
}
|
|
1267
|
+
},
|
|
1268
|
+
scalingProfile: {
|
|
1269
|
+
type: 'string',
|
|
1270
|
+
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`).',
|
|
1271
|
+
default: 'conservative',
|
|
1272
|
+
example: 'conservative',
|
|
1273
|
+
enum: [
|
|
1274
|
+
'aggressive',
|
|
1275
|
+
'conservative'
|
|
1276
|
+
]
|
|
1277
|
+
},
|
|
1278
|
+
taints: {
|
|
1279
|
+
type: 'array',
|
|
1280
|
+
items: {
|
|
1281
|
+
type: 'object',
|
|
1282
|
+
properties: {
|
|
1283
|
+
key: {
|
|
1284
|
+
type: 'string',
|
|
1285
|
+
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.',
|
|
1286
|
+
example: 'dedicated'
|
|
1287
|
+
},
|
|
1288
|
+
value: {
|
|
1289
|
+
type: 'string',
|
|
1290
|
+
maxLength: 63,
|
|
1291
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1292
|
+
description: 'Taint value. Optional.',
|
|
1293
|
+
example: 'ci'
|
|
1294
|
+
},
|
|
1295
|
+
effect: {
|
|
1296
|
+
type: 'string',
|
|
1297
|
+
description: 'Taint effect.',
|
|
1298
|
+
example: 'NoSchedule',
|
|
1299
|
+
enum: [
|
|
1300
|
+
'NoSchedule',
|
|
1301
|
+
'PreferNoSchedule',
|
|
1302
|
+
'NoExecute'
|
|
1303
|
+
]
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
required: [
|
|
1307
|
+
'key',
|
|
1308
|
+
'effect'
|
|
1309
|
+
],
|
|
1310
|
+
additionalProperties: false
|
|
1311
|
+
},
|
|
1312
|
+
maxItems: 50,
|
|
1313
|
+
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.',
|
|
1314
|
+
default: []
|
|
1315
|
+
},
|
|
564
1316
|
id: {
|
|
565
1317
|
type: 'string',
|
|
566
1318
|
maxLength: 63,
|
|
@@ -570,8 +1322,11 @@ export const FleetCreateInputSchema = {
|
|
|
570
1322
|
example: 'new-clouds-fleet'
|
|
571
1323
|
}
|
|
572
1324
|
},
|
|
573
|
-
required: [
|
|
574
|
-
|
|
1325
|
+
required: [
|
|
1326
|
+
'id'
|
|
1327
|
+
],
|
|
1328
|
+
additionalProperties: false,
|
|
1329
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
575
1330
|
};
|
|
576
1331
|
export const FleetSchema = {
|
|
577
1332
|
type: 'object',
|
|
@@ -580,13 +1335,12 @@ export const FleetSchema = {
|
|
|
580
1335
|
type: 'object',
|
|
581
1336
|
properties: {
|
|
582
1337
|
cpu: {
|
|
583
|
-
type: '
|
|
584
|
-
format: 'float',
|
|
1338
|
+
type: 'integer',
|
|
585
1339
|
minimum: 0,
|
|
586
|
-
|
|
1340
|
+
maximum: 100000,
|
|
1341
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
587
1342
|
}
|
|
588
1343
|
},
|
|
589
|
-
required: ['cpu'],
|
|
590
1344
|
additionalProperties: false,
|
|
591
1345
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
592
1346
|
},
|
|
@@ -594,47 +1348,398 @@ export const FleetSchema = {
|
|
|
594
1348
|
type: 'object',
|
|
595
1349
|
properties: {
|
|
596
1350
|
enabled: {
|
|
597
|
-
type: 'boolean'
|
|
598
|
-
default: true
|
|
1351
|
+
type: 'boolean'
|
|
599
1352
|
},
|
|
600
1353
|
project: {
|
|
601
1354
|
type: 'string',
|
|
602
|
-
|
|
1355
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1356
|
+
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.',
|
|
1357
|
+
example: 'my-cloudfleet-project'
|
|
603
1358
|
}
|
|
604
1359
|
},
|
|
605
|
-
required: [
|
|
1360
|
+
required: [
|
|
1361
|
+
'enabled'
|
|
1362
|
+
],
|
|
606
1363
|
additionalProperties: false
|
|
607
1364
|
},
|
|
608
1365
|
hetzner: {
|
|
609
1366
|
type: 'object',
|
|
610
1367
|
properties: {
|
|
611
1368
|
enabled: {
|
|
612
|
-
type: 'boolean'
|
|
613
|
-
default: true
|
|
1369
|
+
type: 'boolean'
|
|
614
1370
|
},
|
|
615
1371
|
apiKey: {
|
|
616
1372
|
type: 'string',
|
|
617
|
-
|
|
1373
|
+
pattern: '^\\*{64}$',
|
|
1374
|
+
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.'
|
|
618
1375
|
}
|
|
619
1376
|
},
|
|
620
|
-
required: [
|
|
1377
|
+
required: [
|
|
1378
|
+
'enabled'
|
|
1379
|
+
],
|
|
621
1380
|
additionalProperties: false
|
|
622
1381
|
},
|
|
623
1382
|
aws: {
|
|
624
1383
|
type: 'object',
|
|
625
1384
|
properties: {
|
|
626
1385
|
enabled: {
|
|
627
|
-
type: 'boolean'
|
|
628
|
-
default: true
|
|
1386
|
+
type: 'boolean'
|
|
629
1387
|
},
|
|
630
1388
|
controllerRoleArn: {
|
|
631
1389
|
type: 'string',
|
|
632
|
-
|
|
1390
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1391
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1392
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
633
1393
|
}
|
|
634
1394
|
},
|
|
635
|
-
required: [
|
|
1395
|
+
required: [
|
|
1396
|
+
'enabled'
|
|
1397
|
+
],
|
|
636
1398
|
additionalProperties: false
|
|
637
1399
|
},
|
|
1400
|
+
constraints: {
|
|
1401
|
+
type: 'object',
|
|
1402
|
+
properties: {
|
|
1403
|
+
'karpenter.sh/capacity-type': {
|
|
1404
|
+
type: 'array',
|
|
1405
|
+
items: {
|
|
1406
|
+
type: 'string',
|
|
1407
|
+
enum: [
|
|
1408
|
+
'on-demand',
|
|
1409
|
+
'spot'
|
|
1410
|
+
]
|
|
1411
|
+
},
|
|
1412
|
+
minItems: 1,
|
|
1413
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1414
|
+
default: [
|
|
1415
|
+
'on-demand',
|
|
1416
|
+
'spot'
|
|
1417
|
+
]
|
|
1418
|
+
},
|
|
1419
|
+
'kubernetes.io/arch': {
|
|
1420
|
+
type: 'array',
|
|
1421
|
+
items: {
|
|
1422
|
+
type: 'string',
|
|
1423
|
+
enum: [
|
|
1424
|
+
'amd64',
|
|
1425
|
+
'arm64'
|
|
1426
|
+
]
|
|
1427
|
+
},
|
|
1428
|
+
minItems: 1,
|
|
1429
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1430
|
+
default: [
|
|
1431
|
+
'amd64'
|
|
1432
|
+
]
|
|
1433
|
+
},
|
|
1434
|
+
'cfke.io/instance-family': {
|
|
1435
|
+
type: 'array',
|
|
1436
|
+
items: {
|
|
1437
|
+
type: 'string',
|
|
1438
|
+
enum: [
|
|
1439
|
+
'a1',
|
|
1440
|
+
'a2',
|
|
1441
|
+
'a3',
|
|
1442
|
+
'a4',
|
|
1443
|
+
'c1',
|
|
1444
|
+
'c2',
|
|
1445
|
+
'c2d',
|
|
1446
|
+
'c3',
|
|
1447
|
+
'c3d',
|
|
1448
|
+
'c4',
|
|
1449
|
+
'c4a',
|
|
1450
|
+
'c4d',
|
|
1451
|
+
'c5',
|
|
1452
|
+
'c5a',
|
|
1453
|
+
'c5ad',
|
|
1454
|
+
'c5d',
|
|
1455
|
+
'c5n',
|
|
1456
|
+
'c6a',
|
|
1457
|
+
'c6g',
|
|
1458
|
+
'c6gd',
|
|
1459
|
+
'c6gn',
|
|
1460
|
+
'c6i',
|
|
1461
|
+
'c6id',
|
|
1462
|
+
'c6in',
|
|
1463
|
+
'c7a',
|
|
1464
|
+
'c7g',
|
|
1465
|
+
'c7gd',
|
|
1466
|
+
'c7gn',
|
|
1467
|
+
'c7i',
|
|
1468
|
+
'c7i-flex',
|
|
1469
|
+
'c8g',
|
|
1470
|
+
'c8gd',
|
|
1471
|
+
'cax',
|
|
1472
|
+
'ccx',
|
|
1473
|
+
'cpx',
|
|
1474
|
+
'cx',
|
|
1475
|
+
'd2',
|
|
1476
|
+
'd3',
|
|
1477
|
+
'd3en',
|
|
1478
|
+
'dl1',
|
|
1479
|
+
'dl2q',
|
|
1480
|
+
'e2',
|
|
1481
|
+
'f1',
|
|
1482
|
+
'f2',
|
|
1483
|
+
'g1',
|
|
1484
|
+
'g2',
|
|
1485
|
+
'g4ad',
|
|
1486
|
+
'g4dn',
|
|
1487
|
+
'g5',
|
|
1488
|
+
'g5g',
|
|
1489
|
+
'g6',
|
|
1490
|
+
'g6e',
|
|
1491
|
+
'gr6',
|
|
1492
|
+
'h1',
|
|
1493
|
+
'h3',
|
|
1494
|
+
'hpc6a',
|
|
1495
|
+
'hpc6id',
|
|
1496
|
+
'hpc7a',
|
|
1497
|
+
'hpc7g',
|
|
1498
|
+
'i2',
|
|
1499
|
+
'i3',
|
|
1500
|
+
'i3en',
|
|
1501
|
+
'i4g',
|
|
1502
|
+
'i4i',
|
|
1503
|
+
'i7i',
|
|
1504
|
+
'i7ie',
|
|
1505
|
+
'i8g',
|
|
1506
|
+
'im4gn',
|
|
1507
|
+
'inf1',
|
|
1508
|
+
'inf2',
|
|
1509
|
+
'is4gen',
|
|
1510
|
+
'm1',
|
|
1511
|
+
'm2',
|
|
1512
|
+
'm3',
|
|
1513
|
+
'm4',
|
|
1514
|
+
'm5',
|
|
1515
|
+
'm5a',
|
|
1516
|
+
'm5ad',
|
|
1517
|
+
'm5d',
|
|
1518
|
+
'm5dn',
|
|
1519
|
+
'm5n',
|
|
1520
|
+
'm5zn',
|
|
1521
|
+
'm6a',
|
|
1522
|
+
'm6g',
|
|
1523
|
+
'm6gd',
|
|
1524
|
+
'm6i',
|
|
1525
|
+
'm6id',
|
|
1526
|
+
'm6idn',
|
|
1527
|
+
'm6in',
|
|
1528
|
+
'm7a',
|
|
1529
|
+
'm7g',
|
|
1530
|
+
'm7gd',
|
|
1531
|
+
'm7i',
|
|
1532
|
+
'm7i-flex',
|
|
1533
|
+
'm8g',
|
|
1534
|
+
'm8gd',
|
|
1535
|
+
'n1',
|
|
1536
|
+
'n2',
|
|
1537
|
+
'n2d',
|
|
1538
|
+
'n4',
|
|
1539
|
+
'p3',
|
|
1540
|
+
'p3dn',
|
|
1541
|
+
'p4d',
|
|
1542
|
+
'p4de',
|
|
1543
|
+
'p5',
|
|
1544
|
+
'p5e',
|
|
1545
|
+
'p5en',
|
|
1546
|
+
'p6-b200',
|
|
1547
|
+
'r3',
|
|
1548
|
+
'r4',
|
|
1549
|
+
'r5',
|
|
1550
|
+
'r5a',
|
|
1551
|
+
'r5ad',
|
|
1552
|
+
'r5b',
|
|
1553
|
+
'r5d',
|
|
1554
|
+
'r5dn',
|
|
1555
|
+
'r5n',
|
|
1556
|
+
'r6a',
|
|
1557
|
+
'r6g',
|
|
1558
|
+
'r6gd',
|
|
1559
|
+
'r6i',
|
|
1560
|
+
'r6id',
|
|
1561
|
+
'r6idn',
|
|
1562
|
+
'r6in',
|
|
1563
|
+
'r7a',
|
|
1564
|
+
'r7g',
|
|
1565
|
+
'r7gd',
|
|
1566
|
+
'r7i',
|
|
1567
|
+
'r7iz',
|
|
1568
|
+
'r8g',
|
|
1569
|
+
'r8gd',
|
|
1570
|
+
't2',
|
|
1571
|
+
't2a',
|
|
1572
|
+
't2d',
|
|
1573
|
+
't3',
|
|
1574
|
+
't3a',
|
|
1575
|
+
't4g',
|
|
1576
|
+
'trn1',
|
|
1577
|
+
'trn1n',
|
|
1578
|
+
'u-3tb1',
|
|
1579
|
+
'u-6tb1',
|
|
1580
|
+
'u7i-12tb',
|
|
1581
|
+
'u7i-6tb',
|
|
1582
|
+
'u7i-8tb',
|
|
1583
|
+
'u7in-16tb',
|
|
1584
|
+
'u7in-24tb',
|
|
1585
|
+
'u7in-32tb',
|
|
1586
|
+
'vt1',
|
|
1587
|
+
'x1',
|
|
1588
|
+
'x1e',
|
|
1589
|
+
'x2gd',
|
|
1590
|
+
'x2idn',
|
|
1591
|
+
'x2iedn',
|
|
1592
|
+
'x2iezn',
|
|
1593
|
+
'x4',
|
|
1594
|
+
'x8g',
|
|
1595
|
+
'z1d',
|
|
1596
|
+
'z3'
|
|
1597
|
+
]
|
|
1598
|
+
},
|
|
1599
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1600
|
+
default: []
|
|
1601
|
+
},
|
|
1602
|
+
'topology.kubernetes.io/region': {
|
|
1603
|
+
type: 'array',
|
|
1604
|
+
items: {
|
|
1605
|
+
type: 'string',
|
|
1606
|
+
enum: [
|
|
1607
|
+
'africa-south1',
|
|
1608
|
+
'ap-northeast-1',
|
|
1609
|
+
'ap-northeast-2',
|
|
1610
|
+
'ap-northeast-3',
|
|
1611
|
+
'ap-south-1',
|
|
1612
|
+
'ap-southeast-1',
|
|
1613
|
+
'ap-southeast-2',
|
|
1614
|
+
'ash',
|
|
1615
|
+
'asia-east1',
|
|
1616
|
+
'asia-east2',
|
|
1617
|
+
'asia-northeast1',
|
|
1618
|
+
'asia-northeast2',
|
|
1619
|
+
'asia-northeast3',
|
|
1620
|
+
'asia-south1',
|
|
1621
|
+
'asia-south2',
|
|
1622
|
+
'asia-southeast1',
|
|
1623
|
+
'asia-southeast2',
|
|
1624
|
+
'australia-southeast1',
|
|
1625
|
+
'australia-southeast2',
|
|
1626
|
+
'ca-central-1',
|
|
1627
|
+
'eu-central-1',
|
|
1628
|
+
'eu-central-2',
|
|
1629
|
+
'eu-north-1',
|
|
1630
|
+
'eu-west-1',
|
|
1631
|
+
'eu-west-2',
|
|
1632
|
+
'eu-west-3',
|
|
1633
|
+
'europe-central2',
|
|
1634
|
+
'europe-north1',
|
|
1635
|
+
'europe-southwest1',
|
|
1636
|
+
'europe-west1',
|
|
1637
|
+
'europe-west10',
|
|
1638
|
+
'europe-west12',
|
|
1639
|
+
'europe-west2',
|
|
1640
|
+
'europe-west3',
|
|
1641
|
+
'europe-west4',
|
|
1642
|
+
'europe-west6',
|
|
1643
|
+
'europe-west8',
|
|
1644
|
+
'europe-west9',
|
|
1645
|
+
'fsn1',
|
|
1646
|
+
'hel1',
|
|
1647
|
+
'hil',
|
|
1648
|
+
'me-central1',
|
|
1649
|
+
'me-central2',
|
|
1650
|
+
'me-west1',
|
|
1651
|
+
'nbg1',
|
|
1652
|
+
'northamerica-northeast1',
|
|
1653
|
+
'northamerica-northeast2',
|
|
1654
|
+
'sa-east-1',
|
|
1655
|
+
'sin',
|
|
1656
|
+
'southamerica-east1',
|
|
1657
|
+
'southamerica-west1',
|
|
1658
|
+
'us-central1',
|
|
1659
|
+
'us-east-1',
|
|
1660
|
+
'us-east-2',
|
|
1661
|
+
'us-east1',
|
|
1662
|
+
'us-east4',
|
|
1663
|
+
'us-east5',
|
|
1664
|
+
'us-south1',
|
|
1665
|
+
'us-west-1',
|
|
1666
|
+
'us-west-2',
|
|
1667
|
+
'us-west1',
|
|
1668
|
+
'us-west2',
|
|
1669
|
+
'us-west3',
|
|
1670
|
+
'us-west4'
|
|
1671
|
+
]
|
|
1672
|
+
},
|
|
1673
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1674
|
+
default: []
|
|
1675
|
+
}
|
|
1676
|
+
},
|
|
1677
|
+
required: [
|
|
1678
|
+
'karpenter.sh/capacity-type',
|
|
1679
|
+
'kubernetes.io/arch'
|
|
1680
|
+
],
|
|
1681
|
+
additionalProperties: false,
|
|
1682
|
+
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.',
|
|
1683
|
+
default: {
|
|
1684
|
+
'karpenter.sh/capacity-type': [
|
|
1685
|
+
'on-demand',
|
|
1686
|
+
'spot'
|
|
1687
|
+
],
|
|
1688
|
+
'kubernetes.io/arch': [
|
|
1689
|
+
'amd64'
|
|
1690
|
+
],
|
|
1691
|
+
'cfke.io/instance-family': [],
|
|
1692
|
+
'topology.kubernetes.io/region': []
|
|
1693
|
+
}
|
|
1694
|
+
},
|
|
1695
|
+
scalingProfile: {
|
|
1696
|
+
type: 'string',
|
|
1697
|
+
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`).',
|
|
1698
|
+
default: 'conservative',
|
|
1699
|
+
example: 'conservative',
|
|
1700
|
+
enum: [
|
|
1701
|
+
'aggressive',
|
|
1702
|
+
'conservative'
|
|
1703
|
+
]
|
|
1704
|
+
},
|
|
1705
|
+
taints: {
|
|
1706
|
+
type: 'array',
|
|
1707
|
+
items: {
|
|
1708
|
+
type: 'object',
|
|
1709
|
+
properties: {
|
|
1710
|
+
key: {
|
|
1711
|
+
type: 'string',
|
|
1712
|
+
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.',
|
|
1713
|
+
example: 'dedicated'
|
|
1714
|
+
},
|
|
1715
|
+
value: {
|
|
1716
|
+
type: 'string',
|
|
1717
|
+
maxLength: 63,
|
|
1718
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
1719
|
+
description: 'Taint value. Optional.',
|
|
1720
|
+
example: 'ci'
|
|
1721
|
+
},
|
|
1722
|
+
effect: {
|
|
1723
|
+
type: 'string',
|
|
1724
|
+
description: 'Taint effect.',
|
|
1725
|
+
example: 'NoSchedule',
|
|
1726
|
+
enum: [
|
|
1727
|
+
'NoSchedule',
|
|
1728
|
+
'PreferNoSchedule',
|
|
1729
|
+
'NoExecute'
|
|
1730
|
+
]
|
|
1731
|
+
}
|
|
1732
|
+
},
|
|
1733
|
+
required: [
|
|
1734
|
+
'key',
|
|
1735
|
+
'effect'
|
|
1736
|
+
],
|
|
1737
|
+
additionalProperties: false
|
|
1738
|
+
},
|
|
1739
|
+
maxItems: 50,
|
|
1740
|
+
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.',
|
|
1741
|
+
default: []
|
|
1742
|
+
},
|
|
638
1743
|
id: {
|
|
639
1744
|
type: 'string',
|
|
640
1745
|
maxLength: 63,
|
|
@@ -642,10 +1747,39 @@ export const FleetSchema = {
|
|
|
642
1747
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
643
1748
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
644
1749
|
example: 'new-clouds-fleet'
|
|
1750
|
+
},
|
|
1751
|
+
ready: {
|
|
1752
|
+
type: 'boolean',
|
|
1753
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1754
|
+
example: true
|
|
1755
|
+
},
|
|
1756
|
+
status_message: {
|
|
1757
|
+
type: 'string',
|
|
1758
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1759
|
+
example: 'Invalid provider permissions.'
|
|
1760
|
+
},
|
|
1761
|
+
created_at: {
|
|
1762
|
+
type: 'string',
|
|
1763
|
+
description: 'Creation date and time of the fleet.',
|
|
1764
|
+
example: '2024-09-12T09:11:27Z'
|
|
1765
|
+
},
|
|
1766
|
+
updated_at: {
|
|
1767
|
+
type: 'string',
|
|
1768
|
+
description: 'Date and time the fleet was last updated.',
|
|
1769
|
+
example: '2024-09-12T09:11:27Z'
|
|
645
1770
|
}
|
|
646
1771
|
},
|
|
647
|
-
required: [
|
|
648
|
-
|
|
1772
|
+
required: [
|
|
1773
|
+
'constraints',
|
|
1774
|
+
'scalingProfile',
|
|
1775
|
+
'taints',
|
|
1776
|
+
'id',
|
|
1777
|
+
'ready',
|
|
1778
|
+
'created_at',
|
|
1779
|
+
'updated_at'
|
|
1780
|
+
],
|
|
1781
|
+
additionalProperties: false,
|
|
1782
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
649
1783
|
};
|
|
650
1784
|
export const FleetUpdateInputSchema = {
|
|
651
1785
|
type: 'object',
|
|
@@ -654,13 +1788,12 @@ export const FleetUpdateInputSchema = {
|
|
|
654
1788
|
type: 'object',
|
|
655
1789
|
properties: {
|
|
656
1790
|
cpu: {
|
|
657
|
-
type: '
|
|
658
|
-
format: 'float',
|
|
1791
|
+
type: 'integer',
|
|
659
1792
|
minimum: 0,
|
|
660
|
-
|
|
1793
|
+
maximum: 100000,
|
|
1794
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
661
1795
|
}
|
|
662
1796
|
},
|
|
663
|
-
required: ['cpu'],
|
|
664
1797
|
additionalProperties: false,
|
|
665
1798
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
666
1799
|
},
|
|
@@ -668,48 +1801,423 @@ export const FleetUpdateInputSchema = {
|
|
|
668
1801
|
type: 'object',
|
|
669
1802
|
properties: {
|
|
670
1803
|
enabled: {
|
|
671
|
-
type: 'boolean'
|
|
672
|
-
default: true
|
|
1804
|
+
type: 'boolean'
|
|
673
1805
|
},
|
|
674
1806
|
project: {
|
|
675
1807
|
type: 'string',
|
|
676
|
-
|
|
1808
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1809
|
+
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.',
|
|
1810
|
+
example: 'my-cloudfleet-project'
|
|
677
1811
|
}
|
|
678
1812
|
},
|
|
679
|
-
required: [
|
|
1813
|
+
required: [
|
|
1814
|
+
'enabled'
|
|
1815
|
+
],
|
|
680
1816
|
additionalProperties: false
|
|
681
1817
|
},
|
|
682
1818
|
hetzner: {
|
|
683
1819
|
type: 'object',
|
|
684
1820
|
properties: {
|
|
685
1821
|
enabled: {
|
|
686
|
-
type: 'boolean'
|
|
687
|
-
default: true
|
|
1822
|
+
type: 'boolean'
|
|
688
1823
|
},
|
|
689
1824
|
apiKey: {
|
|
690
1825
|
type: 'string',
|
|
691
|
-
|
|
1826
|
+
maxLength: 64,
|
|
1827
|
+
minLength: 64,
|
|
1828
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1829
|
+
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.'
|
|
692
1830
|
}
|
|
693
1831
|
},
|
|
694
|
-
required: [
|
|
1832
|
+
required: [
|
|
1833
|
+
'enabled'
|
|
1834
|
+
],
|
|
695
1835
|
additionalProperties: false
|
|
696
1836
|
},
|
|
697
1837
|
aws: {
|
|
698
1838
|
type: 'object',
|
|
699
1839
|
properties: {
|
|
700
1840
|
enabled: {
|
|
701
|
-
type: 'boolean'
|
|
702
|
-
default: true
|
|
1841
|
+
type: 'boolean'
|
|
703
1842
|
},
|
|
704
1843
|
controllerRoleArn: {
|
|
705
1844
|
type: 'string',
|
|
706
|
-
|
|
1845
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1846
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1847
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
707
1848
|
}
|
|
708
1849
|
},
|
|
709
|
-
required: [
|
|
1850
|
+
required: [
|
|
1851
|
+
'enabled'
|
|
1852
|
+
],
|
|
710
1853
|
additionalProperties: false
|
|
1854
|
+
},
|
|
1855
|
+
constraints: {
|
|
1856
|
+
type: 'object',
|
|
1857
|
+
properties: {
|
|
1858
|
+
'karpenter.sh/capacity-type': {
|
|
1859
|
+
type: 'array',
|
|
1860
|
+
items: {
|
|
1861
|
+
type: 'string',
|
|
1862
|
+
enum: [
|
|
1863
|
+
'on-demand',
|
|
1864
|
+
'spot'
|
|
1865
|
+
]
|
|
1866
|
+
},
|
|
1867
|
+
minItems: 1,
|
|
1868
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1869
|
+
default: [
|
|
1870
|
+
'on-demand',
|
|
1871
|
+
'spot'
|
|
1872
|
+
]
|
|
1873
|
+
},
|
|
1874
|
+
'kubernetes.io/arch': {
|
|
1875
|
+
type: 'array',
|
|
1876
|
+
items: {
|
|
1877
|
+
type: 'string',
|
|
1878
|
+
enum: [
|
|
1879
|
+
'amd64',
|
|
1880
|
+
'arm64'
|
|
1881
|
+
]
|
|
1882
|
+
},
|
|
1883
|
+
minItems: 1,
|
|
1884
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1885
|
+
default: [
|
|
1886
|
+
'amd64'
|
|
1887
|
+
]
|
|
1888
|
+
},
|
|
1889
|
+
'cfke.io/instance-family': {
|
|
1890
|
+
type: 'array',
|
|
1891
|
+
items: {
|
|
1892
|
+
type: 'string',
|
|
1893
|
+
enum: [
|
|
1894
|
+
'a1',
|
|
1895
|
+
'a2',
|
|
1896
|
+
'a3',
|
|
1897
|
+
'a4',
|
|
1898
|
+
'c1',
|
|
1899
|
+
'c2',
|
|
1900
|
+
'c2d',
|
|
1901
|
+
'c3',
|
|
1902
|
+
'c3d',
|
|
1903
|
+
'c4',
|
|
1904
|
+
'c4a',
|
|
1905
|
+
'c4d',
|
|
1906
|
+
'c5',
|
|
1907
|
+
'c5a',
|
|
1908
|
+
'c5ad',
|
|
1909
|
+
'c5d',
|
|
1910
|
+
'c5n',
|
|
1911
|
+
'c6a',
|
|
1912
|
+
'c6g',
|
|
1913
|
+
'c6gd',
|
|
1914
|
+
'c6gn',
|
|
1915
|
+
'c6i',
|
|
1916
|
+
'c6id',
|
|
1917
|
+
'c6in',
|
|
1918
|
+
'c7a',
|
|
1919
|
+
'c7g',
|
|
1920
|
+
'c7gd',
|
|
1921
|
+
'c7gn',
|
|
1922
|
+
'c7i',
|
|
1923
|
+
'c7i-flex',
|
|
1924
|
+
'c8g',
|
|
1925
|
+
'c8gd',
|
|
1926
|
+
'cax',
|
|
1927
|
+
'ccx',
|
|
1928
|
+
'cpx',
|
|
1929
|
+
'cx',
|
|
1930
|
+
'd2',
|
|
1931
|
+
'd3',
|
|
1932
|
+
'd3en',
|
|
1933
|
+
'dl1',
|
|
1934
|
+
'dl2q',
|
|
1935
|
+
'e2',
|
|
1936
|
+
'f1',
|
|
1937
|
+
'f2',
|
|
1938
|
+
'g1',
|
|
1939
|
+
'g2',
|
|
1940
|
+
'g4ad',
|
|
1941
|
+
'g4dn',
|
|
1942
|
+
'g5',
|
|
1943
|
+
'g5g',
|
|
1944
|
+
'g6',
|
|
1945
|
+
'g6e',
|
|
1946
|
+
'gr6',
|
|
1947
|
+
'h1',
|
|
1948
|
+
'h3',
|
|
1949
|
+
'hpc6a',
|
|
1950
|
+
'hpc6id',
|
|
1951
|
+
'hpc7a',
|
|
1952
|
+
'hpc7g',
|
|
1953
|
+
'i2',
|
|
1954
|
+
'i3',
|
|
1955
|
+
'i3en',
|
|
1956
|
+
'i4g',
|
|
1957
|
+
'i4i',
|
|
1958
|
+
'i7i',
|
|
1959
|
+
'i7ie',
|
|
1960
|
+
'i8g',
|
|
1961
|
+
'im4gn',
|
|
1962
|
+
'inf1',
|
|
1963
|
+
'inf2',
|
|
1964
|
+
'is4gen',
|
|
1965
|
+
'm1',
|
|
1966
|
+
'm2',
|
|
1967
|
+
'm3',
|
|
1968
|
+
'm4',
|
|
1969
|
+
'm5',
|
|
1970
|
+
'm5a',
|
|
1971
|
+
'm5ad',
|
|
1972
|
+
'm5d',
|
|
1973
|
+
'm5dn',
|
|
1974
|
+
'm5n',
|
|
1975
|
+
'm5zn',
|
|
1976
|
+
'm6a',
|
|
1977
|
+
'm6g',
|
|
1978
|
+
'm6gd',
|
|
1979
|
+
'm6i',
|
|
1980
|
+
'm6id',
|
|
1981
|
+
'm6idn',
|
|
1982
|
+
'm6in',
|
|
1983
|
+
'm7a',
|
|
1984
|
+
'm7g',
|
|
1985
|
+
'm7gd',
|
|
1986
|
+
'm7i',
|
|
1987
|
+
'm7i-flex',
|
|
1988
|
+
'm8g',
|
|
1989
|
+
'm8gd',
|
|
1990
|
+
'n1',
|
|
1991
|
+
'n2',
|
|
1992
|
+
'n2d',
|
|
1993
|
+
'n4',
|
|
1994
|
+
'p3',
|
|
1995
|
+
'p3dn',
|
|
1996
|
+
'p4d',
|
|
1997
|
+
'p4de',
|
|
1998
|
+
'p5',
|
|
1999
|
+
'p5e',
|
|
2000
|
+
'p5en',
|
|
2001
|
+
'p6-b200',
|
|
2002
|
+
'r3',
|
|
2003
|
+
'r4',
|
|
2004
|
+
'r5',
|
|
2005
|
+
'r5a',
|
|
2006
|
+
'r5ad',
|
|
2007
|
+
'r5b',
|
|
2008
|
+
'r5d',
|
|
2009
|
+
'r5dn',
|
|
2010
|
+
'r5n',
|
|
2011
|
+
'r6a',
|
|
2012
|
+
'r6g',
|
|
2013
|
+
'r6gd',
|
|
2014
|
+
'r6i',
|
|
2015
|
+
'r6id',
|
|
2016
|
+
'r6idn',
|
|
2017
|
+
'r6in',
|
|
2018
|
+
'r7a',
|
|
2019
|
+
'r7g',
|
|
2020
|
+
'r7gd',
|
|
2021
|
+
'r7i',
|
|
2022
|
+
'r7iz',
|
|
2023
|
+
'r8g',
|
|
2024
|
+
'r8gd',
|
|
2025
|
+
't2',
|
|
2026
|
+
't2a',
|
|
2027
|
+
't2d',
|
|
2028
|
+
't3',
|
|
2029
|
+
't3a',
|
|
2030
|
+
't4g',
|
|
2031
|
+
'trn1',
|
|
2032
|
+
'trn1n',
|
|
2033
|
+
'u-3tb1',
|
|
2034
|
+
'u-6tb1',
|
|
2035
|
+
'u7i-12tb',
|
|
2036
|
+
'u7i-6tb',
|
|
2037
|
+
'u7i-8tb',
|
|
2038
|
+
'u7in-16tb',
|
|
2039
|
+
'u7in-24tb',
|
|
2040
|
+
'u7in-32tb',
|
|
2041
|
+
'vt1',
|
|
2042
|
+
'x1',
|
|
2043
|
+
'x1e',
|
|
2044
|
+
'x2gd',
|
|
2045
|
+
'x2idn',
|
|
2046
|
+
'x2iedn',
|
|
2047
|
+
'x2iezn',
|
|
2048
|
+
'x4',
|
|
2049
|
+
'x8g',
|
|
2050
|
+
'z1d',
|
|
2051
|
+
'z3'
|
|
2052
|
+
]
|
|
2053
|
+
},
|
|
2054
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2055
|
+
default: []
|
|
2056
|
+
},
|
|
2057
|
+
'topology.kubernetes.io/region': {
|
|
2058
|
+
type: 'array',
|
|
2059
|
+
items: {
|
|
2060
|
+
type: 'string',
|
|
2061
|
+
enum: [
|
|
2062
|
+
'africa-south1',
|
|
2063
|
+
'ap-northeast-1',
|
|
2064
|
+
'ap-northeast-2',
|
|
2065
|
+
'ap-northeast-3',
|
|
2066
|
+
'ap-south-1',
|
|
2067
|
+
'ap-southeast-1',
|
|
2068
|
+
'ap-southeast-2',
|
|
2069
|
+
'ash',
|
|
2070
|
+
'asia-east1',
|
|
2071
|
+
'asia-east2',
|
|
2072
|
+
'asia-northeast1',
|
|
2073
|
+
'asia-northeast2',
|
|
2074
|
+
'asia-northeast3',
|
|
2075
|
+
'asia-south1',
|
|
2076
|
+
'asia-south2',
|
|
2077
|
+
'asia-southeast1',
|
|
2078
|
+
'asia-southeast2',
|
|
2079
|
+
'australia-southeast1',
|
|
2080
|
+
'australia-southeast2',
|
|
2081
|
+
'ca-central-1',
|
|
2082
|
+
'eu-central-1',
|
|
2083
|
+
'eu-central-2',
|
|
2084
|
+
'eu-north-1',
|
|
2085
|
+
'eu-west-1',
|
|
2086
|
+
'eu-west-2',
|
|
2087
|
+
'eu-west-3',
|
|
2088
|
+
'europe-central2',
|
|
2089
|
+
'europe-north1',
|
|
2090
|
+
'europe-southwest1',
|
|
2091
|
+
'europe-west1',
|
|
2092
|
+
'europe-west10',
|
|
2093
|
+
'europe-west12',
|
|
2094
|
+
'europe-west2',
|
|
2095
|
+
'europe-west3',
|
|
2096
|
+
'europe-west4',
|
|
2097
|
+
'europe-west6',
|
|
2098
|
+
'europe-west8',
|
|
2099
|
+
'europe-west9',
|
|
2100
|
+
'fsn1',
|
|
2101
|
+
'hel1',
|
|
2102
|
+
'hil',
|
|
2103
|
+
'me-central1',
|
|
2104
|
+
'me-central2',
|
|
2105
|
+
'me-west1',
|
|
2106
|
+
'nbg1',
|
|
2107
|
+
'northamerica-northeast1',
|
|
2108
|
+
'northamerica-northeast2',
|
|
2109
|
+
'sa-east-1',
|
|
2110
|
+
'sin',
|
|
2111
|
+
'southamerica-east1',
|
|
2112
|
+
'southamerica-west1',
|
|
2113
|
+
'us-central1',
|
|
2114
|
+
'us-east-1',
|
|
2115
|
+
'us-east-2',
|
|
2116
|
+
'us-east1',
|
|
2117
|
+
'us-east4',
|
|
2118
|
+
'us-east5',
|
|
2119
|
+
'us-south1',
|
|
2120
|
+
'us-west-1',
|
|
2121
|
+
'us-west-2',
|
|
2122
|
+
'us-west1',
|
|
2123
|
+
'us-west2',
|
|
2124
|
+
'us-west3',
|
|
2125
|
+
'us-west4'
|
|
2126
|
+
]
|
|
2127
|
+
},
|
|
2128
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2129
|
+
default: []
|
|
2130
|
+
}
|
|
2131
|
+
},
|
|
2132
|
+
additionalProperties: false,
|
|
2133
|
+
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.',
|
|
2134
|
+
default: {
|
|
2135
|
+
'karpenter.sh/capacity-type': [
|
|
2136
|
+
'on-demand',
|
|
2137
|
+
'spot'
|
|
2138
|
+
],
|
|
2139
|
+
'kubernetes.io/arch': [
|
|
2140
|
+
'amd64'
|
|
2141
|
+
],
|
|
2142
|
+
'cfke.io/instance-family': [],
|
|
2143
|
+
'topology.kubernetes.io/region': []
|
|
2144
|
+
}
|
|
2145
|
+
},
|
|
2146
|
+
scalingProfile: {
|
|
2147
|
+
type: 'string',
|
|
2148
|
+
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`).',
|
|
2149
|
+
default: 'conservative',
|
|
2150
|
+
example: 'conservative',
|
|
2151
|
+
enum: [
|
|
2152
|
+
'aggressive',
|
|
2153
|
+
'conservative'
|
|
2154
|
+
]
|
|
2155
|
+
},
|
|
2156
|
+
taints: {
|
|
2157
|
+
type: 'array',
|
|
2158
|
+
items: {
|
|
2159
|
+
type: 'object',
|
|
2160
|
+
properties: {
|
|
2161
|
+
key: {
|
|
2162
|
+
type: 'string',
|
|
2163
|
+
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.',
|
|
2164
|
+
example: 'dedicated'
|
|
2165
|
+
},
|
|
2166
|
+
value: {
|
|
2167
|
+
type: 'string',
|
|
2168
|
+
maxLength: 63,
|
|
2169
|
+
pattern: '^([A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?)?$',
|
|
2170
|
+
description: 'Taint value. Optional.',
|
|
2171
|
+
example: 'ci'
|
|
2172
|
+
},
|
|
2173
|
+
effect: {
|
|
2174
|
+
type: 'string',
|
|
2175
|
+
description: 'Taint effect.',
|
|
2176
|
+
example: 'NoSchedule',
|
|
2177
|
+
enum: [
|
|
2178
|
+
'NoSchedule',
|
|
2179
|
+
'PreferNoSchedule',
|
|
2180
|
+
'NoExecute'
|
|
2181
|
+
]
|
|
2182
|
+
}
|
|
2183
|
+
},
|
|
2184
|
+
required: [
|
|
2185
|
+
'key',
|
|
2186
|
+
'effect'
|
|
2187
|
+
],
|
|
2188
|
+
additionalProperties: false
|
|
2189
|
+
},
|
|
2190
|
+
maxItems: 50,
|
|
2191
|
+
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.',
|
|
2192
|
+
default: []
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
additionalProperties: false,
|
|
2196
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2197
|
+
};
|
|
2198
|
+
export const InviteCreateInputSchema = {
|
|
2199
|
+
type: 'object',
|
|
2200
|
+
properties: {
|
|
2201
|
+
email: {
|
|
2202
|
+
type: 'string',
|
|
2203
|
+
format: 'email',
|
|
2204
|
+
description: 'Email address of the user to invite.',
|
|
2205
|
+
example: 'email@example.com'
|
|
2206
|
+
},
|
|
2207
|
+
role: {
|
|
2208
|
+
type: 'string',
|
|
2209
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2210
|
+
default: 'User',
|
|
2211
|
+
example: 'User',
|
|
2212
|
+
enum: [
|
|
2213
|
+
'Administrator',
|
|
2214
|
+
'User'
|
|
2215
|
+
]
|
|
711
2216
|
}
|
|
712
2217
|
},
|
|
2218
|
+
required: [
|
|
2219
|
+
'email'
|
|
2220
|
+
],
|
|
713
2221
|
additionalProperties: false
|
|
714
2222
|
};
|
|
715
2223
|
export const InviteSchema = {
|
|
@@ -742,453 +2250,255 @@ export const InviteSchema = {
|
|
|
742
2250
|
type: 'string',
|
|
743
2251
|
description: 'Generated unique invite code.',
|
|
744
2252
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2253
|
+
},
|
|
2254
|
+
role: {
|
|
2255
|
+
type: 'string',
|
|
2256
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2257
|
+
default: 'User',
|
|
2258
|
+
example: 'User',
|
|
2259
|
+
enum: [
|
|
2260
|
+
'Administrator',
|
|
2261
|
+
'User'
|
|
2262
|
+
]
|
|
745
2263
|
}
|
|
746
2264
|
},
|
|
747
|
-
required: [
|
|
2265
|
+
required: [
|
|
2266
|
+
'date_created'
|
|
2267
|
+
],
|
|
748
2268
|
additionalProperties: false
|
|
749
2269
|
};
|
|
750
|
-
export const
|
|
2270
|
+
export const InvoicePaymentAttemptSchema = {
|
|
751
2271
|
type: 'object',
|
|
752
2272
|
properties: {
|
|
753
|
-
|
|
754
|
-
type: 'string',
|
|
755
|
-
format: 'uuid',
|
|
756
|
-
description: 'Unique identifier of the invoice. UUID v4 string in canonical form',
|
|
757
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
758
|
-
},
|
|
759
|
-
organizationId: {
|
|
2273
|
+
invoice_id: {
|
|
760
2274
|
type: 'string',
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
2275
|
+
description: 'Identifier of the invoice.',
|
|
2276
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
764
2277
|
},
|
|
765
|
-
|
|
2278
|
+
number: {
|
|
766
2279
|
type: 'string',
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
2280
|
+
nullable: true,
|
|
2281
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2282
|
+
example: 'CF-0042'
|
|
770
2283
|
},
|
|
771
2284
|
amount: {
|
|
772
2285
|
type: 'number',
|
|
773
2286
|
format: 'float',
|
|
774
|
-
description: '
|
|
775
|
-
example:
|
|
2287
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2288
|
+
example: 4200
|
|
776
2289
|
},
|
|
777
2290
|
currency: {
|
|
778
2291
|
type: 'string',
|
|
779
|
-
description: 'Currency of the invoice',
|
|
780
|
-
example: '
|
|
781
|
-
enum: ['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SPL', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XDR', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWD', 'BTC']
|
|
2292
|
+
description: 'Currency of the invoice.',
|
|
2293
|
+
example: 'eur'
|
|
782
2294
|
},
|
|
783
|
-
|
|
784
|
-
type: '
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
2295
|
+
status: {
|
|
2296
|
+
type: 'string',
|
|
2297
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2298
|
+
example: 'paid',
|
|
2299
|
+
enum: [
|
|
2300
|
+
'paid',
|
|
2301
|
+
'processing',
|
|
2302
|
+
'requires_action',
|
|
2303
|
+
'failed'
|
|
2304
|
+
]
|
|
788
2305
|
},
|
|
789
|
-
|
|
790
|
-
type: 'number',
|
|
791
|
-
format: 'float',
|
|
792
|
-
description: 'Total amount of refund adjustments',
|
|
793
|
-
example: 0
|
|
794
|
-
},
|
|
795
|
-
invoiceDate: {
|
|
2306
|
+
client_secret: {
|
|
796
2307
|
type: 'string',
|
|
797
|
-
|
|
798
|
-
|
|
2308
|
+
nullable: true,
|
|
2309
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2310
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
799
2311
|
},
|
|
800
|
-
|
|
2312
|
+
failure_code: {
|
|
801
2313
|
type: 'string',
|
|
802
|
-
|
|
803
|
-
|
|
2314
|
+
nullable: true,
|
|
2315
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2316
|
+
example: 'insufficient_funds'
|
|
804
2317
|
},
|
|
805
|
-
|
|
2318
|
+
failure_message: {
|
|
806
2319
|
type: 'string',
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
2320
|
+
nullable: true,
|
|
2321
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2322
|
+
example: 'Your card has insufficient funds.'
|
|
2323
|
+
}
|
|
2324
|
+
},
|
|
2325
|
+
required: [
|
|
2326
|
+
'invoice_id',
|
|
2327
|
+
'number',
|
|
2328
|
+
'amount',
|
|
2329
|
+
'currency',
|
|
2330
|
+
'status',
|
|
2331
|
+
'client_secret',
|
|
2332
|
+
'failure_code',
|
|
2333
|
+
'failure_message'
|
|
2334
|
+
],
|
|
2335
|
+
additionalProperties: false
|
|
2336
|
+
};
|
|
2337
|
+
export const InvoicePaymentResultSchema = {
|
|
2338
|
+
type: 'object',
|
|
2339
|
+
properties: {
|
|
2340
|
+
code: {
|
|
2341
|
+
type: 'string',
|
|
2342
|
+
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).',
|
|
2343
|
+
example: 'partially_paid',
|
|
2344
|
+
enum: [
|
|
2345
|
+
'paid',
|
|
2346
|
+
'processing',
|
|
2347
|
+
'action_required',
|
|
2348
|
+
'partially_paid',
|
|
2349
|
+
'failed',
|
|
2350
|
+
'nothing_due',
|
|
2351
|
+
'bank_transfer_due'
|
|
2352
|
+
]
|
|
815
2353
|
},
|
|
816
|
-
|
|
2354
|
+
message: {
|
|
817
2355
|
type: 'string',
|
|
818
|
-
description: '
|
|
819
|
-
example: '
|
|
2356
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2357
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
820
2358
|
},
|
|
821
|
-
|
|
2359
|
+
results: {
|
|
822
2360
|
type: 'array',
|
|
823
2361
|
items: {
|
|
824
2362
|
type: 'object',
|
|
825
2363
|
properties: {
|
|
826
|
-
|
|
827
|
-
type: 'string',
|
|
828
|
-
format: 'uuid',
|
|
829
|
-
description: 'Unique identifier of the invoice item. UUID v4 string in canonical form',
|
|
830
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
831
|
-
},
|
|
832
|
-
linkedInvoiceItemId: {
|
|
833
|
-
type: 'string',
|
|
834
|
-
format: 'uuid',
|
|
835
|
-
description: 'Unique identifier of the linked invoice item. UUID v4 string in canonical form',
|
|
836
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
837
|
-
},
|
|
838
|
-
productName: {
|
|
839
|
-
type: 'string',
|
|
840
|
-
description: 'Name of the product',
|
|
841
|
-
example: 'Research team'
|
|
842
|
-
},
|
|
843
|
-
planName: {
|
|
844
|
-
type: 'string',
|
|
845
|
-
description: 'Name of the plan',
|
|
846
|
-
example: 'Plan A'
|
|
847
|
-
},
|
|
848
|
-
phaseName: {
|
|
849
|
-
type: 'string',
|
|
850
|
-
description: 'Name of the phase',
|
|
851
|
-
example: 'Phase A'
|
|
852
|
-
},
|
|
853
|
-
usageName: {
|
|
854
|
-
type: 'string',
|
|
855
|
-
description: 'Name of the usage',
|
|
856
|
-
example: 'Usage A'
|
|
857
|
-
},
|
|
858
|
-
prettyProductName: {
|
|
859
|
-
type: 'string',
|
|
860
|
-
description: 'Pretty name of the product',
|
|
861
|
-
example: 'Research team'
|
|
862
|
-
},
|
|
863
|
-
prettyPlanName: {
|
|
864
|
-
type: 'string',
|
|
865
|
-
description: 'Pretty name of the plan',
|
|
866
|
-
example: 'Plan A'
|
|
867
|
-
},
|
|
868
|
-
prettyPhaseName: {
|
|
869
|
-
type: 'string',
|
|
870
|
-
description: 'Pretty name of the phase',
|
|
871
|
-
example: 'Phase A'
|
|
872
|
-
},
|
|
873
|
-
prettyUsageName: {
|
|
874
|
-
type: 'string',
|
|
875
|
-
description: 'Pretty name of the usage',
|
|
876
|
-
example: 'Usage A'
|
|
877
|
-
},
|
|
878
|
-
itemType: {
|
|
879
|
-
type: 'string',
|
|
880
|
-
description: 'Type of the invoice item',
|
|
881
|
-
example: 'EXTERNAL_CHARGE',
|
|
882
|
-
enum: ['EXTERNAL_CHARGE', 'FIXED', 'RECURRING', 'REPAIR_ADJ', 'CBA_ADJ', 'CREDIT_ADJ', 'ITEM_ADJ', 'USAGE', 'TAX', 'PARENT_SUMMARY']
|
|
883
|
-
},
|
|
884
|
-
description: {
|
|
885
|
-
type: 'string',
|
|
886
|
-
description: 'Description of the invoice item',
|
|
887
|
-
example: 'Description of the invoice item'
|
|
888
|
-
},
|
|
889
|
-
startDate: {
|
|
2364
|
+
invoice_id: {
|
|
890
2365
|
type: 'string',
|
|
891
|
-
description: '
|
|
892
|
-
example: '
|
|
2366
|
+
description: 'Identifier of the invoice.',
|
|
2367
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
893
2368
|
},
|
|
894
|
-
|
|
2369
|
+
number: {
|
|
895
2370
|
type: 'string',
|
|
896
|
-
description: '
|
|
897
|
-
example: '
|
|
2371
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2372
|
+
example: 'CF-0042'
|
|
898
2373
|
},
|
|
899
2374
|
amount: {
|
|
900
2375
|
type: 'number',
|
|
901
2376
|
format: 'float',
|
|
902
|
-
description: 'Amount
|
|
903
|
-
example:
|
|
904
|
-
},
|
|
905
|
-
rate: {
|
|
906
|
-
type: 'number',
|
|
907
|
-
format: 'float',
|
|
908
|
-
description: 'Rate of the invoice item',
|
|
909
|
-
example: 100
|
|
2377
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2378
|
+
example: 4200
|
|
910
2379
|
},
|
|
911
2380
|
currency: {
|
|
912
2381
|
type: 'string',
|
|
913
|
-
description: 'Currency of the invoice
|
|
914
|
-
example: '
|
|
915
|
-
enum: ['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SPL', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XDR', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWD', 'BTC']
|
|
916
|
-
},
|
|
917
|
-
quantity: {
|
|
918
|
-
type: 'number',
|
|
919
|
-
format: 'float',
|
|
920
|
-
description: 'Quantity of the invoice item',
|
|
921
|
-
example: 1
|
|
922
|
-
},
|
|
923
|
-
itemDetails: {
|
|
924
|
-
type: 'string',
|
|
925
|
-
description: 'Details of the invoice item',
|
|
926
|
-
example: 'Details of the invoice item'
|
|
927
|
-
},
|
|
928
|
-
catalogEffectiveDate: {
|
|
929
|
-
type: 'string',
|
|
930
|
-
description: 'Effective date of the catalog',
|
|
931
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
932
|
-
},
|
|
933
|
-
childItems: {
|
|
934
|
-
type: 'array',
|
|
935
|
-
items: {
|
|
936
|
-
oneOf: [
|
|
937
|
-
{
|
|
938
|
-
type: 'array'
|
|
939
|
-
},
|
|
940
|
-
{
|
|
941
|
-
type: 'boolean'
|
|
942
|
-
},
|
|
943
|
-
{
|
|
944
|
-
type: 'number'
|
|
945
|
-
},
|
|
946
|
-
{
|
|
947
|
-
type: 'object',
|
|
948
|
-
additionalProperties: true
|
|
949
|
-
},
|
|
950
|
-
{
|
|
951
|
-
type: 'string'
|
|
952
|
-
}
|
|
953
|
-
]
|
|
954
|
-
},
|
|
955
|
-
description: 'Child items of the invoice item'
|
|
956
|
-
}
|
|
957
|
-
},
|
|
958
|
-
additionalProperties: false
|
|
959
|
-
},
|
|
960
|
-
description: 'Credits of the invoice'
|
|
961
|
-
},
|
|
962
|
-
items: {
|
|
963
|
-
type: 'array',
|
|
964
|
-
items: {
|
|
965
|
-
type: 'object',
|
|
966
|
-
properties: {
|
|
967
|
-
id: {
|
|
968
|
-
type: 'string',
|
|
969
|
-
format: 'uuid',
|
|
970
|
-
description: 'Unique identifier of the invoice item. UUID v4 string in canonical form',
|
|
971
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
972
|
-
},
|
|
973
|
-
linkedInvoiceItemId: {
|
|
974
|
-
type: 'string',
|
|
975
|
-
format: 'uuid',
|
|
976
|
-
description: 'Unique identifier of the linked invoice item. UUID v4 string in canonical form',
|
|
977
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
978
|
-
},
|
|
979
|
-
productName: {
|
|
980
|
-
type: 'string',
|
|
981
|
-
description: 'Name of the product',
|
|
982
|
-
example: 'Research team'
|
|
983
|
-
},
|
|
984
|
-
planName: {
|
|
985
|
-
type: 'string',
|
|
986
|
-
description: 'Name of the plan',
|
|
987
|
-
example: 'Plan A'
|
|
988
|
-
},
|
|
989
|
-
phaseName: {
|
|
990
|
-
type: 'string',
|
|
991
|
-
description: 'Name of the phase',
|
|
992
|
-
example: 'Phase A'
|
|
993
|
-
},
|
|
994
|
-
usageName: {
|
|
995
|
-
type: 'string',
|
|
996
|
-
description: 'Name of the usage',
|
|
997
|
-
example: 'Usage A'
|
|
998
|
-
},
|
|
999
|
-
prettyProductName: {
|
|
1000
|
-
type: 'string',
|
|
1001
|
-
description: 'Pretty name of the product',
|
|
1002
|
-
example: 'Research team'
|
|
1003
|
-
},
|
|
1004
|
-
prettyPlanName: {
|
|
1005
|
-
type: 'string',
|
|
1006
|
-
description: 'Pretty name of the plan',
|
|
1007
|
-
example: 'Plan A'
|
|
1008
|
-
},
|
|
1009
|
-
prettyPhaseName: {
|
|
1010
|
-
type: 'string',
|
|
1011
|
-
description: 'Pretty name of the phase',
|
|
1012
|
-
example: 'Phase A'
|
|
1013
|
-
},
|
|
1014
|
-
prettyUsageName: {
|
|
1015
|
-
type: 'string',
|
|
1016
|
-
description: 'Pretty name of the usage',
|
|
1017
|
-
example: 'Usage A'
|
|
2382
|
+
description: 'Currency of the invoice.',
|
|
2383
|
+
example: 'eur'
|
|
1018
2384
|
},
|
|
1019
|
-
|
|
2385
|
+
status: {
|
|
1020
2386
|
type: 'string',
|
|
1021
|
-
description: '
|
|
1022
|
-
example: '
|
|
1023
|
-
enum: [
|
|
2387
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2388
|
+
example: 'paid',
|
|
2389
|
+
enum: [
|
|
2390
|
+
'paid',
|
|
2391
|
+
'processing',
|
|
2392
|
+
'requires_action',
|
|
2393
|
+
'failed'
|
|
2394
|
+
]
|
|
1024
2395
|
},
|
|
1025
|
-
|
|
2396
|
+
client_secret: {
|
|
1026
2397
|
type: 'string',
|
|
1027
|
-
description: '
|
|
1028
|
-
example: '
|
|
2398
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2399
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
1029
2400
|
},
|
|
1030
|
-
|
|
2401
|
+
failure_code: {
|
|
1031
2402
|
type: 'string',
|
|
1032
|
-
description: '
|
|
1033
|
-
example: '
|
|
1034
|
-
},
|
|
1035
|
-
endDate: {
|
|
1036
|
-
type: 'string',
|
|
1037
|
-
description: 'End date of the invoice item',
|
|
1038
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
1039
|
-
},
|
|
1040
|
-
amount: {
|
|
1041
|
-
type: 'number',
|
|
1042
|
-
format: 'float',
|
|
1043
|
-
description: 'Amount of the invoice item',
|
|
1044
|
-
example: 100
|
|
1045
|
-
},
|
|
1046
|
-
rate: {
|
|
1047
|
-
type: 'number',
|
|
1048
|
-
format: 'float',
|
|
1049
|
-
description: 'Rate of the invoice item',
|
|
1050
|
-
example: 100
|
|
1051
|
-
},
|
|
1052
|
-
currency: {
|
|
1053
|
-
type: 'string',
|
|
1054
|
-
description: 'Currency of the invoice item',
|
|
1055
|
-
example: 'USD',
|
|
1056
|
-
enum: ['AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'IMP', 'INR', 'IQD', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SPL', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XDR', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWD', 'BTC']
|
|
1057
|
-
},
|
|
1058
|
-
quantity: {
|
|
1059
|
-
type: 'number',
|
|
1060
|
-
format: 'float',
|
|
1061
|
-
description: 'Quantity of the invoice item',
|
|
1062
|
-
example: 1
|
|
1063
|
-
},
|
|
1064
|
-
itemDetails: {
|
|
1065
|
-
type: 'string',
|
|
1066
|
-
description: 'Details of the invoice item',
|
|
1067
|
-
example: 'Details of the invoice item'
|
|
2403
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2404
|
+
example: 'insufficient_funds'
|
|
1068
2405
|
},
|
|
1069
|
-
|
|
2406
|
+
failure_message: {
|
|
1070
2407
|
type: 'string',
|
|
1071
|
-
description: '
|
|
1072
|
-
example: '
|
|
1073
|
-
},
|
|
1074
|
-
childItems: {
|
|
1075
|
-
type: 'array',
|
|
1076
|
-
items: {
|
|
1077
|
-
oneOf: [
|
|
1078
|
-
{
|
|
1079
|
-
type: 'array'
|
|
1080
|
-
},
|
|
1081
|
-
{
|
|
1082
|
-
type: 'boolean'
|
|
1083
|
-
},
|
|
1084
|
-
{
|
|
1085
|
-
type: 'number'
|
|
1086
|
-
},
|
|
1087
|
-
{
|
|
1088
|
-
type: 'object',
|
|
1089
|
-
additionalProperties: true
|
|
1090
|
-
},
|
|
1091
|
-
{
|
|
1092
|
-
type: 'string'
|
|
1093
|
-
}
|
|
1094
|
-
]
|
|
1095
|
-
},
|
|
1096
|
-
description: 'Child items of the invoice item'
|
|
2408
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2409
|
+
example: 'Your card has insufficient funds.'
|
|
1097
2410
|
}
|
|
1098
2411
|
},
|
|
2412
|
+
required: [
|
|
2413
|
+
'invoice_id',
|
|
2414
|
+
'number',
|
|
2415
|
+
'amount',
|
|
2416
|
+
'currency',
|
|
2417
|
+
'status',
|
|
2418
|
+
'client_secret',
|
|
2419
|
+
'failure_code',
|
|
2420
|
+
'failure_message'
|
|
2421
|
+
],
|
|
1099
2422
|
additionalProperties: false
|
|
1100
2423
|
},
|
|
1101
|
-
description: '
|
|
2424
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
1102
2425
|
}
|
|
1103
2426
|
},
|
|
2427
|
+
required: [
|
|
2428
|
+
'code',
|
|
2429
|
+
'message',
|
|
2430
|
+
'results'
|
|
2431
|
+
],
|
|
1104
2432
|
additionalProperties: false
|
|
1105
2433
|
};
|
|
1106
|
-
export const
|
|
2434
|
+
export const InvoiceSchema = {
|
|
1107
2435
|
type: 'object',
|
|
1108
2436
|
properties: {
|
|
1109
2437
|
id: {
|
|
1110
2438
|
type: 'string',
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1114
|
-
description: 'Id of the chart listing',
|
|
1115
|
-
example: 'portworx-enterprise-disaster-recovery-baremetal'
|
|
2439
|
+
description: 'Unique identifier of the invoice.',
|
|
2440
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
1116
2441
|
},
|
|
1117
|
-
|
|
1118
|
-
type: 'string'
|
|
1119
|
-
description: 'Name of the chart listing',
|
|
1120
|
-
example: 'Portworx Enterprise + Disaster Recovery - Baremetal'
|
|
2442
|
+
number: {
|
|
2443
|
+
type: 'string'
|
|
1121
2444
|
},
|
|
1122
|
-
|
|
2445
|
+
status: {
|
|
1123
2446
|
type: 'string',
|
|
1124
|
-
description: '
|
|
1125
|
-
example: '
|
|
2447
|
+
description: 'Status of the invoice',
|
|
2448
|
+
example: 'paid'
|
|
1126
2449
|
},
|
|
1127
|
-
|
|
1128
|
-
type: '
|
|
1129
|
-
|
|
1130
|
-
|
|
2450
|
+
total: {
|
|
2451
|
+
type: 'number',
|
|
2452
|
+
format: 'float',
|
|
2453
|
+
description: 'Total amount of the invoice',
|
|
2454
|
+
example: 100
|
|
1131
2455
|
},
|
|
1132
|
-
|
|
2456
|
+
currency: {
|
|
1133
2457
|
type: 'string',
|
|
1134
|
-
description: '
|
|
1135
|
-
example: '
|
|
2458
|
+
description: 'Currency of the invoice',
|
|
2459
|
+
example: 'usd'
|
|
1136
2460
|
},
|
|
1137
|
-
|
|
2461
|
+
created: {
|
|
1138
2462
|
type: 'string',
|
|
1139
|
-
|
|
1140
|
-
|
|
2463
|
+
format: 'date-time',
|
|
2464
|
+
description: 'Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.',
|
|
2465
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
1141
2466
|
},
|
|
1142
|
-
|
|
1143
|
-
type: '
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
},
|
|
1148
|
-
description: 'Tags of the chart'
|
|
2467
|
+
period_start: {
|
|
2468
|
+
type: 'string',
|
|
2469
|
+
format: 'date-time',
|
|
2470
|
+
description: 'Billing period start timestamp. ISO 8601 date string in the UTC timezone.',
|
|
2471
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
1149
2472
|
},
|
|
1150
|
-
|
|
1151
|
-
type: '
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
description: 'Version of the chart.',
|
|
1156
|
-
example: '2.x.x-cfke.x'
|
|
1157
|
-
}
|
|
2473
|
+
period_end: {
|
|
2474
|
+
type: 'string',
|
|
2475
|
+
format: 'date-time',
|
|
2476
|
+
description: 'Billing period end timestamp. ISO 8601 date string in the UTC timezone.',
|
|
2477
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
1158
2478
|
},
|
|
1159
|
-
|
|
1160
|
-
type: '
|
|
1161
|
-
items: {
|
|
1162
|
-
type: 'object',
|
|
1163
|
-
properties: {
|
|
1164
|
-
version: {
|
|
1165
|
-
type: 'string',
|
|
1166
|
-
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-]+)*))?$',
|
|
1167
|
-
description: 'Version of the chart.',
|
|
1168
|
-
example: '2.1.1-cfke.123'
|
|
1169
|
-
},
|
|
1170
|
-
schema: {
|
|
1171
|
-
type: 'string',
|
|
1172
|
-
description: 'Schema of the chart values. JSON Schema as string'
|
|
1173
|
-
},
|
|
1174
|
-
placeholder: {
|
|
1175
|
-
type: 'string',
|
|
1176
|
-
description: 'Schema of the chart values',
|
|
1177
|
-
example: `foo: 1
|
|
1178
|
-
bar: example`
|
|
1179
|
-
}
|
|
1180
|
-
},
|
|
1181
|
-
required: ['version', 'schema', 'placeholder'],
|
|
1182
|
-
additionalProperties: false
|
|
1183
|
-
}
|
|
2479
|
+
invoice_pdf: {
|
|
2480
|
+
type: 'string'
|
|
1184
2481
|
}
|
|
1185
2482
|
},
|
|
1186
|
-
required: [
|
|
2483
|
+
required: [
|
|
2484
|
+
'created',
|
|
2485
|
+
'period_start',
|
|
2486
|
+
'period_end'
|
|
2487
|
+
],
|
|
1187
2488
|
additionalProperties: false
|
|
1188
2489
|
};
|
|
1189
2490
|
export const OrganizationCreateInputSchema = {
|
|
1190
2491
|
type: 'object',
|
|
1191
2492
|
properties: {
|
|
2493
|
+
type: {
|
|
2494
|
+
type: 'string',
|
|
2495
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2496
|
+
example: 'business',
|
|
2497
|
+
enum: [
|
|
2498
|
+
'business',
|
|
2499
|
+
'personal'
|
|
2500
|
+
]
|
|
2501
|
+
},
|
|
1192
2502
|
email: {
|
|
1193
2503
|
type: 'string',
|
|
1194
2504
|
format: 'email',
|
|
@@ -1197,11 +2507,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1197
2507
|
},
|
|
1198
2508
|
first_name: {
|
|
1199
2509
|
type: 'string',
|
|
2510
|
+
minLength: 1,
|
|
1200
2511
|
description: 'First name of the billing contact person.',
|
|
1201
2512
|
example: 'John'
|
|
1202
2513
|
},
|
|
1203
2514
|
last_name: {
|
|
1204
2515
|
type: 'string',
|
|
2516
|
+
minLength: 1,
|
|
1205
2517
|
description: 'Last name of the billing contact person.',
|
|
1206
2518
|
example: 'Doe'
|
|
1207
2519
|
},
|
|
@@ -1219,7 +2531,28 @@ export const OrganizationCreateInputSchema = {
|
|
|
1219
2531
|
description: 'Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.'
|
|
1220
2532
|
}
|
|
1221
2533
|
},
|
|
1222
|
-
required: [
|
|
2534
|
+
required: [
|
|
2535
|
+
'type',
|
|
2536
|
+
'email',
|
|
2537
|
+
'first_name',
|
|
2538
|
+
'last_name',
|
|
2539
|
+
'company_name',
|
|
2540
|
+
'password'
|
|
2541
|
+
],
|
|
2542
|
+
additionalProperties: false
|
|
2543
|
+
};
|
|
2544
|
+
export const OrganizationCreateOutputSchema = {
|
|
2545
|
+
type: 'object',
|
|
2546
|
+
properties: {
|
|
2547
|
+
id: {
|
|
2548
|
+
type: 'string',
|
|
2549
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2550
|
+
example: 'organization-id'
|
|
2551
|
+
}
|
|
2552
|
+
},
|
|
2553
|
+
required: [
|
|
2554
|
+
'id'
|
|
2555
|
+
],
|
|
1223
2556
|
additionalProperties: false
|
|
1224
2557
|
};
|
|
1225
2558
|
export const OrganizationSchema = {
|
|
@@ -1238,6 +2571,15 @@ export const OrganizationSchema = {
|
|
|
1238
2571
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
1239
2572
|
example: 'ACME Corp.'
|
|
1240
2573
|
},
|
|
2574
|
+
type: {
|
|
2575
|
+
type: 'string',
|
|
2576
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2577
|
+
example: 'business',
|
|
2578
|
+
enum: [
|
|
2579
|
+
'business',
|
|
2580
|
+
'personal'
|
|
2581
|
+
]
|
|
2582
|
+
},
|
|
1241
2583
|
date_created: {
|
|
1242
2584
|
type: 'string',
|
|
1243
2585
|
format: 'date-time',
|
|
@@ -1269,6 +2611,17 @@ export const OrganizationSchema = {
|
|
|
1269
2611
|
description: 'Available number of Pro clusters that can be created.',
|
|
1270
2612
|
example: 999
|
|
1271
2613
|
},
|
|
2614
|
+
enterprise_clusters_max: {
|
|
2615
|
+
type: 'integer',
|
|
2616
|
+
minimum: 0,
|
|
2617
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2618
|
+
example: 999
|
|
2619
|
+
},
|
|
2620
|
+
enterprise_clusters_available: {
|
|
2621
|
+
type: 'integer',
|
|
2622
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2623
|
+
example: 999
|
|
2624
|
+
},
|
|
1272
2625
|
fleets_max: {
|
|
1273
2626
|
type: 'integer',
|
|
1274
2627
|
minimum: 0,
|
|
@@ -1279,107 +2632,959 @@ export const OrganizationSchema = {
|
|
|
1279
2632
|
type: 'array',
|
|
1280
2633
|
items: {
|
|
1281
2634
|
type: 'string',
|
|
1282
|
-
example: 'basic'
|
|
2635
|
+
example: 'basic'
|
|
2636
|
+
},
|
|
2637
|
+
minItems: 0,
|
|
2638
|
+
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
2639
|
+
},
|
|
2640
|
+
regions: {
|
|
2641
|
+
type: 'array',
|
|
2642
|
+
items: {
|
|
2643
|
+
type: 'string',
|
|
2644
|
+
example: 'northamerica-central-1a'
|
|
2645
|
+
},
|
|
2646
|
+
minItems: 1,
|
|
2647
|
+
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
2648
|
+
},
|
|
2649
|
+
versions: {
|
|
2650
|
+
type: 'array',
|
|
2651
|
+
items: {
|
|
2652
|
+
type: 'object',
|
|
2653
|
+
properties: {
|
|
2654
|
+
id: {
|
|
2655
|
+
type: 'string',
|
|
2656
|
+
description: 'Id of the control plane version. Used in API calls.',
|
|
2657
|
+
example: '1.33.x-cfke.x'
|
|
2658
|
+
},
|
|
2659
|
+
label: {
|
|
2660
|
+
type: 'string',
|
|
2661
|
+
description: 'Label of the control plane version. Used in frontent UI.',
|
|
2662
|
+
example: '1.33.x (Always latest 1.33 patch version)'
|
|
2663
|
+
}
|
|
2664
|
+
},
|
|
2665
|
+
required: [
|
|
2666
|
+
'id',
|
|
2667
|
+
'label'
|
|
2668
|
+
],
|
|
2669
|
+
additionalProperties: false
|
|
2670
|
+
},
|
|
2671
|
+
minItems: 1,
|
|
2672
|
+
description: 'List of CFKE control plane versions available for the organization.'
|
|
2673
|
+
},
|
|
2674
|
+
cfcr_storage_gb: {
|
|
2675
|
+
type: 'integer',
|
|
2676
|
+
minimum: -1,
|
|
2677
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
2678
|
+
example: 500
|
|
2679
|
+
}
|
|
2680
|
+
},
|
|
2681
|
+
required: [
|
|
2682
|
+
'basic_clusters_max',
|
|
2683
|
+
'basic_clusters_available',
|
|
2684
|
+
'pro_clusters_max',
|
|
2685
|
+
'pro_clusters_available',
|
|
2686
|
+
'enterprise_clusters_max',
|
|
2687
|
+
'enterprise_clusters_available',
|
|
2688
|
+
'fleets_max',
|
|
2689
|
+
'cluster_tiers',
|
|
2690
|
+
'regions',
|
|
2691
|
+
'versions',
|
|
2692
|
+
'cfcr_storage_gb'
|
|
2693
|
+
],
|
|
2694
|
+
additionalProperties: false,
|
|
2695
|
+
description: 'For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.'
|
|
2696
|
+
},
|
|
2697
|
+
status: {
|
|
2698
|
+
type: 'string',
|
|
2699
|
+
description: 'Status of the organization. Can be `active` or `closed`, or `suspended`.',
|
|
2700
|
+
enum: [
|
|
2701
|
+
'active',
|
|
2702
|
+
'closed',
|
|
2703
|
+
'suspended'
|
|
2704
|
+
]
|
|
2705
|
+
},
|
|
2706
|
+
verification: {
|
|
2707
|
+
type: 'string',
|
|
2708
|
+
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.',
|
|
2709
|
+
example: 'verified',
|
|
2710
|
+
enum: [
|
|
2711
|
+
'none',
|
|
2712
|
+
'submitted',
|
|
2713
|
+
'verified'
|
|
2714
|
+
]
|
|
2715
|
+
}
|
|
2716
|
+
},
|
|
2717
|
+
required: [
|
|
2718
|
+
'id',
|
|
2719
|
+
'type',
|
|
2720
|
+
'date_created',
|
|
2721
|
+
'quota',
|
|
2722
|
+
'status',
|
|
2723
|
+
'verification'
|
|
2724
|
+
],
|
|
2725
|
+
additionalProperties: false
|
|
2726
|
+
};
|
|
2727
|
+
export const PaymentMethodSchema = {
|
|
2728
|
+
type: 'object',
|
|
2729
|
+
properties: {
|
|
2730
|
+
id: {
|
|
2731
|
+
type: 'string',
|
|
2732
|
+
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.',
|
|
2733
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2734
|
+
},
|
|
2735
|
+
type: {
|
|
2736
|
+
type: 'string',
|
|
2737
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2738
|
+
example: 'card',
|
|
2739
|
+
enum: [
|
|
2740
|
+
'card',
|
|
2741
|
+
'sepa_debit',
|
|
2742
|
+
'bank_transfer'
|
|
2743
|
+
]
|
|
2744
|
+
},
|
|
2745
|
+
last4: {
|
|
2746
|
+
type: 'string',
|
|
2747
|
+
nullable: true,
|
|
2748
|
+
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.',
|
|
2749
|
+
example: '4242'
|
|
2750
|
+
},
|
|
2751
|
+
exp_month: {
|
|
2752
|
+
type: 'integer',
|
|
2753
|
+
minimum: 1,
|
|
2754
|
+
maximum: 12,
|
|
2755
|
+
nullable: true,
|
|
2756
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2757
|
+
example: 12
|
|
2758
|
+
},
|
|
2759
|
+
exp_year: {
|
|
2760
|
+
type: 'integer',
|
|
2761
|
+
nullable: true,
|
|
2762
|
+
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.',
|
|
2763
|
+
example: 2028
|
|
2764
|
+
},
|
|
2765
|
+
brand: {
|
|
2766
|
+
type: 'string',
|
|
2767
|
+
nullable: true,
|
|
2768
|
+
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.',
|
|
2769
|
+
example: 'visa'
|
|
2770
|
+
},
|
|
2771
|
+
iban: {
|
|
2772
|
+
type: 'string',
|
|
2773
|
+
nullable: true,
|
|
2774
|
+
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.',
|
|
2775
|
+
example: 'DE11243015658023127510'
|
|
2776
|
+
},
|
|
2777
|
+
bic: {
|
|
2778
|
+
type: 'string',
|
|
2779
|
+
nullable: true,
|
|
2780
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2781
|
+
example: 'SOGEDEFFXXX'
|
|
2782
|
+
},
|
|
2783
|
+
account_holder_name: {
|
|
2784
|
+
type: 'string',
|
|
2785
|
+
nullable: true,
|
|
2786
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2787
|
+
example: 'Cloudfleet GmbH'
|
|
2788
|
+
},
|
|
2789
|
+
is_default: {
|
|
2790
|
+
type: 'boolean',
|
|
2791
|
+
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).',
|
|
2792
|
+
example: true
|
|
2793
|
+
}
|
|
2794
|
+
},
|
|
2795
|
+
required: [
|
|
2796
|
+
'id',
|
|
2797
|
+
'type',
|
|
2798
|
+
'last4',
|
|
2799
|
+
'exp_month',
|
|
2800
|
+
'exp_year',
|
|
2801
|
+
'brand',
|
|
2802
|
+
'iban',
|
|
2803
|
+
'bic',
|
|
2804
|
+
'account_holder_name',
|
|
2805
|
+
'is_default'
|
|
2806
|
+
],
|
|
2807
|
+
additionalProperties: false
|
|
2808
|
+
};
|
|
2809
|
+
export const PlatformQuotaSchema = {
|
|
2810
|
+
type: 'object',
|
|
2811
|
+
properties: {
|
|
2812
|
+
basic_clusters_max: {
|
|
2813
|
+
type: 'integer',
|
|
2814
|
+
minimum: 0,
|
|
2815
|
+
description: 'Maximum number of Basic clusters that can be created.',
|
|
2816
|
+
example: 999
|
|
2817
|
+
},
|
|
2818
|
+
basic_clusters_available: {
|
|
2819
|
+
type: 'integer',
|
|
2820
|
+
description: 'Available number of Basic clusters that can be created.',
|
|
2821
|
+
example: 999
|
|
2822
|
+
},
|
|
2823
|
+
pro_clusters_max: {
|
|
2824
|
+
type: 'integer',
|
|
2825
|
+
minimum: 0,
|
|
2826
|
+
description: 'Maximum number of Pro clusters that can be created.',
|
|
2827
|
+
example: 999
|
|
2828
|
+
},
|
|
2829
|
+
pro_clusters_available: {
|
|
2830
|
+
type: 'integer',
|
|
2831
|
+
description: 'Available number of Pro clusters that can be created.',
|
|
2832
|
+
example: 999
|
|
2833
|
+
},
|
|
2834
|
+
enterprise_clusters_max: {
|
|
2835
|
+
type: 'integer',
|
|
2836
|
+
minimum: 0,
|
|
2837
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2838
|
+
example: 999
|
|
2839
|
+
},
|
|
2840
|
+
enterprise_clusters_available: {
|
|
2841
|
+
type: 'integer',
|
|
2842
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2843
|
+
example: 999
|
|
2844
|
+
},
|
|
2845
|
+
fleets_max: {
|
|
2846
|
+
type: 'integer',
|
|
2847
|
+
minimum: 0,
|
|
2848
|
+
description: 'Maximum number of fleets that can be created per cluster.',
|
|
2849
|
+
example: 999
|
|
2850
|
+
},
|
|
2851
|
+
cluster_tiers: {
|
|
2852
|
+
type: 'array',
|
|
2853
|
+
items: {
|
|
2854
|
+
type: 'string',
|
|
2855
|
+
example: 'basic'
|
|
2856
|
+
},
|
|
2857
|
+
minItems: 0,
|
|
2858
|
+
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
2859
|
+
},
|
|
2860
|
+
regions: {
|
|
2861
|
+
type: 'array',
|
|
2862
|
+
items: {
|
|
2863
|
+
type: 'string',
|
|
2864
|
+
example: 'northamerica-central-1a'
|
|
2865
|
+
},
|
|
2866
|
+
minItems: 1,
|
|
2867
|
+
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
2868
|
+
},
|
|
2869
|
+
versions: {
|
|
2870
|
+
type: 'array',
|
|
2871
|
+
items: {
|
|
2872
|
+
type: 'object',
|
|
2873
|
+
properties: {
|
|
2874
|
+
id: {
|
|
2875
|
+
type: 'string',
|
|
2876
|
+
description: 'Id of the control plane version. Used in API calls.',
|
|
2877
|
+
example: '1.33.x-cfke.x'
|
|
2878
|
+
},
|
|
2879
|
+
label: {
|
|
2880
|
+
type: 'string',
|
|
2881
|
+
description: 'Label of the control plane version. Used in frontent UI.',
|
|
2882
|
+
example: '1.33.x (Always latest 1.33 patch version)'
|
|
2883
|
+
}
|
|
2884
|
+
},
|
|
2885
|
+
required: [
|
|
2886
|
+
'id',
|
|
2887
|
+
'label'
|
|
2888
|
+
],
|
|
2889
|
+
additionalProperties: false
|
|
2890
|
+
},
|
|
2891
|
+
minItems: 1,
|
|
2892
|
+
description: 'List of CFKE control plane versions available for the organization.'
|
|
2893
|
+
},
|
|
2894
|
+
cfcr_storage_gb: {
|
|
2895
|
+
type: 'integer',
|
|
2896
|
+
minimum: -1,
|
|
2897
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
2898
|
+
example: 500
|
|
2899
|
+
}
|
|
2900
|
+
},
|
|
2901
|
+
required: [
|
|
2902
|
+
'basic_clusters_max',
|
|
2903
|
+
'basic_clusters_available',
|
|
2904
|
+
'pro_clusters_max',
|
|
2905
|
+
'pro_clusters_available',
|
|
2906
|
+
'enterprise_clusters_max',
|
|
2907
|
+
'enterprise_clusters_available',
|
|
2908
|
+
'fleets_max',
|
|
2909
|
+
'cluster_tiers',
|
|
2910
|
+
'regions',
|
|
2911
|
+
'versions',
|
|
2912
|
+
'cfcr_storage_gb'
|
|
2913
|
+
],
|
|
2914
|
+
additionalProperties: false
|
|
2915
|
+
};
|
|
2916
|
+
export const RegistryRepositorySchema = {
|
|
2917
|
+
type: 'object',
|
|
2918
|
+
properties: {
|
|
2919
|
+
name: {
|
|
2920
|
+
type: 'string',
|
|
2921
|
+
description: 'Repository name.',
|
|
2922
|
+
example: 'my-app'
|
|
2923
|
+
},
|
|
2924
|
+
region: {
|
|
2925
|
+
type: 'string',
|
|
2926
|
+
description: 'Registry region.',
|
|
2927
|
+
example: 'northamerica'
|
|
2928
|
+
},
|
|
2929
|
+
uri: {
|
|
2930
|
+
type: 'string',
|
|
2931
|
+
description: 'Full URI of the repository.',
|
|
2932
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
2933
|
+
}
|
|
2934
|
+
},
|
|
2935
|
+
required: [
|
|
2936
|
+
'name',
|
|
2937
|
+
'region',
|
|
2938
|
+
'uri'
|
|
2939
|
+
],
|
|
2940
|
+
additionalProperties: false
|
|
2941
|
+
};
|
|
2942
|
+
export const RegistryRepositoryWithTagsSchema = {
|
|
2943
|
+
type: 'object',
|
|
2944
|
+
properties: {
|
|
2945
|
+
name: {
|
|
2946
|
+
type: 'string',
|
|
2947
|
+
description: 'Repository name.',
|
|
2948
|
+
example: 'my-app'
|
|
2949
|
+
},
|
|
2950
|
+
region: {
|
|
2951
|
+
type: 'string',
|
|
2952
|
+
description: 'Registry region.',
|
|
2953
|
+
example: 'northamerica'
|
|
2954
|
+
},
|
|
2955
|
+
uri: {
|
|
2956
|
+
type: 'string',
|
|
2957
|
+
description: 'Full URI of the repository.',
|
|
2958
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
2959
|
+
},
|
|
2960
|
+
tags: {
|
|
2961
|
+
type: 'array',
|
|
2962
|
+
items: {
|
|
2963
|
+
type: 'object',
|
|
2964
|
+
properties: {
|
|
2965
|
+
name: {
|
|
2966
|
+
type: 'string',
|
|
2967
|
+
description: 'Tag name.',
|
|
2968
|
+
example: 'latest'
|
|
2969
|
+
},
|
|
2970
|
+
size: {
|
|
2971
|
+
type: 'number',
|
|
2972
|
+
format: 'float',
|
|
2973
|
+
description: 'Size of the tag in bytes.',
|
|
2974
|
+
example: 123456789
|
|
2975
|
+
},
|
|
2976
|
+
mediaType: {
|
|
2977
|
+
type: 'string',
|
|
2978
|
+
description: 'Media type of the manifest.',
|
|
2979
|
+
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
2980
|
+
},
|
|
2981
|
+
platforms: {
|
|
2982
|
+
type: 'array',
|
|
2983
|
+
items: {
|
|
2984
|
+
type: 'string'
|
|
2985
|
+
},
|
|
2986
|
+
description: 'Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).',
|
|
2987
|
+
example: [
|
|
2988
|
+
'linux/amd64',
|
|
2989
|
+
'linux/arm64'
|
|
2990
|
+
]
|
|
2991
|
+
}
|
|
2992
|
+
},
|
|
2993
|
+
required: [
|
|
2994
|
+
'name',
|
|
2995
|
+
'size'
|
|
2996
|
+
],
|
|
2997
|
+
additionalProperties: false
|
|
2998
|
+
},
|
|
2999
|
+
description: 'Array of tags in the repository.'
|
|
3000
|
+
},
|
|
3001
|
+
totalSize: {
|
|
3002
|
+
type: 'number',
|
|
3003
|
+
format: 'float',
|
|
3004
|
+
description: 'Total size of all tags in the repository in bytes.',
|
|
3005
|
+
example: 987654321
|
|
3006
|
+
}
|
|
3007
|
+
},
|
|
3008
|
+
required: [
|
|
3009
|
+
'name',
|
|
3010
|
+
'region',
|
|
3011
|
+
'uri',
|
|
3012
|
+
'tags',
|
|
3013
|
+
'totalSize'
|
|
3014
|
+
],
|
|
3015
|
+
additionalProperties: false
|
|
3016
|
+
};
|
|
3017
|
+
export const RegistryTagSchema = {
|
|
3018
|
+
type: 'object',
|
|
3019
|
+
properties: {
|
|
3020
|
+
name: {
|
|
3021
|
+
type: 'string',
|
|
3022
|
+
description: 'Tag name.',
|
|
3023
|
+
example: 'latest'
|
|
3024
|
+
},
|
|
3025
|
+
digest: {
|
|
3026
|
+
type: 'string',
|
|
3027
|
+
description: 'Manifest digest for pulling by digest.',
|
|
3028
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3029
|
+
},
|
|
3030
|
+
mediaType: {
|
|
3031
|
+
type: 'string',
|
|
3032
|
+
description: 'Media type of the manifest.',
|
|
3033
|
+
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
3034
|
+
},
|
|
3035
|
+
config: {
|
|
3036
|
+
type: 'object',
|
|
3037
|
+
properties: {
|
|
3038
|
+
size: {
|
|
3039
|
+
type: 'number',
|
|
3040
|
+
format: 'float',
|
|
3041
|
+
description: 'Size of the config in bytes.',
|
|
3042
|
+
example: 1234
|
|
3043
|
+
}
|
|
3044
|
+
},
|
|
3045
|
+
required: [
|
|
3046
|
+
'size'
|
|
3047
|
+
],
|
|
3048
|
+
additionalProperties: false,
|
|
3049
|
+
description: 'Manifest config metadata.'
|
|
3050
|
+
},
|
|
3051
|
+
layers: {
|
|
3052
|
+
type: 'array',
|
|
3053
|
+
items: {
|
|
3054
|
+
type: 'object',
|
|
3055
|
+
properties: {
|
|
3056
|
+
digest: {
|
|
3057
|
+
type: 'string',
|
|
3058
|
+
description: 'Digest of the layer.',
|
|
3059
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3060
|
+
},
|
|
3061
|
+
size: {
|
|
3062
|
+
type: 'number',
|
|
3063
|
+
format: 'float',
|
|
3064
|
+
description: 'Size of the layer in bytes.',
|
|
3065
|
+
example: 5678
|
|
3066
|
+
}
|
|
3067
|
+
},
|
|
3068
|
+
required: [
|
|
3069
|
+
'size'
|
|
3070
|
+
],
|
|
3071
|
+
additionalProperties: false
|
|
3072
|
+
},
|
|
3073
|
+
description: 'Array of layer metadata.'
|
|
3074
|
+
},
|
|
3075
|
+
manifests: {
|
|
3076
|
+
type: 'array',
|
|
3077
|
+
items: {
|
|
3078
|
+
type: 'object',
|
|
3079
|
+
properties: {
|
|
3080
|
+
digest: {
|
|
3081
|
+
type: 'string',
|
|
3082
|
+
description: 'Digest of the manifest.',
|
|
3083
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3084
|
+
},
|
|
3085
|
+
platform: {
|
|
3086
|
+
type: 'object',
|
|
3087
|
+
properties: {
|
|
3088
|
+
architecture: {
|
|
3089
|
+
type: 'string',
|
|
3090
|
+
description: 'Architecture of the platform.',
|
|
3091
|
+
example: 'amd64'
|
|
3092
|
+
},
|
|
3093
|
+
os: {
|
|
3094
|
+
type: 'string',
|
|
3095
|
+
description: 'Operating system of the platform.',
|
|
3096
|
+
example: 'linux'
|
|
3097
|
+
},
|
|
3098
|
+
variant: {
|
|
3099
|
+
type: 'string',
|
|
3100
|
+
description: 'Variant of the platform (e.g., v7, v8 for ARM).',
|
|
3101
|
+
example: 'v8'
|
|
3102
|
+
}
|
|
3103
|
+
},
|
|
3104
|
+
required: [
|
|
3105
|
+
'architecture',
|
|
3106
|
+
'os'
|
|
3107
|
+
],
|
|
3108
|
+
additionalProperties: false,
|
|
3109
|
+
description: 'Platform information for the manifest.'
|
|
3110
|
+
},
|
|
3111
|
+
layers: {
|
|
3112
|
+
type: 'array',
|
|
3113
|
+
items: {
|
|
3114
|
+
type: 'object',
|
|
3115
|
+
properties: {
|
|
3116
|
+
digest: {
|
|
3117
|
+
type: 'string',
|
|
3118
|
+
description: 'Digest of the layer.',
|
|
3119
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
3120
|
+
},
|
|
3121
|
+
size: {
|
|
3122
|
+
type: 'number',
|
|
3123
|
+
format: 'float',
|
|
3124
|
+
description: 'Size of the layer in bytes.',
|
|
3125
|
+
example: 5678
|
|
3126
|
+
}
|
|
3127
|
+
},
|
|
3128
|
+
required: [
|
|
3129
|
+
'size'
|
|
3130
|
+
],
|
|
3131
|
+
additionalProperties: false
|
|
3132
|
+
},
|
|
3133
|
+
description: 'Layers for this platform.'
|
|
3134
|
+
},
|
|
3135
|
+
size: {
|
|
3136
|
+
type: 'number',
|
|
3137
|
+
format: 'float',
|
|
3138
|
+
description: 'Total size of this platform manifest in bytes.',
|
|
3139
|
+
example: 12345678
|
|
3140
|
+
}
|
|
3141
|
+
},
|
|
3142
|
+
required: [
|
|
3143
|
+
'digest'
|
|
3144
|
+
],
|
|
3145
|
+
additionalProperties: false
|
|
3146
|
+
},
|
|
3147
|
+
description: 'Array of manifests for multi-arch images.'
|
|
3148
|
+
},
|
|
3149
|
+
size: {
|
|
3150
|
+
type: 'number',
|
|
3151
|
+
format: 'float',
|
|
3152
|
+
description: 'Total size of the tag in bytes.',
|
|
3153
|
+
example: 123456789
|
|
3154
|
+
},
|
|
3155
|
+
region: {
|
|
3156
|
+
type: 'string',
|
|
3157
|
+
description: 'Registry region.',
|
|
3158
|
+
example: 'northamerica'
|
|
3159
|
+
},
|
|
3160
|
+
repository: {
|
|
3161
|
+
type: 'string',
|
|
3162
|
+
description: 'Repository name.',
|
|
3163
|
+
example: 'my-app'
|
|
3164
|
+
},
|
|
3165
|
+
uri: {
|
|
3166
|
+
type: 'string',
|
|
3167
|
+
description: 'Full URI of the tag.',
|
|
3168
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest'
|
|
3169
|
+
}
|
|
3170
|
+
},
|
|
3171
|
+
required: [
|
|
3172
|
+
'name',
|
|
3173
|
+
'digest',
|
|
3174
|
+
'size',
|
|
3175
|
+
'region',
|
|
3176
|
+
'repository',
|
|
3177
|
+
'uri'
|
|
3178
|
+
],
|
|
3179
|
+
additionalProperties: false
|
|
3180
|
+
};
|
|
3181
|
+
export const RoadmapItemCreateInputSchema = {
|
|
3182
|
+
type: 'object',
|
|
3183
|
+
properties: {
|
|
3184
|
+
text: {
|
|
3185
|
+
type: 'string',
|
|
3186
|
+
maxLength: 500,
|
|
3187
|
+
minLength: 1,
|
|
3188
|
+
description: 'Your suggestion in one or two sentences. It is reviewed before it appears on the roadmap.',
|
|
3189
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3190
|
+
}
|
|
3191
|
+
},
|
|
3192
|
+
required: [
|
|
3193
|
+
'text'
|
|
3194
|
+
],
|
|
3195
|
+
additionalProperties: false
|
|
3196
|
+
};
|
|
3197
|
+
export const RoadmapItemSchema = {
|
|
3198
|
+
type: 'object',
|
|
3199
|
+
properties: {
|
|
3200
|
+
id: {
|
|
3201
|
+
type: 'string',
|
|
3202
|
+
description: 'Unique identifier of the roadmap item (Mongo ObjectId).',
|
|
3203
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3204
|
+
},
|
|
3205
|
+
text: {
|
|
3206
|
+
type: 'string',
|
|
3207
|
+
description: 'Short description of the roadmap item.',
|
|
3208
|
+
example: 'Support for ARM nodes on Hetzner.'
|
|
3209
|
+
},
|
|
3210
|
+
vote: {
|
|
3211
|
+
type: 'integer',
|
|
3212
|
+
nullable: true,
|
|
3213
|
+
description: 'The caller\'s vote on this item: -1 (down), 1 (up), 2 (double up), or null if the caller has not voted.',
|
|
3214
|
+
example: 1,
|
|
3215
|
+
enum: [
|
|
3216
|
+
-1,
|
|
3217
|
+
1,
|
|
3218
|
+
2
|
|
3219
|
+
]
|
|
3220
|
+
}
|
|
3221
|
+
},
|
|
3222
|
+
required: [
|
|
3223
|
+
'id',
|
|
3224
|
+
'text',
|
|
3225
|
+
'vote'
|
|
3226
|
+
],
|
|
3227
|
+
additionalProperties: false
|
|
3228
|
+
};
|
|
3229
|
+
export const RoadmapVoteInputSchema = {
|
|
3230
|
+
type: 'object',
|
|
3231
|
+
properties: {
|
|
3232
|
+
value: {
|
|
3233
|
+
type: 'integer',
|
|
3234
|
+
description: 'Vote value: -1 (down), 1 (up), or 2 (double up).',
|
|
3235
|
+
example: 1,
|
|
3236
|
+
enum: [
|
|
3237
|
+
-1,
|
|
3238
|
+
1,
|
|
3239
|
+
2
|
|
3240
|
+
]
|
|
3241
|
+
}
|
|
3242
|
+
},
|
|
3243
|
+
required: [
|
|
3244
|
+
'value'
|
|
3245
|
+
],
|
|
3246
|
+
additionalProperties: false
|
|
3247
|
+
};
|
|
3248
|
+
export const TicketAttachmentSchema = {
|
|
3249
|
+
type: 'object',
|
|
3250
|
+
properties: {
|
|
3251
|
+
id: {
|
|
3252
|
+
type: 'string',
|
|
3253
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3254
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3255
|
+
},
|
|
3256
|
+
filename: {
|
|
3257
|
+
type: 'string',
|
|
3258
|
+
description: 'Original filename as uploaded.',
|
|
3259
|
+
example: 'debug.log'
|
|
3260
|
+
},
|
|
3261
|
+
content_type: {
|
|
3262
|
+
type: 'string',
|
|
3263
|
+
description: 'MIME content type of the attachment.',
|
|
3264
|
+
example: 'text/plain'
|
|
3265
|
+
},
|
|
3266
|
+
size: {
|
|
3267
|
+
type: 'integer',
|
|
3268
|
+
description: 'Size of the attachment in bytes.',
|
|
3269
|
+
example: 12345
|
|
3270
|
+
}
|
|
3271
|
+
},
|
|
3272
|
+
required: [
|
|
3273
|
+
'id',
|
|
3274
|
+
'filename',
|
|
3275
|
+
'content_type',
|
|
3276
|
+
'size'
|
|
3277
|
+
],
|
|
3278
|
+
additionalProperties: false
|
|
3279
|
+
};
|
|
3280
|
+
export const TicketCreateInputSchema = {
|
|
3281
|
+
type: 'object',
|
|
3282
|
+
properties: {
|
|
3283
|
+
category: {
|
|
3284
|
+
type: 'string',
|
|
3285
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
3286
|
+
example: 'technical',
|
|
3287
|
+
enum: [
|
|
3288
|
+
'billing',
|
|
3289
|
+
'technical',
|
|
3290
|
+
'general'
|
|
3291
|
+
]
|
|
3292
|
+
},
|
|
3293
|
+
body: {
|
|
3294
|
+
type: 'string',
|
|
3295
|
+
maxLength: 50000,
|
|
3296
|
+
minLength: 1,
|
|
3297
|
+
pattern: '\\S',
|
|
3298
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
3299
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
3300
|
+
},
|
|
3301
|
+
properties: {
|
|
3302
|
+
type: 'object',
|
|
3303
|
+
additionalProperties: true,
|
|
3304
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
3305
|
+
example: {
|
|
3306
|
+
subcategory: 'cluster-question',
|
|
3307
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
3308
|
+
}
|
|
3309
|
+
},
|
|
3310
|
+
grant_support_access: {
|
|
3311
|
+
type: 'boolean',
|
|
3312
|
+
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.',
|
|
3313
|
+
example: true
|
|
3314
|
+
}
|
|
3315
|
+
},
|
|
3316
|
+
required: [
|
|
3317
|
+
'category',
|
|
3318
|
+
'body'
|
|
3319
|
+
],
|
|
3320
|
+
additionalProperties: false
|
|
3321
|
+
};
|
|
3322
|
+
export const TicketMessageInputSchema = {
|
|
3323
|
+
type: 'object',
|
|
3324
|
+
properties: {
|
|
3325
|
+
body: {
|
|
3326
|
+
type: 'string',
|
|
3327
|
+
maxLength: 50000,
|
|
3328
|
+
minLength: 1,
|
|
3329
|
+
pattern: '\\S',
|
|
3330
|
+
description: 'Reply body in markdown.',
|
|
3331
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3332
|
+
}
|
|
3333
|
+
},
|
|
3334
|
+
required: [
|
|
3335
|
+
'body'
|
|
3336
|
+
],
|
|
3337
|
+
additionalProperties: false
|
|
3338
|
+
};
|
|
3339
|
+
export const TicketMessageSchema = {
|
|
3340
|
+
type: 'object',
|
|
3341
|
+
properties: {
|
|
3342
|
+
id: {
|
|
3343
|
+
type: 'string',
|
|
3344
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3345
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3346
|
+
},
|
|
3347
|
+
type: {
|
|
3348
|
+
type: 'string',
|
|
3349
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3350
|
+
example: 'customer_reply',
|
|
3351
|
+
enum: [
|
|
3352
|
+
'customer_reply',
|
|
3353
|
+
'agent_reply'
|
|
3354
|
+
]
|
|
3355
|
+
},
|
|
3356
|
+
body: {
|
|
3357
|
+
type: 'string',
|
|
3358
|
+
description: 'Message body in markdown.',
|
|
3359
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3360
|
+
},
|
|
3361
|
+
author_first_name: {
|
|
3362
|
+
type: 'string',
|
|
3363
|
+
nullable: true,
|
|
3364
|
+
description: 'First name of the author. Null when not provided.',
|
|
3365
|
+
example: 'Jane'
|
|
3366
|
+
},
|
|
3367
|
+
author_last_name: {
|
|
3368
|
+
type: 'string',
|
|
3369
|
+
nullable: true,
|
|
3370
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3371
|
+
example: 'Doe'
|
|
3372
|
+
},
|
|
3373
|
+
attachments: {
|
|
3374
|
+
type: 'array',
|
|
3375
|
+
items: {
|
|
3376
|
+
type: 'object',
|
|
3377
|
+
properties: {
|
|
3378
|
+
id: {
|
|
3379
|
+
type: 'string',
|
|
3380
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3381
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
1283
3382
|
},
|
|
1284
|
-
|
|
1285
|
-
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
1286
|
-
},
|
|
1287
|
-
regions: {
|
|
1288
|
-
type: 'array',
|
|
1289
|
-
items: {
|
|
3383
|
+
filename: {
|
|
1290
3384
|
type: 'string',
|
|
1291
|
-
|
|
3385
|
+
description: 'Original filename as uploaded.',
|
|
3386
|
+
example: 'debug.log'
|
|
1292
3387
|
},
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
type: 'array',
|
|
1298
|
-
items: {
|
|
1299
|
-
type: 'object',
|
|
1300
|
-
properties: {
|
|
1301
|
-
id: {
|
|
1302
|
-
type: 'string',
|
|
1303
|
-
description: 'Id of the control plane version. Used in API calls.',
|
|
1304
|
-
example: '1.29.x-cfke.x'
|
|
1305
|
-
},
|
|
1306
|
-
label: {
|
|
1307
|
-
type: 'string',
|
|
1308
|
-
description: 'Label of the control plane version. Used in frontent UI.',
|
|
1309
|
-
example: '1.29.x (Always latest 1.29 patch version)'
|
|
1310
|
-
}
|
|
1311
|
-
},
|
|
1312
|
-
required: ['id', 'label'],
|
|
1313
|
-
additionalProperties: false
|
|
3388
|
+
content_type: {
|
|
3389
|
+
type: 'string',
|
|
3390
|
+
description: 'MIME content type of the attachment.',
|
|
3391
|
+
example: 'text/plain'
|
|
1314
3392
|
},
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
3393
|
+
size: {
|
|
3394
|
+
type: 'integer',
|
|
3395
|
+
description: 'Size of the attachment in bytes.',
|
|
3396
|
+
example: 12345
|
|
3397
|
+
}
|
|
3398
|
+
},
|
|
3399
|
+
required: [
|
|
3400
|
+
'id',
|
|
3401
|
+
'filename',
|
|
3402
|
+
'content_type',
|
|
3403
|
+
'size'
|
|
3404
|
+
],
|
|
3405
|
+
additionalProperties: false
|
|
1318
3406
|
},
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
description: 'For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.'
|
|
3407
|
+
description: 'Attachments associated with this message.',
|
|
3408
|
+
example: []
|
|
1322
3409
|
},
|
|
1323
|
-
|
|
3410
|
+
date_created: {
|
|
1324
3411
|
type: 'string',
|
|
1325
|
-
|
|
1326
|
-
|
|
3412
|
+
format: 'date-time',
|
|
3413
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3414
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1327
3415
|
}
|
|
1328
3416
|
},
|
|
1329
|
-
required: [
|
|
3417
|
+
required: [
|
|
3418
|
+
'id',
|
|
3419
|
+
'type',
|
|
3420
|
+
'body',
|
|
3421
|
+
'date_created'
|
|
3422
|
+
],
|
|
1330
3423
|
additionalProperties: false
|
|
1331
3424
|
};
|
|
1332
|
-
export const
|
|
3425
|
+
export const TicketSchema = {
|
|
1333
3426
|
type: 'object',
|
|
1334
3427
|
properties: {
|
|
1335
3428
|
id: {
|
|
1336
3429
|
type: 'string',
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
3430
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
3431
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
3432
|
+
},
|
|
3433
|
+
status: {
|
|
3434
|
+
type: 'string',
|
|
3435
|
+
description: 'Current state of the ticket.',
|
|
3436
|
+
example: 'waiting_on_us',
|
|
3437
|
+
enum: [
|
|
3438
|
+
'waiting_on_us',
|
|
3439
|
+
'waiting_on_user',
|
|
3440
|
+
'closed'
|
|
3441
|
+
]
|
|
3442
|
+
},
|
|
3443
|
+
category: {
|
|
3444
|
+
type: 'string',
|
|
3445
|
+
description: 'Ticket category.',
|
|
3446
|
+
example: 'technical',
|
|
3447
|
+
enum: [
|
|
3448
|
+
'billing',
|
|
3449
|
+
'technical',
|
|
3450
|
+
'general'
|
|
3451
|
+
]
|
|
3452
|
+
},
|
|
3453
|
+
summary: {
|
|
3454
|
+
type: 'string',
|
|
3455
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
3456
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
1340
3457
|
},
|
|
1341
|
-
|
|
3458
|
+
support_access_granted: {
|
|
1342
3459
|
type: 'boolean',
|
|
1343
|
-
description: 'Whether organization
|
|
3460
|
+
description: 'Whether Cloudfleet support staff currently have access to the organization\'s resources. True once access is granted and until the ticket is closed.',
|
|
1344
3461
|
example: true
|
|
1345
3462
|
},
|
|
1346
|
-
|
|
3463
|
+
support_access_granted_at: {
|
|
1347
3464
|
type: 'string',
|
|
3465
|
+
format: 'date-time',
|
|
1348
3466
|
nullable: true,
|
|
1349
|
-
description: '
|
|
1350
|
-
example: '
|
|
1351
|
-
enum: ['card']
|
|
3467
|
+
description: 'When support access was granted. Null if it never was. Kept after the ticket is closed.',
|
|
3468
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1352
3469
|
},
|
|
1353
|
-
|
|
3470
|
+
closed_at: {
|
|
1354
3471
|
type: 'string',
|
|
3472
|
+
format: 'date-time',
|
|
1355
3473
|
nullable: true,
|
|
1356
|
-
description: '
|
|
1357
|
-
example: '
|
|
1358
|
-
},
|
|
1359
|
-
exp_month: {
|
|
1360
|
-
type: 'integer',
|
|
1361
|
-
minimum: 1,
|
|
1362
|
-
maximum: 12,
|
|
1363
|
-
nullable: true,
|
|
1364
|
-
description: "Two-digit number representing the card's expiration month.",
|
|
1365
|
-
example: '12'
|
|
3474
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3475
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
1366
3476
|
},
|
|
1367
|
-
|
|
1368
|
-
type: '
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
example: '2028'
|
|
3477
|
+
date_created: {
|
|
3478
|
+
type: 'string',
|
|
3479
|
+
format: 'date-time',
|
|
3480
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
3481
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1373
3482
|
},
|
|
1374
|
-
|
|
3483
|
+
date_updated: {
|
|
1375
3484
|
type: 'string',
|
|
1376
|
-
|
|
1377
|
-
description: '
|
|
1378
|
-
example: '
|
|
1379
|
-
|
|
3485
|
+
format: 'date-time',
|
|
3486
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
3487
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3488
|
+
},
|
|
3489
|
+
messages: {
|
|
3490
|
+
type: 'array',
|
|
3491
|
+
items: {
|
|
3492
|
+
type: 'object',
|
|
3493
|
+
properties: {
|
|
3494
|
+
id: {
|
|
3495
|
+
type: 'string',
|
|
3496
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
3497
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
3498
|
+
},
|
|
3499
|
+
type: {
|
|
3500
|
+
type: 'string',
|
|
3501
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
3502
|
+
example: 'customer_reply',
|
|
3503
|
+
enum: [
|
|
3504
|
+
'customer_reply',
|
|
3505
|
+
'agent_reply'
|
|
3506
|
+
]
|
|
3507
|
+
},
|
|
3508
|
+
body: {
|
|
3509
|
+
type: 'string',
|
|
3510
|
+
description: 'Message body in markdown.',
|
|
3511
|
+
example: 'Thanks — that resolved it on my side.'
|
|
3512
|
+
},
|
|
3513
|
+
author_first_name: {
|
|
3514
|
+
type: 'string',
|
|
3515
|
+
description: 'First name of the author. Null when not provided.',
|
|
3516
|
+
example: 'Jane'
|
|
3517
|
+
},
|
|
3518
|
+
author_last_name: {
|
|
3519
|
+
type: 'string',
|
|
3520
|
+
description: 'Last name of the author. Null when not provided.',
|
|
3521
|
+
example: 'Doe'
|
|
3522
|
+
},
|
|
3523
|
+
attachments: {
|
|
3524
|
+
type: 'array',
|
|
3525
|
+
items: {
|
|
3526
|
+
type: 'object',
|
|
3527
|
+
properties: {
|
|
3528
|
+
id: {
|
|
3529
|
+
type: 'string',
|
|
3530
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
3531
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
3532
|
+
},
|
|
3533
|
+
filename: {
|
|
3534
|
+
type: 'string',
|
|
3535
|
+
description: 'Original filename as uploaded.',
|
|
3536
|
+
example: 'debug.log'
|
|
3537
|
+
},
|
|
3538
|
+
content_type: {
|
|
3539
|
+
type: 'string',
|
|
3540
|
+
description: 'MIME content type of the attachment.',
|
|
3541
|
+
example: 'text/plain'
|
|
3542
|
+
},
|
|
3543
|
+
size: {
|
|
3544
|
+
type: 'integer',
|
|
3545
|
+
description: 'Size of the attachment in bytes.',
|
|
3546
|
+
example: 12345
|
|
3547
|
+
}
|
|
3548
|
+
},
|
|
3549
|
+
required: [
|
|
3550
|
+
'id',
|
|
3551
|
+
'filename',
|
|
3552
|
+
'content_type',
|
|
3553
|
+
'size'
|
|
3554
|
+
],
|
|
3555
|
+
additionalProperties: false
|
|
3556
|
+
},
|
|
3557
|
+
description: 'Attachments associated with this message.',
|
|
3558
|
+
example: []
|
|
3559
|
+
},
|
|
3560
|
+
date_created: {
|
|
3561
|
+
type: 'string',
|
|
3562
|
+
format: 'date-time',
|
|
3563
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
3564
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
3565
|
+
}
|
|
3566
|
+
},
|
|
3567
|
+
required: [
|
|
3568
|
+
'id',
|
|
3569
|
+
'type',
|
|
3570
|
+
'body',
|
|
3571
|
+
'date_created'
|
|
3572
|
+
],
|
|
3573
|
+
additionalProperties: false
|
|
3574
|
+
},
|
|
3575
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
1380
3576
|
}
|
|
1381
3577
|
},
|
|
1382
|
-
required: [
|
|
3578
|
+
required: [
|
|
3579
|
+
'id',
|
|
3580
|
+
'status',
|
|
3581
|
+
'category',
|
|
3582
|
+
'summary',
|
|
3583
|
+
'support_access_granted',
|
|
3584
|
+
'support_access_granted_at',
|
|
3585
|
+
'date_created',
|
|
3586
|
+
'date_updated'
|
|
3587
|
+
],
|
|
1383
3588
|
additionalProperties: false
|
|
1384
3589
|
};
|
|
1385
3590
|
export const TokenCreateInputSchema = {
|
|
@@ -1397,10 +3602,16 @@ export const TokenCreateInputSchema = {
|
|
|
1397
3602
|
type: 'string',
|
|
1398
3603
|
description: 'Role assumed by the token.',
|
|
1399
3604
|
example: 'User',
|
|
1400
|
-
enum: [
|
|
3605
|
+
enum: [
|
|
3606
|
+
'Administrator',
|
|
3607
|
+
'User'
|
|
3608
|
+
]
|
|
1401
3609
|
}
|
|
1402
3610
|
},
|
|
1403
|
-
required: [
|
|
3611
|
+
required: [
|
|
3612
|
+
'name',
|
|
3613
|
+
'role'
|
|
3614
|
+
],
|
|
1404
3615
|
additionalProperties: false
|
|
1405
3616
|
};
|
|
1406
3617
|
export const TokenSchema = {
|
|
@@ -1418,7 +3629,10 @@ export const TokenSchema = {
|
|
|
1418
3629
|
type: 'string',
|
|
1419
3630
|
description: 'Role assumed by the token.',
|
|
1420
3631
|
example: 'User',
|
|
1421
|
-
enum: [
|
|
3632
|
+
enum: [
|
|
3633
|
+
'Administrator',
|
|
3634
|
+
'User'
|
|
3635
|
+
]
|
|
1422
3636
|
},
|
|
1423
3637
|
id: {
|
|
1424
3638
|
type: 'string',
|
|
@@ -1437,7 +3651,11 @@ export const TokenSchema = {
|
|
|
1437
3651
|
example: '2023-12-20T13:53:32.000Z'
|
|
1438
3652
|
}
|
|
1439
3653
|
},
|
|
1440
|
-
required: [
|
|
3654
|
+
required: [
|
|
3655
|
+
'name',
|
|
3656
|
+
'role',
|
|
3657
|
+
'date_created'
|
|
3658
|
+
],
|
|
1441
3659
|
additionalProperties: false
|
|
1442
3660
|
};
|
|
1443
3661
|
export const TokenUpdateInputSchema = {
|
|
@@ -1455,9 +3673,154 @@ export const TokenUpdateInputSchema = {
|
|
|
1455
3673
|
type: 'string',
|
|
1456
3674
|
description: 'Role assumed by the token.',
|
|
1457
3675
|
example: 'User',
|
|
1458
|
-
enum: [
|
|
3676
|
+
enum: [
|
|
3677
|
+
'Administrator',
|
|
3678
|
+
'User'
|
|
3679
|
+
]
|
|
3680
|
+
}
|
|
3681
|
+
},
|
|
3682
|
+
additionalProperties: false
|
|
3683
|
+
};
|
|
3684
|
+
export const UsageFacetsSchema = {
|
|
3685
|
+
type: 'object',
|
|
3686
|
+
properties: {
|
|
3687
|
+
cluster_id: {
|
|
3688
|
+
type: 'array',
|
|
3689
|
+
items: {
|
|
3690
|
+
type: 'string'
|
|
3691
|
+
},
|
|
3692
|
+
description: 'List of unique cluster IDs',
|
|
3693
|
+
example: [
|
|
3694
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3695
|
+
]
|
|
3696
|
+
},
|
|
3697
|
+
product: {
|
|
3698
|
+
type: 'array',
|
|
3699
|
+
items: {
|
|
3700
|
+
type: 'string',
|
|
3701
|
+
enum: [
|
|
3702
|
+
'cfke_controlplane_basic',
|
|
3703
|
+
'cfke_controlplane_pro',
|
|
3704
|
+
'cfke_controlplane_enterprise',
|
|
3705
|
+
'cfke_connected_nodes_basic',
|
|
3706
|
+
'cfke_connected_nodes_pro',
|
|
3707
|
+
'cfke_connected_nodes_enterprise',
|
|
3708
|
+
'cfcr_storage'
|
|
3709
|
+
]
|
|
3710
|
+
},
|
|
3711
|
+
description: 'List of unique products',
|
|
3712
|
+
example: [
|
|
3713
|
+
'cfke_controlplane_pro',
|
|
3714
|
+
'cfke_connected_nodes_pro'
|
|
3715
|
+
]
|
|
3716
|
+
}
|
|
3717
|
+
},
|
|
3718
|
+
additionalProperties: false
|
|
3719
|
+
};
|
|
3720
|
+
export const UsageResponseSchema = {
|
|
3721
|
+
type: 'object',
|
|
3722
|
+
properties: {
|
|
3723
|
+
data: {
|
|
3724
|
+
type: 'array',
|
|
3725
|
+
items: {
|
|
3726
|
+
type: 'object',
|
|
3727
|
+
properties: {
|
|
3728
|
+
hour: {
|
|
3729
|
+
type: 'string',
|
|
3730
|
+
description: 'Hour of the usage',
|
|
3731
|
+
example: '2019-01-01T00:00:00.000Z'
|
|
3732
|
+
},
|
|
3733
|
+
cluster_id: {
|
|
3734
|
+
type: 'string',
|
|
3735
|
+
description: 'Unique identifier of the kubernetes cluster. UUID v4 string in canonical form',
|
|
3736
|
+
example: '6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3737
|
+
},
|
|
3738
|
+
product: {
|
|
3739
|
+
type: 'string',
|
|
3740
|
+
description: 'The product the usage is associated with',
|
|
3741
|
+
example: 'cfke_controlplane_pro',
|
|
3742
|
+
enum: [
|
|
3743
|
+
'cfke_controlplane_basic',
|
|
3744
|
+
'cfke_controlplane_pro',
|
|
3745
|
+
'cfke_controlplane_enterprise',
|
|
3746
|
+
'cfke_connected_nodes_basic',
|
|
3747
|
+
'cfke_connected_nodes_pro',
|
|
3748
|
+
'cfke_connected_nodes_enterprise',
|
|
3749
|
+
'cfcr_storage'
|
|
3750
|
+
]
|
|
3751
|
+
},
|
|
3752
|
+
value: {
|
|
3753
|
+
type: 'number',
|
|
3754
|
+
format: 'float',
|
|
3755
|
+
description: 'Consumption',
|
|
3756
|
+
example: 4
|
|
3757
|
+
},
|
|
3758
|
+
price: {
|
|
3759
|
+
type: 'number',
|
|
3760
|
+
format: 'float',
|
|
3761
|
+
description: 'Price per unit',
|
|
3762
|
+
example: 0.01
|
|
3763
|
+
},
|
|
3764
|
+
total: {
|
|
3765
|
+
type: 'number',
|
|
3766
|
+
format: 'float',
|
|
3767
|
+
description: 'Total cost'
|
|
3768
|
+
}
|
|
3769
|
+
},
|
|
3770
|
+
required: [
|
|
3771
|
+
'hour',
|
|
3772
|
+
'cluster_id',
|
|
3773
|
+
'product',
|
|
3774
|
+
'value',
|
|
3775
|
+
'price',
|
|
3776
|
+
'total'
|
|
3777
|
+
],
|
|
3778
|
+
additionalProperties: false
|
|
3779
|
+
},
|
|
3780
|
+
description: 'Usage data'
|
|
3781
|
+
},
|
|
3782
|
+
facets: {
|
|
3783
|
+
type: 'object',
|
|
3784
|
+
properties: {
|
|
3785
|
+
cluster_id: {
|
|
3786
|
+
type: 'array',
|
|
3787
|
+
items: {
|
|
3788
|
+
type: 'string'
|
|
3789
|
+
},
|
|
3790
|
+
description: 'List of unique cluster IDs',
|
|
3791
|
+
example: [
|
|
3792
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
3793
|
+
]
|
|
3794
|
+
},
|
|
3795
|
+
product: {
|
|
3796
|
+
type: 'array',
|
|
3797
|
+
items: {
|
|
3798
|
+
type: 'string',
|
|
3799
|
+
enum: [
|
|
3800
|
+
'cfke_controlplane_basic',
|
|
3801
|
+
'cfke_controlplane_pro',
|
|
3802
|
+
'cfke_controlplane_enterprise',
|
|
3803
|
+
'cfke_connected_nodes_basic',
|
|
3804
|
+
'cfke_connected_nodes_pro',
|
|
3805
|
+
'cfke_connected_nodes_enterprise',
|
|
3806
|
+
'cfcr_storage'
|
|
3807
|
+
]
|
|
3808
|
+
},
|
|
3809
|
+
description: 'List of unique products',
|
|
3810
|
+
example: [
|
|
3811
|
+
'cfke_controlplane_pro',
|
|
3812
|
+
'cfke_connected_nodes_pro'
|
|
3813
|
+
]
|
|
3814
|
+
}
|
|
3815
|
+
},
|
|
3816
|
+
additionalProperties: false,
|
|
3817
|
+
description: 'Facets for filtering'
|
|
1459
3818
|
}
|
|
1460
3819
|
},
|
|
3820
|
+
required: [
|
|
3821
|
+
'data',
|
|
3822
|
+
'facets'
|
|
3823
|
+
],
|
|
1461
3824
|
additionalProperties: false
|
|
1462
3825
|
};
|
|
1463
3826
|
export const UsageSchema = {
|
|
@@ -1470,90 +3833,49 @@ export const UsageSchema = {
|
|
|
1470
3833
|
},
|
|
1471
3834
|
cluster_id: {
|
|
1472
3835
|
type: 'string',
|
|
1473
|
-
format: 'uuid',
|
|
1474
3836
|
description: 'Unique identifier of the kubernetes cluster. UUID v4 string in canonical form',
|
|
1475
3837
|
example: '6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
1476
3838
|
},
|
|
1477
|
-
cluster_tier: {
|
|
1478
|
-
type: 'string',
|
|
1479
|
-
description: 'Tier of the cluster.',
|
|
1480
|
-
example: 'pro',
|
|
1481
|
-
enum: ['basic', 'pro', '']
|
|
1482
|
-
},
|
|
1483
3839
|
product: {
|
|
1484
3840
|
type: 'string',
|
|
1485
3841
|
description: 'The product the usage is associated with',
|
|
1486
|
-
example: '
|
|
1487
|
-
enum: [
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
type: 'string',
|
|
1496
|
-
description: 'SKU of the Kubernetes node',
|
|
1497
|
-
example: 'GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT'
|
|
1498
|
-
},
|
|
1499
|
-
cpu: {
|
|
1500
|
-
anyOf: [
|
|
1501
|
-
{
|
|
1502
|
-
type: 'number',
|
|
1503
|
-
format: 'float',
|
|
1504
|
-
description: 'CPU core count of the node',
|
|
1505
|
-
example: 4
|
|
1506
|
-
},
|
|
1507
|
-
{
|
|
1508
|
-
type: 'string',
|
|
1509
|
-
enum: ['']
|
|
1510
|
-
}
|
|
1511
|
-
]
|
|
1512
|
-
},
|
|
1513
|
-
price: {
|
|
1514
|
-
anyOf: [
|
|
1515
|
-
{
|
|
1516
|
-
type: 'number',
|
|
1517
|
-
format: 'float',
|
|
1518
|
-
description: 'Price',
|
|
1519
|
-
example: 4
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
type: 'string',
|
|
1523
|
-
enum: ['']
|
|
1524
|
-
}
|
|
3842
|
+
example: 'cfke_controlplane_pro',
|
|
3843
|
+
enum: [
|
|
3844
|
+
'cfke_controlplane_basic',
|
|
3845
|
+
'cfke_controlplane_pro',
|
|
3846
|
+
'cfke_controlplane_enterprise',
|
|
3847
|
+
'cfke_connected_nodes_basic',
|
|
3848
|
+
'cfke_connected_nodes_pro',
|
|
3849
|
+
'cfke_connected_nodes_enterprise',
|
|
3850
|
+
'cfcr_storage'
|
|
1525
3851
|
]
|
|
1526
3852
|
},
|
|
1527
3853
|
value: {
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
}
|
|
1539
|
-
]
|
|
3854
|
+
type: 'number',
|
|
3855
|
+
format: 'float',
|
|
3856
|
+
description: 'Consumption',
|
|
3857
|
+
example: 4
|
|
3858
|
+
},
|
|
3859
|
+
price: {
|
|
3860
|
+
type: 'number',
|
|
3861
|
+
format: 'float',
|
|
3862
|
+
description: 'Price per unit',
|
|
3863
|
+
example: 0.01
|
|
1540
3864
|
},
|
|
1541
3865
|
total: {
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
format: 'float',
|
|
1546
|
-
description: 'Total',
|
|
1547
|
-
example: 4
|
|
1548
|
-
},
|
|
1549
|
-
{
|
|
1550
|
-
type: 'string',
|
|
1551
|
-
enum: ['']
|
|
1552
|
-
}
|
|
1553
|
-
]
|
|
3866
|
+
type: 'number',
|
|
3867
|
+
format: 'float',
|
|
3868
|
+
description: 'Total cost'
|
|
1554
3869
|
}
|
|
1555
3870
|
},
|
|
1556
|
-
required: [
|
|
3871
|
+
required: [
|
|
3872
|
+
'hour',
|
|
3873
|
+
'cluster_id',
|
|
3874
|
+
'product',
|
|
3875
|
+
'value',
|
|
3876
|
+
'price',
|
|
3877
|
+
'total'
|
|
3878
|
+
],
|
|
1557
3879
|
additionalProperties: false
|
|
1558
3880
|
};
|
|
1559
3881
|
export const UserCreateInputSchema = {
|
|
@@ -1589,21 +3911,15 @@ export const UserCreateInputSchema = {
|
|
|
1589
3911
|
type: 'string',
|
|
1590
3912
|
minLength: 8,
|
|
1591
3913
|
description: 'User password. Must be at least 8 characters long.'
|
|
1592
|
-
},
|
|
1593
|
-
status: {
|
|
1594
|
-
type: 'string',
|
|
1595
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1596
|
-
example: 'active',
|
|
1597
|
-
enum: ['active', 'inactive']
|
|
1598
|
-
},
|
|
1599
|
-
role: {
|
|
1600
|
-
type: 'string',
|
|
1601
|
-
description: "User role. Can be 'Administrator', 'User'.",
|
|
1602
|
-
example: 'User',
|
|
1603
|
-
enum: ['Administrator', 'User']
|
|
1604
3914
|
}
|
|
1605
3915
|
},
|
|
1606
|
-
required: [
|
|
3916
|
+
required: [
|
|
3917
|
+
'email',
|
|
3918
|
+
'first_name',
|
|
3919
|
+
'last_name',
|
|
3920
|
+
'code',
|
|
3921
|
+
'password'
|
|
3922
|
+
],
|
|
1607
3923
|
additionalProperties: false
|
|
1608
3924
|
};
|
|
1609
3925
|
export const UserSchema = {
|
|
@@ -1631,15 +3947,21 @@ export const UserSchema = {
|
|
|
1631
3947
|
},
|
|
1632
3948
|
role: {
|
|
1633
3949
|
type: 'string',
|
|
1634
|
-
description:
|
|
3950
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1635
3951
|
example: 'User',
|
|
1636
|
-
enum: [
|
|
3952
|
+
enum: [
|
|
3953
|
+
'Administrator',
|
|
3954
|
+
'User'
|
|
3955
|
+
]
|
|
1637
3956
|
},
|
|
1638
3957
|
status: {
|
|
1639
3958
|
type: 'string',
|
|
1640
3959
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1641
3960
|
example: 'active',
|
|
1642
|
-
enum: [
|
|
3961
|
+
enum: [
|
|
3962
|
+
'active',
|
|
3963
|
+
'inactive'
|
|
3964
|
+
]
|
|
1643
3965
|
},
|
|
1644
3966
|
id: {
|
|
1645
3967
|
type: 'string',
|
|
@@ -1654,7 +3976,15 @@ export const UserSchema = {
|
|
|
1654
3976
|
example: '2023-11-02T16:08:14.338Z'
|
|
1655
3977
|
}
|
|
1656
3978
|
},
|
|
1657
|
-
required: [
|
|
3979
|
+
required: [
|
|
3980
|
+
'email',
|
|
3981
|
+
'first_name',
|
|
3982
|
+
'last_name',
|
|
3983
|
+
'role',
|
|
3984
|
+
'status',
|
|
3985
|
+
'id',
|
|
3986
|
+
'date_created'
|
|
3987
|
+
],
|
|
1658
3988
|
additionalProperties: false
|
|
1659
3989
|
};
|
|
1660
3990
|
export const UserUpdateInputSchema = {
|
|
@@ -1682,15 +4012,21 @@ export const UserUpdateInputSchema = {
|
|
|
1682
4012
|
},
|
|
1683
4013
|
role: {
|
|
1684
4014
|
type: 'string',
|
|
1685
|
-
description:
|
|
4015
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1686
4016
|
example: 'User',
|
|
1687
|
-
enum: [
|
|
4017
|
+
enum: [
|
|
4018
|
+
'Administrator',
|
|
4019
|
+
'User'
|
|
4020
|
+
]
|
|
1688
4021
|
},
|
|
1689
4022
|
status: {
|
|
1690
4023
|
type: 'string',
|
|
1691
4024
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1692
4025
|
example: 'active',
|
|
1693
|
-
enum: [
|
|
4026
|
+
enum: [
|
|
4027
|
+
'active',
|
|
4028
|
+
'inactive'
|
|
4029
|
+
]
|
|
1694
4030
|
}
|
|
1695
4031
|
},
|
|
1696
4032
|
additionalProperties: false
|