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