@meshery/schemas 1.3.8 → 1.4.0

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 (103) hide show
  1. package/dist/cloudApi.d.mts +4154 -1704
  2. package/dist/cloudApi.d.ts +4154 -1704
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
  10. package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
  11. package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
  12. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
  13. package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
  14. package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
  15. package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
  16. package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
  17. package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
  18. package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
  19. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
  20. package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
  21. package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
  22. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
  23. package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
  24. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
  25. package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
  26. package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
  27. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
  28. package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
  29. package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
  30. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
  31. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
  32. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
  33. package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
  34. package/dist/constructs/v1beta1/system/System.d.ts +250 -385
  35. package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
  36. package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
  37. package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
  38. package/dist/constructs/v1beta1/view/View.d.ts +664 -833
  39. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
  40. package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
  41. package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
  42. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
  43. package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
  44. package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
  45. package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
  46. package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
  47. package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
  48. package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
  49. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
  50. package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
  51. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
  52. package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
  53. package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
  54. package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
  55. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
  56. package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
  57. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
  58. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
  59. package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
  60. package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
  61. package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
  62. package/dist/constructs/v1beta2/view/View.d.ts +669 -838
  63. package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
  64. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  65. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  66. package/dist/constructs/v1beta3/component/Component.d.ts +857 -753
  67. package/dist/constructs/v1beta3/connection/Connection.d.ts +5919 -1416
  68. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +25 -1
  69. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +25 -1
  70. package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
  71. package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
  72. package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
  73. package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
  74. package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
  75. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  76. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  77. package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
  78. package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
  79. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
  80. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
  81. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  82. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  83. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
  84. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
  85. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
  86. package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
  87. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
  88. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
  89. package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
  90. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  91. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  92. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
  93. package/dist/index.d.mts +5032 -5501
  94. package/dist/index.d.ts +5032 -5501
  95. package/dist/mesheryApi.d.mts +3334 -884
  96. package/dist/mesheryApi.d.ts +3334 -884
  97. package/dist/mesheryApi.js +1 -1
  98. package/dist/mesheryApi.mjs +1 -1
  99. package/dist/permissions.d.mts +25 -1
  100. package/dist/permissions.d.ts +25 -1
  101. package/dist/permissions.js +1 -1
  102. package/dist/permissions.mjs +1 -1
  103. package/package.json +1 -1
@@ -4,68 +4,336 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/identity/orgs/{orgId}/users/keys": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
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;
14
90
  /**
15
- * Get User Keys
16
- * @description Get all keys based on roles assigned to user
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.
17
93
  */
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;
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;
113
+ /**
114
+ * Format: date-time
115
+ * @description Timestamp when the key was soft-deleted.
116
+ */
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
+ };
26
127
  };
27
- "/api/auth/keys": {
28
- parameters: {
29
- query?: never;
30
- header?: never;
31
- path?: never;
32
- cookie?: never;
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
+ };
33
226
  };
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;
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
+ };
44
246
  };
45
- "/api/auth/key/{keyId}": {
46
- parameters: {
47
- query?: never;
48
- header?: never;
49
- path?: never;
50
- cookie?: never;
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;
51
327
  };
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;
328
+ };
62
329
  };
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: {
330
+ };
331
+ upsertKey: {
332
+ responses: {
333
+ /** Key upserted */
334
+ 200: {
335
+ content: {
336
+ "application/json": {
69
337
  /**
70
338
  * Format: uuid
71
339
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -99,571 +367,158 @@ export interface components {
99
367
  * @description Timestamp when the key was soft-deleted.
100
368
  */
101
369
  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;
102
408
  };
103
- /** @description Payload for creating or updating a key. */
104
- KeyPayload: {
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": {
105
424
  /**
106
425
  * Format: uuid
107
426
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
108
427
  */
109
- id?: string;
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;
110
434
  /** @description Operation permitted by the key. */
111
- function?: string;
435
+ function: string;
112
436
  /** @description Category for the key. */
113
- category?: string;
437
+ category: string;
114
438
  /** @description Subcategory for the key. */
115
- subcategory?: string;
439
+ subcategory: string;
116
440
  /** @description Human readable description of the key. */
117
- description?: string;
118
- };
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
- }[];
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
+ };
163
458
  };
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
- };
459
+ };
460
+ /** Invalid request body or request param */
461
+ 400: {
462
+ content: {
463
+ "text/plain": string;
174
464
  };
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
- };
465
+ };
466
+ /** Expired JWT token used or insufficient privilege */
467
+ 401: {
468
+ content: {
469
+ "text/plain": string;
183
470
  };
184
- /** @description Result not found */
185
- 404: {
186
- headers: {
187
- [name: string]: unknown;
188
- };
189
- content: {
190
- "text/plain": string;
191
- };
471
+ };
472
+ /** Result not found */
473
+ 404: {
474
+ content: {
475
+ "text/plain": string;
192
476
  };
193
- /** @description Internal server error */
194
- 500: {
195
- headers: {
196
- [name: string]: unknown;
197
- };
198
- content: {
199
- "text/plain": string;
200
- };
477
+ };
478
+ /** Internal server error */
479
+ 500: {
480
+ content: {
481
+ "text/plain": string;
201
482
  };
483
+ };
202
484
  };
485
+ };
486
+ deleteKey: {
203
487
  parameters: {
204
- /** @description Organization ID */
205
- orgId: string;
206
- /** @description Key ID */
488
+ path: {
489
+ /** Key ID */
207
490
  keyId: string;
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;
491
+ };
216
492
  };
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
- };
445
- };
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
- };
517
- };
518
- };
519
- getKeyById: {
520
- parameters: {
521
- query?: never;
522
- header?: never;
523
- path: {
524
- /** @description Key ID */
525
- keyId: string;
526
- };
527
- cookie?: never;
493
+ responses: {
494
+ /** Key deleted */
495
+ 204: never;
496
+ /** Invalid request body or request param */
497
+ 400: {
498
+ content: {
499
+ "text/plain": string;
528
500
  };
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
- };
501
+ };
502
+ /** Expired JWT token used or insufficient privilege */
503
+ 401: {
504
+ content: {
505
+ "text/plain": string;
610
506
  };
611
- };
612
- deleteKey: {
613
- parameters: {
614
- query?: never;
615
- header?: never;
616
- path: {
617
- /** @description Key ID */
618
- keyId: string;
619
- };
620
- cookie?: never;
507
+ };
508
+ /** Result not found */
509
+ 404: {
510
+ content: {
511
+ "text/plain": string;
621
512
  };
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
- };
513
+ };
514
+ /** Internal server error */
515
+ 500: {
516
+ content: {
517
+ "text/plain": string;
667
518
  };
519
+ };
668
520
  };
521
+ };
669
522
  }
523
+
524
+ export interface external {}