@cloudfleet/sdk 0.0.1-dba2400 → 0.0.1-dc16042
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/dist/@tanstack/react-query.gen.d.ts +1125 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1129 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +113 -98
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.gen.d.ts +9 -13
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +6 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +10 -12
- package/dist/client/utils.gen.js.map +1 -1
- 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.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.js.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +16 -8
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.d.ts +10 -0
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/params.gen.js +18 -6
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.js +3 -11
- package/dist/core/pathSerializer.gen.js.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.js +4 -11
- package/dist/core/queryKeySerializer.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +6 -9
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1020 -484
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1629 -574
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +86 -22
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +158 -151
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +920 -323
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1041 -1936
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +501 -1075
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -5
package/dist/schemas.gen.js
CHANGED
|
@@ -58,15 +58,10 @@ export const BillingContactSchema = {
|
|
|
58
58
|
description: 'Email address used for billing as a string.',
|
|
59
59
|
example: 'email@example.com'
|
|
60
60
|
},
|
|
61
|
-
|
|
62
|
-
type: 'string',
|
|
63
|
-
description: 'First name of the billing contact person.',
|
|
64
|
-
example: 'John'
|
|
65
|
-
},
|
|
66
|
-
last_name: {
|
|
61
|
+
individual_name: {
|
|
67
62
|
type: 'string',
|
|
68
|
-
description: '
|
|
69
|
-
example: 'Doe'
|
|
63
|
+
description: 'Name of the billing contact person.',
|
|
64
|
+
example: 'John Doe'
|
|
70
65
|
},
|
|
71
66
|
tax_id: {
|
|
72
67
|
type: 'string',
|
|
@@ -79,10 +74,142 @@ export const BillingContactSchema = {
|
|
|
79
74
|
nullable: true,
|
|
80
75
|
description: 'Type of the tax ID.',
|
|
81
76
|
example: 'de_vat',
|
|
82
|
-
enum: [
|
|
77
|
+
enum: [
|
|
78
|
+
'ad_nrt',
|
|
79
|
+
'ae_trn',
|
|
80
|
+
'al_tin',
|
|
81
|
+
'am_tin',
|
|
82
|
+
'ao_tin',
|
|
83
|
+
'ar_cuit',
|
|
84
|
+
'at_vat',
|
|
85
|
+
'au_abn',
|
|
86
|
+
'au_arn',
|
|
87
|
+
'ba_tin',
|
|
88
|
+
'bb_tin',
|
|
89
|
+
'be_vat',
|
|
90
|
+
'bg_uic',
|
|
91
|
+
'bg_vat',
|
|
92
|
+
'bh_vat',
|
|
93
|
+
'bo_tin',
|
|
94
|
+
'br_cnpj',
|
|
95
|
+
'br_cpf',
|
|
96
|
+
'bs_tin',
|
|
97
|
+
'by_tin',
|
|
98
|
+
'ca_bn',
|
|
99
|
+
'ca_gst_hst',
|
|
100
|
+
'ca_pst_bc',
|
|
101
|
+
'ca_pst_mb',
|
|
102
|
+
'ca_pst_sk',
|
|
103
|
+
'ca_qst',
|
|
104
|
+
'cd_nif',
|
|
105
|
+
'ch_uid',
|
|
106
|
+
'ch_vat',
|
|
107
|
+
'cl_tin',
|
|
108
|
+
'cn_tin',
|
|
109
|
+
'co_nit',
|
|
110
|
+
'cr_tin',
|
|
111
|
+
'cy_vat',
|
|
112
|
+
'cz_vat',
|
|
113
|
+
'de_stn',
|
|
114
|
+
'de_vat',
|
|
115
|
+
'dk_vat',
|
|
116
|
+
'do_rcn',
|
|
117
|
+
'ec_ruc',
|
|
118
|
+
'ee_vat',
|
|
119
|
+
'eg_tin',
|
|
120
|
+
'es_cif',
|
|
121
|
+
'es_vat',
|
|
122
|
+
'eu_oss_vat',
|
|
123
|
+
'fi_vat',
|
|
124
|
+
'fr_vat',
|
|
125
|
+
'gb_vat',
|
|
126
|
+
'ge_vat',
|
|
127
|
+
'gn_nif',
|
|
128
|
+
'gr_vat',
|
|
129
|
+
'hk_br',
|
|
130
|
+
'hr_oib',
|
|
131
|
+
'hr_vat',
|
|
132
|
+
'hu_tin',
|
|
133
|
+
'hu_vat',
|
|
134
|
+
'id_npwp',
|
|
135
|
+
'ie_vat',
|
|
136
|
+
'il_vat',
|
|
137
|
+
'in_gst',
|
|
138
|
+
'is_vat',
|
|
139
|
+
'it_vat',
|
|
140
|
+
'jp_cn',
|
|
141
|
+
'jp_rn',
|
|
142
|
+
'jp_trn',
|
|
143
|
+
'ke_pin',
|
|
144
|
+
'kh_tin',
|
|
145
|
+
'kr_brn',
|
|
146
|
+
'kz_bin',
|
|
147
|
+
'li_uid',
|
|
148
|
+
'li_vat',
|
|
149
|
+
'lt_vat',
|
|
150
|
+
'lu_vat',
|
|
151
|
+
'lv_vat',
|
|
152
|
+
'ma_vat',
|
|
153
|
+
'md_vat',
|
|
154
|
+
'me_pib',
|
|
155
|
+
'mk_vat',
|
|
156
|
+
'mr_nif',
|
|
157
|
+
'mt_vat',
|
|
158
|
+
'mx_rfc',
|
|
159
|
+
'my_frp',
|
|
160
|
+
'my_itn',
|
|
161
|
+
'my_sst',
|
|
162
|
+
'ng_tin',
|
|
163
|
+
'nl_vat',
|
|
164
|
+
'no_vat',
|
|
165
|
+
'no_voec',
|
|
166
|
+
'np_pan',
|
|
167
|
+
'nz_gst',
|
|
168
|
+
'om_vat',
|
|
169
|
+
'pe_ruc',
|
|
170
|
+
'ph_tin',
|
|
171
|
+
'pl_vat',
|
|
172
|
+
'pt_vat',
|
|
173
|
+
'ro_tin',
|
|
174
|
+
'ro_vat',
|
|
175
|
+
'rs_pib',
|
|
176
|
+
'ru_inn',
|
|
177
|
+
'ru_kpp',
|
|
178
|
+
'sa_vat',
|
|
179
|
+
'se_vat',
|
|
180
|
+
'sg_gst',
|
|
181
|
+
'sg_uen',
|
|
182
|
+
'si_tin',
|
|
183
|
+
'si_vat',
|
|
184
|
+
'sk_vat',
|
|
185
|
+
'sn_ninea',
|
|
186
|
+
'sr_fin',
|
|
187
|
+
'sv_nit',
|
|
188
|
+
'th_vat',
|
|
189
|
+
'tj_tin',
|
|
190
|
+
'tr_tin',
|
|
191
|
+
'tw_vat',
|
|
192
|
+
'tz_vat',
|
|
193
|
+
'ua_vat',
|
|
194
|
+
'ug_tin',
|
|
195
|
+
'us_ein',
|
|
196
|
+
'uy_ruc',
|
|
197
|
+
'uz_tin',
|
|
198
|
+
'uz_vat',
|
|
199
|
+
've_rif',
|
|
200
|
+
'vn_tin',
|
|
201
|
+
'xi_vat',
|
|
202
|
+
'za_vat',
|
|
203
|
+
'zm_tin',
|
|
204
|
+
'zw_tin',
|
|
205
|
+
''
|
|
206
|
+
]
|
|
83
207
|
}
|
|
84
208
|
},
|
|
85
|
-
required: [
|
|
209
|
+
required: [
|
|
210
|
+
'email',
|
|
211
|
+
'individual_name'
|
|
212
|
+
],
|
|
86
213
|
additionalProperties: false
|
|
87
214
|
};
|
|
88
215
|
export const BillingCreditsSchema = {
|
|
@@ -93,10 +220,25 @@ export const BillingCreditsSchema = {
|
|
|
93
220
|
description: 'Generated unique identifier of the promotional code.',
|
|
94
221
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
95
222
|
},
|
|
96
|
-
|
|
223
|
+
type: {
|
|
224
|
+
type: 'string',
|
|
225
|
+
description: 'Type of the promotional code.',
|
|
226
|
+
example: 'credit',
|
|
227
|
+
enum: [
|
|
228
|
+
'credit',
|
|
229
|
+
'discount'
|
|
230
|
+
]
|
|
231
|
+
},
|
|
232
|
+
date_start: {
|
|
97
233
|
type: 'string',
|
|
98
234
|
format: 'date-time',
|
|
99
|
-
description: '
|
|
235
|
+
description: 'Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.',
|
|
236
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
237
|
+
},
|
|
238
|
+
date_end: {
|
|
239
|
+
type: 'string',
|
|
240
|
+
format: 'date-time',
|
|
241
|
+
description: 'Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.',
|
|
100
242
|
example: '2023-12-20T13:53:32.000Z'
|
|
101
243
|
},
|
|
102
244
|
code: {
|
|
@@ -109,40 +251,25 @@ export const BillingCreditsSchema = {
|
|
|
109
251
|
description: 'Description of the promotional code.',
|
|
110
252
|
example: '10% off on all products'
|
|
111
253
|
},
|
|
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: {
|
|
254
|
+
value_total: {
|
|
127
255
|
type: 'number',
|
|
128
256
|
format: 'float',
|
|
129
|
-
description: '
|
|
257
|
+
description: 'Total value of the promotional code.',
|
|
130
258
|
example: 10
|
|
131
259
|
},
|
|
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
260
|
value_remaining: {
|
|
139
261
|
type: 'number',
|
|
140
262
|
format: 'float',
|
|
141
|
-
description: '
|
|
142
|
-
example:
|
|
263
|
+
description: 'Remaining value of the promotional code.',
|
|
264
|
+
example: 8
|
|
143
265
|
}
|
|
144
266
|
},
|
|
145
|
-
required: [
|
|
267
|
+
required: [
|
|
268
|
+
'type',
|
|
269
|
+
'date_start',
|
|
270
|
+
'code',
|
|
271
|
+
'value_total'
|
|
272
|
+
],
|
|
146
273
|
additionalProperties: false
|
|
147
274
|
};
|
|
148
275
|
export const ChartCreateInputSchema = {
|
|
@@ -183,7 +310,13 @@ export const ChartCreateInputSchema = {
|
|
|
183
310
|
example: 'postgresql'
|
|
184
311
|
}
|
|
185
312
|
},
|
|
186
|
-
required: [
|
|
313
|
+
required: [
|
|
314
|
+
'values',
|
|
315
|
+
'version_channel',
|
|
316
|
+
'name',
|
|
317
|
+
'namespace',
|
|
318
|
+
'chart'
|
|
319
|
+
],
|
|
187
320
|
additionalProperties: false
|
|
188
321
|
};
|
|
189
322
|
export const ChartSchema = {
|
|
@@ -227,7 +360,22 @@ export const ChartSchema = {
|
|
|
227
360
|
type: 'string',
|
|
228
361
|
description: 'Status of the chart deployment.',
|
|
229
362
|
example: 'active',
|
|
230
|
-
enum: [
|
|
363
|
+
enum: [
|
|
364
|
+
'InstallSucceeded',
|
|
365
|
+
'InstallFailed',
|
|
366
|
+
'UpgradeSucceeded',
|
|
367
|
+
'UpgradeFailed',
|
|
368
|
+
'TestSucceeded',
|
|
369
|
+
'TestFailed',
|
|
370
|
+
'RollbackSucceeded',
|
|
371
|
+
'RollbackFailed',
|
|
372
|
+
'UninstallSucceeded',
|
|
373
|
+
'UninstallFailed',
|
|
374
|
+
'ArtifactFailed',
|
|
375
|
+
'DependencyNotReady',
|
|
376
|
+
'Progressing',
|
|
377
|
+
'SourceNotReady'
|
|
378
|
+
]
|
|
231
379
|
},
|
|
232
380
|
version_current: {
|
|
233
381
|
type: 'string',
|
|
@@ -250,7 +398,18 @@ export const ChartSchema = {
|
|
|
250
398
|
example: true
|
|
251
399
|
}
|
|
252
400
|
},
|
|
253
|
-
required: [
|
|
401
|
+
required: [
|
|
402
|
+
'values',
|
|
403
|
+
'version_channel',
|
|
404
|
+
'name',
|
|
405
|
+
'namespace',
|
|
406
|
+
'chart',
|
|
407
|
+
'status',
|
|
408
|
+
'version_current',
|
|
409
|
+
'created_at',
|
|
410
|
+
'updated_at',
|
|
411
|
+
'ready'
|
|
412
|
+
],
|
|
254
413
|
additionalProperties: false
|
|
255
414
|
};
|
|
256
415
|
export const ChartUpdateInputSchema = {
|
|
@@ -267,7 +426,10 @@ export const ChartUpdateInputSchema = {
|
|
|
267
426
|
example: '2.x.x-cfke.x'
|
|
268
427
|
}
|
|
269
428
|
},
|
|
270
|
-
required: [
|
|
429
|
+
required: [
|
|
430
|
+
'values',
|
|
431
|
+
'version_channel'
|
|
432
|
+
],
|
|
271
433
|
additionalProperties: false
|
|
272
434
|
};
|
|
273
435
|
export const ClusterCreateInputSchema = {
|
|
@@ -285,24 +447,41 @@ export const ClusterCreateInputSchema = {
|
|
|
285
447
|
type: 'string',
|
|
286
448
|
description: 'Tier of the cluster.',
|
|
287
449
|
example: 'pro',
|
|
288
|
-
enum: [
|
|
450
|
+
enum: [
|
|
451
|
+
'basic',
|
|
452
|
+
'pro'
|
|
453
|
+
]
|
|
289
454
|
},
|
|
290
455
|
region: {
|
|
291
456
|
type: 'string',
|
|
292
|
-
description: 'Cloudfleet control plane region. One of "staging", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a". This field can not be updated after creation.',
|
|
293
|
-
default: 'staging',
|
|
457
|
+
description: 'Cloudfleet control plane region. One of "staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a". This field can not be updated after creation.',
|
|
458
|
+
default: 'staging-1a',
|
|
294
459
|
example: 'northamerica-central-1a',
|
|
295
|
-
enum: [
|
|
460
|
+
enum: [
|
|
461
|
+
'staging-1a',
|
|
462
|
+
'northamerica-central-1',
|
|
463
|
+
'europe-central-1a',
|
|
464
|
+
'northamerica-central-1a'
|
|
465
|
+
]
|
|
296
466
|
},
|
|
297
467
|
version_channel: {
|
|
298
468
|
type: 'string',
|
|
299
469
|
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
470
|
description: 'Version of the kubernetes cluster.',
|
|
301
471
|
default: '1.x.x-cfke.x',
|
|
302
|
-
example: '1.
|
|
472
|
+
example: '1.x.x-cfke.x',
|
|
473
|
+
enum: [
|
|
474
|
+
'1.x.x-cfke.x',
|
|
475
|
+
'1.31.x-cfke.x',
|
|
476
|
+
'1.32.x-cfke.x',
|
|
477
|
+
'1.33.x-cfke.x'
|
|
478
|
+
]
|
|
303
479
|
}
|
|
304
480
|
},
|
|
305
|
-
required: [
|
|
481
|
+
required: [
|
|
482
|
+
'name',
|
|
483
|
+
'tier'
|
|
484
|
+
],
|
|
306
485
|
additionalProperties: false
|
|
307
486
|
};
|
|
308
487
|
export const ClusterJoinInformationSchema = {
|
|
@@ -311,8 +490,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
311
490
|
certificate_authority: {
|
|
312
491
|
type: 'string',
|
|
313
492
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
314
|
-
example:
|
|
315
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
493
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
316
494
|
},
|
|
317
495
|
endpoint: {
|
|
318
496
|
type: 'string',
|
|
@@ -320,6 +498,11 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
320
498
|
description: 'Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.',
|
|
321
499
|
example: 'https://10.31.64.7:6443'
|
|
322
500
|
},
|
|
501
|
+
cluster_dns: {
|
|
502
|
+
type: 'string',
|
|
503
|
+
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
|
+
example: '10.96.0.10'
|
|
505
|
+
},
|
|
323
506
|
auth_key: {
|
|
324
507
|
type: 'string',
|
|
325
508
|
description: 'Authentication key for the cluster.',
|
|
@@ -336,7 +519,7 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
336
519
|
kubernetes: {
|
|
337
520
|
type: 'string',
|
|
338
521
|
description: 'Kubernetes version of the cluster.',
|
|
339
|
-
example: '1.
|
|
522
|
+
example: '1.33.7'
|
|
340
523
|
},
|
|
341
524
|
tailscale: {
|
|
342
525
|
type: 'string',
|
|
@@ -354,7 +537,12 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
354
537
|
example: '565.0.0'
|
|
355
538
|
}
|
|
356
539
|
},
|
|
357
|
-
required: [
|
|
540
|
+
required: [
|
|
541
|
+
'kubernetes',
|
|
542
|
+
'tailscale',
|
|
543
|
+
'containerd',
|
|
544
|
+
'nvidia_driver'
|
|
545
|
+
],
|
|
358
546
|
additionalProperties: false,
|
|
359
547
|
description: 'Versions of the different components of the cluster.'
|
|
360
548
|
},
|
|
@@ -377,12 +565,24 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
377
565
|
example: '//iam.googleapis.com/projects/89014267864/locations/global/workloadIdentityPools/cfke/providers/oidc'
|
|
378
566
|
}
|
|
379
567
|
},
|
|
380
|
-
required: [
|
|
568
|
+
required: [
|
|
569
|
+
'metadata_url',
|
|
570
|
+
'aws_role_arn',
|
|
571
|
+
'gcp_workload_identity_provider'
|
|
572
|
+
],
|
|
381
573
|
additionalProperties: false,
|
|
382
|
-
description:
|
|
574
|
+
description: 'OIDC Information for hosts to access to third party API\'s.'
|
|
383
575
|
}
|
|
384
576
|
},
|
|
385
|
-
required: [
|
|
577
|
+
required: [
|
|
578
|
+
'certificate_authority',
|
|
579
|
+
'endpoint',
|
|
580
|
+
'cluster_dns',
|
|
581
|
+
'auth_key',
|
|
582
|
+
'bootstrap_token',
|
|
583
|
+
'versions',
|
|
584
|
+
'third_party_api_access_config'
|
|
585
|
+
],
|
|
386
586
|
additionalProperties: false
|
|
387
587
|
};
|
|
388
588
|
export const ClusterSchema = {
|
|
@@ -400,21 +600,22 @@ export const ClusterSchema = {
|
|
|
400
600
|
type: 'string',
|
|
401
601
|
description: 'Tier of the cluster.',
|
|
402
602
|
example: 'pro',
|
|
403
|
-
enum: [
|
|
603
|
+
enum: [
|
|
604
|
+
'basic',
|
|
605
|
+
'pro'
|
|
606
|
+
]
|
|
404
607
|
},
|
|
405
608
|
region: {
|
|
406
609
|
type: 'string',
|
|
407
|
-
description: 'Cloudfleet control plane region. One of "staging", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a". This field can not be updated after creation.',
|
|
408
|
-
default: 'staging',
|
|
610
|
+
description: 'Cloudfleet control plane region. One of "staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a". This field can not be updated after creation.',
|
|
611
|
+
default: 'staging-1a',
|
|
409
612
|
example: 'northamerica-central-1a',
|
|
410
|
-
enum: [
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
default: '1.x.x-cfke.x',
|
|
417
|
-
example: '1.29.x-cfke.x'
|
|
613
|
+
enum: [
|
|
614
|
+
'staging-1a',
|
|
615
|
+
'northamerica-central-1',
|
|
616
|
+
'europe-central-1a',
|
|
617
|
+
'northamerica-central-1a'
|
|
618
|
+
]
|
|
418
619
|
},
|
|
419
620
|
id: {
|
|
420
621
|
type: 'string',
|
|
@@ -426,32 +627,57 @@ export const ClusterSchema = {
|
|
|
426
627
|
type: 'string',
|
|
427
628
|
description: 'Status of the cluster. When creating a new cluster, set to `active`. When deleting a clusters, set to `deleted`.',
|
|
428
629
|
example: 'active',
|
|
429
|
-
enum: [
|
|
630
|
+
enum: [
|
|
631
|
+
'active',
|
|
632
|
+
'disabled',
|
|
633
|
+
'deleted',
|
|
634
|
+
'creating',
|
|
635
|
+
'deployed',
|
|
636
|
+
'failed',
|
|
637
|
+
'updating'
|
|
638
|
+
]
|
|
430
639
|
},
|
|
431
640
|
endpoint: {
|
|
432
641
|
anyOf: [
|
|
433
642
|
{
|
|
434
643
|
type: 'string',
|
|
435
644
|
format: 'uri',
|
|
436
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
645
|
+
description: 'URL signed by the private CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster. (Deprecated, use endpoint_public instead)',
|
|
437
646
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.cloudfleet.dev:6443'
|
|
438
647
|
},
|
|
439
648
|
{
|
|
440
649
|
type: 'string',
|
|
441
|
-
enum: [
|
|
650
|
+
enum: [
|
|
651
|
+
''
|
|
652
|
+
]
|
|
653
|
+
}
|
|
654
|
+
]
|
|
655
|
+
},
|
|
656
|
+
endpoint_public: {
|
|
657
|
+
anyOf: [
|
|
658
|
+
{
|
|
659
|
+
type: 'string',
|
|
660
|
+
format: 'uri',
|
|
661
|
+
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.',
|
|
662
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
type: 'string',
|
|
666
|
+
enum: [
|
|
667
|
+
''
|
|
668
|
+
]
|
|
442
669
|
}
|
|
443
670
|
]
|
|
444
671
|
},
|
|
445
672
|
certificate_ca: {
|
|
446
673
|
type: 'string',
|
|
447
674
|
description: 'Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.',
|
|
448
|
-
example:
|
|
449
|
-
MIIC0DCCAbigAwIBAgI...`
|
|
675
|
+
example: '-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...'
|
|
450
676
|
},
|
|
451
677
|
version_current: {
|
|
452
678
|
type: 'string',
|
|
453
679
|
description: 'Current version of the cluster.',
|
|
454
|
-
example: '1.
|
|
680
|
+
example: '1.33.7-cfke.264'
|
|
455
681
|
},
|
|
456
682
|
created_at: {
|
|
457
683
|
type: 'string',
|
|
@@ -467,9 +693,20 @@ MIIC0DCCAbigAwIBAgI...`
|
|
|
467
693
|
type: 'boolean',
|
|
468
694
|
description: 'Indicates if the cluster is ready to be used.',
|
|
469
695
|
example: true
|
|
696
|
+
},
|
|
697
|
+
version_channel: {
|
|
698
|
+
type: 'string',
|
|
699
|
+
pattern: '^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$',
|
|
700
|
+
description: 'Version of the kubernetes cluster.',
|
|
701
|
+
example: '1.x.x-cfke.x'
|
|
470
702
|
}
|
|
471
703
|
},
|
|
472
|
-
required: [
|
|
704
|
+
required: [
|
|
705
|
+
'name',
|
|
706
|
+
'tier',
|
|
707
|
+
'id',
|
|
708
|
+
'status'
|
|
709
|
+
],
|
|
473
710
|
additionalProperties: false
|
|
474
711
|
};
|
|
475
712
|
export const ClusterUpdateInputSchema = {
|
|
@@ -487,16 +724,21 @@ export const ClusterUpdateInputSchema = {
|
|
|
487
724
|
type: 'string',
|
|
488
725
|
description: 'Tier of the cluster.',
|
|
489
726
|
example: 'pro',
|
|
490
|
-
enum: [
|
|
727
|
+
enum: [
|
|
728
|
+
'basic',
|
|
729
|
+
'pro'
|
|
730
|
+
]
|
|
491
731
|
},
|
|
492
732
|
version_channel: {
|
|
493
733
|
type: 'string',
|
|
494
734
|
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
735
|
description: 'Version of the kubernetes cluster.',
|
|
496
|
-
example: '1.
|
|
736
|
+
example: '1.x.x-cfke.x'
|
|
497
737
|
}
|
|
498
738
|
},
|
|
499
|
-
required: [
|
|
739
|
+
required: [
|
|
740
|
+
'tier'
|
|
741
|
+
],
|
|
500
742
|
additionalProperties: false
|
|
501
743
|
};
|
|
502
744
|
export const FleetCreateInputSchema = {
|
|
@@ -512,7 +754,9 @@ export const FleetCreateInputSchema = {
|
|
|
512
754
|
description: 'CPU limit in cores.'
|
|
513
755
|
}
|
|
514
756
|
},
|
|
515
|
-
required: [
|
|
757
|
+
required: [
|
|
758
|
+
'cpu'
|
|
759
|
+
],
|
|
516
760
|
additionalProperties: false,
|
|
517
761
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
518
762
|
},
|
|
@@ -528,7 +772,9 @@ export const FleetCreateInputSchema = {
|
|
|
528
772
|
description: 'Project GCP Project id to deploy instances into'
|
|
529
773
|
}
|
|
530
774
|
},
|
|
531
|
-
required: [
|
|
775
|
+
required: [
|
|
776
|
+
'project'
|
|
777
|
+
],
|
|
532
778
|
additionalProperties: false
|
|
533
779
|
},
|
|
534
780
|
hetzner: {
|
|
@@ -543,7 +789,9 @@ export const FleetCreateInputSchema = {
|
|
|
543
789
|
description: 'Hetzner Cloud API key with read / write access'
|
|
544
790
|
}
|
|
545
791
|
},
|
|
546
|
-
required: [
|
|
792
|
+
required: [
|
|
793
|
+
'apiKey'
|
|
794
|
+
],
|
|
547
795
|
additionalProperties: false
|
|
548
796
|
},
|
|
549
797
|
aws: {
|
|
@@ -558,7 +806,9 @@ export const FleetCreateInputSchema = {
|
|
|
558
806
|
description: 'ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.'
|
|
559
807
|
}
|
|
560
808
|
},
|
|
561
|
-
required: [
|
|
809
|
+
required: [
|
|
810
|
+
'controllerRoleArn'
|
|
811
|
+
],
|
|
562
812
|
additionalProperties: false
|
|
563
813
|
},
|
|
564
814
|
id: {
|
|
@@ -570,7 +820,9 @@ export const FleetCreateInputSchema = {
|
|
|
570
820
|
example: 'new-clouds-fleet'
|
|
571
821
|
}
|
|
572
822
|
},
|
|
573
|
-
required: [
|
|
823
|
+
required: [
|
|
824
|
+
'id'
|
|
825
|
+
],
|
|
574
826
|
additionalProperties: false
|
|
575
827
|
};
|
|
576
828
|
export const FleetSchema = {
|
|
@@ -586,7 +838,9 @@ export const FleetSchema = {
|
|
|
586
838
|
description: 'CPU limit in cores.'
|
|
587
839
|
}
|
|
588
840
|
},
|
|
589
|
-
required: [
|
|
841
|
+
required: [
|
|
842
|
+
'cpu'
|
|
843
|
+
],
|
|
590
844
|
additionalProperties: false,
|
|
591
845
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
592
846
|
},
|
|
@@ -602,7 +856,9 @@ export const FleetSchema = {
|
|
|
602
856
|
description: 'Project GCP Project id to deploy instances into'
|
|
603
857
|
}
|
|
604
858
|
},
|
|
605
|
-
required: [
|
|
859
|
+
required: [
|
|
860
|
+
'project'
|
|
861
|
+
],
|
|
606
862
|
additionalProperties: false
|
|
607
863
|
},
|
|
608
864
|
hetzner: {
|
|
@@ -617,7 +873,9 @@ export const FleetSchema = {
|
|
|
617
873
|
description: 'Hetzner Cloud API key with read / write access'
|
|
618
874
|
}
|
|
619
875
|
},
|
|
620
|
-
required: [
|
|
876
|
+
required: [
|
|
877
|
+
'apiKey'
|
|
878
|
+
],
|
|
621
879
|
additionalProperties: false
|
|
622
880
|
},
|
|
623
881
|
aws: {
|
|
@@ -632,7 +890,9 @@ export const FleetSchema = {
|
|
|
632
890
|
description: 'ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.'
|
|
633
891
|
}
|
|
634
892
|
},
|
|
635
|
-
required: [
|
|
893
|
+
required: [
|
|
894
|
+
'controllerRoleArn'
|
|
895
|
+
],
|
|
636
896
|
additionalProperties: false
|
|
637
897
|
},
|
|
638
898
|
id: {
|
|
@@ -644,7 +904,9 @@ export const FleetSchema = {
|
|
|
644
904
|
example: 'new-clouds-fleet'
|
|
645
905
|
}
|
|
646
906
|
},
|
|
647
|
-
required: [
|
|
907
|
+
required: [
|
|
908
|
+
'id'
|
|
909
|
+
],
|
|
648
910
|
additionalProperties: false
|
|
649
911
|
};
|
|
650
912
|
export const FleetUpdateInputSchema = {
|
|
@@ -660,7 +922,9 @@ export const FleetUpdateInputSchema = {
|
|
|
660
922
|
description: 'CPU limit in cores.'
|
|
661
923
|
}
|
|
662
924
|
},
|
|
663
|
-
required: [
|
|
925
|
+
required: [
|
|
926
|
+
'cpu'
|
|
927
|
+
],
|
|
664
928
|
additionalProperties: false,
|
|
665
929
|
description: 'Limits define a set of bounds for provisioning capacity.'
|
|
666
930
|
},
|
|
@@ -676,7 +940,9 @@ export const FleetUpdateInputSchema = {
|
|
|
676
940
|
description: 'Project GCP Project id to deploy instances into'
|
|
677
941
|
}
|
|
678
942
|
},
|
|
679
|
-
required: [
|
|
943
|
+
required: [
|
|
944
|
+
'project'
|
|
945
|
+
],
|
|
680
946
|
additionalProperties: false
|
|
681
947
|
},
|
|
682
948
|
hetzner: {
|
|
@@ -691,7 +957,9 @@ export const FleetUpdateInputSchema = {
|
|
|
691
957
|
description: 'Hetzner Cloud API key with read / write access'
|
|
692
958
|
}
|
|
693
959
|
},
|
|
694
|
-
required: [
|
|
960
|
+
required: [
|
|
961
|
+
'apiKey'
|
|
962
|
+
],
|
|
695
963
|
additionalProperties: false
|
|
696
964
|
},
|
|
697
965
|
aws: {
|
|
@@ -706,7 +974,9 @@ export const FleetUpdateInputSchema = {
|
|
|
706
974
|
description: 'ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.'
|
|
707
975
|
}
|
|
708
976
|
},
|
|
709
|
-
required: [
|
|
977
|
+
required: [
|
|
978
|
+
'controllerRoleArn'
|
|
979
|
+
],
|
|
710
980
|
additionalProperties: false
|
|
711
981
|
}
|
|
712
982
|
},
|
|
@@ -744,7 +1014,9 @@ export const InviteSchema = {
|
|
|
744
1014
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
745
1015
|
}
|
|
746
1016
|
},
|
|
747
|
-
required: [
|
|
1017
|
+
required: [
|
|
1018
|
+
'date_created'
|
|
1019
|
+
],
|
|
748
1020
|
additionalProperties: false
|
|
749
1021
|
};
|
|
750
1022
|
export const InvoiceSchema = {
|
|
@@ -752,23 +1024,18 @@ export const InvoiceSchema = {
|
|
|
752
1024
|
properties: {
|
|
753
1025
|
id: {
|
|
754
1026
|
type: 'string',
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
1027
|
+
description: 'Unique identifier of the invoice.',
|
|
1028
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
758
1029
|
},
|
|
759
|
-
|
|
760
|
-
type: 'string'
|
|
761
|
-
format: 'uuid',
|
|
762
|
-
description: 'Unique identifier of the organization. UUID v4 string in canonical form',
|
|
763
|
-
example: '415026b6-f00f-44f8-968d-fc6ef4d0fc6d'
|
|
1030
|
+
number: {
|
|
1031
|
+
type: 'string'
|
|
764
1032
|
},
|
|
765
1033
|
status: {
|
|
766
1034
|
type: 'string',
|
|
767
1035
|
description: 'Status of the invoice',
|
|
768
|
-
example: '
|
|
769
|
-
enum: ['DRAFT', 'COMMITTED', 'VOID']
|
|
1036
|
+
example: 'paid'
|
|
770
1037
|
},
|
|
771
|
-
|
|
1038
|
+
total: {
|
|
772
1039
|
type: 'number',
|
|
773
1040
|
format: 'float',
|
|
774
1041
|
description: 'Total amount of the invoice',
|
|
@@ -777,413 +1044,189 @@ export const InvoiceSchema = {
|
|
|
777
1044
|
currency: {
|
|
778
1045
|
type: 'string',
|
|
779
1046
|
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']
|
|
782
|
-
},
|
|
783
|
-
creditAdj: {
|
|
784
|
-
type: 'number',
|
|
785
|
-
format: 'float',
|
|
786
|
-
description: 'Total amount of credit adjustments',
|
|
787
|
-
example: 0
|
|
788
|
-
},
|
|
789
|
-
refundAdj: {
|
|
790
|
-
type: 'number',
|
|
791
|
-
format: 'float',
|
|
792
|
-
description: 'Total amount of refund adjustments',
|
|
793
|
-
example: 0
|
|
794
|
-
},
|
|
795
|
-
invoiceDate: {
|
|
796
|
-
type: 'string',
|
|
797
|
-
description: 'Date of the invoice',
|
|
798
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
1047
|
+
example: 'usd'
|
|
799
1048
|
},
|
|
800
|
-
|
|
1049
|
+
created: {
|
|
801
1050
|
type: 'string',
|
|
802
|
-
|
|
803
|
-
|
|
1051
|
+
format: 'date-time',
|
|
1052
|
+
description: 'Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.',
|
|
1053
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
804
1054
|
},
|
|
805
|
-
|
|
1055
|
+
period_start: {
|
|
806
1056
|
type: 'string',
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
balance: {
|
|
811
|
-
type: 'number',
|
|
812
|
-
format: 'float',
|
|
813
|
-
description: 'Balance of the invoice',
|
|
814
|
-
example: 100
|
|
1057
|
+
format: 'date-time',
|
|
1058
|
+
description: 'Billing period start timestamp. ISO 8601 date string in the UTC timezone.',
|
|
1059
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
815
1060
|
},
|
|
816
|
-
|
|
1061
|
+
period_end: {
|
|
817
1062
|
type: 'string',
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
credits: {
|
|
822
|
-
type: 'array',
|
|
823
|
-
items: {
|
|
824
|
-
type: 'object',
|
|
825
|
-
properties: {
|
|
826
|
-
id: {
|
|
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: {
|
|
890
|
-
type: 'string',
|
|
891
|
-
description: 'Start date of the invoice item',
|
|
892
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
893
|
-
},
|
|
894
|
-
endDate: {
|
|
895
|
-
type: 'string',
|
|
896
|
-
description: 'End date of the invoice item',
|
|
897
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
898
|
-
},
|
|
899
|
-
amount: {
|
|
900
|
-
type: 'number',
|
|
901
|
-
format: 'float',
|
|
902
|
-
description: 'Amount of the invoice item',
|
|
903
|
-
example: 100
|
|
904
|
-
},
|
|
905
|
-
rate: {
|
|
906
|
-
type: 'number',
|
|
907
|
-
format: 'float',
|
|
908
|
-
description: 'Rate of the invoice item',
|
|
909
|
-
example: 100
|
|
910
|
-
},
|
|
911
|
-
currency: {
|
|
912
|
-
type: 'string',
|
|
913
|
-
description: 'Currency of the invoice item',
|
|
914
|
-
example: 'USD',
|
|
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'
|
|
1063
|
+
format: 'date-time',
|
|
1064
|
+
description: 'Billing period end timestamp. ISO 8601 date string in the UTC timezone.',
|
|
1065
|
+
example: '2023-12-20T13:53:32.000Z'
|
|
961
1066
|
},
|
|
962
|
-
|
|
963
|
-
type: '
|
|
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'
|
|
1018
|
-
},
|
|
1019
|
-
itemType: {
|
|
1020
|
-
type: 'string',
|
|
1021
|
-
description: 'Type of the invoice item',
|
|
1022
|
-
example: 'EXTERNAL_CHARGE',
|
|
1023
|
-
enum: ['EXTERNAL_CHARGE', 'FIXED', 'RECURRING', 'REPAIR_ADJ', 'CBA_ADJ', 'CREDIT_ADJ', 'ITEM_ADJ', 'USAGE', 'TAX', 'PARENT_SUMMARY']
|
|
1024
|
-
},
|
|
1025
|
-
description: {
|
|
1026
|
-
type: 'string',
|
|
1027
|
-
description: 'Description of the invoice item',
|
|
1028
|
-
example: 'Description of the invoice item'
|
|
1029
|
-
},
|
|
1030
|
-
startDate: {
|
|
1031
|
-
type: 'string',
|
|
1032
|
-
description: 'Start date of the invoice item',
|
|
1033
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
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'
|
|
1068
|
-
},
|
|
1069
|
-
catalogEffectiveDate: {
|
|
1070
|
-
type: 'string',
|
|
1071
|
-
description: 'Effective date of the catalog',
|
|
1072
|
-
example: '2019-01-01T00:00:00.000Z'
|
|
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'
|
|
1097
|
-
}
|
|
1098
|
-
},
|
|
1099
|
-
additionalProperties: false
|
|
1100
|
-
},
|
|
1101
|
-
description: 'Items of the invoice'
|
|
1067
|
+
invoice_pdf: {
|
|
1068
|
+
type: 'string'
|
|
1102
1069
|
}
|
|
1103
1070
|
},
|
|
1071
|
+
required: [
|
|
1072
|
+
'created',
|
|
1073
|
+
'period_start',
|
|
1074
|
+
'period_end'
|
|
1075
|
+
],
|
|
1104
1076
|
additionalProperties: false
|
|
1105
1077
|
};
|
|
1106
|
-
export const
|
|
1078
|
+
export const MarketplaceListingFilesSchema = {
|
|
1107
1079
|
type: 'object',
|
|
1108
1080
|
properties: {
|
|
1109
|
-
|
|
1110
|
-
type: 'string',
|
|
1111
|
-
maxLength: 63,
|
|
1112
|
-
minLength: 1,
|
|
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'
|
|
1116
|
-
},
|
|
1117
|
-
name: {
|
|
1081
|
+
chartYaml: {
|
|
1118
1082
|
type: 'string',
|
|
1119
|
-
description: '
|
|
1120
|
-
example: '
|
|
1121
|
-
},
|
|
1122
|
-
developer: {
|
|
1123
|
-
type: 'string',
|
|
1124
|
-
description: 'Author of the chart listing',
|
|
1125
|
-
example: 'Portworx'
|
|
1083
|
+
description: 'Raw Chart.yaml content from the Helm chart',
|
|
1084
|
+
example: 'apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4'
|
|
1126
1085
|
},
|
|
1127
|
-
|
|
1086
|
+
valuesYaml: {
|
|
1128
1087
|
type: 'string',
|
|
1129
|
-
description: '
|
|
1130
|
-
example: '
|
|
1088
|
+
description: 'Raw values.yaml content from the Helm chart',
|
|
1089
|
+
example: 'replicaCount: 1\nimage:\n repository: nginx\n tag: latest'
|
|
1131
1090
|
},
|
|
1132
|
-
|
|
1091
|
+
valuesSchemaJson: {
|
|
1133
1092
|
type: 'string',
|
|
1134
|
-
description: '
|
|
1135
|
-
example: '
|
|
1136
|
-
}
|
|
1137
|
-
|
|
1093
|
+
description: 'JSON schema for values.yaml as a string',
|
|
1094
|
+
example: '{"type":"object","properties":{"replicaCount":{"type":"number"}}}'
|
|
1095
|
+
}
|
|
1096
|
+
},
|
|
1097
|
+
additionalProperties: false
|
|
1098
|
+
};
|
|
1099
|
+
export const MarketplaceListingSchema = {
|
|
1100
|
+
type: 'object',
|
|
1101
|
+
properties: {
|
|
1102
|
+
name: {
|
|
1138
1103
|
type: 'string',
|
|
1139
|
-
description: '
|
|
1140
|
-
example: '
|
|
1104
|
+
description: 'Name of the chart',
|
|
1105
|
+
example: 'nginx-ingress'
|
|
1141
1106
|
},
|
|
1142
|
-
|
|
1107
|
+
versions: {
|
|
1143
1108
|
type: 'array',
|
|
1144
1109
|
items: {
|
|
1145
1110
|
type: 'string',
|
|
1146
|
-
|
|
1111
|
+
pattern: '^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(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-]+)*))?$',
|
|
1112
|
+
description: 'Specific version of the chart',
|
|
1113
|
+
example: '1.18.2-cfke.45'
|
|
1147
1114
|
},
|
|
1148
|
-
description: '
|
|
1115
|
+
description: 'Available versions of the chart'
|
|
1149
1116
|
},
|
|
1150
1117
|
version_channels: {
|
|
1151
1118
|
type: 'array',
|
|
1152
1119
|
items: {
|
|
1153
1120
|
type: 'string',
|
|
1154
1121
|
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-]+)*))?$',
|
|
1155
|
-
description: 'Version
|
|
1156
|
-
example: '
|
|
1157
|
-
}
|
|
1122
|
+
description: 'Version channel pattern',
|
|
1123
|
+
example: '1.18.x-cfke.x'
|
|
1124
|
+
},
|
|
1125
|
+
description: 'Version channels for the chart'
|
|
1158
1126
|
},
|
|
1159
|
-
|
|
1160
|
-
type: '
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1127
|
+
latestVersion: {
|
|
1128
|
+
type: 'string',
|
|
1129
|
+
description: 'Latest version of the chart',
|
|
1130
|
+
example: '1.18.2-cfke.45'
|
|
1131
|
+
},
|
|
1132
|
+
metadata: {
|
|
1133
|
+
type: 'object',
|
|
1134
|
+
properties: {
|
|
1135
|
+
name: {
|
|
1136
|
+
type: 'string',
|
|
1137
|
+
description: 'Chart name from metadata',
|
|
1138
|
+
example: 'nginx-ingress'
|
|
1139
|
+
},
|
|
1140
|
+
version: {
|
|
1141
|
+
type: 'string',
|
|
1142
|
+
description: 'Chart version from metadata',
|
|
1143
|
+
example: '1.18.2-cfke.45'
|
|
1144
|
+
},
|
|
1145
|
+
description: {
|
|
1146
|
+
type: 'string',
|
|
1147
|
+
description: 'Chart description',
|
|
1148
|
+
example: 'NGINX Ingress Controller for Kubernetes'
|
|
1149
|
+
},
|
|
1150
|
+
appVersion: {
|
|
1151
|
+
type: 'string',
|
|
1152
|
+
description: 'Application version',
|
|
1153
|
+
example: '1.9.4'
|
|
1154
|
+
},
|
|
1155
|
+
apiVersion: {
|
|
1156
|
+
type: 'string',
|
|
1157
|
+
description: 'Helm API version',
|
|
1158
|
+
example: 'v2'
|
|
1159
|
+
},
|
|
1160
|
+
keywords: {
|
|
1161
|
+
type: 'array',
|
|
1162
|
+
items: {
|
|
1163
|
+
type: 'string'
|
|
1164
|
+
},
|
|
1165
|
+
description: 'Chart keywords',
|
|
1166
|
+
example: [
|
|
1167
|
+
'ingress',
|
|
1168
|
+
'nginx',
|
|
1169
|
+
'load-balancer'
|
|
1170
|
+
]
|
|
1171
|
+
},
|
|
1172
|
+
home: {
|
|
1173
|
+
type: 'string',
|
|
1174
|
+
description: 'Chart home URL',
|
|
1175
|
+
example: 'https://kubernetes.github.io/ingress-nginx/'
|
|
1176
|
+
},
|
|
1177
|
+
icon: {
|
|
1178
|
+
type: 'string',
|
|
1179
|
+
description: 'A URL to an SVG or PNG image to be used as an icon',
|
|
1180
|
+
example: 'https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png'
|
|
1181
|
+
},
|
|
1182
|
+
sources: {
|
|
1183
|
+
type: 'array',
|
|
1184
|
+
items: {
|
|
1185
|
+
type: 'string'
|
|
1186
|
+
},
|
|
1187
|
+
description: 'Chart source URLs',
|
|
1188
|
+
example: [
|
|
1189
|
+
'https://github.com/kubernetes/ingress-nginx'
|
|
1190
|
+
]
|
|
1191
|
+
},
|
|
1192
|
+
maintainers: {
|
|
1193
|
+
type: 'array',
|
|
1194
|
+
items: {
|
|
1195
|
+
type: 'object',
|
|
1196
|
+
properties: {
|
|
1197
|
+
name: {
|
|
1198
|
+
type: 'string',
|
|
1199
|
+
description: 'Maintainer name',
|
|
1200
|
+
example: 'NGINX Team'
|
|
1201
|
+
},
|
|
1202
|
+
email: {
|
|
1203
|
+
type: 'string',
|
|
1204
|
+
description: 'Maintainer email',
|
|
1205
|
+
example: 'support@nginx.org'
|
|
1206
|
+
}
|
|
1207
|
+
},
|
|
1208
|
+
required: [
|
|
1209
|
+
'name'
|
|
1210
|
+
],
|
|
1211
|
+
additionalProperties: false
|
|
1212
|
+
},
|
|
1213
|
+
description: 'Chart maintainers'
|
|
1214
|
+
}
|
|
1215
|
+
},
|
|
1216
|
+
required: [
|
|
1217
|
+
'name',
|
|
1218
|
+
'version'
|
|
1219
|
+
],
|
|
1220
|
+
additionalProperties: false,
|
|
1221
|
+
description: 'Chart metadata'
|
|
1184
1222
|
}
|
|
1185
1223
|
},
|
|
1186
|
-
required: [
|
|
1224
|
+
required: [
|
|
1225
|
+
'name',
|
|
1226
|
+
'versions',
|
|
1227
|
+
'version_channels',
|
|
1228
|
+
'latestVersion'
|
|
1229
|
+
],
|
|
1187
1230
|
additionalProperties: false
|
|
1188
1231
|
};
|
|
1189
1232
|
export const OrganizationCreateInputSchema = {
|
|
@@ -1219,7 +1262,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
1219
1262
|
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
1263
|
}
|
|
1221
1264
|
},
|
|
1222
|
-
required: [
|
|
1265
|
+
required: [
|
|
1266
|
+
'email',
|
|
1267
|
+
'first_name',
|
|
1268
|
+
'last_name',
|
|
1269
|
+
'company_name',
|
|
1270
|
+
'password'
|
|
1271
|
+
],
|
|
1223
1272
|
additionalProperties: false
|
|
1224
1273
|
};
|
|
1225
1274
|
export const OrganizationSchema = {
|
|
@@ -1301,32 +1350,60 @@ export const OrganizationSchema = {
|
|
|
1301
1350
|
id: {
|
|
1302
1351
|
type: 'string',
|
|
1303
1352
|
description: 'Id of the control plane version. Used in API calls.',
|
|
1304
|
-
example: '1.
|
|
1353
|
+
example: '1.33.x-cfke.x'
|
|
1305
1354
|
},
|
|
1306
1355
|
label: {
|
|
1307
1356
|
type: 'string',
|
|
1308
1357
|
description: 'Label of the control plane version. Used in frontent UI.',
|
|
1309
|
-
example: '1.
|
|
1358
|
+
example: '1.33.x (Always latest 1.33 patch version)'
|
|
1310
1359
|
}
|
|
1311
1360
|
},
|
|
1312
|
-
required: [
|
|
1361
|
+
required: [
|
|
1362
|
+
'id',
|
|
1363
|
+
'label'
|
|
1364
|
+
],
|
|
1313
1365
|
additionalProperties: false
|
|
1314
1366
|
},
|
|
1315
1367
|
minItems: 1,
|
|
1316
1368
|
description: 'List of CFKE control plane versions available for the organization.'
|
|
1369
|
+
},
|
|
1370
|
+
cfcr_storage_gb: {
|
|
1371
|
+
type: 'integer',
|
|
1372
|
+
minimum: -1,
|
|
1373
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
1374
|
+
example: 500
|
|
1317
1375
|
}
|
|
1318
1376
|
},
|
|
1319
|
-
required: [
|
|
1377
|
+
required: [
|
|
1378
|
+
'basic_clusters_max',
|
|
1379
|
+
'basic_clusters_available',
|
|
1380
|
+
'pro_clusters_max',
|
|
1381
|
+
'pro_clusters_available',
|
|
1382
|
+
'fleets_max',
|
|
1383
|
+
'cluster_tiers',
|
|
1384
|
+
'regions',
|
|
1385
|
+
'versions',
|
|
1386
|
+
'cfcr_storage_gb'
|
|
1387
|
+
],
|
|
1320
1388
|
additionalProperties: false,
|
|
1321
1389
|
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.'
|
|
1322
1390
|
},
|
|
1323
1391
|
status: {
|
|
1324
1392
|
type: 'string',
|
|
1325
1393
|
description: 'Status of the organization. Can be `active` or `closed`, or `suspended`.',
|
|
1326
|
-
enum: [
|
|
1394
|
+
enum: [
|
|
1395
|
+
'active',
|
|
1396
|
+
'closed',
|
|
1397
|
+
'suspended'
|
|
1398
|
+
]
|
|
1327
1399
|
}
|
|
1328
1400
|
},
|
|
1329
|
-
required: [
|
|
1401
|
+
required: [
|
|
1402
|
+
'id',
|
|
1403
|
+
'date_created',
|
|
1404
|
+
'quota',
|
|
1405
|
+
'status'
|
|
1406
|
+
],
|
|
1330
1407
|
additionalProperties: false
|
|
1331
1408
|
};
|
|
1332
1409
|
export const PaymentMethodSchema = {
|
|
@@ -1348,7 +1425,9 @@ export const PaymentMethodSchema = {
|
|
|
1348
1425
|
nullable: true,
|
|
1349
1426
|
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
1350
1427
|
example: 'card',
|
|
1351
|
-
enum: [
|
|
1428
|
+
enum: [
|
|
1429
|
+
'card'
|
|
1430
|
+
]
|
|
1352
1431
|
},
|
|
1353
1432
|
last4: {
|
|
1354
1433
|
type: 'string',
|
|
@@ -1361,14 +1440,14 @@ export const PaymentMethodSchema = {
|
|
|
1361
1440
|
minimum: 1,
|
|
1362
1441
|
maximum: 12,
|
|
1363
1442
|
nullable: true,
|
|
1364
|
-
description:
|
|
1443
|
+
description: 'Two-digit number representing the card\'s expiration month.',
|
|
1365
1444
|
example: '12'
|
|
1366
1445
|
},
|
|
1367
1446
|
exp_year: {
|
|
1368
1447
|
type: 'integer',
|
|
1369
1448
|
minimum: 2024,
|
|
1370
1449
|
nullable: true,
|
|
1371
|
-
description:
|
|
1450
|
+
description: 'Four-digit number representing the card\'s expiration year.',
|
|
1372
1451
|
example: '2028'
|
|
1373
1452
|
},
|
|
1374
1453
|
brand: {
|
|
@@ -1376,10 +1455,873 @@ export const PaymentMethodSchema = {
|
|
|
1376
1455
|
nullable: true,
|
|
1377
1456
|
description: 'Payment card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.',
|
|
1378
1457
|
example: 'visa',
|
|
1379
|
-
enum: [
|
|
1458
|
+
enum: [
|
|
1459
|
+
'amex',
|
|
1460
|
+
'diners',
|
|
1461
|
+
'discover',
|
|
1462
|
+
'eftpos_au',
|
|
1463
|
+
'jcb',
|
|
1464
|
+
'mastercard',
|
|
1465
|
+
'unionpay',
|
|
1466
|
+
'visa',
|
|
1467
|
+
'unknown'
|
|
1468
|
+
]
|
|
1469
|
+
}
|
|
1470
|
+
},
|
|
1471
|
+
required: [
|
|
1472
|
+
'id',
|
|
1473
|
+
'setup',
|
|
1474
|
+
'type',
|
|
1475
|
+
'last4',
|
|
1476
|
+
'exp_month',
|
|
1477
|
+
'exp_year',
|
|
1478
|
+
'brand'
|
|
1479
|
+
],
|
|
1480
|
+
additionalProperties: false
|
|
1481
|
+
};
|
|
1482
|
+
export const PlatformQuotaSchema = {
|
|
1483
|
+
type: 'object',
|
|
1484
|
+
properties: {
|
|
1485
|
+
basic_clusters_max: {
|
|
1486
|
+
type: 'integer',
|
|
1487
|
+
minimum: 0,
|
|
1488
|
+
description: 'Maximum number of Basic clusters that can be created.',
|
|
1489
|
+
example: 999
|
|
1490
|
+
},
|
|
1491
|
+
basic_clusters_available: {
|
|
1492
|
+
type: 'integer',
|
|
1493
|
+
description: 'Available number of Basic clusters that can be created.',
|
|
1494
|
+
example: 999
|
|
1495
|
+
},
|
|
1496
|
+
pro_clusters_max: {
|
|
1497
|
+
type: 'integer',
|
|
1498
|
+
minimum: 0,
|
|
1499
|
+
description: 'Maximum number of Pro clusters that can be created.',
|
|
1500
|
+
example: 999
|
|
1501
|
+
},
|
|
1502
|
+
pro_clusters_available: {
|
|
1503
|
+
type: 'integer',
|
|
1504
|
+
description: 'Available number of Pro clusters that can be created.',
|
|
1505
|
+
example: 999
|
|
1506
|
+
},
|
|
1507
|
+
fleets_max: {
|
|
1508
|
+
type: 'integer',
|
|
1509
|
+
minimum: 0,
|
|
1510
|
+
description: 'Maximum number of fleets that can be created per cluster.',
|
|
1511
|
+
example: 999
|
|
1512
|
+
},
|
|
1513
|
+
cluster_tiers: {
|
|
1514
|
+
type: 'array',
|
|
1515
|
+
items: {
|
|
1516
|
+
type: 'string',
|
|
1517
|
+
example: 'basic'
|
|
1518
|
+
},
|
|
1519
|
+
minItems: 0,
|
|
1520
|
+
description: 'List of Cloudfleet cluster tiers available for the organization.'
|
|
1521
|
+
},
|
|
1522
|
+
regions: {
|
|
1523
|
+
type: 'array',
|
|
1524
|
+
items: {
|
|
1525
|
+
type: 'string',
|
|
1526
|
+
example: 'northamerica-central-1'
|
|
1527
|
+
},
|
|
1528
|
+
minItems: 1,
|
|
1529
|
+
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
1530
|
+
},
|
|
1531
|
+
versions: {
|
|
1532
|
+
type: 'array',
|
|
1533
|
+
items: {
|
|
1534
|
+
type: 'object',
|
|
1535
|
+
properties: {
|
|
1536
|
+
id: {
|
|
1537
|
+
type: 'string',
|
|
1538
|
+
description: 'Id of the control plane version. Used in API calls.',
|
|
1539
|
+
example: '1.33.x-cfke.x'
|
|
1540
|
+
},
|
|
1541
|
+
label: {
|
|
1542
|
+
type: 'string',
|
|
1543
|
+
description: 'Label of the control plane version. Used in frontent UI.',
|
|
1544
|
+
example: '1.33.x (Always latest 1.33 patch version)'
|
|
1545
|
+
}
|
|
1546
|
+
},
|
|
1547
|
+
required: [
|
|
1548
|
+
'id',
|
|
1549
|
+
'label'
|
|
1550
|
+
],
|
|
1551
|
+
additionalProperties: false
|
|
1552
|
+
},
|
|
1553
|
+
minItems: 1,
|
|
1554
|
+
description: 'List of CFKE control plane versions available for the organization.'
|
|
1555
|
+
},
|
|
1556
|
+
cfcr_storage_gb: {
|
|
1557
|
+
type: 'integer',
|
|
1558
|
+
minimum: -1,
|
|
1559
|
+
description: 'Organization-level maximum CFCR storage volume in GB. -1 means no limit.',
|
|
1560
|
+
example: 500
|
|
1561
|
+
}
|
|
1562
|
+
},
|
|
1563
|
+
required: [
|
|
1564
|
+
'basic_clusters_max',
|
|
1565
|
+
'basic_clusters_available',
|
|
1566
|
+
'pro_clusters_max',
|
|
1567
|
+
'pro_clusters_available',
|
|
1568
|
+
'fleets_max',
|
|
1569
|
+
'cluster_tiers',
|
|
1570
|
+
'regions',
|
|
1571
|
+
'versions',
|
|
1572
|
+
'cfcr_storage_gb'
|
|
1573
|
+
],
|
|
1574
|
+
additionalProperties: false
|
|
1575
|
+
};
|
|
1576
|
+
export const RegistryRepositorySchema = {
|
|
1577
|
+
type: 'object',
|
|
1578
|
+
properties: {
|
|
1579
|
+
name: {
|
|
1580
|
+
type: 'string',
|
|
1581
|
+
description: 'Repository name.',
|
|
1582
|
+
example: 'my-app'
|
|
1583
|
+
},
|
|
1584
|
+
region: {
|
|
1585
|
+
type: 'string',
|
|
1586
|
+
description: 'Registry region.',
|
|
1587
|
+
example: 'northamerica'
|
|
1588
|
+
},
|
|
1589
|
+
uri: {
|
|
1590
|
+
type: 'string',
|
|
1591
|
+
description: 'Full URI of the repository.',
|
|
1592
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
1593
|
+
}
|
|
1594
|
+
},
|
|
1595
|
+
required: [
|
|
1596
|
+
'name',
|
|
1597
|
+
'region',
|
|
1598
|
+
'uri'
|
|
1599
|
+
],
|
|
1600
|
+
additionalProperties: false
|
|
1601
|
+
};
|
|
1602
|
+
export const RegistryRepositoryWithTagsSchema = {
|
|
1603
|
+
type: 'object',
|
|
1604
|
+
properties: {
|
|
1605
|
+
name: {
|
|
1606
|
+
type: 'string',
|
|
1607
|
+
description: 'Repository name.',
|
|
1608
|
+
example: 'my-app'
|
|
1609
|
+
},
|
|
1610
|
+
region: {
|
|
1611
|
+
type: 'string',
|
|
1612
|
+
description: 'Registry region.',
|
|
1613
|
+
example: 'northamerica'
|
|
1614
|
+
},
|
|
1615
|
+
uri: {
|
|
1616
|
+
type: 'string',
|
|
1617
|
+
description: 'Full URI of the repository.',
|
|
1618
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app'
|
|
1619
|
+
},
|
|
1620
|
+
tags: {
|
|
1621
|
+
type: 'array',
|
|
1622
|
+
items: {
|
|
1623
|
+
type: 'object',
|
|
1624
|
+
properties: {
|
|
1625
|
+
name: {
|
|
1626
|
+
type: 'string',
|
|
1627
|
+
description: 'Tag name.',
|
|
1628
|
+
example: 'latest'
|
|
1629
|
+
},
|
|
1630
|
+
size: {
|
|
1631
|
+
type: 'number',
|
|
1632
|
+
format: 'float',
|
|
1633
|
+
description: 'Size of the tag in bytes.',
|
|
1634
|
+
example: 123456789
|
|
1635
|
+
},
|
|
1636
|
+
mediaType: {
|
|
1637
|
+
type: 'string',
|
|
1638
|
+
description: 'Media type of the manifest.',
|
|
1639
|
+
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
1640
|
+
},
|
|
1641
|
+
platforms: {
|
|
1642
|
+
type: 'array',
|
|
1643
|
+
items: {
|
|
1644
|
+
type: 'string'
|
|
1645
|
+
},
|
|
1646
|
+
description: 'Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).',
|
|
1647
|
+
example: [
|
|
1648
|
+
'linux/amd64',
|
|
1649
|
+
'linux/arm64'
|
|
1650
|
+
]
|
|
1651
|
+
}
|
|
1652
|
+
},
|
|
1653
|
+
required: [
|
|
1654
|
+
'name',
|
|
1655
|
+
'size'
|
|
1656
|
+
],
|
|
1657
|
+
additionalProperties: false
|
|
1658
|
+
},
|
|
1659
|
+
description: 'Array of tags in the repository.'
|
|
1660
|
+
},
|
|
1661
|
+
totalSize: {
|
|
1662
|
+
type: 'number',
|
|
1663
|
+
format: 'float',
|
|
1664
|
+
description: 'Total size of all tags in the repository in bytes.',
|
|
1665
|
+
example: 987654321
|
|
1666
|
+
}
|
|
1667
|
+
},
|
|
1668
|
+
required: [
|
|
1669
|
+
'name',
|
|
1670
|
+
'region',
|
|
1671
|
+
'uri',
|
|
1672
|
+
'tags',
|
|
1673
|
+
'totalSize'
|
|
1674
|
+
],
|
|
1675
|
+
additionalProperties: false
|
|
1676
|
+
};
|
|
1677
|
+
export const RegistryTagSchema = {
|
|
1678
|
+
type: 'object',
|
|
1679
|
+
properties: {
|
|
1680
|
+
name: {
|
|
1681
|
+
type: 'string',
|
|
1682
|
+
description: 'Tag name.',
|
|
1683
|
+
example: 'latest'
|
|
1684
|
+
},
|
|
1685
|
+
digest: {
|
|
1686
|
+
type: 'string',
|
|
1687
|
+
description: 'Manifest digest for pulling by digest.',
|
|
1688
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
1689
|
+
},
|
|
1690
|
+
mediaType: {
|
|
1691
|
+
type: 'string',
|
|
1692
|
+
description: 'Media type of the manifest.',
|
|
1693
|
+
example: 'application/vnd.docker.distribution.manifest.v2+json'
|
|
1694
|
+
},
|
|
1695
|
+
config: {
|
|
1696
|
+
type: 'object',
|
|
1697
|
+
properties: {
|
|
1698
|
+
size: {
|
|
1699
|
+
type: 'number',
|
|
1700
|
+
format: 'float',
|
|
1701
|
+
description: 'Size of the config in bytes.',
|
|
1702
|
+
example: 1234
|
|
1703
|
+
}
|
|
1704
|
+
},
|
|
1705
|
+
required: [
|
|
1706
|
+
'size'
|
|
1707
|
+
],
|
|
1708
|
+
additionalProperties: false,
|
|
1709
|
+
description: 'Manifest config metadata.'
|
|
1710
|
+
},
|
|
1711
|
+
layers: {
|
|
1712
|
+
type: 'array',
|
|
1713
|
+
items: {
|
|
1714
|
+
type: 'object',
|
|
1715
|
+
properties: {
|
|
1716
|
+
digest: {
|
|
1717
|
+
type: 'string',
|
|
1718
|
+
description: 'Digest of the layer.',
|
|
1719
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
1720
|
+
},
|
|
1721
|
+
size: {
|
|
1722
|
+
type: 'number',
|
|
1723
|
+
format: 'float',
|
|
1724
|
+
description: 'Size of the layer in bytes.',
|
|
1725
|
+
example: 5678
|
|
1726
|
+
}
|
|
1727
|
+
},
|
|
1728
|
+
required: [
|
|
1729
|
+
'size'
|
|
1730
|
+
],
|
|
1731
|
+
additionalProperties: false
|
|
1732
|
+
},
|
|
1733
|
+
description: 'Array of layer metadata.'
|
|
1734
|
+
},
|
|
1735
|
+
manifests: {
|
|
1736
|
+
type: 'array',
|
|
1737
|
+
items: {
|
|
1738
|
+
type: 'object',
|
|
1739
|
+
properties: {
|
|
1740
|
+
digest: {
|
|
1741
|
+
type: 'string',
|
|
1742
|
+
description: 'Digest of the manifest.',
|
|
1743
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
1744
|
+
},
|
|
1745
|
+
platform: {
|
|
1746
|
+
type: 'object',
|
|
1747
|
+
properties: {
|
|
1748
|
+
architecture: {
|
|
1749
|
+
type: 'string',
|
|
1750
|
+
description: 'Architecture of the platform.',
|
|
1751
|
+
example: 'amd64'
|
|
1752
|
+
},
|
|
1753
|
+
os: {
|
|
1754
|
+
type: 'string',
|
|
1755
|
+
description: 'Operating system of the platform.',
|
|
1756
|
+
example: 'linux'
|
|
1757
|
+
},
|
|
1758
|
+
variant: {
|
|
1759
|
+
type: 'string',
|
|
1760
|
+
description: 'Variant of the platform (e.g., v7, v8 for ARM).',
|
|
1761
|
+
example: 'v8'
|
|
1762
|
+
}
|
|
1763
|
+
},
|
|
1764
|
+
required: [
|
|
1765
|
+
'architecture',
|
|
1766
|
+
'os'
|
|
1767
|
+
],
|
|
1768
|
+
additionalProperties: false,
|
|
1769
|
+
description: 'Platform information for the manifest.'
|
|
1770
|
+
},
|
|
1771
|
+
layers: {
|
|
1772
|
+
type: 'array',
|
|
1773
|
+
items: {
|
|
1774
|
+
type: 'object',
|
|
1775
|
+
properties: {
|
|
1776
|
+
digest: {
|
|
1777
|
+
type: 'string',
|
|
1778
|
+
description: 'Digest of the layer.',
|
|
1779
|
+
example: 'sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890'
|
|
1780
|
+
},
|
|
1781
|
+
size: {
|
|
1782
|
+
type: 'number',
|
|
1783
|
+
format: 'float',
|
|
1784
|
+
description: 'Size of the layer in bytes.',
|
|
1785
|
+
example: 5678
|
|
1786
|
+
}
|
|
1787
|
+
},
|
|
1788
|
+
required: [
|
|
1789
|
+
'size'
|
|
1790
|
+
],
|
|
1791
|
+
additionalProperties: false
|
|
1792
|
+
},
|
|
1793
|
+
description: 'Layers for this platform.'
|
|
1794
|
+
},
|
|
1795
|
+
size: {
|
|
1796
|
+
type: 'number',
|
|
1797
|
+
format: 'float',
|
|
1798
|
+
description: 'Total size of this platform manifest in bytes.',
|
|
1799
|
+
example: 12345678
|
|
1800
|
+
}
|
|
1801
|
+
},
|
|
1802
|
+
required: [
|
|
1803
|
+
'digest'
|
|
1804
|
+
],
|
|
1805
|
+
additionalProperties: false
|
|
1806
|
+
},
|
|
1807
|
+
description: 'Array of manifests for multi-arch images.'
|
|
1808
|
+
},
|
|
1809
|
+
size: {
|
|
1810
|
+
type: 'number',
|
|
1811
|
+
format: 'float',
|
|
1812
|
+
description: 'Total size of the tag in bytes.',
|
|
1813
|
+
example: 123456789
|
|
1814
|
+
},
|
|
1815
|
+
region: {
|
|
1816
|
+
type: 'string',
|
|
1817
|
+
description: 'Registry region.',
|
|
1818
|
+
example: 'northamerica'
|
|
1819
|
+
},
|
|
1820
|
+
repository: {
|
|
1821
|
+
type: 'string',
|
|
1822
|
+
description: 'Repository name.',
|
|
1823
|
+
example: 'my-app'
|
|
1824
|
+
},
|
|
1825
|
+
uri: {
|
|
1826
|
+
type: 'string',
|
|
1827
|
+
description: 'Full URI of the tag.',
|
|
1828
|
+
example: 'ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest'
|
|
1829
|
+
}
|
|
1830
|
+
},
|
|
1831
|
+
required: [
|
|
1832
|
+
'name',
|
|
1833
|
+
'digest',
|
|
1834
|
+
'size',
|
|
1835
|
+
'region',
|
|
1836
|
+
'repository',
|
|
1837
|
+
'uri'
|
|
1838
|
+
],
|
|
1839
|
+
additionalProperties: false
|
|
1840
|
+
};
|
|
1841
|
+
export const TicketAttachmentSchema = {
|
|
1842
|
+
type: 'object',
|
|
1843
|
+
properties: {
|
|
1844
|
+
id: {
|
|
1845
|
+
type: 'string',
|
|
1846
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
1847
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
1848
|
+
},
|
|
1849
|
+
filename: {
|
|
1850
|
+
type: 'string',
|
|
1851
|
+
description: 'Original filename as uploaded.',
|
|
1852
|
+
example: 'debug.log'
|
|
1853
|
+
},
|
|
1854
|
+
content_type: {
|
|
1855
|
+
type: 'string',
|
|
1856
|
+
description: 'MIME content type of the attachment.',
|
|
1857
|
+
example: 'text/plain'
|
|
1858
|
+
},
|
|
1859
|
+
size: {
|
|
1860
|
+
type: 'integer',
|
|
1861
|
+
description: 'Size of the attachment in bytes.',
|
|
1862
|
+
example: 12345
|
|
1863
|
+
}
|
|
1864
|
+
},
|
|
1865
|
+
required: [
|
|
1866
|
+
'id',
|
|
1867
|
+
'filename',
|
|
1868
|
+
'content_type',
|
|
1869
|
+
'size'
|
|
1870
|
+
],
|
|
1871
|
+
additionalProperties: false
|
|
1872
|
+
};
|
|
1873
|
+
export const TicketCreateInputSchema = {
|
|
1874
|
+
type: 'object',
|
|
1875
|
+
properties: {
|
|
1876
|
+
category: {
|
|
1877
|
+
type: 'string',
|
|
1878
|
+
description: 'Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.',
|
|
1879
|
+
example: 'technical',
|
|
1880
|
+
enum: [
|
|
1881
|
+
'billing',
|
|
1882
|
+
'technical',
|
|
1883
|
+
'general'
|
|
1884
|
+
]
|
|
1885
|
+
},
|
|
1886
|
+
body: {
|
|
1887
|
+
type: 'string',
|
|
1888
|
+
maxLength: 50000,
|
|
1889
|
+
minLength: 1,
|
|
1890
|
+
pattern: '\\S',
|
|
1891
|
+
description: 'Initial message body in markdown. There is no separate subject — the first message body is the description.',
|
|
1892
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
1893
|
+
},
|
|
1894
|
+
properties: {
|
|
1895
|
+
type: 'object',
|
|
1896
|
+
additionalProperties: true,
|
|
1897
|
+
description: 'Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).',
|
|
1898
|
+
example: {
|
|
1899
|
+
subcategory: 'cluster-question',
|
|
1900
|
+
cluster_id: '60c72b2f9f1b2c001f8e4d3a'
|
|
1901
|
+
}
|
|
1902
|
+
}
|
|
1903
|
+
},
|
|
1904
|
+
required: [
|
|
1905
|
+
'category',
|
|
1906
|
+
'body'
|
|
1907
|
+
],
|
|
1908
|
+
additionalProperties: false
|
|
1909
|
+
};
|
|
1910
|
+
export const TicketListResponseSchema = {
|
|
1911
|
+
type: 'object',
|
|
1912
|
+
properties: {
|
|
1913
|
+
items: {
|
|
1914
|
+
type: 'array',
|
|
1915
|
+
items: {
|
|
1916
|
+
type: 'object',
|
|
1917
|
+
properties: {
|
|
1918
|
+
id: {
|
|
1919
|
+
type: 'string',
|
|
1920
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
1921
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
1922
|
+
},
|
|
1923
|
+
status: {
|
|
1924
|
+
type: 'string',
|
|
1925
|
+
description: 'Current state of the ticket.',
|
|
1926
|
+
example: 'waiting_on_us',
|
|
1927
|
+
enum: [
|
|
1928
|
+
'waiting_on_us',
|
|
1929
|
+
'waiting_on_user',
|
|
1930
|
+
'closed'
|
|
1931
|
+
]
|
|
1932
|
+
},
|
|
1933
|
+
category: {
|
|
1934
|
+
type: 'string',
|
|
1935
|
+
description: 'Ticket category.',
|
|
1936
|
+
example: 'technical',
|
|
1937
|
+
enum: [
|
|
1938
|
+
'billing',
|
|
1939
|
+
'technical',
|
|
1940
|
+
'general'
|
|
1941
|
+
]
|
|
1942
|
+
},
|
|
1943
|
+
summary: {
|
|
1944
|
+
type: 'string',
|
|
1945
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
1946
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
1947
|
+
},
|
|
1948
|
+
closed_at: {
|
|
1949
|
+
type: 'string',
|
|
1950
|
+
format: 'date-time',
|
|
1951
|
+
nullable: true,
|
|
1952
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
1953
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
1954
|
+
},
|
|
1955
|
+
date_created: {
|
|
1956
|
+
type: 'string',
|
|
1957
|
+
format: 'date-time',
|
|
1958
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
1959
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1960
|
+
},
|
|
1961
|
+
date_updated: {
|
|
1962
|
+
type: 'string',
|
|
1963
|
+
format: 'date-time',
|
|
1964
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
1965
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
1966
|
+
},
|
|
1967
|
+
messages: {
|
|
1968
|
+
type: 'array',
|
|
1969
|
+
items: {
|
|
1970
|
+
type: 'object',
|
|
1971
|
+
properties: {
|
|
1972
|
+
id: {
|
|
1973
|
+
type: 'string',
|
|
1974
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
1975
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
1976
|
+
},
|
|
1977
|
+
type: {
|
|
1978
|
+
type: 'string',
|
|
1979
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
1980
|
+
example: 'customer_reply',
|
|
1981
|
+
enum: [
|
|
1982
|
+
'customer_reply',
|
|
1983
|
+
'agent_reply'
|
|
1984
|
+
]
|
|
1985
|
+
},
|
|
1986
|
+
body: {
|
|
1987
|
+
type: 'string',
|
|
1988
|
+
description: 'Message body in markdown.',
|
|
1989
|
+
example: 'Thanks — that resolved it on my side.'
|
|
1990
|
+
},
|
|
1991
|
+
author_first_name: {
|
|
1992
|
+
type: 'string',
|
|
1993
|
+
nullable: true,
|
|
1994
|
+
description: 'First name of the author. Null when not provided.',
|
|
1995
|
+
example: 'Jane'
|
|
1996
|
+
},
|
|
1997
|
+
author_last_name: {
|
|
1998
|
+
type: 'string',
|
|
1999
|
+
nullable: true,
|
|
2000
|
+
description: 'Last name of the author. Null when not provided.',
|
|
2001
|
+
example: 'Doe'
|
|
2002
|
+
},
|
|
2003
|
+
attachments: {
|
|
2004
|
+
type: 'array',
|
|
2005
|
+
items: {
|
|
2006
|
+
type: 'object',
|
|
2007
|
+
properties: {
|
|
2008
|
+
id: {
|
|
2009
|
+
type: 'string',
|
|
2010
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2011
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2012
|
+
},
|
|
2013
|
+
filename: {
|
|
2014
|
+
type: 'string',
|
|
2015
|
+
description: 'Original filename as uploaded.',
|
|
2016
|
+
example: 'debug.log'
|
|
2017
|
+
},
|
|
2018
|
+
content_type: {
|
|
2019
|
+
type: 'string',
|
|
2020
|
+
description: 'MIME content type of the attachment.',
|
|
2021
|
+
example: 'text/plain'
|
|
2022
|
+
},
|
|
2023
|
+
size: {
|
|
2024
|
+
type: 'integer',
|
|
2025
|
+
description: 'Size of the attachment in bytes.',
|
|
2026
|
+
example: 12345
|
|
2027
|
+
}
|
|
2028
|
+
},
|
|
2029
|
+
required: [
|
|
2030
|
+
'id',
|
|
2031
|
+
'filename',
|
|
2032
|
+
'content_type',
|
|
2033
|
+
'size'
|
|
2034
|
+
],
|
|
2035
|
+
additionalProperties: false
|
|
2036
|
+
},
|
|
2037
|
+
description: 'Attachments associated with this message.',
|
|
2038
|
+
example: []
|
|
2039
|
+
},
|
|
2040
|
+
date_created: {
|
|
2041
|
+
type: 'string',
|
|
2042
|
+
format: 'date-time',
|
|
2043
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2044
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
2045
|
+
}
|
|
2046
|
+
},
|
|
2047
|
+
required: [
|
|
2048
|
+
'id',
|
|
2049
|
+
'type',
|
|
2050
|
+
'body',
|
|
2051
|
+
'date_created'
|
|
2052
|
+
],
|
|
2053
|
+
additionalProperties: false
|
|
2054
|
+
},
|
|
2055
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
2056
|
+
}
|
|
2057
|
+
},
|
|
2058
|
+
required: [
|
|
2059
|
+
'id',
|
|
2060
|
+
'status',
|
|
2061
|
+
'category',
|
|
2062
|
+
'summary',
|
|
2063
|
+
'date_created',
|
|
2064
|
+
'date_updated'
|
|
2065
|
+
],
|
|
2066
|
+
additionalProperties: false
|
|
2067
|
+
},
|
|
2068
|
+
description: 'Tickets for the organization, ordered newest first. Messages are omitted from list responses.'
|
|
2069
|
+
}
|
|
2070
|
+
},
|
|
2071
|
+
required: [
|
|
2072
|
+
'items'
|
|
2073
|
+
],
|
|
2074
|
+
additionalProperties: false
|
|
2075
|
+
};
|
|
2076
|
+
export const TicketMessageInputSchema = {
|
|
2077
|
+
type: 'object',
|
|
2078
|
+
properties: {
|
|
2079
|
+
body: {
|
|
2080
|
+
type: 'string',
|
|
2081
|
+
maxLength: 50000,
|
|
2082
|
+
minLength: 1,
|
|
2083
|
+
pattern: '\\S',
|
|
2084
|
+
description: 'Reply body in markdown.',
|
|
2085
|
+
example: 'Thanks — that resolved it on my side.'
|
|
2086
|
+
}
|
|
2087
|
+
},
|
|
2088
|
+
required: [
|
|
2089
|
+
'body'
|
|
2090
|
+
],
|
|
2091
|
+
additionalProperties: false
|
|
2092
|
+
};
|
|
2093
|
+
export const TicketMessageSchema = {
|
|
2094
|
+
type: 'object',
|
|
2095
|
+
properties: {
|
|
2096
|
+
id: {
|
|
2097
|
+
type: 'string',
|
|
2098
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
2099
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
2100
|
+
},
|
|
2101
|
+
type: {
|
|
2102
|
+
type: 'string',
|
|
2103
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
2104
|
+
example: 'customer_reply',
|
|
2105
|
+
enum: [
|
|
2106
|
+
'customer_reply',
|
|
2107
|
+
'agent_reply'
|
|
2108
|
+
]
|
|
2109
|
+
},
|
|
2110
|
+
body: {
|
|
2111
|
+
type: 'string',
|
|
2112
|
+
description: 'Message body in markdown.',
|
|
2113
|
+
example: 'Thanks — that resolved it on my side.'
|
|
2114
|
+
},
|
|
2115
|
+
author_first_name: {
|
|
2116
|
+
type: 'string',
|
|
2117
|
+
description: 'First name of the author. Null when not provided.',
|
|
2118
|
+
example: 'Jane'
|
|
2119
|
+
},
|
|
2120
|
+
author_last_name: {
|
|
2121
|
+
type: 'string',
|
|
2122
|
+
description: 'Last name of the author. Null when not provided.',
|
|
2123
|
+
example: 'Doe'
|
|
2124
|
+
},
|
|
2125
|
+
attachments: {
|
|
2126
|
+
type: 'array',
|
|
2127
|
+
items: {
|
|
2128
|
+
type: 'object',
|
|
2129
|
+
properties: {
|
|
2130
|
+
id: {
|
|
2131
|
+
type: 'string',
|
|
2132
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2133
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2134
|
+
},
|
|
2135
|
+
filename: {
|
|
2136
|
+
type: 'string',
|
|
2137
|
+
description: 'Original filename as uploaded.',
|
|
2138
|
+
example: 'debug.log'
|
|
2139
|
+
},
|
|
2140
|
+
content_type: {
|
|
2141
|
+
type: 'string',
|
|
2142
|
+
description: 'MIME content type of the attachment.',
|
|
2143
|
+
example: 'text/plain'
|
|
2144
|
+
},
|
|
2145
|
+
size: {
|
|
2146
|
+
type: 'integer',
|
|
2147
|
+
description: 'Size of the attachment in bytes.',
|
|
2148
|
+
example: 12345
|
|
2149
|
+
}
|
|
2150
|
+
},
|
|
2151
|
+
required: [
|
|
2152
|
+
'id',
|
|
2153
|
+
'filename',
|
|
2154
|
+
'content_type',
|
|
2155
|
+
'size'
|
|
2156
|
+
],
|
|
2157
|
+
additionalProperties: false
|
|
2158
|
+
},
|
|
2159
|
+
description: 'Attachments associated with this message.',
|
|
2160
|
+
example: []
|
|
2161
|
+
},
|
|
2162
|
+
date_created: {
|
|
2163
|
+
type: 'string',
|
|
2164
|
+
format: 'date-time',
|
|
2165
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2166
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
2167
|
+
}
|
|
2168
|
+
},
|
|
2169
|
+
required: [
|
|
2170
|
+
'id',
|
|
2171
|
+
'type',
|
|
2172
|
+
'body',
|
|
2173
|
+
'date_created'
|
|
2174
|
+
],
|
|
2175
|
+
additionalProperties: false
|
|
2176
|
+
};
|
|
2177
|
+
export const TicketSchema = {
|
|
2178
|
+
type: 'object',
|
|
2179
|
+
properties: {
|
|
2180
|
+
id: {
|
|
2181
|
+
type: 'string',
|
|
2182
|
+
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
2183
|
+
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
2184
|
+
},
|
|
2185
|
+
status: {
|
|
2186
|
+
type: 'string',
|
|
2187
|
+
description: 'Current state of the ticket.',
|
|
2188
|
+
example: 'waiting_on_us',
|
|
2189
|
+
enum: [
|
|
2190
|
+
'waiting_on_us',
|
|
2191
|
+
'waiting_on_user',
|
|
2192
|
+
'closed'
|
|
2193
|
+
]
|
|
2194
|
+
},
|
|
2195
|
+
category: {
|
|
2196
|
+
type: 'string',
|
|
2197
|
+
description: 'Ticket category.',
|
|
2198
|
+
example: 'technical',
|
|
2199
|
+
enum: [
|
|
2200
|
+
'billing',
|
|
2201
|
+
'technical',
|
|
2202
|
+
'general'
|
|
2203
|
+
]
|
|
2204
|
+
},
|
|
2205
|
+
summary: {
|
|
2206
|
+
type: 'string',
|
|
2207
|
+
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
2208
|
+
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
2209
|
+
},
|
|
2210
|
+
closed_at: {
|
|
2211
|
+
type: 'string',
|
|
2212
|
+
format: 'date-time',
|
|
2213
|
+
description: 'Closure timestamp. Null while the ticket is open.',
|
|
2214
|
+
example: '2026-05-18T16:08:14.338Z'
|
|
2215
|
+
},
|
|
2216
|
+
date_created: {
|
|
2217
|
+
type: 'string',
|
|
2218
|
+
format: 'date-time',
|
|
2219
|
+
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
2220
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
2221
|
+
},
|
|
2222
|
+
date_updated: {
|
|
2223
|
+
type: 'string',
|
|
2224
|
+
format: 'date-time',
|
|
2225
|
+
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
2226
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
2227
|
+
},
|
|
2228
|
+
messages: {
|
|
2229
|
+
type: 'array',
|
|
2230
|
+
items: {
|
|
2231
|
+
type: 'object',
|
|
2232
|
+
properties: {
|
|
2233
|
+
id: {
|
|
2234
|
+
type: 'string',
|
|
2235
|
+
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
2236
|
+
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
2237
|
+
},
|
|
2238
|
+
type: {
|
|
2239
|
+
type: 'string',
|
|
2240
|
+
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
2241
|
+
example: 'customer_reply',
|
|
2242
|
+
enum: [
|
|
2243
|
+
'customer_reply',
|
|
2244
|
+
'agent_reply'
|
|
2245
|
+
]
|
|
2246
|
+
},
|
|
2247
|
+
body: {
|
|
2248
|
+
type: 'string',
|
|
2249
|
+
description: 'Message body in markdown.',
|
|
2250
|
+
example: 'Thanks — that resolved it on my side.'
|
|
2251
|
+
},
|
|
2252
|
+
author_first_name: {
|
|
2253
|
+
type: 'string',
|
|
2254
|
+
description: 'First name of the author. Null when not provided.',
|
|
2255
|
+
example: 'Jane'
|
|
2256
|
+
},
|
|
2257
|
+
author_last_name: {
|
|
2258
|
+
type: 'string',
|
|
2259
|
+
description: 'Last name of the author. Null when not provided.',
|
|
2260
|
+
example: 'Doe'
|
|
2261
|
+
},
|
|
2262
|
+
attachments: {
|
|
2263
|
+
type: 'array',
|
|
2264
|
+
items: {
|
|
2265
|
+
type: 'object',
|
|
2266
|
+
properties: {
|
|
2267
|
+
id: {
|
|
2268
|
+
type: 'string',
|
|
2269
|
+
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2270
|
+
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2271
|
+
},
|
|
2272
|
+
filename: {
|
|
2273
|
+
type: 'string',
|
|
2274
|
+
description: 'Original filename as uploaded.',
|
|
2275
|
+
example: 'debug.log'
|
|
2276
|
+
},
|
|
2277
|
+
content_type: {
|
|
2278
|
+
type: 'string',
|
|
2279
|
+
description: 'MIME content type of the attachment.',
|
|
2280
|
+
example: 'text/plain'
|
|
2281
|
+
},
|
|
2282
|
+
size: {
|
|
2283
|
+
type: 'integer',
|
|
2284
|
+
description: 'Size of the attachment in bytes.',
|
|
2285
|
+
example: 12345
|
|
2286
|
+
}
|
|
2287
|
+
},
|
|
2288
|
+
required: [
|
|
2289
|
+
'id',
|
|
2290
|
+
'filename',
|
|
2291
|
+
'content_type',
|
|
2292
|
+
'size'
|
|
2293
|
+
],
|
|
2294
|
+
additionalProperties: false
|
|
2295
|
+
},
|
|
2296
|
+
description: 'Attachments associated with this message.',
|
|
2297
|
+
example: []
|
|
2298
|
+
},
|
|
2299
|
+
date_created: {
|
|
2300
|
+
type: 'string',
|
|
2301
|
+
format: 'date-time',
|
|
2302
|
+
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2303
|
+
example: '2026-05-11T16:08:14.338Z'
|
|
2304
|
+
}
|
|
2305
|
+
},
|
|
2306
|
+
required: [
|
|
2307
|
+
'id',
|
|
2308
|
+
'type',
|
|
2309
|
+
'body',
|
|
2310
|
+
'date_created'
|
|
2311
|
+
],
|
|
2312
|
+
additionalProperties: false
|
|
2313
|
+
},
|
|
2314
|
+
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
1380
2315
|
}
|
|
1381
2316
|
},
|
|
1382
|
-
required: [
|
|
2317
|
+
required: [
|
|
2318
|
+
'id',
|
|
2319
|
+
'status',
|
|
2320
|
+
'category',
|
|
2321
|
+
'summary',
|
|
2322
|
+
'date_created',
|
|
2323
|
+
'date_updated'
|
|
2324
|
+
],
|
|
1383
2325
|
additionalProperties: false
|
|
1384
2326
|
};
|
|
1385
2327
|
export const TokenCreateInputSchema = {
|
|
@@ -1397,10 +2339,16 @@ export const TokenCreateInputSchema = {
|
|
|
1397
2339
|
type: 'string',
|
|
1398
2340
|
description: 'Role assumed by the token.',
|
|
1399
2341
|
example: 'User',
|
|
1400
|
-
enum: [
|
|
2342
|
+
enum: [
|
|
2343
|
+
'Administrator',
|
|
2344
|
+
'User'
|
|
2345
|
+
]
|
|
1401
2346
|
}
|
|
1402
2347
|
},
|
|
1403
|
-
required: [
|
|
2348
|
+
required: [
|
|
2349
|
+
'name',
|
|
2350
|
+
'role'
|
|
2351
|
+
],
|
|
1404
2352
|
additionalProperties: false
|
|
1405
2353
|
};
|
|
1406
2354
|
export const TokenSchema = {
|
|
@@ -1418,7 +2366,10 @@ export const TokenSchema = {
|
|
|
1418
2366
|
type: 'string',
|
|
1419
2367
|
description: 'Role assumed by the token.',
|
|
1420
2368
|
example: 'User',
|
|
1421
|
-
enum: [
|
|
2369
|
+
enum: [
|
|
2370
|
+
'Administrator',
|
|
2371
|
+
'User'
|
|
2372
|
+
]
|
|
1422
2373
|
},
|
|
1423
2374
|
id: {
|
|
1424
2375
|
type: 'string',
|
|
@@ -1437,7 +2388,11 @@ export const TokenSchema = {
|
|
|
1437
2388
|
example: '2023-12-20T13:53:32.000Z'
|
|
1438
2389
|
}
|
|
1439
2390
|
},
|
|
1440
|
-
required: [
|
|
2391
|
+
required: [
|
|
2392
|
+
'name',
|
|
2393
|
+
'role',
|
|
2394
|
+
'date_created'
|
|
2395
|
+
],
|
|
1441
2396
|
additionalProperties: false
|
|
1442
2397
|
};
|
|
1443
2398
|
export const TokenUpdateInputSchema = {
|
|
@@ -1455,9 +2410,127 @@ export const TokenUpdateInputSchema = {
|
|
|
1455
2410
|
type: 'string',
|
|
1456
2411
|
description: 'Role assumed by the token.',
|
|
1457
2412
|
example: 'User',
|
|
1458
|
-
enum: [
|
|
2413
|
+
enum: [
|
|
2414
|
+
'Administrator',
|
|
2415
|
+
'User'
|
|
2416
|
+
]
|
|
2417
|
+
}
|
|
2418
|
+
},
|
|
2419
|
+
additionalProperties: false
|
|
2420
|
+
};
|
|
2421
|
+
export const UsageFacetsSchema = {
|
|
2422
|
+
type: 'object',
|
|
2423
|
+
properties: {
|
|
2424
|
+
cluster_id: {
|
|
2425
|
+
type: 'array',
|
|
2426
|
+
items: {
|
|
2427
|
+
type: 'string'
|
|
2428
|
+
},
|
|
2429
|
+
description: 'List of unique cluster IDs',
|
|
2430
|
+
example: [
|
|
2431
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
2432
|
+
]
|
|
2433
|
+
},
|
|
2434
|
+
product: {
|
|
2435
|
+
type: 'array',
|
|
2436
|
+
items: {
|
|
2437
|
+
type: 'string'
|
|
2438
|
+
},
|
|
2439
|
+
description: 'List of unique products',
|
|
2440
|
+
example: [
|
|
2441
|
+
'cfke_controlplane',
|
|
2442
|
+
'cfke_connected_nodes'
|
|
2443
|
+
]
|
|
2444
|
+
}
|
|
2445
|
+
},
|
|
2446
|
+
additionalProperties: false
|
|
2447
|
+
};
|
|
2448
|
+
export const UsageResponseSchema = {
|
|
2449
|
+
type: 'object',
|
|
2450
|
+
properties: {
|
|
2451
|
+
data: {
|
|
2452
|
+
type: 'array',
|
|
2453
|
+
items: {
|
|
2454
|
+
type: 'object',
|
|
2455
|
+
properties: {
|
|
2456
|
+
hour: {
|
|
2457
|
+
type: 'string',
|
|
2458
|
+
description: 'Hour of the usage',
|
|
2459
|
+
example: '2019-01-01T00:00:00.000Z'
|
|
2460
|
+
},
|
|
2461
|
+
cluster_id: {
|
|
2462
|
+
type: 'string',
|
|
2463
|
+
description: 'Unique identifier of the kubernetes cluster. UUID v4 string in canonical form',
|
|
2464
|
+
example: '6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
2465
|
+
},
|
|
2466
|
+
product: {
|
|
2467
|
+
type: 'string',
|
|
2468
|
+
description: 'The product the usage is associated with',
|
|
2469
|
+
example: 'cfke_controlplane'
|
|
2470
|
+
},
|
|
2471
|
+
value: {
|
|
2472
|
+
type: 'number',
|
|
2473
|
+
format: 'float',
|
|
2474
|
+
description: 'Consumption',
|
|
2475
|
+
example: 4
|
|
2476
|
+
},
|
|
2477
|
+
price: {
|
|
2478
|
+
type: 'number',
|
|
2479
|
+
format: 'float',
|
|
2480
|
+
description: 'Price per unit',
|
|
2481
|
+
example: 0.01
|
|
2482
|
+
},
|
|
2483
|
+
total: {
|
|
2484
|
+
type: 'number',
|
|
2485
|
+
format: 'float',
|
|
2486
|
+
description: 'Total cost'
|
|
2487
|
+
}
|
|
2488
|
+
},
|
|
2489
|
+
required: [
|
|
2490
|
+
'hour',
|
|
2491
|
+
'cluster_id',
|
|
2492
|
+
'product',
|
|
2493
|
+
'value',
|
|
2494
|
+
'price',
|
|
2495
|
+
'total'
|
|
2496
|
+
],
|
|
2497
|
+
additionalProperties: false
|
|
2498
|
+
},
|
|
2499
|
+
description: 'Usage data'
|
|
2500
|
+
},
|
|
2501
|
+
facets: {
|
|
2502
|
+
type: 'object',
|
|
2503
|
+
properties: {
|
|
2504
|
+
cluster_id: {
|
|
2505
|
+
type: 'array',
|
|
2506
|
+
items: {
|
|
2507
|
+
type: 'string'
|
|
2508
|
+
},
|
|
2509
|
+
description: 'List of unique cluster IDs',
|
|
2510
|
+
example: [
|
|
2511
|
+
'6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
2512
|
+
]
|
|
2513
|
+
},
|
|
2514
|
+
product: {
|
|
2515
|
+
type: 'array',
|
|
2516
|
+
items: {
|
|
2517
|
+
type: 'string'
|
|
2518
|
+
},
|
|
2519
|
+
description: 'List of unique products',
|
|
2520
|
+
example: [
|
|
2521
|
+
'cfke_controlplane',
|
|
2522
|
+
'cfke_connected_nodes'
|
|
2523
|
+
]
|
|
2524
|
+
}
|
|
2525
|
+
},
|
|
2526
|
+
additionalProperties: false,
|
|
2527
|
+
description: 'Facets for filtering'
|
|
1459
2528
|
}
|
|
1460
2529
|
},
|
|
2530
|
+
required: [
|
|
2531
|
+
'data',
|
|
2532
|
+
'facets'
|
|
2533
|
+
],
|
|
1461
2534
|
additionalProperties: false
|
|
1462
2535
|
};
|
|
1463
2536
|
export const UsageSchema = {
|
|
@@ -1470,90 +2543,40 @@ export const UsageSchema = {
|
|
|
1470
2543
|
},
|
|
1471
2544
|
cluster_id: {
|
|
1472
2545
|
type: 'string',
|
|
1473
|
-
format: 'uuid',
|
|
1474
2546
|
description: 'Unique identifier of the kubernetes cluster. UUID v4 string in canonical form',
|
|
1475
2547
|
example: '6b5439b1-923a-4f2b-a371-d554e5ea23fa'
|
|
1476
2548
|
},
|
|
1477
|
-
cluster_tier: {
|
|
1478
|
-
type: 'string',
|
|
1479
|
-
description: 'Tier of the cluster.',
|
|
1480
|
-
example: 'pro',
|
|
1481
|
-
enum: ['basic', 'pro', '']
|
|
1482
|
-
},
|
|
1483
2549
|
product: {
|
|
1484
2550
|
type: 'string',
|
|
1485
2551
|
description: 'The product the usage is associated with',
|
|
1486
|
-
example: 'cfke_controlplane'
|
|
1487
|
-
enum: ['cfke_controlplane', 'cfke_connected_nodes', 'infra_compute', 'infra_storage', 'infra_loadbalancing', 'infra_traffic', 'cfcr_storage']
|
|
2552
|
+
example: 'cfke_controlplane'
|
|
1488
2553
|
},
|
|
1489
|
-
|
|
1490
|
-
type: '
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
sku: {
|
|
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
|
-
]
|
|
2554
|
+
value: {
|
|
2555
|
+
type: 'number',
|
|
2556
|
+
format: 'float',
|
|
2557
|
+
description: 'Consumption',
|
|
2558
|
+
example: 4
|
|
1512
2559
|
},
|
|
1513
2560
|
price: {
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
description: 'Price',
|
|
1519
|
-
example: 4
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
type: 'string',
|
|
1523
|
-
enum: ['']
|
|
1524
|
-
}
|
|
1525
|
-
]
|
|
1526
|
-
},
|
|
1527
|
-
value: {
|
|
1528
|
-
anyOf: [
|
|
1529
|
-
{
|
|
1530
|
-
type: 'number',
|
|
1531
|
-
format: 'float',
|
|
1532
|
-
description: 'Value',
|
|
1533
|
-
example: 4
|
|
1534
|
-
},
|
|
1535
|
-
{
|
|
1536
|
-
type: 'string',
|
|
1537
|
-
enum: ['']
|
|
1538
|
-
}
|
|
1539
|
-
]
|
|
2561
|
+
type: 'number',
|
|
2562
|
+
format: 'float',
|
|
2563
|
+
description: 'Price per unit',
|
|
2564
|
+
example: 0.01
|
|
1540
2565
|
},
|
|
1541
2566
|
total: {
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
format: 'float',
|
|
1546
|
-
description: 'Total',
|
|
1547
|
-
example: 4
|
|
1548
|
-
},
|
|
1549
|
-
{
|
|
1550
|
-
type: 'string',
|
|
1551
|
-
enum: ['']
|
|
1552
|
-
}
|
|
1553
|
-
]
|
|
2567
|
+
type: 'number',
|
|
2568
|
+
format: 'float',
|
|
2569
|
+
description: 'Total cost'
|
|
1554
2570
|
}
|
|
1555
2571
|
},
|
|
1556
|
-
required: [
|
|
2572
|
+
required: [
|
|
2573
|
+
'hour',
|
|
2574
|
+
'cluster_id',
|
|
2575
|
+
'product',
|
|
2576
|
+
'value',
|
|
2577
|
+
'price',
|
|
2578
|
+
'total'
|
|
2579
|
+
],
|
|
1557
2580
|
additionalProperties: false
|
|
1558
2581
|
};
|
|
1559
2582
|
export const UserCreateInputSchema = {
|
|
@@ -1594,16 +2617,28 @@ export const UserCreateInputSchema = {
|
|
|
1594
2617
|
type: 'string',
|
|
1595
2618
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1596
2619
|
example: 'active',
|
|
1597
|
-
enum: [
|
|
2620
|
+
enum: [
|
|
2621
|
+
'active',
|
|
2622
|
+
'inactive'
|
|
2623
|
+
]
|
|
1598
2624
|
},
|
|
1599
2625
|
role: {
|
|
1600
2626
|
type: 'string',
|
|
1601
|
-
description:
|
|
2627
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1602
2628
|
example: 'User',
|
|
1603
|
-
enum: [
|
|
2629
|
+
enum: [
|
|
2630
|
+
'Administrator',
|
|
2631
|
+
'User'
|
|
2632
|
+
]
|
|
1604
2633
|
}
|
|
1605
2634
|
},
|
|
1606
|
-
required: [
|
|
2635
|
+
required: [
|
|
2636
|
+
'email',
|
|
2637
|
+
'first_name',
|
|
2638
|
+
'last_name',
|
|
2639
|
+
'code',
|
|
2640
|
+
'password'
|
|
2641
|
+
],
|
|
1607
2642
|
additionalProperties: false
|
|
1608
2643
|
};
|
|
1609
2644
|
export const UserSchema = {
|
|
@@ -1631,15 +2666,21 @@ export const UserSchema = {
|
|
|
1631
2666
|
},
|
|
1632
2667
|
role: {
|
|
1633
2668
|
type: 'string',
|
|
1634
|
-
description:
|
|
2669
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1635
2670
|
example: 'User',
|
|
1636
|
-
enum: [
|
|
2671
|
+
enum: [
|
|
2672
|
+
'Administrator',
|
|
2673
|
+
'User'
|
|
2674
|
+
]
|
|
1637
2675
|
},
|
|
1638
2676
|
status: {
|
|
1639
2677
|
type: 'string',
|
|
1640
2678
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1641
2679
|
example: 'active',
|
|
1642
|
-
enum: [
|
|
2680
|
+
enum: [
|
|
2681
|
+
'active',
|
|
2682
|
+
'inactive'
|
|
2683
|
+
]
|
|
1643
2684
|
},
|
|
1644
2685
|
id: {
|
|
1645
2686
|
type: 'string',
|
|
@@ -1654,7 +2695,15 @@ export const UserSchema = {
|
|
|
1654
2695
|
example: '2023-11-02T16:08:14.338Z'
|
|
1655
2696
|
}
|
|
1656
2697
|
},
|
|
1657
|
-
required: [
|
|
2698
|
+
required: [
|
|
2699
|
+
'email',
|
|
2700
|
+
'first_name',
|
|
2701
|
+
'last_name',
|
|
2702
|
+
'role',
|
|
2703
|
+
'status',
|
|
2704
|
+
'id',
|
|
2705
|
+
'date_created'
|
|
2706
|
+
],
|
|
1658
2707
|
additionalProperties: false
|
|
1659
2708
|
};
|
|
1660
2709
|
export const UserUpdateInputSchema = {
|
|
@@ -1682,15 +2731,21 @@ export const UserUpdateInputSchema = {
|
|
|
1682
2731
|
},
|
|
1683
2732
|
role: {
|
|
1684
2733
|
type: 'string',
|
|
1685
|
-
description:
|
|
2734
|
+
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
1686
2735
|
example: 'User',
|
|
1687
|
-
enum: [
|
|
2736
|
+
enum: [
|
|
2737
|
+
'Administrator',
|
|
2738
|
+
'User'
|
|
2739
|
+
]
|
|
1688
2740
|
},
|
|
1689
2741
|
status: {
|
|
1690
2742
|
type: 'string',
|
|
1691
2743
|
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
1692
2744
|
example: 'active',
|
|
1693
|
-
enum: [
|
|
2745
|
+
enum: [
|
|
2746
|
+
'active',
|
|
2747
|
+
'inactive'
|
|
2748
|
+
]
|
|
1694
2749
|
}
|
|
1695
2750
|
},
|
|
1696
2751
|
additionalProperties: false
|