@meshery/schemas 1.2.22 → 1.2.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,225 +4,86 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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;
|
|
57
|
-
};
|
|
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;
|
|
106
|
-
};
|
|
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;
|
|
7
|
+
"/api/organizations/badges/{badgeId}": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
158
13
|
};
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
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
|
-
};
|
|
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;
|
|
180
24
|
};
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
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;
|
|
186
41
|
};
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
42
|
+
"/api/identity/badges": {
|
|
43
|
+
parameters: {
|
|
44
|
+
query?: never;
|
|
45
|
+
header?: never;
|
|
46
|
+
path?: never;
|
|
47
|
+
cookie?: never;
|
|
48
|
+
};
|
|
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;
|
|
192
58
|
};
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
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;
|
|
198
75
|
};
|
|
199
|
-
};
|
|
200
|
-
parameters: {
|
|
201
|
-
/** @description Badge ID */
|
|
202
|
-
badgeId: string;
|
|
203
|
-
/** @description Organization ID to scope the badge listing to. */
|
|
204
|
-
orgIdQuery: string;
|
|
205
|
-
};
|
|
206
76
|
}
|
|
207
|
-
|
|
208
|
-
export interface
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
/** Badge ID */
|
|
213
|
-
badgeId: string;
|
|
214
|
-
};
|
|
215
|
-
};
|
|
216
|
-
responses: {
|
|
217
|
-
/** Badge response */
|
|
218
|
-
200: {
|
|
219
|
-
content: {
|
|
220
|
-
"application/json": {
|
|
77
|
+
export type webhooks = Record<string, never>;
|
|
78
|
+
export interface components {
|
|
79
|
+
schemas: {
|
|
80
|
+
/** @description Payload for creating or updating a badge. */
|
|
81
|
+
BadgePayload: {
|
|
221
82
|
/**
|
|
222
83
|
* Format: uuid
|
|
223
84
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
224
85
|
*/
|
|
225
|
-
id
|
|
86
|
+
id?: string;
|
|
226
87
|
/**
|
|
227
88
|
* Format: uuid
|
|
228
89
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
@@ -249,80 +110,9 @@ export interface operations {
|
|
|
249
110
|
* @example https://raw.githubusercontent.com/meshery-extensions/meshery-academy/refs/heads/master/.github/assets/images/mershery-icon.png
|
|
250
111
|
*/
|
|
251
112
|
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;
|
|
310
113
|
};
|
|
311
|
-
|
|
312
|
-
|
|
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": {
|
|
114
|
+
/** @description Badge entity — a named recognition issued within an organization. */
|
|
115
|
+
Badge: {
|
|
326
116
|
/**
|
|
327
117
|
* Format: uuid
|
|
328
118
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
@@ -369,195 +159,562 @@ export interface operations {
|
|
|
369
159
|
* @description Timestamp when the badge was soft-deleted, if applicable.
|
|
370
160
|
*/
|
|
371
161
|
deletedAt: string;
|
|
372
|
-
};
|
|
373
162
|
};
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
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
|
+
};
|
|
385
216
|
};
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
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;
|
|
391
228
|
};
|
|
392
|
-
};
|
|
393
229
|
};
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
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
|
+
};
|
|
248
|
+
};
|
|
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
|
+
};
|
|
428
266
|
};
|
|
429
|
-
};
|
|
430
267
|
};
|
|
431
|
-
};
|
|
432
|
-
getAvailableBadges: {
|
|
433
268
|
parameters: {
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
269
|
+
/** @description Badge ID */
|
|
270
|
+
badgeId: string;
|
|
271
|
+
/** @description Organization ID to scope the badge listing to. */
|
|
272
|
+
orgIdQuery: string;
|
|
438
273
|
};
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
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
|
-
};
|
|
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;
|
|
496
289
|
};
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
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
|
+
};
|
|
502
375
|
};
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
376
|
+
};
|
|
377
|
+
deleteBadgeById: {
|
|
378
|
+
parameters: {
|
|
379
|
+
query?: never;
|
|
380
|
+
header?: never;
|
|
381
|
+
path: {
|
|
382
|
+
/** @description Badge ID */
|
|
383
|
+
badgeId: string;
|
|
384
|
+
};
|
|
385
|
+
cookie?: never;
|
|
508
386
|
};
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
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
|
+
};
|
|
514
423
|
};
|
|
515
|
-
};
|
|
516
424
|
};
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
"application/json": { [key: string]: unknown };
|
|
425
|
+
createOrUpdateBadge: {
|
|
426
|
+
parameters: {
|
|
427
|
+
query?: never;
|
|
428
|
+
header?: never;
|
|
429
|
+
path?: never;
|
|
430
|
+
cookie?: never;
|
|
524
431
|
};
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
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
|
+
};
|
|
530
468
|
};
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
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
|
+
};
|
|
536
553
|
};
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
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
|
+
};
|
|
542
655
|
};
|
|
543
|
-
};
|
|
544
656
|
};
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
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
|
+
};
|
|
557
718
|
};
|
|
558
|
-
};
|
|
559
719
|
};
|
|
560
|
-
};
|
|
561
720
|
}
|
|
562
|
-
|
|
563
|
-
export interface external {}
|