@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,228 +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/{id}": {
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
- user_id?: 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 resource was created.
46
- */
47
- created_at?: string;
48
- /**
49
- * Format: date-time
50
- * @description Timestamp when the resource was updated.
51
- */
52
- updated_at?: string;
53
- /**
54
- * Format: date-time
55
- * @description Timestamp when the credential was soft-deleted.
56
- */
57
- deleted_at?: string;
58
- };
59
- /** @description A paginated list of credentials. */
60
- CredentialPage: {
61
- /** @description The credentials of the credentialpage. */
62
- credentials: {
7
+ "/api/integrations/credentials": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
63
14
  /**
64
- * Format: uuid
65
- * @description Unique identifier for the credential.
15
+ * Get credentials
16
+ * @description Retrieves all credentials belonging to the authenticated user.
66
17
  */
67
- id?: string;
68
- /** @description Human-readable name for the credential. */
69
- name: string;
18
+ get: operations["getUserCredentials"];
70
19
  /**
71
- * Format: uuid
72
- * @description UUID of the user who owns this credential.
20
+ * Update credential
21
+ * @description Updates an existing credential for the authenticated user.
73
22
  */
74
- user_id?: string;
75
- /** @description Credential type (e.g. token, basic, AWS). */
76
- type: string;
77
- /** @description Key-value pairs containing the sensitive credential data. */
78
- secret?: { [key: string]: unknown };
23
+ put: operations["updateUserCredential"];
79
24
  /**
80
- * Format: date-time
81
- * @description Timestamp when the resource was created.
25
+ * Save credential
26
+ * @description Saves a new credential for the authenticated user.
82
27
  */
83
- created_at?: string;
28
+ post: operations["saveUserCredential"];
84
29
  /**
85
- * Format: date-time
86
- * @description Timestamp when the resource was updated.
30
+ * Delete credential
31
+ * @description Deletes a credential belonging to the authenticated user.
87
32
  */
88
- updated_at?: string;
33
+ delete: operations["deleteUserCredential"];
34
+ options?: never;
35
+ head?: never;
36
+ patch?: never;
37
+ trace?: never;
38
+ };
39
+ "/api/integrations/credentials/{id}": {
40
+ parameters: {
41
+ query?: never;
42
+ header?: never;
43
+ path?: never;
44
+ cookie?: never;
45
+ };
89
46
  /**
90
- * Format: date-time
91
- * @description Timestamp when the credential was soft-deleted.
47
+ * Get credential by ID
48
+ * @description Retrieves a specific credential by its ID.
92
49
  */
93
- deleted_at?: string;
94
- }[];
95
- /** @description Total number of credentials across all pages. */
96
- total_count: number;
97
- /** @description Current page number (zero-based). */
98
- page: number;
99
- /** @description Number of credentials per page. */
100
- page_size: number;
101
- };
102
- };
103
- responses: {
104
- /** Invalid request body or request param */
105
- 400: {
106
- content: {
107
- "text/plain": string;
108
- };
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;
109
58
  };
110
- /** Expired JWT token used or insufficient privilege */
111
- 401: {
112
- content: {
113
- "text/plain": string;
114
- };
115
- };
116
- /** Result not found */
117
- 404: {
118
- content: {
119
- "text/plain": string;
120
- };
121
- };
122
- /** Internal server error */
123
- 500: {
124
- content: {
125
- "text/plain": string;
126
- };
127
- };
128
- };
129
- parameters: {
130
- /** @description Credential ID */
131
- id: string;
132
- /** @description Credential ID */
133
- credentialId: string;
134
- /** @description Get responses by page */
135
- page: string;
136
- /** @description Get responses by pagesize */
137
- pagesize: string;
138
- /** @description Get responses that match search param value */
139
- search: string;
140
- /** @description Get ordered responses */
141
- order: string;
142
- };
143
59
  }
144
-
145
- export interface operations {
146
- /** Retrieves all credentials belonging to the authenticated user. */
147
- getUserCredentials: {
148
- parameters: {
149
- query: {
150
- /** Get responses by page */
151
- page?: string;
152
- /** Get responses by pagesize */
153
- pagesize?: string;
154
- /** Get responses that match search param value */
155
- search?: string;
156
- /** Get ordered responses */
157
- order?: string;
158
- };
159
- };
160
- responses: {
161
- /** Credentials response */
162
- 200: {
163
- content: {
164
- "application/json": {
165
- /** @description The credentials of the credentialpage. */
166
- credentials: {
167
- /**
168
- * Format: uuid
169
- * @description Unique identifier for the credential.
170
- */
171
- id?: string;
172
- /** @description Human-readable name for the credential. */
173
- name: string;
174
- /**
175
- * Format: uuid
176
- * @description UUID of the user who owns this credential.
177
- */
178
- user_id?: string;
179
- /** @description Credential type (e.g. token, basic, AWS). */
180
- type: string;
181
- /** @description Key-value pairs containing the sensitive credential data. */
182
- secret?: { [key: string]: unknown };
183
- /**
184
- * Format: date-time
185
- * @description Timestamp when the resource was created.
186
- */
187
- created_at?: string;
188
- /**
189
- * Format: date-time
190
- * @description Timestamp when the resource was updated.
191
- */
192
- updated_at?: string;
193
- /**
194
- * Format: date-time
195
- * @description Timestamp when the credential was soft-deleted.
196
- */
197
- deleted_at?: string;
198
- }[];
199
- /** @description Total number of credentials across all pages. */
200
- total_count: number;
201
- /** @description Current page number (zero-based). */
202
- page: number;
203
- /** @description Number of credentials per page. */
204
- page_size: number;
205
- };
206
- };
207
- };
208
- /** Expired JWT token used or insufficient privilege */
209
- 401: {
210
- content: {
211
- "text/plain": string;
212
- };
213
- };
214
- /** Internal server error */
215
- 500: {
216
- content: {
217
- "text/plain": string;
218
- };
219
- };
220
- };
221
- };
222
- /** Updates an existing credential for the authenticated user. */
223
- updateUserCredential: {
224
- responses: {
225
- /** Credential updated */
226
- 200: {
227
- content: {
228
- "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: {
229
65
  /**
230
66
  * Format: uuid
231
67
  * @description Unique identifier for the credential.
@@ -241,7 +77,7 @@ export interface operations {
241
77
  /** @description Credential type (e.g. token, basic, AWS). */
242
78
  type: string;
243
79
  /** @description Key-value pairs containing the sensitive credential data. */
244
- secret?: { [key: string]: unknown };
80
+ secret?: Record<string, never>;
245
81
  /**
246
82
  * Format: date-time
247
83
  * @description Timestamp when the resource was created.
@@ -257,274 +93,573 @@ export interface operations {
257
93
  * @description Timestamp when the credential was soft-deleted.
258
94
  */
259
95
  deleted_at?: string;
260
- };
261
96
  };
262
- };
263
- /** Invalid request body or request param */
264
- 400: {
265
- content: {
266
- "text/plain": string;
267
- };
268
- };
269
- /** Expired JWT token used or insufficient privilege */
270
- 401: {
271
- content: {
272
- "text/plain": string;
273
- };
274
- };
275
- /** Result not found */
276
- 404: {
277
- content: {
278
- "text/plain": string;
279
- };
280
- };
281
- /** Internal server error */
282
- 500: {
283
- content: {
284
- "text/plain": string;
285
- };
286
- };
287
- };
288
- requestBody: {
289
- content: {
290
- "application/json": {
291
- /**
292
- * Format: uuid
293
- * @description Unique identifier for the credential.
294
- */
295
- id?: string;
296
- /** @description Human-readable name for the credential. */
297
- name: string;
298
- /**
299
- * Format: uuid
300
- * @description UUID of the user who owns this credential.
301
- */
302
- user_id?: string;
303
- /** @description Credential type (e.g. token, basic, AWS). */
304
- type: string;
305
- /** @description Key-value pairs containing the sensitive credential data. */
306
- secret?: { [key: string]: unknown };
307
- /**
308
- * Format: date-time
309
- * @description Timestamp when the resource was created.
310
- */
311
- created_at?: string;
312
- /**
313
- * Format: date-time
314
- * @description Timestamp when the resource was updated.
315
- */
316
- updated_at?: string;
317
- /**
318
- * Format: date-time
319
- * @description Timestamp when the credential was soft-deleted.
320
- */
321
- deleted_at?: string;
97
+ /** @description A paginated list of credentials. */
98
+ CredentialPage: {
99
+ /** @description The credentials of the credentialpage. */
100
+ credentials: {
101
+ /**
102
+ * Format: uuid
103
+ * @description Unique identifier for the credential.
104
+ */
105
+ id?: string;
106
+ /** @description Human-readable name for the credential. */
107
+ name: string;
108
+ /**
109
+ * Format: uuid
110
+ * @description UUID of the user who owns this credential.
111
+ */
112
+ user_id?: string;
113
+ /** @description Credential type (e.g. token, basic, AWS). */
114
+ type: string;
115
+ /** @description Key-value pairs containing the sensitive credential data. */
116
+ secret?: Record<string, never>;
117
+ /**
118
+ * Format: date-time
119
+ * @description Timestamp when the resource was created.
120
+ */
121
+ created_at?: string;
122
+ /**
123
+ * Format: date-time
124
+ * @description Timestamp when the resource was updated.
125
+ */
126
+ updated_at?: string;
127
+ /**
128
+ * Format: date-time
129
+ * @description Timestamp when the credential was soft-deleted.
130
+ */
131
+ deleted_at?: string;
132
+ }[];
133
+ /** @description Total number of credentials across all pages. */
134
+ total_count: number;
135
+ /** @description Current page number (zero-based). */
136
+ page: number;
137
+ /** @description Number of credentials per page. */
138
+ page_size: number;
322
139
  };
323
- };
324
140
  };
325
- };
326
- /** Saves a new credential for the authenticated user. */
327
- saveUserCredential: {
328
141
  responses: {
329
- /** Credential saved */
330
- 201: {
331
- content: {
332
- "application/json": {
333
- /**
334
- * Format: uuid
335
- * @description Unique identifier for the credential.
336
- */
337
- id?: string;
338
- /** @description Human-readable name for the credential. */
339
- name: string;
340
- /**
341
- * Format: uuid
342
- * @description UUID of the user who owns this credential.
343
- */
344
- user_id?: string;
345
- /** @description Credential type (e.g. token, basic, AWS). */
346
- type: string;
347
- /** @description Key-value pairs containing the sensitive credential data. */
348
- secret?: { [key: string]: unknown };
349
- /**
350
- * Format: date-time
351
- * @description Timestamp when the resource was created.
352
- */
353
- created_at?: string;
354
- /**
355
- * Format: date-time
356
- * @description Timestamp when the resource was updated.
357
- */
358
- updated_at?: string;
359
- /**
360
- * Format: date-time
361
- * @description Timestamp when the credential was soft-deleted.
362
- */
363
- deleted_at?: string;
364
- };
365
- };
366
- };
367
- /** Invalid request body or request param */
368
- 400: {
369
- content: {
370
- "text/plain": string;
142
+ /** @description Invalid request body or request param */
143
+ 400: {
144
+ headers: {
145
+ [name: string]: unknown;
146
+ };
147
+ content: {
148
+ "text/plain": string;
149
+ };
371
150
  };
372
- };
373
- /** Expired JWT token used or insufficient privilege */
374
- 401: {
375
- content: {
376
- "text/plain": string;
151
+ /** @description Expired JWT token used or insufficient privilege */
152
+ 401: {
153
+ headers: {
154
+ [name: string]: unknown;
155
+ };
156
+ content: {
157
+ "text/plain": string;
158
+ };
377
159
  };
378
- };
379
- /** Internal server error */
380
- 500: {
381
- content: {
382
- "text/plain": string;
160
+ /** @description Result not found */
161
+ 404: {
162
+ headers: {
163
+ [name: string]: unknown;
164
+ };
165
+ content: {
166
+ "text/plain": string;
167
+ };
383
168
  };
384
- };
385
- };
386
- requestBody: {
387
- content: {
388
- "application/json": {
389
- /**
390
- * Format: uuid
391
- * @description Unique identifier for the credential.
392
- */
393
- id?: string;
394
- /** @description Human-readable name for the credential. */
395
- name: string;
396
- /**
397
- * Format: uuid
398
- * @description UUID of the user who owns this credential.
399
- */
400
- user_id?: string;
401
- /** @description Credential type (e.g. token, basic, AWS). */
402
- type: string;
403
- /** @description Key-value pairs containing the sensitive credential data. */
404
- secret?: { [key: string]: unknown };
405
- /**
406
- * Format: date-time
407
- * @description Timestamp when the resource was created.
408
- */
409
- created_at?: string;
410
- /**
411
- * Format: date-time
412
- * @description Timestamp when the resource was updated.
413
- */
414
- updated_at?: string;
415
- /**
416
- * Format: date-time
417
- * @description Timestamp when the credential was soft-deleted.
418
- */
419
- deleted_at?: string;
169
+ /** @description Internal server error */
170
+ 500: {
171
+ headers: {
172
+ [name: string]: unknown;
173
+ };
174
+ content: {
175
+ "text/plain": string;
176
+ };
420
177
  };
421
- };
422
178
  };
423
- };
424
- /** Deletes a credential belonging to the authenticated user. */
425
- deleteUserCredential: {
426
179
  parameters: {
427
- query: {
428
- /** Credential ID */
180
+ /** @description Credential ID */
181
+ id: string;
182
+ /** @description Credential ID */
429
183
  credentialId: string;
430
- };
184
+ /** @description Get responses by page */
185
+ page: string;
186
+ /** @description Get responses by pagesize */
187
+ pagesize: string;
188
+ /** @description Get responses that match search param value */
189
+ search: string;
190
+ /** @description Get ordered responses */
191
+ order: string;
431
192
  };
432
- responses: {
433
- /** Credential deleted */
434
- 204: never;
435
- /** Invalid request body or request param */
436
- 400: {
437
- content: {
438
- "text/plain": string;
193
+ requestBodies: never;
194
+ headers: never;
195
+ pathItems: never;
196
+ }
197
+ export type $defs = Record<string, never>;
198
+ export interface operations {
199
+ getUserCredentials: {
200
+ parameters: {
201
+ query?: {
202
+ /** @description Get responses by page */
203
+ page?: string;
204
+ /** @description Get responses by pagesize */
205
+ pagesize?: string;
206
+ /** @description Get responses that match search param value */
207
+ search?: string;
208
+ /** @description Get ordered responses */
209
+ order?: string;
210
+ };
211
+ header?: never;
212
+ path?: never;
213
+ cookie?: never;
214
+ };
215
+ requestBody?: never;
216
+ responses: {
217
+ /** @description Credentials response */
218
+ 200: {
219
+ headers: {
220
+ [name: string]: unknown;
221
+ };
222
+ content: {
223
+ "application/json": {
224
+ /** @description The credentials of the credentialpage. */
225
+ credentials: {
226
+ /**
227
+ * Format: uuid
228
+ * @description Unique identifier for the credential.
229
+ */
230
+ id?: string;
231
+ /** @description Human-readable name for the credential. */
232
+ name: string;
233
+ /**
234
+ * Format: uuid
235
+ * @description UUID of the user who owns this credential.
236
+ */
237
+ user_id?: string;
238
+ /** @description Credential type (e.g. token, basic, AWS). */
239
+ type: string;
240
+ /** @description Key-value pairs containing the sensitive credential data. */
241
+ secret?: Record<string, never>;
242
+ /**
243
+ * Format: date-time
244
+ * @description Timestamp when the resource was created.
245
+ */
246
+ created_at?: string;
247
+ /**
248
+ * Format: date-time
249
+ * @description Timestamp when the resource was updated.
250
+ */
251
+ updated_at?: string;
252
+ /**
253
+ * Format: date-time
254
+ * @description Timestamp when the credential was soft-deleted.
255
+ */
256
+ deleted_at?: string;
257
+ }[];
258
+ /** @description Total number of credentials across all pages. */
259
+ total_count: number;
260
+ /** @description Current page number (zero-based). */
261
+ page: number;
262
+ /** @description Number of credentials per page. */
263
+ page_size: number;
264
+ };
265
+ };
266
+ };
267
+ /** @description Expired JWT token used or insufficient privilege */
268
+ 401: {
269
+ headers: {
270
+ [name: string]: unknown;
271
+ };
272
+ content: {
273
+ "text/plain": string;
274
+ };
275
+ };
276
+ /** @description Internal server error */
277
+ 500: {
278
+ headers: {
279
+ [name: string]: unknown;
280
+ };
281
+ content: {
282
+ "text/plain": string;
283
+ };
284
+ };
439
285
  };
440
- };
441
- /** Expired JWT token used or insufficient privilege */
442
- 401: {
443
- content: {
444
- "text/plain": string;
286
+ };
287
+ updateUserCredential: {
288
+ parameters: {
289
+ query?: never;
290
+ header?: never;
291
+ path?: never;
292
+ cookie?: never;
445
293
  };
446
- };
447
- /** Result not found */
448
- 404: {
449
- content: {
450
- "text/plain": string;
294
+ requestBody: {
295
+ content: {
296
+ "application/json": {
297
+ /**
298
+ * Format: uuid
299
+ * @description Unique identifier for the credential.
300
+ */
301
+ id?: string;
302
+ /** @description Human-readable name for the credential. */
303
+ name: string;
304
+ /**
305
+ * Format: uuid
306
+ * @description UUID of the user who owns this credential.
307
+ */
308
+ user_id?: string;
309
+ /** @description Credential type (e.g. token, basic, AWS). */
310
+ type: string;
311
+ /** @description Key-value pairs containing the sensitive credential data. */
312
+ secret?: Record<string, never>;
313
+ /**
314
+ * Format: date-time
315
+ * @description Timestamp when the resource was created.
316
+ */
317
+ created_at?: string;
318
+ /**
319
+ * Format: date-time
320
+ * @description Timestamp when the resource was updated.
321
+ */
322
+ updated_at?: string;
323
+ /**
324
+ * Format: date-time
325
+ * @description Timestamp when the credential was soft-deleted.
326
+ */
327
+ deleted_at?: string;
328
+ };
329
+ };
451
330
  };
452
- };
453
- /** Internal server error */
454
- 500: {
455
- content: {
456
- "text/plain": string;
331
+ responses: {
332
+ /** @description Credential updated */
333
+ 200: {
334
+ headers: {
335
+ [name: string]: unknown;
336
+ };
337
+ content: {
338
+ "application/json": {
339
+ /**
340
+ * Format: uuid
341
+ * @description Unique identifier for the credential.
342
+ */
343
+ id?: string;
344
+ /** @description Human-readable name for the credential. */
345
+ name: string;
346
+ /**
347
+ * Format: uuid
348
+ * @description UUID of the user who owns this credential.
349
+ */
350
+ user_id?: string;
351
+ /** @description Credential type (e.g. token, basic, AWS). */
352
+ type: string;
353
+ /** @description Key-value pairs containing the sensitive credential data. */
354
+ secret?: Record<string, never>;
355
+ /**
356
+ * Format: date-time
357
+ * @description Timestamp when the resource was created.
358
+ */
359
+ created_at?: string;
360
+ /**
361
+ * Format: date-time
362
+ * @description Timestamp when the resource was updated.
363
+ */
364
+ updated_at?: string;
365
+ /**
366
+ * Format: date-time
367
+ * @description Timestamp when the credential was soft-deleted.
368
+ */
369
+ deleted_at?: string;
370
+ };
371
+ };
372
+ };
373
+ /** @description Invalid request body or request param */
374
+ 400: {
375
+ headers: {
376
+ [name: string]: unknown;
377
+ };
378
+ content: {
379
+ "text/plain": string;
380
+ };
381
+ };
382
+ /** @description Expired JWT token used or insufficient privilege */
383
+ 401: {
384
+ headers: {
385
+ [name: string]: unknown;
386
+ };
387
+ content: {
388
+ "text/plain": string;
389
+ };
390
+ };
391
+ /** @description Result not found */
392
+ 404: {
393
+ headers: {
394
+ [name: string]: unknown;
395
+ };
396
+ content: {
397
+ "text/plain": string;
398
+ };
399
+ };
400
+ /** @description Internal server error */
401
+ 500: {
402
+ headers: {
403
+ [name: string]: unknown;
404
+ };
405
+ content: {
406
+ "text/plain": string;
407
+ };
408
+ };
457
409
  };
458
- };
459
410
  };
460
- };
461
- /** Retrieves a specific credential by its ID. */
462
- getCredentialById: {
463
- parameters: {
464
- path: {
465
- /** Credential ID */
466
- id: string;
467
- };
411
+ saveUserCredential: {
412
+ parameters: {
413
+ query?: never;
414
+ header?: never;
415
+ path?: never;
416
+ cookie?: never;
417
+ };
418
+ requestBody: {
419
+ content: {
420
+ "application/json": {
421
+ /**
422
+ * Format: uuid
423
+ * @description Unique identifier for the credential.
424
+ */
425
+ id?: string;
426
+ /** @description Human-readable name for the credential. */
427
+ name: string;
428
+ /**
429
+ * Format: uuid
430
+ * @description UUID of the user who owns this credential.
431
+ */
432
+ user_id?: string;
433
+ /** @description Credential type (e.g. token, basic, AWS). */
434
+ type: string;
435
+ /** @description Key-value pairs containing the sensitive credential data. */
436
+ secret?: Record<string, never>;
437
+ /**
438
+ * Format: date-time
439
+ * @description Timestamp when the resource was created.
440
+ */
441
+ created_at?: string;
442
+ /**
443
+ * Format: date-time
444
+ * @description Timestamp when the resource was updated.
445
+ */
446
+ updated_at?: string;
447
+ /**
448
+ * Format: date-time
449
+ * @description Timestamp when the credential was soft-deleted.
450
+ */
451
+ deleted_at?: string;
452
+ };
453
+ };
454
+ };
455
+ responses: {
456
+ /** @description Credential saved */
457
+ 201: {
458
+ headers: {
459
+ [name: string]: unknown;
460
+ };
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
+ user_id?: 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?: Record<string, never>;
479
+ /**
480
+ * Format: date-time
481
+ * @description Timestamp when the resource was created.
482
+ */
483
+ created_at?: string;
484
+ /**
485
+ * Format: date-time
486
+ * @description Timestamp when the resource was updated.
487
+ */
488
+ updated_at?: string;
489
+ /**
490
+ * Format: date-time
491
+ * @description Timestamp when the credential was soft-deleted.
492
+ */
493
+ deleted_at?: string;
494
+ };
495
+ };
496
+ };
497
+ /** @description Invalid request body or request param */
498
+ 400: {
499
+ headers: {
500
+ [name: string]: unknown;
501
+ };
502
+ content: {
503
+ "text/plain": string;
504
+ };
505
+ };
506
+ /** @description Expired JWT token used or insufficient privilege */
507
+ 401: {
508
+ headers: {
509
+ [name: string]: unknown;
510
+ };
511
+ content: {
512
+ "text/plain": string;
513
+ };
514
+ };
515
+ /** @description Internal server error */
516
+ 500: {
517
+ headers: {
518
+ [name: string]: unknown;
519
+ };
520
+ content: {
521
+ "text/plain": string;
522
+ };
523
+ };
524
+ };
468
525
  };
469
- responses: {
470
- /** Credential response */
471
- 200: {
472
- content: {
473
- "application/json": {
474
- /**
475
- * Format: uuid
476
- * @description Unique identifier for the credential.
477
- */
478
- id?: string;
479
- /** @description Human-readable name for the credential. */
480
- name: string;
481
- /**
482
- * Format: uuid
483
- * @description UUID of the user who owns this credential.
484
- */
485
- user_id?: string;
486
- /** @description Credential type (e.g. token, basic, AWS). */
487
- type: string;
488
- /** @description Key-value pairs containing the sensitive credential data. */
489
- secret?: { [key: string]: unknown };
490
- /**
491
- * Format: date-time
492
- * @description Timestamp when the resource was created.
493
- */
494
- created_at?: string;
495
- /**
496
- * Format: date-time
497
- * @description Timestamp when the resource was updated.
498
- */
499
- updated_at?: string;
500
- /**
501
- * Format: date-time
502
- * @description Timestamp when the credential was soft-deleted.
503
- */
504
- deleted_at?: string;
505
- };
526
+ deleteUserCredential: {
527
+ parameters: {
528
+ query: {
529
+ /** @description Credential ID */
530
+ credentialId: string;
531
+ };
532
+ header?: never;
533
+ path?: never;
534
+ cookie?: never;
506
535
  };
507
- };
508
- /** Expired JWT token used or insufficient privilege */
509
- 401: {
510
- content: {
511
- "text/plain": string;
536
+ requestBody?: never;
537
+ responses: {
538
+ /** @description Credential deleted */
539
+ 204: {
540
+ headers: {
541
+ [name: string]: unknown;
542
+ };
543
+ content?: never;
544
+ };
545
+ /** @description Invalid request body or request param */
546
+ 400: {
547
+ headers: {
548
+ [name: string]: unknown;
549
+ };
550
+ content: {
551
+ "text/plain": string;
552
+ };
553
+ };
554
+ /** @description Expired JWT token used or insufficient privilege */
555
+ 401: {
556
+ headers: {
557
+ [name: string]: unknown;
558
+ };
559
+ content: {
560
+ "text/plain": string;
561
+ };
562
+ };
563
+ /** @description Result not found */
564
+ 404: {
565
+ headers: {
566
+ [name: string]: unknown;
567
+ };
568
+ content: {
569
+ "text/plain": string;
570
+ };
571
+ };
572
+ /** @description Internal server error */
573
+ 500: {
574
+ headers: {
575
+ [name: string]: unknown;
576
+ };
577
+ content: {
578
+ "text/plain": string;
579
+ };
580
+ };
512
581
  };
513
- };
514
- /** Result not found */
515
- 404: {
516
- content: {
517
- "text/plain": string;
582
+ };
583
+ getCredentialById: {
584
+ parameters: {
585
+ query?: never;
586
+ header?: never;
587
+ path: {
588
+ /** @description Credential ID */
589
+ id: string;
590
+ };
591
+ cookie?: never;
518
592
  };
519
- };
520
- /** Internal server error */
521
- 500: {
522
- content: {
523
- "text/plain": string;
593
+ requestBody?: never;
594
+ responses: {
595
+ /** @description Credential response */
596
+ 200: {
597
+ headers: {
598
+ [name: string]: unknown;
599
+ };
600
+ content: {
601
+ "application/json": {
602
+ /**
603
+ * Format: uuid
604
+ * @description Unique identifier for the credential.
605
+ */
606
+ id?: string;
607
+ /** @description Human-readable name for the credential. */
608
+ name: string;
609
+ /**
610
+ * Format: uuid
611
+ * @description UUID of the user who owns this credential.
612
+ */
613
+ user_id?: string;
614
+ /** @description Credential type (e.g. token, basic, AWS). */
615
+ type: string;
616
+ /** @description Key-value pairs containing the sensitive credential data. */
617
+ secret?: Record<string, never>;
618
+ /**
619
+ * Format: date-time
620
+ * @description Timestamp when the resource was created.
621
+ */
622
+ created_at?: string;
623
+ /**
624
+ * Format: date-time
625
+ * @description Timestamp when the resource was updated.
626
+ */
627
+ updated_at?: string;
628
+ /**
629
+ * Format: date-time
630
+ * @description Timestamp when the credential was soft-deleted.
631
+ */
632
+ deleted_at?: string;
633
+ };
634
+ };
635
+ };
636
+ /** @description Expired JWT token used or insufficient privilege */
637
+ 401: {
638
+ headers: {
639
+ [name: string]: unknown;
640
+ };
641
+ content: {
642
+ "text/plain": string;
643
+ };
644
+ };
645
+ /** @description Result not found */
646
+ 404: {
647
+ headers: {
648
+ [name: string]: unknown;
649
+ };
650
+ content: {
651
+ "text/plain": string;
652
+ };
653
+ };
654
+ /** @description Internal server error */
655
+ 500: {
656
+ headers: {
657
+ [name: string]: unknown;
658
+ };
659
+ content: {
660
+ "text/plain": string;
661
+ };
662
+ };
524
663
  };
525
- };
526
664
  };
527
- };
528
665
  }
529
-
530
- export interface external {}