@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,86 +4,225 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/organizations/badges/{badgeId}": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
14
- /** Get a badge by its ID */
15
- get: operations["getBadgeById"];
16
- put?: never;
17
- post?: never;
18
- /** Delete a badge by its ID */
19
- delete: operations["deleteBadgeById"];
20
- options?: never;
21
- head?: never;
22
- patch?: never;
23
- trace?: never;
7
+ "/api/organizations/badges/{badgeId}": {
8
+ get: operations["getBadgeById"];
9
+ delete: operations["deleteBadgeById"];
10
+ };
11
+ "/api/organizations/badges": {
12
+ post: operations["createOrUpdateBadge"];
13
+ };
14
+ "/api/identity/badges": {
15
+ get: operations["getAvailableBadges"];
16
+ };
17
+ "/api/identity/users/badges": {
18
+ put: operations["assignBadges"];
19
+ };
20
+ }
21
+
22
+ export interface components {
23
+ schemas: {
24
+ /** @description Payload for creating or updating a badge. */
25
+ BadgePayload: {
26
+ /**
27
+ * Format: uuid
28
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
29
+ */
30
+ id?: string;
31
+ /**
32
+ * Format: uuid
33
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
34
+ */
35
+ orgId: string;
36
+ /**
37
+ * @description Unique identifier for the badge, typically slug-style (auto generated).
38
+ * @example Kubernetes-Expert
39
+ */
40
+ label: string;
41
+ /**
42
+ * @description Concise descriptor for the badge or certificate.
43
+ * @example Kubernetes Expert
44
+ */
45
+ name: string;
46
+ /**
47
+ * @description A description of the milestone achieved, often including criteria for receiving this recognition.
48
+ * @example Awarded for mastering Kubernetes concepts and practices.
49
+ */
50
+ description: string;
51
+ /**
52
+ * Format: uri
53
+ * @description URL to the badge image.
54
+ * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
55
+ */
56
+ imageUrl: string;
24
57
  };
25
- "/api/organizations/badges": {
26
- parameters: {
27
- query?: never;
28
- header?: never;
29
- path?: never;
30
- cookie?: never;
31
- };
32
- get?: never;
33
- put?: never;
34
- /** Create a new badge or update an existing badge */
35
- post: operations["createOrUpdateBadge"];
36
- delete?: never;
37
- options?: never;
38
- head?: never;
39
- patch?: never;
40
- trace?: never;
58
+ /** @description Badge entity — a named recognition issued within an organization. */
59
+ Badge: {
60
+ /**
61
+ * Format: uuid
62
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
63
+ */
64
+ id: string;
65
+ /**
66
+ * Format: uuid
67
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
68
+ */
69
+ orgId: string;
70
+ /**
71
+ * @description Unique identifier for the badge, typically slug-style (auto generated).
72
+ * @example Kubernetes-Expert
73
+ */
74
+ label: string;
75
+ /**
76
+ * @description Concise descriptor for the badge or certificate.
77
+ * @example Kubernetes Expert
78
+ */
79
+ name: string;
80
+ /**
81
+ * @description A description of the milestone achieved, often including criteria for receiving this recognition.
82
+ * @example Awarded for mastering Kubernetes concepts and practices.
83
+ */
84
+ description: string;
85
+ /**
86
+ * Format: uri
87
+ * @description URL to the badge image.
88
+ * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
89
+ */
90
+ imageUrl: string;
91
+ /**
92
+ * Format: date-time
93
+ * @description Timestamp when the badge was created.
94
+ */
95
+ createdAt: string;
96
+ /**
97
+ * Format: date-time
98
+ * @description Timestamp when the badge was last updated.
99
+ */
100
+ updatedAt: string;
101
+ /**
102
+ * Format: date-time
103
+ * @description Timestamp when the badge was soft-deleted, if applicable.
104
+ */
105
+ deletedAt: string;
41
106
  };
42
- "/api/identity/badges": {
43
- parameters: {
44
- query?: never;
45
- header?: never;
46
- path?: never;
47
- cookie?: never;
107
+ /** @description Map of badges available in an organization, keyed by badge label. */
108
+ BadgesPage: {
109
+ /** @description Available badges, keyed by badge label. */
110
+ badges?: {
111
+ [key: string]: {
112
+ /**
113
+ * Format: uuid
114
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
115
+ */
116
+ id: string;
117
+ /**
118
+ * Format: uuid
119
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
120
+ */
121
+ orgId: string;
122
+ /**
123
+ * @description Unique identifier for the badge, typically slug-style (auto generated).
124
+ * @example Kubernetes-Expert
125
+ */
126
+ label: string;
127
+ /**
128
+ * @description Concise descriptor for the badge or certificate.
129
+ * @example Kubernetes Expert
130
+ */
131
+ name: string;
132
+ /**
133
+ * @description A description of the milestone achieved, often including criteria for receiving this recognition.
134
+ * @example Awarded for mastering Kubernetes concepts and practices.
135
+ */
136
+ description: string;
137
+ /**
138
+ * Format: uri
139
+ * @description URL to the badge image.
140
+ * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
141
+ */
142
+ imageUrl: string;
143
+ /**
144
+ * Format: date-time
145
+ * @description Timestamp when the badge was created.
146
+ */
147
+ createdAt: string;
148
+ /**
149
+ * Format: date-time
150
+ * @description Timestamp when the badge was last updated.
151
+ */
152
+ updatedAt: string;
153
+ /**
154
+ * Format: date-time
155
+ * @description Timestamp when the badge was soft-deleted, if applicable.
156
+ */
157
+ deletedAt: string;
48
158
  };
49
- /** Get available badges */
50
- get: operations["getAvailableBadges"];
51
- put?: never;
52
- post?: never;
53
- delete?: never;
54
- options?: never;
55
- head?: never;
56
- patch?: never;
57
- trace?: never;
159
+ };
58
160
  };
59
- "/api/identity/users/badges": {
60
- parameters: {
61
- query?: never;
62
- header?: never;
63
- path?: never;
64
- cookie?: never;
65
- };
66
- get?: never;
67
- /** Assign badges to a user */
68
- put: operations["assignBadges"];
69
- post?: never;
70
- delete?: never;
71
- options?: never;
72
- head?: never;
73
- patch?: never;
74
- trace?: never;
161
+ /** @description Payload for assigning a set of badges to a user. */
162
+ BadgeAssignmentPayload: {
163
+ /** @description Labels of the badges being assigned to the user. */
164
+ badges: string[];
165
+ /**
166
+ * Format: uuid
167
+ * @description ID of the user to receive the badges.
168
+ */
169
+ userId: string;
170
+ /** @description When true, send a notification to the user about the new badge assignment. */
171
+ notify?: boolean;
172
+ };
173
+ };
174
+ responses: {
175
+ /** Invalid request body or request param */
176
+ 400: {
177
+ content: {
178
+ "text/plain": string;
179
+ };
75
180
  };
181
+ /** Expired JWT token used or insufficient privilege */
182
+ 401: {
183
+ content: {
184
+ "text/plain": string;
185
+ };
186
+ };
187
+ /** Result not found */
188
+ 404: {
189
+ content: {
190
+ "text/plain": string;
191
+ };
192
+ };
193
+ /** Internal server error */
194
+ 500: {
195
+ content: {
196
+ "text/plain": string;
197
+ };
198
+ };
199
+ };
200
+ parameters: {
201
+ /** @description Badge ID */
202
+ badgeId: string;
203
+ /** @description Organization ID to scope the badge listing to. */
204
+ orgIdQuery: string;
205
+ };
76
206
  }
77
- export type webhooks = Record<string, never>;
78
- export interface components {
79
- schemas: {
80
- /** @description Payload for creating or updating a badge. */
81
- BadgePayload: {
207
+
208
+ export interface operations {
209
+ getBadgeById: {
210
+ parameters: {
211
+ path: {
212
+ /** Badge ID */
213
+ badgeId: string;
214
+ };
215
+ };
216
+ responses: {
217
+ /** Badge response */
218
+ 200: {
219
+ content: {
220
+ "application/json": {
82
221
  /**
83
222
  * Format: uuid
84
223
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
85
224
  */
86
- id?: string;
225
+ id: string;
87
226
  /**
88
227
  * Format: uuid
89
228
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -110,9 +249,80 @@ export interface components {
110
249
  * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
111
250
  */
112
251
  imageUrl: string;
252
+ /**
253
+ * Format: date-time
254
+ * @description Timestamp when the badge was created.
255
+ */
256
+ createdAt: string;
257
+ /**
258
+ * Format: date-time
259
+ * @description Timestamp when the badge was last updated.
260
+ */
261
+ updatedAt: string;
262
+ /**
263
+ * Format: date-time
264
+ * @description Timestamp when the badge was soft-deleted, if applicable.
265
+ */
266
+ deletedAt: string;
267
+ };
268
+ };
269
+ };
270
+ /** Expired JWT token used or insufficient privilege */
271
+ 401: {
272
+ content: {
273
+ "text/plain": string;
274
+ };
275
+ };
276
+ /** Result not found */
277
+ 404: {
278
+ content: {
279
+ "text/plain": string;
280
+ };
281
+ };
282
+ /** Internal server error */
283
+ 500: {
284
+ content: {
285
+ "text/plain": string;
286
+ };
287
+ };
288
+ };
289
+ };
290
+ deleteBadgeById: {
291
+ parameters: {
292
+ path: {
293
+ /** Badge ID */
294
+ badgeId: string;
295
+ };
296
+ };
297
+ responses: {
298
+ /** Badge deleted */
299
+ 204: never;
300
+ /** Expired JWT token used or insufficient privilege */
301
+ 401: {
302
+ content: {
303
+ "text/plain": string;
304
+ };
305
+ };
306
+ /** Result not found */
307
+ 404: {
308
+ content: {
309
+ "text/plain": string;
113
310
  };
114
- /** @description Badge entity — a named recognition issued within an organization. */
115
- Badge: {
311
+ };
312
+ /** Internal server error */
313
+ 500: {
314
+ content: {
315
+ "text/plain": string;
316
+ };
317
+ };
318
+ };
319
+ };
320
+ createOrUpdateBadge: {
321
+ responses: {
322
+ /** Badge upserted */
323
+ 200: {
324
+ content: {
325
+ "application/json": {
116
326
  /**
117
327
  * Format: uuid
118
328
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -159,562 +369,195 @@ export interface components {
159
369
  * @description Timestamp when the badge was soft-deleted, if applicable.
160
370
  */
161
371
  deletedAt: string;
372
+ };
162
373
  };
163
- /** @description Map of badges available in an organization, keyed by badge label. */
164
- BadgesPage: {
165
- /** @description Available badges, keyed by badge label. */
166
- badges?: {
167
- [key: string]: {
168
- /**
169
- * Format: uuid
170
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
171
- */
172
- id: string;
173
- /**
174
- * Format: uuid
175
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
176
- */
177
- orgId: string;
178
- /**
179
- * @description Unique identifier for the badge, typically slug-style (auto generated).
180
- * @example Kubernetes-Expert
181
- */
182
- label: string;
183
- /**
184
- * @description Concise descriptor for the badge or certificate.
185
- * @example Kubernetes Expert
186
- */
187
- name: string;
188
- /**
189
- * @description A description of the milestone achieved, often including criteria for receiving this recognition.
190
- * @example Awarded for mastering Kubernetes concepts and practices.
191
- */
192
- description: string;
193
- /**
194
- * Format: uri
195
- * @description URL to the badge image.
196
- * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
197
- */
198
- imageUrl: string;
199
- /**
200
- * Format: date-time
201
- * @description Timestamp when the badge was created.
202
- */
203
- createdAt: string;
204
- /**
205
- * Format: date-time
206
- * @description Timestamp when the badge was last updated.
207
- */
208
- updatedAt: string;
209
- /**
210
- * Format: date-time
211
- * @description Timestamp when the badge was soft-deleted, if applicable.
212
- */
213
- deletedAt: string;
214
- };
215
- };
374
+ };
375
+ /** Invalid request body or request param */
376
+ 400: {
377
+ content: {
378
+ "text/plain": string;
216
379
  };
217
- /** @description Payload for assigning a set of badges to a user. */
218
- BadgeAssignmentPayload: {
219
- /** @description Labels of the badges being assigned to the user. */
220
- badges: string[];
221
- /**
222
- * Format: uuid
223
- * @description ID of the user to receive the badges.
224
- */
225
- userId: string;
226
- /** @description When true, send a notification to the user about the new badge assignment. */
227
- notify?: boolean;
380
+ };
381
+ /** Expired JWT token used or insufficient privilege */
382
+ 401: {
383
+ content: {
384
+ "text/plain": string;
228
385
  };
229
- };
230
- responses: {
231
- /** @description Invalid request body or request param */
232
- 400: {
233
- headers: {
234
- [name: string]: unknown;
235
- };
236
- content: {
237
- "text/plain": string;
238
- };
239
- };
240
- /** @description Expired JWT token used or insufficient privilege */
241
- 401: {
242
- headers: {
243
- [name: string]: unknown;
244
- };
245
- content: {
246
- "text/plain": string;
247
- };
386
+ };
387
+ /** Internal server error */
388
+ 500: {
389
+ content: {
390
+ "text/plain": string;
248
391
  };
249
- /** @description Result not found */
250
- 404: {
251
- headers: {
252
- [name: string]: unknown;
253
- };
254
- content: {
255
- "text/plain": string;
256
- };
257
- };
258
- /** @description Internal server error */
259
- 500: {
260
- headers: {
261
- [name: string]: unknown;
262
- };
263
- content: {
264
- "text/plain": string;
265
- };
392
+ };
393
+ };
394
+ requestBody: {
395
+ content: {
396
+ "application/json": {
397
+ /**
398
+ * Format: uuid
399
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
400
+ */
401
+ id?: string;
402
+ /**
403
+ * Format: uuid
404
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
405
+ */
406
+ orgId: string;
407
+ /**
408
+ * @description Unique identifier for the badge, typically slug-style (auto generated).
409
+ * @example Kubernetes-Expert
410
+ */
411
+ label: string;
412
+ /**
413
+ * @description Concise descriptor for the badge or certificate.
414
+ * @example Kubernetes Expert
415
+ */
416
+ name: string;
417
+ /**
418
+ * @description A description of the milestone achieved, often including criteria for receiving this recognition.
419
+ * @example Awarded for mastering Kubernetes concepts and practices.
420
+ */
421
+ description: string;
422
+ /**
423
+ * Format: uri
424
+ * @description URL to the badge image.
425
+ * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
426
+ */
427
+ imageUrl: string;
266
428
  };
429
+ };
267
430
  };
431
+ };
432
+ getAvailableBadges: {
268
433
  parameters: {
269
- /** @description Badge ID */
270
- badgeId: string;
271
- /** @description Organization ID to scope the badge listing to. */
272
- orgIdQuery: string;
434
+ query: {
435
+ /** Organization ID to scope the badge listing to. */
436
+ orgId?: string;
437
+ };
273
438
  };
274
- requestBodies: never;
275
- headers: never;
276
- pathItems: never;
277
- }
278
- export type $defs = Record<string, never>;
279
- export interface operations {
280
- getBadgeById: {
281
- parameters: {
282
- query?: never;
283
- header?: never;
284
- path: {
285
- /** @description Badge ID */
286
- badgeId: string;
287
- };
288
- cookie?: never;
439
+ responses: {
440
+ /** Available badges */
441
+ 200: {
442
+ content: {
443
+ "application/json": {
444
+ /** @description Available badges, keyed by badge label. */
445
+ badges?: {
446
+ [key: string]: {
447
+ /**
448
+ * Format: uuid
449
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
450
+ */
451
+ id: string;
452
+ /**
453
+ * Format: uuid
454
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
455
+ */
456
+ orgId: string;
457
+ /**
458
+ * @description Unique identifier for the badge, typically slug-style (auto generated).
459
+ * @example Kubernetes-Expert
460
+ */
461
+ label: string;
462
+ /**
463
+ * @description Concise descriptor for the badge or certificate.
464
+ * @example Kubernetes Expert
465
+ */
466
+ name: string;
467
+ /**
468
+ * @description A description of the milestone achieved, often including criteria for receiving this recognition.
469
+ * @example Awarded for mastering Kubernetes concepts and practices.
470
+ */
471
+ description: string;
472
+ /**
473
+ * Format: uri
474
+ * @description URL to the badge image.
475
+ * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
476
+ */
477
+ imageUrl: string;
478
+ /**
479
+ * Format: date-time
480
+ * @description Timestamp when the badge was created.
481
+ */
482
+ createdAt: string;
483
+ /**
484
+ * Format: date-time
485
+ * @description Timestamp when the badge was last updated.
486
+ */
487
+ updatedAt: string;
488
+ /**
489
+ * Format: date-time
490
+ * @description Timestamp when the badge was soft-deleted, if applicable.
491
+ */
492
+ deletedAt: string;
493
+ };
494
+ };
495
+ };
289
496
  };
290
- requestBody?: never;
291
- responses: {
292
- /** @description Badge response */
293
- 200: {
294
- headers: {
295
- [name: string]: unknown;
296
- };
297
- content: {
298
- "application/json": {
299
- /**
300
- * Format: uuid
301
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
302
- */
303
- id: string;
304
- /**
305
- * Format: uuid
306
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
307
- */
308
- orgId: string;
309
- /**
310
- * @description Unique identifier for the badge, typically slug-style (auto generated).
311
- * @example Kubernetes-Expert
312
- */
313
- label: string;
314
- /**
315
- * @description Concise descriptor for the badge or certificate.
316
- * @example Kubernetes Expert
317
- */
318
- name: string;
319
- /**
320
- * @description A description of the milestone achieved, often including criteria for receiving this recognition.
321
- * @example Awarded for mastering Kubernetes concepts and practices.
322
- */
323
- description: string;
324
- /**
325
- * Format: uri
326
- * @description URL to the badge image.
327
- * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
328
- */
329
- imageUrl: string;
330
- /**
331
- * Format: date-time
332
- * @description Timestamp when the badge was created.
333
- */
334
- createdAt: string;
335
- /**
336
- * Format: date-time
337
- * @description Timestamp when the badge was last updated.
338
- */
339
- updatedAt: string;
340
- /**
341
- * Format: date-time
342
- * @description Timestamp when the badge was soft-deleted, if applicable.
343
- */
344
- deletedAt: string;
345
- };
346
- };
347
- };
348
- /** @description Expired JWT token used or insufficient privilege */
349
- 401: {
350
- headers: {
351
- [name: string]: unknown;
352
- };
353
- content: {
354
- "text/plain": string;
355
- };
356
- };
357
- /** @description Result not found */
358
- 404: {
359
- headers: {
360
- [name: string]: unknown;
361
- };
362
- content: {
363
- "text/plain": string;
364
- };
365
- };
366
- /** @description Internal server error */
367
- 500: {
368
- headers: {
369
- [name: string]: unknown;
370
- };
371
- content: {
372
- "text/plain": string;
373
- };
374
- };
497
+ };
498
+ /** Invalid request body or request param */
499
+ 400: {
500
+ content: {
501
+ "text/plain": string;
375
502
  };
376
- };
377
- deleteBadgeById: {
378
- parameters: {
379
- query?: never;
380
- header?: never;
381
- path: {
382
- /** @description Badge ID */
383
- badgeId: string;
384
- };
385
- cookie?: never;
503
+ };
504
+ /** Expired JWT token used or insufficient privilege */
505
+ 401: {
506
+ content: {
507
+ "text/plain": string;
386
508
  };
387
- requestBody?: never;
388
- responses: {
389
- /** @description Badge deleted */
390
- 204: {
391
- headers: {
392
- [name: string]: unknown;
393
- };
394
- content?: never;
395
- };
396
- /** @description Expired JWT token used or insufficient privilege */
397
- 401: {
398
- headers: {
399
- [name: string]: unknown;
400
- };
401
- content: {
402
- "text/plain": string;
403
- };
404
- };
405
- /** @description Result not found */
406
- 404: {
407
- headers: {
408
- [name: string]: unknown;
409
- };
410
- content: {
411
- "text/plain": string;
412
- };
413
- };
414
- /** @description Internal server error */
415
- 500: {
416
- headers: {
417
- [name: string]: unknown;
418
- };
419
- content: {
420
- "text/plain": string;
421
- };
422
- };
509
+ };
510
+ /** Internal server error */
511
+ 500: {
512
+ content: {
513
+ "text/plain": string;
423
514
  };
515
+ };
424
516
  };
425
- createOrUpdateBadge: {
426
- parameters: {
427
- query?: never;
428
- header?: never;
429
- path?: never;
430
- cookie?: never;
517
+ };
518
+ assignBadges: {
519
+ responses: {
520
+ /** Badge assignment result */
521
+ 200: {
522
+ content: {
523
+ "application/json": { [key: string]: unknown };
431
524
  };
432
- requestBody: {
433
- content: {
434
- "application/json": {
435
- /**
436
- * Format: uuid
437
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
438
- */
439
- id?: string;
440
- /**
441
- * Format: uuid
442
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
443
- */
444
- orgId: string;
445
- /**
446
- * @description Unique identifier for the badge, typically slug-style (auto generated).
447
- * @example Kubernetes-Expert
448
- */
449
- label: string;
450
- /**
451
- * @description Concise descriptor for the badge or certificate.
452
- * @example Kubernetes Expert
453
- */
454
- name: string;
455
- /**
456
- * @description A description of the milestone achieved, often including criteria for receiving this recognition.
457
- * @example Awarded for mastering Kubernetes concepts and practices.
458
- */
459
- description: string;
460
- /**
461
- * Format: uri
462
- * @description URL to the badge image.
463
- * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
464
- */
465
- imageUrl: string;
466
- };
467
- };
525
+ };
526
+ /** Invalid request body or request param */
527
+ 400: {
528
+ content: {
529
+ "text/plain": string;
468
530
  };
469
- responses: {
470
- /** @description Badge upserted */
471
- 200: {
472
- headers: {
473
- [name: string]: unknown;
474
- };
475
- content: {
476
- "application/json": {
477
- /**
478
- * Format: uuid
479
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
480
- */
481
- id: string;
482
- /**
483
- * Format: uuid
484
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
485
- */
486
- orgId: string;
487
- /**
488
- * @description Unique identifier for the badge, typically slug-style (auto generated).
489
- * @example Kubernetes-Expert
490
- */
491
- label: string;
492
- /**
493
- * @description Concise descriptor for the badge or certificate.
494
- * @example Kubernetes Expert
495
- */
496
- name: string;
497
- /**
498
- * @description A description of the milestone achieved, often including criteria for receiving this recognition.
499
- * @example Awarded for mastering Kubernetes concepts and practices.
500
- */
501
- description: string;
502
- /**
503
- * Format: uri
504
- * @description URL to the badge image.
505
- * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
506
- */
507
- imageUrl: string;
508
- /**
509
- * Format: date-time
510
- * @description Timestamp when the badge was created.
511
- */
512
- createdAt: string;
513
- /**
514
- * Format: date-time
515
- * @description Timestamp when the badge was last updated.
516
- */
517
- updatedAt: string;
518
- /**
519
- * Format: date-time
520
- * @description Timestamp when the badge was soft-deleted, if applicable.
521
- */
522
- deletedAt: string;
523
- };
524
- };
525
- };
526
- /** @description Invalid request body or request param */
527
- 400: {
528
- headers: {
529
- [name: string]: unknown;
530
- };
531
- content: {
532
- "text/plain": string;
533
- };
534
- };
535
- /** @description Expired JWT token used or insufficient privilege */
536
- 401: {
537
- headers: {
538
- [name: string]: unknown;
539
- };
540
- content: {
541
- "text/plain": string;
542
- };
543
- };
544
- /** @description Internal server error */
545
- 500: {
546
- headers: {
547
- [name: string]: unknown;
548
- };
549
- content: {
550
- "text/plain": string;
551
- };
552
- };
531
+ };
532
+ /** Expired JWT token used or insufficient privilege */
533
+ 401: {
534
+ content: {
535
+ "text/plain": string;
553
536
  };
554
- };
555
- getAvailableBadges: {
556
- parameters: {
557
- query?: {
558
- /** @description Organization ID to scope the badge listing to. */
559
- orgId?: string;
560
- };
561
- header?: never;
562
- path?: never;
563
- cookie?: never;
564
- };
565
- requestBody?: never;
566
- responses: {
567
- /** @description Available badges */
568
- 200: {
569
- headers: {
570
- [name: string]: unknown;
571
- };
572
- content: {
573
- "application/json": {
574
- /** @description Available badges, keyed by badge label. */
575
- badges?: {
576
- [key: string]: {
577
- /**
578
- * Format: uuid
579
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
580
- */
581
- id: string;
582
- /**
583
- * Format: uuid
584
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
585
- */
586
- orgId: string;
587
- /**
588
- * @description Unique identifier for the badge, typically slug-style (auto generated).
589
- * @example Kubernetes-Expert
590
- */
591
- label: string;
592
- /**
593
- * @description Concise descriptor for the badge or certificate.
594
- * @example Kubernetes Expert
595
- */
596
- name: string;
597
- /**
598
- * @description A description of the milestone achieved, often including criteria for receiving this recognition.
599
- * @example Awarded for mastering Kubernetes concepts and practices.
600
- */
601
- description: string;
602
- /**
603
- * Format: uri
604
- * @description URL to the badge image.
605
- * @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
606
- */
607
- imageUrl: string;
608
- /**
609
- * Format: date-time
610
- * @description Timestamp when the badge was created.
611
- */
612
- createdAt: string;
613
- /**
614
- * Format: date-time
615
- * @description Timestamp when the badge was last updated.
616
- */
617
- updatedAt: string;
618
- /**
619
- * Format: date-time
620
- * @description Timestamp when the badge was soft-deleted, if applicable.
621
- */
622
- deletedAt: string;
623
- };
624
- };
625
- };
626
- };
627
- };
628
- /** @description Invalid request body or request param */
629
- 400: {
630
- headers: {
631
- [name: string]: unknown;
632
- };
633
- content: {
634
- "text/plain": string;
635
- };
636
- };
637
- /** @description Expired JWT token used or insufficient privilege */
638
- 401: {
639
- headers: {
640
- [name: string]: unknown;
641
- };
642
- content: {
643
- "text/plain": string;
644
- };
645
- };
646
- /** @description Internal server error */
647
- 500: {
648
- headers: {
649
- [name: string]: unknown;
650
- };
651
- content: {
652
- "text/plain": string;
653
- };
654
- };
537
+ };
538
+ /** Internal server error */
539
+ 500: {
540
+ content: {
541
+ "text/plain": string;
655
542
  };
543
+ };
656
544
  };
657
- assignBadges: {
658
- parameters: {
659
- query?: never;
660
- header?: never;
661
- path?: never;
662
- cookie?: never;
663
- };
664
- requestBody: {
665
- content: {
666
- "application/json": {
667
- /** @description Labels of the badges being assigned to the user. */
668
- badges: string[];
669
- /**
670
- * Format: uuid
671
- * @description ID of the user to receive the badges.
672
- */
673
- userId: string;
674
- /** @description When true, send a notification to the user about the new badge assignment. */
675
- notify?: boolean;
676
- };
677
- };
678
- };
679
- responses: {
680
- /** @description Badge assignment result */
681
- 200: {
682
- headers: {
683
- [name: string]: unknown;
684
- };
685
- content: {
686
- "application/json": {
687
- [key: string]: unknown;
688
- };
689
- };
690
- };
691
- /** @description Invalid request body or request param */
692
- 400: {
693
- headers: {
694
- [name: string]: unknown;
695
- };
696
- content: {
697
- "text/plain": string;
698
- };
699
- };
700
- /** @description Expired JWT token used or insufficient privilege */
701
- 401: {
702
- headers: {
703
- [name: string]: unknown;
704
- };
705
- content: {
706
- "text/plain": string;
707
- };
708
- };
709
- /** @description Internal server error */
710
- 500: {
711
- headers: {
712
- [name: string]: unknown;
713
- };
714
- content: {
715
- "text/plain": string;
716
- };
717
- };
545
+ requestBody: {
546
+ content: {
547
+ "application/json": {
548
+ /** @description Labels of the badges being assigned to the user. */
549
+ badges: string[];
550
+ /**
551
+ * Format: uuid
552
+ * @description ID of the user to receive the badges.
553
+ */
554
+ userId: string;
555
+ /** @description When true, send a notification to the user about the new badge assignment. */
556
+ notify?: boolean;
718
557
  };
558
+ };
719
559
  };
560
+ };
720
561
  }
562
+
563
+ export interface external {}