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