@meshery/schemas 1.2.22 → 1.2.23

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 (88) hide show
  1. package/dist/cloudApi.d.mts +1719 -1518
  2. package/dist/cloudApi.d.ts +1719 -1518
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
  10. package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
  11. package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
  12. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
  13. package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
  14. package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
  15. package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
  16. package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
  17. package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
  18. package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
  19. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
  20. package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
  21. package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
  22. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
  23. package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
  24. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
  25. package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
  26. package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
  27. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
  28. package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
  29. package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
  30. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
  31. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
  32. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
  33. package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
  34. package/dist/constructs/v1beta1/system/System.d.ts +434 -0
  35. package/dist/constructs/v1beta1/system/System.js +1 -0
  36. package/dist/constructs/v1beta1/system/System.mjs +0 -0
  37. package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
  38. package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
  39. package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
  40. package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
  41. package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
  42. package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
  43. package/dist/constructs/v1beta1/view/View.d.ts +833 -664
  44. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
  45. package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
  46. package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
  47. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
  48. package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
  49. package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
  50. package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
  51. package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
  52. package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
  53. package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
  54. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
  55. package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
  56. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
  57. package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
  58. package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
  59. package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
  60. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
  61. package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
  62. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
  63. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
  64. package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
  65. package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
  66. package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
  67. package/dist/constructs/v1beta2/view/View.d.ts +838 -669
  68. package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
  69. package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
  70. package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
  71. package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
  72. package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
  73. package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
  74. package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
  75. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
  76. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
  77. package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
  78. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
  79. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
  80. package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
  81. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
  82. package/dist/index.d.mts +5480 -5022
  83. package/dist/index.d.ts +5480 -5022
  84. package/dist/mesheryApi.d.mts +1314 -522
  85. package/dist/mesheryApi.d.ts +1314 -522
  86. package/dist/mesheryApi.js +1 -1
  87. package/dist/mesheryApi.mjs +1 -1
  88. package/package.json +1 -2
@@ -4,247 +4,64 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/integrations/credentials": {
8
- /** Retrieves all credentials belonging to the authenticated user. */
9
- get: operations["getUserCredentials"];
10
- /** Updates an existing credential for the authenticated user. */
11
- put: operations["updateUserCredential"];
12
- /** Saves a new credential for the authenticated user. */
13
- post: operations["saveUserCredential"];
14
- /** Deletes a credential belonging to the authenticated user. */
15
- delete: operations["deleteUserCredential"];
16
- };
17
- "/api/integrations/credentials/{credentialId}": {
18
- /** Retrieves a specific credential by its ID. */
19
- get: operations["getCredentialById"];
20
- };
21
- }
22
-
23
- export interface components {
24
- schemas: {
25
- /** @description Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems. */
26
- Credential: {
27
- /**
28
- * Format: uuid
29
- * @description Unique identifier for the credential.
30
- */
31
- id: string;
32
- /** @description Human-readable name for the credential. */
33
- name: string;
34
- /**
35
- * Format: uuid
36
- * @description UUID of the user who owns this credential.
37
- */
38
- userId: string;
39
- /** @description Credential type (e.g. token, basic, AWS). */
40
- type: string;
41
- /** @description Key-value pairs containing the sensitive credential data. */
42
- secret?: { [key: string]: unknown };
43
- /**
44
- * Format: date-time
45
- * @description Timestamp when the credential was created.
46
- */
47
- createdAt: string;
48
- /**
49
- * Format: date-time
50
- * @description Timestamp when the credential was last updated.
51
- */
52
- updatedAt: string;
53
- /**
54
- * Format: date-time
55
- * @description Timestamp when the credential was soft-deleted.
56
- */
57
- deletedAt?: string;
58
- };
59
- /** @description Payload for creating or updating a credential. */
60
- CredentialPayload: {
61
- /**
62
- * Format: uuid
63
- * @description Existing credential ID for updates; omit on create.
64
- */
65
- id?: string;
66
- /** @description Human-readable name for the credential. */
67
- name: string;
68
- /**
69
- * Format: uuid
70
- * @description UUID of the user who owns this credential.
71
- */
72
- userId?: string;
73
- /** @description Credential type (e.g. token, basic, AWS). */
74
- type: string;
75
- /** @description Key-value pairs containing the sensitive credential data. */
76
- secret?: { [key: string]: unknown };
77
- };
78
- /** @description A paginated list of credentials. */
79
- CredentialPage: {
80
- /** @description The credentials returned on the current page. */
81
- credentials: {
7
+ "/api/integrations/credentials": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
82
14
  /**
83
- * Format: uuid
84
- * @description Unique identifier for the credential.
15
+ * Get credentials
16
+ * @description Retrieves all credentials belonging to the authenticated user.
85
17
  */
86
- id: string;
87
- /** @description Human-readable name for the credential. */
88
- name: string;
18
+ get: operations["getUserCredentials"];
89
19
  /**
90
- * Format: uuid
91
- * @description UUID of the user who owns this credential.
20
+ * Update credential
21
+ * @description Updates an existing credential for the authenticated user.
92
22
  */
93
- userId: string;
94
- /** @description Credential type (e.g. token, basic, AWS). */
95
- type: string;
96
- /** @description Key-value pairs containing the sensitive credential data. */
97
- secret?: { [key: string]: unknown };
23
+ put: operations["updateUserCredential"];
98
24
  /**
99
- * Format: date-time
100
- * @description Timestamp when the credential was created.
25
+ * Save credential
26
+ * @description Saves a new credential for the authenticated user.
101
27
  */
102
- createdAt: string;
28
+ post: operations["saveUserCredential"];
103
29
  /**
104
- * Format: date-time
105
- * @description Timestamp when the credential was last updated.
30
+ * Delete credential
31
+ * @description Deletes a credential belonging to the authenticated user.
106
32
  */
107
- updatedAt: string;
33
+ delete: operations["deleteUserCredential"];
34
+ options?: never;
35
+ head?: never;
36
+ patch?: never;
37
+ trace?: never;
38
+ };
39
+ "/api/integrations/credentials/{credentialId}": {
40
+ parameters: {
41
+ query?: never;
42
+ header?: never;
43
+ path?: never;
44
+ cookie?: never;
45
+ };
108
46
  /**
109
- * Format: date-time
110
- * @description Timestamp when the credential was soft-deleted.
47
+ * Get credential by ID
48
+ * @description Retrieves a specific credential by its ID.
111
49
  */
112
- deletedAt?: string;
113
- }[];
114
- /** @description Total number of credentials across all pages. */
115
- total_count: number;
116
- /** @description Current page number (zero-based). */
117
- page: number;
118
- /** @description Number of credentials per page. */
119
- page_size: number;
50
+ get: operations["getCredentialById"];
51
+ put?: never;
52
+ post?: never;
53
+ delete?: never;
54
+ options?: never;
55
+ head?: never;
56
+ patch?: never;
57
+ trace?: never;
120
58
  };
121
- };
122
- responses: {
123
- /** Invalid request body or request param */
124
- 400: {
125
- content: {
126
- "text/plain": string;
127
- };
128
- };
129
- /** Expired JWT token used or insufficient privilege */
130
- 401: {
131
- content: {
132
- "text/plain": string;
133
- };
134
- };
135
- /** Result not found */
136
- 404: {
137
- content: {
138
- "text/plain": string;
139
- };
140
- };
141
- /** Internal server error */
142
- 500: {
143
- content: {
144
- "text/plain": string;
145
- };
146
- };
147
- };
148
- parameters: {
149
- /** @description Credential ID */
150
- credentialId: string;
151
- /** @description Credential ID */
152
- credentialIdQuery: string;
153
- /** @description Get responses by page */
154
- page: string;
155
- /** @description Get responses by pagesize */
156
- pagesize: string;
157
- /** @description Get responses that match search param value */
158
- search: string;
159
- /** @description Get ordered responses */
160
- order: string;
161
- };
162
59
  }
163
-
164
- export interface operations {
165
- /** Retrieves all credentials belonging to the authenticated user. */
166
- getUserCredentials: {
167
- parameters: {
168
- query: {
169
- /** Get responses by page */
170
- page?: string;
171
- /** Get responses by pagesize */
172
- pagesize?: string;
173
- /** Get responses that match search param value */
174
- search?: string;
175
- /** Get ordered responses */
176
- order?: string;
177
- };
178
- };
179
- responses: {
180
- /** Credentials response */
181
- 200: {
182
- content: {
183
- "application/json": {
184
- /** @description The credentials returned on the current page. */
185
- credentials: {
186
- /**
187
- * Format: uuid
188
- * @description Unique identifier for the credential.
189
- */
190
- id: string;
191
- /** @description Human-readable name for the credential. */
192
- name: string;
193
- /**
194
- * Format: uuid
195
- * @description UUID of the user who owns this credential.
196
- */
197
- userId: string;
198
- /** @description Credential type (e.g. token, basic, AWS). */
199
- type: string;
200
- /** @description Key-value pairs containing the sensitive credential data. */
201
- secret?: { [key: string]: unknown };
202
- /**
203
- * Format: date-time
204
- * @description Timestamp when the credential was created.
205
- */
206
- createdAt: string;
207
- /**
208
- * Format: date-time
209
- * @description Timestamp when the credential was last updated.
210
- */
211
- updatedAt: string;
212
- /**
213
- * Format: date-time
214
- * @description Timestamp when the credential was soft-deleted.
215
- */
216
- deletedAt?: string;
217
- }[];
218
- /** @description Total number of credentials across all pages. */
219
- total_count: number;
220
- /** @description Current page number (zero-based). */
221
- page: number;
222
- /** @description Number of credentials per page. */
223
- page_size: number;
224
- };
225
- };
226
- };
227
- /** Expired JWT token used or insufficient privilege */
228
- 401: {
229
- content: {
230
- "text/plain": string;
231
- };
232
- };
233
- /** Internal server error */
234
- 500: {
235
- content: {
236
- "text/plain": string;
237
- };
238
- };
239
- };
240
- };
241
- /** Updates an existing credential for the authenticated user. */
242
- updateUserCredential: {
243
- responses: {
244
- /** Credential updated */
245
- 200: {
246
- content: {
247
- "application/json": {
60
+ export type webhooks = Record<string, never>;
61
+ export interface components {
62
+ schemas: {
63
+ /** @description Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems. */
64
+ Credential: {
248
65
  /**
249
66
  * Format: uuid
250
67
  * @description Unique identifier for the credential.
@@ -260,7 +77,7 @@ export interface operations {
260
77
  /** @description Credential type (e.g. token, basic, AWS). */
261
78
  type: string;
262
79
  /** @description Key-value pairs containing the sensitive credential data. */
263
- secret?: { [key: string]: unknown };
80
+ secret?: Record<string, never>;
264
81
  /**
265
82
  * Format: date-time
266
83
  * @description Timestamp when the credential was created.
@@ -276,244 +93,562 @@ export interface operations {
276
93
  * @description Timestamp when the credential was soft-deleted.
277
94
  */
278
95
  deletedAt?: string;
279
- };
280
- };
281
- };
282
- /** Invalid request body or request param */
283
- 400: {
284
- content: {
285
- "text/plain": string;
286
- };
287
- };
288
- /** Expired JWT token used or insufficient privilege */
289
- 401: {
290
- content: {
291
- "text/plain": string;
292
- };
293
- };
294
- /** Result not found */
295
- 404: {
296
- content: {
297
- "text/plain": string;
298
- };
299
- };
300
- /** Internal server error */
301
- 500: {
302
- content: {
303
- "text/plain": string;
304
96
  };
305
- };
306
- };
307
- requestBody: {
308
- content: {
309
- "application/json": {
310
- /**
311
- * Format: uuid
312
- * @description Existing credential ID for updates; omit on create.
313
- */
314
- id?: string;
315
- /** @description Human-readable name for the credential. */
316
- name: string;
317
- /**
318
- * Format: uuid
319
- * @description UUID of the user who owns this credential.
320
- */
321
- userId?: string;
322
- /** @description Credential type (e.g. token, basic, AWS). */
323
- type: string;
324
- /** @description Key-value pairs containing the sensitive credential data. */
325
- secret?: { [key: string]: unknown };
326
- };
327
- };
328
- };
329
- };
330
- /** Saves a new credential for the authenticated user. */
331
- saveUserCredential: {
332
- responses: {
333
- /** Credential saved */
334
- 201: {
335
- content: {
336
- "application/json": {
97
+ /** @description Payload for creating or updating a credential. */
98
+ CredentialPayload: {
337
99
  /**
338
100
  * Format: uuid
339
- * @description Unique identifier for the credential.
101
+ * @description Existing credential ID for updates; omit on create.
340
102
  */
341
- id: string;
103
+ id?: string;
342
104
  /** @description Human-readable name for the credential. */
343
105
  name: string;
344
106
  /**
345
107
  * Format: uuid
346
108
  * @description UUID of the user who owns this credential.
347
109
  */
348
- userId: string;
110
+ userId?: string;
349
111
  /** @description Credential type (e.g. token, basic, AWS). */
350
112
  type: string;
351
113
  /** @description Key-value pairs containing the sensitive credential data. */
352
- secret?: { [key: string]: unknown };
353
- /**
354
- * Format: date-time
355
- * @description Timestamp when the credential was created.
356
- */
357
- createdAt: string;
358
- /**
359
- * Format: date-time
360
- * @description Timestamp when the credential was last updated.
361
- */
362
- updatedAt: string;
363
- /**
364
- * Format: date-time
365
- * @description Timestamp when the credential was soft-deleted.
366
- */
367
- deletedAt?: string;
368
- };
114
+ secret?: Record<string, never>;
369
115
  };
370
- };
371
- /** Invalid request body or request param */
372
- 400: {
373
- content: {
374
- "text/plain": string;
116
+ /** @description A paginated list of credentials. */
117
+ CredentialPage: {
118
+ /** @description The credentials returned on the current page. */
119
+ credentials: {
120
+ /**
121
+ * Format: uuid
122
+ * @description Unique identifier for the credential.
123
+ */
124
+ id: string;
125
+ /** @description Human-readable name for the credential. */
126
+ name: string;
127
+ /**
128
+ * Format: uuid
129
+ * @description UUID of the user who owns this credential.
130
+ */
131
+ userId: string;
132
+ /** @description Credential type (e.g. token, basic, AWS). */
133
+ type: string;
134
+ /** @description Key-value pairs containing the sensitive credential data. */
135
+ secret?: Record<string, never>;
136
+ /**
137
+ * Format: date-time
138
+ * @description Timestamp when the credential was created.
139
+ */
140
+ createdAt: string;
141
+ /**
142
+ * Format: date-time
143
+ * @description Timestamp when the credential was last updated.
144
+ */
145
+ updatedAt: string;
146
+ /**
147
+ * Format: date-time
148
+ * @description Timestamp when the credential was soft-deleted.
149
+ */
150
+ deletedAt?: string;
151
+ }[];
152
+ /** @description Total number of credentials across all pages. */
153
+ total_count: number;
154
+ /** @description Current page number (zero-based). */
155
+ page: number;
156
+ /** @description Number of credentials per page. */
157
+ page_size: number;
375
158
  };
376
- };
377
- /** Expired JWT token used or insufficient privilege */
378
- 401: {
379
- content: {
380
- "text/plain": string;
159
+ };
160
+ responses: {
161
+ /** @description Invalid request body or request param */
162
+ 400: {
163
+ headers: {
164
+ [name: string]: unknown;
165
+ };
166
+ content: {
167
+ "text/plain": string;
168
+ };
381
169
  };
382
- };
383
- /** Internal server error */
384
- 500: {
385
- content: {
386
- "text/plain": string;
170
+ /** @description Expired JWT token used or insufficient privilege */
171
+ 401: {
172
+ headers: {
173
+ [name: string]: unknown;
174
+ };
175
+ content: {
176
+ "text/plain": string;
177
+ };
387
178
  };
388
- };
389
- };
390
- requestBody: {
391
- content: {
392
- "application/json": {
393
- /**
394
- * Format: uuid
395
- * @description Existing credential ID for updates; omit on create.
396
- */
397
- id?: string;
398
- /** @description Human-readable name for the credential. */
399
- name: string;
400
- /**
401
- * Format: uuid
402
- * @description UUID of the user who owns this credential.
403
- */
404
- userId?: string;
405
- /** @description Credential type (e.g. token, basic, AWS). */
406
- type: string;
407
- /** @description Key-value pairs containing the sensitive credential data. */
408
- secret?: { [key: string]: unknown };
179
+ /** @description Result not found */
180
+ 404: {
181
+ headers: {
182
+ [name: string]: unknown;
183
+ };
184
+ content: {
185
+ "text/plain": string;
186
+ };
187
+ };
188
+ /** @description Internal server error */
189
+ 500: {
190
+ headers: {
191
+ [name: string]: unknown;
192
+ };
193
+ content: {
194
+ "text/plain": string;
195
+ };
409
196
  };
410
- };
411
197
  };
412
- };
413
- /** Deletes a credential belonging to the authenticated user. */
414
- deleteUserCredential: {
415
198
  parameters: {
416
- query: {
417
- /** Credential ID */
199
+ /** @description Credential ID */
418
200
  credentialId: string;
419
- };
201
+ /** @description Credential ID */
202
+ credentialIdQuery: string;
203
+ /** @description Get responses by page */
204
+ page: string;
205
+ /** @description Get responses by pagesize */
206
+ pagesize: string;
207
+ /** @description Get responses that match search param value */
208
+ search: string;
209
+ /** @description Get ordered responses */
210
+ order: string;
420
211
  };
421
- responses: {
422
- /** Credential deleted */
423
- 204: never;
424
- /** Invalid request body or request param */
425
- 400: {
426
- content: {
427
- "text/plain": string;
212
+ requestBodies: never;
213
+ headers: never;
214
+ pathItems: never;
215
+ }
216
+ export type $defs = Record<string, never>;
217
+ export interface operations {
218
+ getUserCredentials: {
219
+ parameters: {
220
+ query?: {
221
+ /** @description Get responses by page */
222
+ page?: string;
223
+ /** @description Get responses by pagesize */
224
+ pagesize?: string;
225
+ /** @description Get responses that match search param value */
226
+ search?: string;
227
+ /** @description Get ordered responses */
228
+ order?: string;
229
+ };
230
+ header?: never;
231
+ path?: never;
232
+ cookie?: never;
428
233
  };
429
- };
430
- /** Expired JWT token used or insufficient privilege */
431
- 401: {
432
- content: {
433
- "text/plain": string;
234
+ requestBody?: never;
235
+ responses: {
236
+ /** @description Credentials response */
237
+ 200: {
238
+ headers: {
239
+ [name: string]: unknown;
240
+ };
241
+ content: {
242
+ "application/json": {
243
+ /** @description The credentials returned on the current page. */
244
+ credentials: {
245
+ /**
246
+ * Format: uuid
247
+ * @description Unique identifier for the credential.
248
+ */
249
+ id: string;
250
+ /** @description Human-readable name for the credential. */
251
+ name: string;
252
+ /**
253
+ * Format: uuid
254
+ * @description UUID of the user who owns this credential.
255
+ */
256
+ userId: string;
257
+ /** @description Credential type (e.g. token, basic, AWS). */
258
+ type: string;
259
+ /** @description Key-value pairs containing the sensitive credential data. */
260
+ secret?: Record<string, never>;
261
+ /**
262
+ * Format: date-time
263
+ * @description Timestamp when the credential was created.
264
+ */
265
+ createdAt: string;
266
+ /**
267
+ * Format: date-time
268
+ * @description Timestamp when the credential was last updated.
269
+ */
270
+ updatedAt: string;
271
+ /**
272
+ * Format: date-time
273
+ * @description Timestamp when the credential was soft-deleted.
274
+ */
275
+ deletedAt?: string;
276
+ }[];
277
+ /** @description Total number of credentials across all pages. */
278
+ total_count: number;
279
+ /** @description Current page number (zero-based). */
280
+ page: number;
281
+ /** @description Number of credentials per page. */
282
+ page_size: number;
283
+ };
284
+ };
285
+ };
286
+ /** @description Expired JWT token used or insufficient privilege */
287
+ 401: {
288
+ headers: {
289
+ [name: string]: unknown;
290
+ };
291
+ content: {
292
+ "text/plain": string;
293
+ };
294
+ };
295
+ /** @description Internal server error */
296
+ 500: {
297
+ headers: {
298
+ [name: string]: unknown;
299
+ };
300
+ content: {
301
+ "text/plain": string;
302
+ };
303
+ };
304
+ };
305
+ };
306
+ updateUserCredential: {
307
+ parameters: {
308
+ query?: never;
309
+ header?: never;
310
+ path?: never;
311
+ cookie?: never;
434
312
  };
435
- };
436
- /** Result not found */
437
- 404: {
438
- content: {
439
- "text/plain": string;
313
+ requestBody: {
314
+ content: {
315
+ "application/json": {
316
+ /**
317
+ * Format: uuid
318
+ * @description Existing credential ID for updates; omit on create.
319
+ */
320
+ id?: string;
321
+ /** @description Human-readable name for the credential. */
322
+ name: string;
323
+ /**
324
+ * Format: uuid
325
+ * @description UUID of the user who owns this credential.
326
+ */
327
+ userId?: string;
328
+ /** @description Credential type (e.g. token, basic, AWS). */
329
+ type: string;
330
+ /** @description Key-value pairs containing the sensitive credential data. */
331
+ secret?: Record<string, never>;
332
+ };
333
+ };
440
334
  };
441
- };
442
- /** Internal server error */
443
- 500: {
444
- content: {
445
- "text/plain": string;
335
+ responses: {
336
+ /** @description Credential updated */
337
+ 200: {
338
+ headers: {
339
+ [name: string]: unknown;
340
+ };
341
+ content: {
342
+ "application/json": {
343
+ /**
344
+ * Format: uuid
345
+ * @description Unique identifier for the credential.
346
+ */
347
+ id: string;
348
+ /** @description Human-readable name for the credential. */
349
+ name: string;
350
+ /**
351
+ * Format: uuid
352
+ * @description UUID of the user who owns this credential.
353
+ */
354
+ userId: string;
355
+ /** @description Credential type (e.g. token, basic, AWS). */
356
+ type: string;
357
+ /** @description Key-value pairs containing the sensitive credential data. */
358
+ secret?: Record<string, never>;
359
+ /**
360
+ * Format: date-time
361
+ * @description Timestamp when the credential was created.
362
+ */
363
+ createdAt: string;
364
+ /**
365
+ * Format: date-time
366
+ * @description Timestamp when the credential was last updated.
367
+ */
368
+ updatedAt: string;
369
+ /**
370
+ * Format: date-time
371
+ * @description Timestamp when the credential was soft-deleted.
372
+ */
373
+ deletedAt?: string;
374
+ };
375
+ };
376
+ };
377
+ /** @description Invalid request body or request param */
378
+ 400: {
379
+ headers: {
380
+ [name: string]: unknown;
381
+ };
382
+ content: {
383
+ "text/plain": string;
384
+ };
385
+ };
386
+ /** @description Expired JWT token used or insufficient privilege */
387
+ 401: {
388
+ headers: {
389
+ [name: string]: unknown;
390
+ };
391
+ content: {
392
+ "text/plain": string;
393
+ };
394
+ };
395
+ /** @description Result not found */
396
+ 404: {
397
+ headers: {
398
+ [name: string]: unknown;
399
+ };
400
+ content: {
401
+ "text/plain": string;
402
+ };
403
+ };
404
+ /** @description Internal server error */
405
+ 500: {
406
+ headers: {
407
+ [name: string]: unknown;
408
+ };
409
+ content: {
410
+ "text/plain": string;
411
+ };
412
+ };
446
413
  };
447
- };
448
414
  };
449
- };
450
- /** Retrieves a specific credential by its ID. */
451
- getCredentialById: {
452
- parameters: {
453
- path: {
454
- /** Credential ID */
455
- credentialId: string;
456
- };
415
+ saveUserCredential: {
416
+ parameters: {
417
+ query?: never;
418
+ header?: never;
419
+ path?: never;
420
+ cookie?: never;
421
+ };
422
+ requestBody: {
423
+ content: {
424
+ "application/json": {
425
+ /**
426
+ * Format: uuid
427
+ * @description Existing credential ID for updates; omit on create.
428
+ */
429
+ id?: string;
430
+ /** @description Human-readable name for the credential. */
431
+ name: string;
432
+ /**
433
+ * Format: uuid
434
+ * @description UUID of the user who owns this credential.
435
+ */
436
+ userId?: string;
437
+ /** @description Credential type (e.g. token, basic, AWS). */
438
+ type: string;
439
+ /** @description Key-value pairs containing the sensitive credential data. */
440
+ secret?: Record<string, never>;
441
+ };
442
+ };
443
+ };
444
+ responses: {
445
+ /** @description Credential saved */
446
+ 201: {
447
+ headers: {
448
+ [name: string]: unknown;
449
+ };
450
+ content: {
451
+ "application/json": {
452
+ /**
453
+ * Format: uuid
454
+ * @description Unique identifier for the credential.
455
+ */
456
+ id: string;
457
+ /** @description Human-readable name for the credential. */
458
+ name: string;
459
+ /**
460
+ * Format: uuid
461
+ * @description UUID of the user who owns this credential.
462
+ */
463
+ userId: string;
464
+ /** @description Credential type (e.g. token, basic, AWS). */
465
+ type: string;
466
+ /** @description Key-value pairs containing the sensitive credential data. */
467
+ secret?: Record<string, never>;
468
+ /**
469
+ * Format: date-time
470
+ * @description Timestamp when the credential was created.
471
+ */
472
+ createdAt: string;
473
+ /**
474
+ * Format: date-time
475
+ * @description Timestamp when the credential was last updated.
476
+ */
477
+ updatedAt: string;
478
+ /**
479
+ * Format: date-time
480
+ * @description Timestamp when the credential was soft-deleted.
481
+ */
482
+ deletedAt?: string;
483
+ };
484
+ };
485
+ };
486
+ /** @description Invalid request body or request param */
487
+ 400: {
488
+ headers: {
489
+ [name: string]: unknown;
490
+ };
491
+ content: {
492
+ "text/plain": string;
493
+ };
494
+ };
495
+ /** @description Expired JWT token used or insufficient privilege */
496
+ 401: {
497
+ headers: {
498
+ [name: string]: unknown;
499
+ };
500
+ content: {
501
+ "text/plain": string;
502
+ };
503
+ };
504
+ /** @description Internal server error */
505
+ 500: {
506
+ headers: {
507
+ [name: string]: unknown;
508
+ };
509
+ content: {
510
+ "text/plain": string;
511
+ };
512
+ };
513
+ };
457
514
  };
458
- responses: {
459
- /** Credential response */
460
- 200: {
461
- content: {
462
- "application/json": {
463
- /**
464
- * Format: uuid
465
- * @description Unique identifier for the credential.
466
- */
467
- id: string;
468
- /** @description Human-readable name for the credential. */
469
- name: string;
470
- /**
471
- * Format: uuid
472
- * @description UUID of the user who owns this credential.
473
- */
474
- userId: string;
475
- /** @description Credential type (e.g. token, basic, AWS). */
476
- type: string;
477
- /** @description Key-value pairs containing the sensitive credential data. */
478
- secret?: { [key: string]: unknown };
479
- /**
480
- * Format: date-time
481
- * @description Timestamp when the credential was created.
482
- */
483
- createdAt: string;
484
- /**
485
- * Format: date-time
486
- * @description Timestamp when the credential was last updated.
487
- */
488
- updatedAt: string;
489
- /**
490
- * Format: date-time
491
- * @description Timestamp when the credential was soft-deleted.
492
- */
493
- deletedAt?: string;
494
- };
515
+ deleteUserCredential: {
516
+ parameters: {
517
+ query: {
518
+ /** @description Credential ID */
519
+ credentialId: string;
520
+ };
521
+ header?: never;
522
+ path?: never;
523
+ cookie?: never;
495
524
  };
496
- };
497
- /** Expired JWT token used or insufficient privilege */
498
- 401: {
499
- content: {
500
- "text/plain": string;
525
+ requestBody?: never;
526
+ responses: {
527
+ /** @description Credential deleted */
528
+ 204: {
529
+ headers: {
530
+ [name: string]: unknown;
531
+ };
532
+ content?: never;
533
+ };
534
+ /** @description Invalid request body or request param */
535
+ 400: {
536
+ headers: {
537
+ [name: string]: unknown;
538
+ };
539
+ content: {
540
+ "text/plain": string;
541
+ };
542
+ };
543
+ /** @description Expired JWT token used or insufficient privilege */
544
+ 401: {
545
+ headers: {
546
+ [name: string]: unknown;
547
+ };
548
+ content: {
549
+ "text/plain": string;
550
+ };
551
+ };
552
+ /** @description Result not found */
553
+ 404: {
554
+ headers: {
555
+ [name: string]: unknown;
556
+ };
557
+ content: {
558
+ "text/plain": string;
559
+ };
560
+ };
561
+ /** @description Internal server error */
562
+ 500: {
563
+ headers: {
564
+ [name: string]: unknown;
565
+ };
566
+ content: {
567
+ "text/plain": string;
568
+ };
569
+ };
501
570
  };
502
- };
503
- /** Result not found */
504
- 404: {
505
- content: {
506
- "text/plain": string;
571
+ };
572
+ getCredentialById: {
573
+ parameters: {
574
+ query?: never;
575
+ header?: never;
576
+ path: {
577
+ /** @description Credential ID */
578
+ credentialId: string;
579
+ };
580
+ cookie?: never;
507
581
  };
508
- };
509
- /** Internal server error */
510
- 500: {
511
- content: {
512
- "text/plain": string;
582
+ requestBody?: never;
583
+ responses: {
584
+ /** @description Credential response */
585
+ 200: {
586
+ headers: {
587
+ [name: string]: unknown;
588
+ };
589
+ content: {
590
+ "application/json": {
591
+ /**
592
+ * Format: uuid
593
+ * @description Unique identifier for the credential.
594
+ */
595
+ id: string;
596
+ /** @description Human-readable name for the credential. */
597
+ name: string;
598
+ /**
599
+ * Format: uuid
600
+ * @description UUID of the user who owns this credential.
601
+ */
602
+ userId: string;
603
+ /** @description Credential type (e.g. token, basic, AWS). */
604
+ type: string;
605
+ /** @description Key-value pairs containing the sensitive credential data. */
606
+ secret?: Record<string, never>;
607
+ /**
608
+ * Format: date-time
609
+ * @description Timestamp when the credential was created.
610
+ */
611
+ createdAt: string;
612
+ /**
613
+ * Format: date-time
614
+ * @description Timestamp when the credential was last updated.
615
+ */
616
+ updatedAt: string;
617
+ /**
618
+ * Format: date-time
619
+ * @description Timestamp when the credential was soft-deleted.
620
+ */
621
+ deletedAt?: string;
622
+ };
623
+ };
624
+ };
625
+ /** @description Expired JWT token used or insufficient privilege */
626
+ 401: {
627
+ headers: {
628
+ [name: string]: unknown;
629
+ };
630
+ content: {
631
+ "text/plain": string;
632
+ };
633
+ };
634
+ /** @description Result not found */
635
+ 404: {
636
+ headers: {
637
+ [name: string]: unknown;
638
+ };
639
+ content: {
640
+ "text/plain": string;
641
+ };
642
+ };
643
+ /** @description Internal server error */
644
+ 500: {
645
+ headers: {
646
+ [name: string]: unknown;
647
+ };
648
+ content: {
649
+ "text/plain": string;
650
+ };
651
+ };
513
652
  };
514
- };
515
653
  };
516
- };
517
654
  }
518
-
519
- export interface external {}