@cloudfleet/sdk 0.0.1-9835b73 → 0.0.1-9bc5464

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