@meshery/schemas 1.2.22 → 1.3.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.
- 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,407 +4,125 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
/** Gets a team by its ID */
|
|
15
|
-
get: operations["getTeamById"];
|
|
16
|
-
/** Updates a team's information */
|
|
17
|
-
put: operations["updateTeam"];
|
|
18
|
-
/** Deletes a team by its ID */
|
|
19
|
-
delete: operations["deleteTeam"];
|
|
20
|
-
};
|
|
21
|
-
"/api/identity/teams/{teamId}/users": {
|
|
22
|
-
/** Gets all users that belong to a team */
|
|
23
|
-
get: operations["getTeamUsers"];
|
|
24
|
-
};
|
|
25
|
-
"/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}": {
|
|
26
|
-
/** Assigns a user to a team */
|
|
27
|
-
post: operations["addUserToTeam"];
|
|
28
|
-
/** Unassigns a user from a team */
|
|
29
|
-
delete: operations["removeUserFromTeam"];
|
|
30
|
-
};
|
|
31
|
-
"/api/identity/orgs/{orgId}/teams/{teamId}/users": {
|
|
32
|
-
get: operations["listUsersNotInTeam"];
|
|
33
|
-
};
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
export interface components {
|
|
37
|
-
schemas: {
|
|
38
|
-
/** @description A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams */
|
|
39
|
-
Team: {
|
|
40
|
-
/**
|
|
41
|
-
* Format: uuid
|
|
42
|
-
* @description Team ID
|
|
43
|
-
*/
|
|
44
|
-
id: string;
|
|
45
|
-
/** @description Team name */
|
|
46
|
-
name: string;
|
|
47
|
-
/** @description Team description */
|
|
48
|
-
description?: string;
|
|
49
|
-
/**
|
|
50
|
-
* Format: uuid
|
|
51
|
-
* @description User ID of the owner of the team
|
|
52
|
-
*/
|
|
53
|
-
owner?: string;
|
|
54
|
-
/** @description Additional metadata for the team */
|
|
55
|
-
metadata?: { [key: string]: unknown };
|
|
56
|
-
/**
|
|
57
|
-
* Format: date-time
|
|
58
|
-
* @description Timestamp when the team was created.
|
|
59
|
-
*/
|
|
60
|
-
createdAt: string;
|
|
61
|
-
/**
|
|
62
|
-
* Format: date-time
|
|
63
|
-
* @description Timestamp when the team was last updated.
|
|
64
|
-
*/
|
|
65
|
-
updatedAt: string;
|
|
66
|
-
/**
|
|
67
|
-
* Format: date-time
|
|
68
|
-
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
69
|
-
*/
|
|
70
|
-
deletedAt?: string;
|
|
71
|
-
};
|
|
72
|
-
/** @description Payload for creating a new team */
|
|
73
|
-
TeamPayload: {
|
|
74
|
-
/** @description Team name. Provide a meaningful name that represents this team. */
|
|
75
|
-
name: string;
|
|
76
|
-
/** @description A detailed description of the team's purpose and responsibilities. */
|
|
77
|
-
description?: string;
|
|
78
|
-
};
|
|
79
|
-
/** @description Payload for updating an existing team */
|
|
80
|
-
TeamUpdatePayload: {
|
|
81
|
-
/** @description Updated team name */
|
|
82
|
-
name?: string;
|
|
83
|
-
/** @description Updated team description */
|
|
84
|
-
description?: string;
|
|
85
|
-
};
|
|
86
|
-
/** @description Paginated list of teams */
|
|
87
|
-
TeamPage: {
|
|
88
|
-
/** @description Current page number of the result set. */
|
|
89
|
-
page?: number;
|
|
90
|
-
/** @description Number of items per page. */
|
|
91
|
-
page_size?: number;
|
|
92
|
-
/** @description Total number of items available. */
|
|
93
|
-
total_count?: number;
|
|
94
|
-
/** @description The teams of the teampage. */
|
|
95
|
-
teams?: {
|
|
96
|
-
/**
|
|
97
|
-
* Format: uuid
|
|
98
|
-
* @description Team ID
|
|
99
|
-
*/
|
|
100
|
-
id: string;
|
|
101
|
-
/** @description Team name */
|
|
102
|
-
name: string;
|
|
103
|
-
/** @description Team description */
|
|
104
|
-
description?: string;
|
|
105
|
-
/**
|
|
106
|
-
* Format: uuid
|
|
107
|
-
* @description User ID of the owner of the team
|
|
108
|
-
*/
|
|
109
|
-
owner?: string;
|
|
110
|
-
/** @description Additional metadata for the team */
|
|
111
|
-
metadata?: { [key: string]: unknown };
|
|
112
|
-
/**
|
|
113
|
-
* Format: date-time
|
|
114
|
-
* @description Timestamp when the team was created.
|
|
115
|
-
*/
|
|
116
|
-
createdAt: string;
|
|
7
|
+
"/api/identity/orgs/{orgId}/teams": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
117
14
|
/**
|
|
118
|
-
*
|
|
119
|
-
* @description
|
|
15
|
+
* Get all teams for an organization
|
|
16
|
+
* @description Gets all teams within an organization
|
|
120
17
|
*/
|
|
121
|
-
|
|
18
|
+
get: operations["getTeams"];
|
|
19
|
+
put?: never;
|
|
122
20
|
/**
|
|
123
|
-
*
|
|
124
|
-
* @description
|
|
21
|
+
* Create a team
|
|
22
|
+
* @description Creates a new team within an organization
|
|
125
23
|
*/
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
id?: string;
|
|
133
|
-
/**
|
|
134
|
-
* Format: uuid
|
|
135
|
-
* @description Team ID
|
|
136
|
-
*/
|
|
137
|
-
teamId?: string;
|
|
138
|
-
/**
|
|
139
|
-
* Format: uuid
|
|
140
|
-
* @description User ID
|
|
141
|
-
*/
|
|
142
|
-
userId?: string;
|
|
143
|
-
/**
|
|
144
|
-
* Format: uuid
|
|
145
|
-
* @description Optional role assigned to this team membership. Nullable because a membership may exist without an explicit role (e.g., team-admin assignments are stamped on insert; non-owner adds may leave `role_id` null until a role is assigned). References `roles.id`.
|
|
146
|
-
*/
|
|
147
|
-
roleId?: string;
|
|
148
|
-
/**
|
|
149
|
-
* Format: date-time
|
|
150
|
-
* @description Timestamp when the mapping was created.
|
|
151
|
-
*/
|
|
152
|
-
createdAt?: string;
|
|
153
|
-
/**
|
|
154
|
-
* Format: date-time
|
|
155
|
-
* @description Timestamp when the mapping was last updated.
|
|
156
|
-
*/
|
|
157
|
-
updatedAt?: string;
|
|
158
|
-
/**
|
|
159
|
-
* Format: date-time
|
|
160
|
-
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
161
|
-
*/
|
|
162
|
-
deletedAt?: string;
|
|
24
|
+
post: operations["createTeam"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
163
30
|
};
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
total_count?: number;
|
|
172
|
-
/** @description The user-team mappings on the current page. */
|
|
173
|
-
usersTeamsMapping?: {
|
|
174
|
-
/** Format: uuid */
|
|
175
|
-
id?: string;
|
|
176
|
-
/**
|
|
177
|
-
* Format: uuid
|
|
178
|
-
* @description Team ID
|
|
179
|
-
*/
|
|
180
|
-
teamId?: string;
|
|
31
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
37
|
+
};
|
|
181
38
|
/**
|
|
182
|
-
*
|
|
183
|
-
* @description
|
|
39
|
+
* Get a team by ID
|
|
40
|
+
* @description Gets a team by its ID
|
|
184
41
|
*/
|
|
185
|
-
|
|
42
|
+
get: operations["getTeamById"];
|
|
186
43
|
/**
|
|
187
|
-
*
|
|
188
|
-
* @description
|
|
44
|
+
* Update a team
|
|
45
|
+
* @description Updates a team's information
|
|
189
46
|
*/
|
|
190
|
-
|
|
47
|
+
put: operations["updateTeam"];
|
|
48
|
+
post?: never;
|
|
191
49
|
/**
|
|
192
|
-
*
|
|
193
|
-
* @description
|
|
50
|
+
* Delete a team
|
|
51
|
+
* @description Deletes a team by its ID
|
|
194
52
|
*/
|
|
195
|
-
|
|
53
|
+
delete: operations["deleteTeam"];
|
|
54
|
+
options?: never;
|
|
55
|
+
head?: never;
|
|
56
|
+
patch?: never;
|
|
57
|
+
trace?: never;
|
|
58
|
+
};
|
|
59
|
+
"/api/identity/teams/{teamId}/users": {
|
|
60
|
+
parameters: {
|
|
61
|
+
query?: never;
|
|
62
|
+
header?: never;
|
|
63
|
+
path?: never;
|
|
64
|
+
cookie?: never;
|
|
65
|
+
};
|
|
196
66
|
/**
|
|
197
|
-
*
|
|
198
|
-
* @description
|
|
67
|
+
* Get all users in a team
|
|
68
|
+
* @description Gets all users that belong to a team
|
|
199
69
|
*/
|
|
200
|
-
|
|
70
|
+
get: operations["getTeamUsers"];
|
|
71
|
+
put?: never;
|
|
72
|
+
post?: never;
|
|
73
|
+
delete?: never;
|
|
74
|
+
options?: never;
|
|
75
|
+
head?: never;
|
|
76
|
+
patch?: never;
|
|
77
|
+
trace?: never;
|
|
78
|
+
};
|
|
79
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}": {
|
|
80
|
+
parameters: {
|
|
81
|
+
query?: never;
|
|
82
|
+
header?: never;
|
|
83
|
+
path?: never;
|
|
84
|
+
cookie?: never;
|
|
85
|
+
};
|
|
86
|
+
get?: never;
|
|
87
|
+
put?: never;
|
|
201
88
|
/**
|
|
202
|
-
*
|
|
203
|
-
* @description
|
|
89
|
+
* Add a user to a team
|
|
90
|
+
* @description Assigns a user to a team
|
|
204
91
|
*/
|
|
205
|
-
|
|
206
|
-
}[];
|
|
207
|
-
};
|
|
208
|
-
/** @description A user who is a prospective or existing team member. Returned by the "list users in team" endpoint. `joinedAt` is the first canonicalised projection field — other user fields (`id`, `firstName`, `lastName`, `email`, `avatarUrl`) continue to flow through `additionalProperties` pending migration of the user schema to the canonical-casing contract. See meshery/schemas#832 for the per-field roadmap. */
|
|
209
|
-
TeamMember: {
|
|
210
|
-
/**
|
|
211
|
-
* Format: date-time
|
|
212
|
-
* @description Timestamp when the user joined the team. Server-computed from the earliest matching row in `users_teams_mapping` for this (team, user) pair. Server-managed; clients cannot set this.
|
|
213
|
-
*/
|
|
214
|
-
joinedAt?: string;
|
|
215
|
-
} & { [key: string]: unknown };
|
|
216
|
-
/** @description Paginated list of team members. */
|
|
217
|
-
TeamMembersPage: {
|
|
218
|
-
/** @description Current page number of the result set. */
|
|
219
|
-
page?: number;
|
|
220
|
-
/** @description Number of items per page. */
|
|
221
|
-
page_size?: number;
|
|
222
|
-
/** @description Total number of items available. */
|
|
223
|
-
total_count?: number;
|
|
224
|
-
/** @description The data of the teammemberspage. */
|
|
225
|
-
data?: ({
|
|
92
|
+
post: operations["addUserToTeam"];
|
|
226
93
|
/**
|
|
227
|
-
*
|
|
228
|
-
* @description
|
|
94
|
+
* Remove a user from a team
|
|
95
|
+
* @description Unassigns a user from a team
|
|
229
96
|
*/
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
/** ok */
|
|
236
|
-
200: {
|
|
237
|
-
content: {
|
|
238
|
-
"text/plain": string;
|
|
239
|
-
};
|
|
240
|
-
};
|
|
241
|
-
/** Invalid request body or request param */
|
|
242
|
-
400: {
|
|
243
|
-
content: {
|
|
244
|
-
"text/plain": string;
|
|
245
|
-
};
|
|
246
|
-
};
|
|
247
|
-
/** Expired JWT token used or insufficient privilege */
|
|
248
|
-
401: {
|
|
249
|
-
content: {
|
|
250
|
-
"text/plain": string;
|
|
251
|
-
};
|
|
252
|
-
};
|
|
253
|
-
/** Result not found */
|
|
254
|
-
404: {
|
|
255
|
-
content: {
|
|
256
|
-
"text/plain": string;
|
|
257
|
-
};
|
|
258
|
-
};
|
|
259
|
-
/** Internal server error */
|
|
260
|
-
500: {
|
|
261
|
-
content: {
|
|
262
|
-
"text/plain": string;
|
|
263
|
-
};
|
|
264
|
-
};
|
|
265
|
-
};
|
|
266
|
-
parameters: {
|
|
267
|
-
/** @description Team ID */
|
|
268
|
-
teamId: string;
|
|
269
|
-
/** @description Organization ID */
|
|
270
|
-
orgId: string;
|
|
271
|
-
/** @description User ID */
|
|
272
|
-
userId: string;
|
|
273
|
-
/** @description Get responses that match search param value */
|
|
274
|
-
search: string;
|
|
275
|
-
/** @description Get ordered responses */
|
|
276
|
-
order: string;
|
|
277
|
-
/** @description Get responses by page */
|
|
278
|
-
page: string;
|
|
279
|
-
/** @description Get responses by pagesize */
|
|
280
|
-
pagesize: string;
|
|
281
|
-
};
|
|
282
|
-
requestBodies: {
|
|
283
|
-
/** Body for creating a team */
|
|
284
|
-
teamPayload: {
|
|
285
|
-
content: {
|
|
286
|
-
"application/json": {
|
|
287
|
-
/** @description Team name. Provide a meaningful name that represents this team. */
|
|
288
|
-
name: string;
|
|
289
|
-
/** @description A detailed description of the team's purpose and responsibilities. */
|
|
290
|
-
description?: string;
|
|
291
|
-
};
|
|
292
|
-
};
|
|
97
|
+
delete: operations["removeUserFromTeam"];
|
|
98
|
+
options?: never;
|
|
99
|
+
head?: never;
|
|
100
|
+
patch?: never;
|
|
101
|
+
trace?: never;
|
|
293
102
|
};
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
103
|
+
"/api/identity/orgs/{orgId}/teams/{teamId}/users": {
|
|
104
|
+
parameters: {
|
|
105
|
+
query?: never;
|
|
106
|
+
header?: never;
|
|
107
|
+
path?: never;
|
|
108
|
+
cookie?: never;
|
|
109
|
+
};
|
|
110
|
+
/** Get users that are not in a team */
|
|
111
|
+
get: operations["listUsersNotInTeam"];
|
|
112
|
+
put?: never;
|
|
113
|
+
post?: never;
|
|
114
|
+
delete?: never;
|
|
115
|
+
options?: never;
|
|
116
|
+
head?: never;
|
|
117
|
+
patch?: never;
|
|
118
|
+
trace?: never;
|
|
304
119
|
};
|
|
305
|
-
};
|
|
306
120
|
}
|
|
307
|
-
|
|
308
|
-
export interface
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
path: {
|
|
313
|
-
/** Organization ID */
|
|
314
|
-
orgId: string;
|
|
315
|
-
};
|
|
316
|
-
query: {
|
|
317
|
-
/** Get responses that match search param value */
|
|
318
|
-
search?: string;
|
|
319
|
-
/** Get ordered responses */
|
|
320
|
-
order?: string;
|
|
321
|
-
/** Get responses by page */
|
|
322
|
-
page?: string;
|
|
323
|
-
/** Get responses by pagesize */
|
|
324
|
-
pagesize?: string;
|
|
325
|
-
};
|
|
326
|
-
};
|
|
327
|
-
responses: {
|
|
328
|
-
/** Teams */
|
|
329
|
-
200: {
|
|
330
|
-
content: {
|
|
331
|
-
"application/json": {
|
|
332
|
-
/** @description Current page number of the result set. */
|
|
333
|
-
page?: number;
|
|
334
|
-
/** @description Number of items per page. */
|
|
335
|
-
page_size?: number;
|
|
336
|
-
/** @description Total number of items available. */
|
|
337
|
-
total_count?: number;
|
|
338
|
-
/** @description The teams of the teampage. */
|
|
339
|
-
teams?: {
|
|
340
|
-
/**
|
|
341
|
-
* Format: uuid
|
|
342
|
-
* @description Team ID
|
|
343
|
-
*/
|
|
344
|
-
id: string;
|
|
345
|
-
/** @description Team name */
|
|
346
|
-
name: string;
|
|
347
|
-
/** @description Team description */
|
|
348
|
-
description?: string;
|
|
349
|
-
/**
|
|
350
|
-
* Format: uuid
|
|
351
|
-
* @description User ID of the owner of the team
|
|
352
|
-
*/
|
|
353
|
-
owner?: string;
|
|
354
|
-
/** @description Additional metadata for the team */
|
|
355
|
-
metadata?: { [key: string]: unknown };
|
|
356
|
-
/**
|
|
357
|
-
* Format: date-time
|
|
358
|
-
* @description Timestamp when the team was created.
|
|
359
|
-
*/
|
|
360
|
-
createdAt: string;
|
|
361
|
-
/**
|
|
362
|
-
* Format: date-time
|
|
363
|
-
* @description Timestamp when the team was last updated.
|
|
364
|
-
*/
|
|
365
|
-
updatedAt: string;
|
|
366
|
-
/**
|
|
367
|
-
* Format: date-time
|
|
368
|
-
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
369
|
-
*/
|
|
370
|
-
deletedAt?: string;
|
|
371
|
-
}[];
|
|
372
|
-
};
|
|
373
|
-
};
|
|
374
|
-
};
|
|
375
|
-
/** Expired JWT token used or insufficient privilege */
|
|
376
|
-
401: {
|
|
377
|
-
content: {
|
|
378
|
-
"text/plain": string;
|
|
379
|
-
};
|
|
380
|
-
};
|
|
381
|
-
/** Result not found */
|
|
382
|
-
404: {
|
|
383
|
-
content: {
|
|
384
|
-
"text/plain": string;
|
|
385
|
-
};
|
|
386
|
-
};
|
|
387
|
-
/** Internal server error */
|
|
388
|
-
500: {
|
|
389
|
-
content: {
|
|
390
|
-
"text/plain": string;
|
|
391
|
-
};
|
|
392
|
-
};
|
|
393
|
-
};
|
|
394
|
-
};
|
|
395
|
-
/** Creates a new team within an organization */
|
|
396
|
-
createTeam: {
|
|
397
|
-
parameters: {
|
|
398
|
-
path: {
|
|
399
|
-
/** Organization ID */
|
|
400
|
-
orgId: string;
|
|
401
|
-
};
|
|
402
|
-
};
|
|
403
|
-
responses: {
|
|
404
|
-
/** Created team */
|
|
405
|
-
201: {
|
|
406
|
-
content: {
|
|
407
|
-
"application/json": {
|
|
121
|
+
export type webhooks = Record<string, never>;
|
|
122
|
+
export interface components {
|
|
123
|
+
schemas: {
|
|
124
|
+
/** @description A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams */
|
|
125
|
+
Team: {
|
|
408
126
|
/**
|
|
409
127
|
* Format: uuid
|
|
410
128
|
* @description Team ID
|
|
@@ -420,7 +138,7 @@ export interface operations {
|
|
|
420
138
|
*/
|
|
421
139
|
owner?: string;
|
|
422
140
|
/** @description Additional metadata for the team */
|
|
423
|
-
metadata?:
|
|
141
|
+
metadata?: Record<string, never>;
|
|
424
142
|
/**
|
|
425
143
|
* Format: date-time
|
|
426
144
|
* @description Timestamp when the team was created.
|
|
@@ -436,356 +154,66 @@ export interface operations {
|
|
|
436
154
|
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
437
155
|
*/
|
|
438
156
|
deletedAt?: string;
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
400: {
|
|
444
|
-
content: {
|
|
445
|
-
"text/plain": string;
|
|
446
|
-
};
|
|
447
|
-
};
|
|
448
|
-
/** Expired JWT token used or insufficient privilege */
|
|
449
|
-
401: {
|
|
450
|
-
content: {
|
|
451
|
-
"text/plain": string;
|
|
452
|
-
};
|
|
453
|
-
};
|
|
454
|
-
/** Result not found */
|
|
455
|
-
404: {
|
|
456
|
-
content: {
|
|
457
|
-
"text/plain": string;
|
|
458
|
-
};
|
|
459
|
-
};
|
|
460
|
-
/** Internal server error */
|
|
461
|
-
500: {
|
|
462
|
-
content: {
|
|
463
|
-
"text/plain": string;
|
|
464
|
-
};
|
|
465
|
-
};
|
|
466
|
-
};
|
|
467
|
-
/** Body for creating a team */
|
|
468
|
-
requestBody: {
|
|
469
|
-
content: {
|
|
470
|
-
"application/json": {
|
|
471
|
-
/** @description Team name. Provide a meaningful name that represents this team. */
|
|
472
|
-
name: string;
|
|
473
|
-
/** @description A detailed description of the team's purpose and responsibilities. */
|
|
474
|
-
description?: string;
|
|
475
|
-
};
|
|
476
|
-
};
|
|
477
|
-
};
|
|
478
|
-
};
|
|
479
|
-
/** Gets a team by its ID */
|
|
480
|
-
getTeamById: {
|
|
481
|
-
parameters: {
|
|
482
|
-
path: {
|
|
483
|
-
/** Organization ID */
|
|
484
|
-
orgId: string;
|
|
485
|
-
/** Team ID */
|
|
486
|
-
teamId: string;
|
|
487
|
-
};
|
|
488
|
-
};
|
|
489
|
-
responses: {
|
|
490
|
-
/** Team */
|
|
491
|
-
200: {
|
|
492
|
-
content: {
|
|
493
|
-
"application/json": {
|
|
494
|
-
/**
|
|
495
|
-
* Format: uuid
|
|
496
|
-
* @description Team ID
|
|
497
|
-
*/
|
|
498
|
-
id: string;
|
|
499
|
-
/** @description Team name */
|
|
157
|
+
};
|
|
158
|
+
/** @description Payload for creating a new team */
|
|
159
|
+
TeamPayload: {
|
|
160
|
+
/** @description Team name. Provide a meaningful name that represents this team. */
|
|
500
161
|
name: string;
|
|
501
|
-
/** @description
|
|
162
|
+
/** @description A detailed description of the team's purpose and responsibilities. */
|
|
502
163
|
description?: string;
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
/** @description
|
|
509
|
-
metadata?: { [key: string]: unknown };
|
|
510
|
-
/**
|
|
511
|
-
* Format: date-time
|
|
512
|
-
* @description Timestamp when the team was created.
|
|
513
|
-
*/
|
|
514
|
-
createdAt: string;
|
|
515
|
-
/**
|
|
516
|
-
* Format: date-time
|
|
517
|
-
* @description Timestamp when the team was last updated.
|
|
518
|
-
*/
|
|
519
|
-
updatedAt: string;
|
|
520
|
-
/**
|
|
521
|
-
* Format: date-time
|
|
522
|
-
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
523
|
-
*/
|
|
524
|
-
deletedAt?: string;
|
|
525
|
-
};
|
|
526
|
-
};
|
|
527
|
-
};
|
|
528
|
-
/** Invalid request body or request param */
|
|
529
|
-
400: {
|
|
530
|
-
content: {
|
|
531
|
-
"text/plain": string;
|
|
532
|
-
};
|
|
533
|
-
};
|
|
534
|
-
/** Expired JWT token used or insufficient privilege */
|
|
535
|
-
401: {
|
|
536
|
-
content: {
|
|
537
|
-
"text/plain": string;
|
|
538
|
-
};
|
|
539
|
-
};
|
|
540
|
-
/** Result not found */
|
|
541
|
-
404: {
|
|
542
|
-
content: {
|
|
543
|
-
"text/plain": string;
|
|
544
|
-
};
|
|
545
|
-
};
|
|
546
|
-
/** Internal server error */
|
|
547
|
-
500: {
|
|
548
|
-
content: {
|
|
549
|
-
"text/plain": string;
|
|
550
|
-
};
|
|
551
|
-
};
|
|
552
|
-
};
|
|
553
|
-
};
|
|
554
|
-
/** Updates a team's information */
|
|
555
|
-
updateTeam: {
|
|
556
|
-
parameters: {
|
|
557
|
-
path: {
|
|
558
|
-
/** Organization ID */
|
|
559
|
-
orgId: string;
|
|
560
|
-
/** Team ID */
|
|
561
|
-
teamId: string;
|
|
562
|
-
};
|
|
563
|
-
};
|
|
564
|
-
responses: {
|
|
565
|
-
/** Updated team */
|
|
566
|
-
200: {
|
|
567
|
-
content: {
|
|
568
|
-
"application/json": {
|
|
569
|
-
/**
|
|
570
|
-
* Format: uuid
|
|
571
|
-
* @description Team ID
|
|
572
|
-
*/
|
|
573
|
-
id: string;
|
|
574
|
-
/** @description Team name */
|
|
575
|
-
name: string;
|
|
576
|
-
/** @description Team description */
|
|
164
|
+
};
|
|
165
|
+
/** @description Payload for updating an existing team */
|
|
166
|
+
TeamUpdatePayload: {
|
|
167
|
+
/** @description Updated team name */
|
|
168
|
+
name?: string;
|
|
169
|
+
/** @description Updated team description */
|
|
577
170
|
description?: string;
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
*/
|
|
582
|
-
owner?: string;
|
|
583
|
-
/** @description Additional metadata for the team */
|
|
584
|
-
metadata?: { [key: string]: unknown };
|
|
585
|
-
/**
|
|
586
|
-
* Format: date-time
|
|
587
|
-
* @description Timestamp when the team was created.
|
|
588
|
-
*/
|
|
589
|
-
createdAt: string;
|
|
590
|
-
/**
|
|
591
|
-
* Format: date-time
|
|
592
|
-
* @description Timestamp when the team was last updated.
|
|
593
|
-
*/
|
|
594
|
-
updatedAt: string;
|
|
595
|
-
/**
|
|
596
|
-
* Format: date-time
|
|
597
|
-
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
598
|
-
*/
|
|
599
|
-
deletedAt?: string;
|
|
600
|
-
};
|
|
601
|
-
};
|
|
602
|
-
};
|
|
603
|
-
/** Invalid request body or request param */
|
|
604
|
-
400: {
|
|
605
|
-
content: {
|
|
606
|
-
"text/plain": string;
|
|
607
|
-
};
|
|
608
|
-
};
|
|
609
|
-
/** Expired JWT token used or insufficient privilege */
|
|
610
|
-
401: {
|
|
611
|
-
content: {
|
|
612
|
-
"text/plain": string;
|
|
613
|
-
};
|
|
614
|
-
};
|
|
615
|
-
/** Result not found */
|
|
616
|
-
404: {
|
|
617
|
-
content: {
|
|
618
|
-
"text/plain": string;
|
|
619
|
-
};
|
|
620
|
-
};
|
|
621
|
-
/** Internal server error */
|
|
622
|
-
500: {
|
|
623
|
-
content: {
|
|
624
|
-
"text/plain": string;
|
|
625
|
-
};
|
|
626
|
-
};
|
|
627
|
-
};
|
|
628
|
-
/** Body for updating a team */
|
|
629
|
-
requestBody: {
|
|
630
|
-
content: {
|
|
631
|
-
"application/json": {
|
|
632
|
-
/** @description Updated team name */
|
|
633
|
-
name?: string;
|
|
634
|
-
/** @description Updated team description */
|
|
635
|
-
description?: string;
|
|
636
|
-
};
|
|
637
|
-
};
|
|
638
|
-
};
|
|
639
|
-
};
|
|
640
|
-
/** Deletes a team by its ID */
|
|
641
|
-
deleteTeam: {
|
|
642
|
-
parameters: {
|
|
643
|
-
path: {
|
|
644
|
-
/** Organization ID */
|
|
645
|
-
orgId: string;
|
|
646
|
-
/** Team ID */
|
|
647
|
-
teamId: string;
|
|
648
|
-
};
|
|
649
|
-
};
|
|
650
|
-
responses: {
|
|
651
|
-
/** Team deleted */
|
|
652
|
-
204: never;
|
|
653
|
-
/** Invalid request body or request param */
|
|
654
|
-
400: {
|
|
655
|
-
content: {
|
|
656
|
-
"text/plain": string;
|
|
657
|
-
};
|
|
658
|
-
};
|
|
659
|
-
/** Expired JWT token used or insufficient privilege */
|
|
660
|
-
401: {
|
|
661
|
-
content: {
|
|
662
|
-
"text/plain": string;
|
|
663
|
-
};
|
|
664
|
-
};
|
|
665
|
-
/** Result not found */
|
|
666
|
-
404: {
|
|
667
|
-
content: {
|
|
668
|
-
"text/plain": string;
|
|
669
|
-
};
|
|
670
|
-
};
|
|
671
|
-
/** Internal server error */
|
|
672
|
-
500: {
|
|
673
|
-
content: {
|
|
674
|
-
"text/plain": string;
|
|
675
|
-
};
|
|
676
|
-
};
|
|
677
|
-
};
|
|
678
|
-
};
|
|
679
|
-
/** Gets all users that belong to a team */
|
|
680
|
-
getTeamUsers: {
|
|
681
|
-
parameters: {
|
|
682
|
-
path: {
|
|
683
|
-
/** Team ID */
|
|
684
|
-
teamId: string;
|
|
685
|
-
};
|
|
686
|
-
query: {
|
|
687
|
-
/** Get responses that match search param value */
|
|
688
|
-
search?: string;
|
|
689
|
-
/** Get ordered responses */
|
|
690
|
-
order?: string;
|
|
691
|
-
/** Get responses by page */
|
|
692
|
-
page?: string;
|
|
693
|
-
/** Get responses by pagesize */
|
|
694
|
-
pagesize?: string;
|
|
695
|
-
};
|
|
696
|
-
};
|
|
697
|
-
responses: {
|
|
698
|
-
/** Team users mapping */
|
|
699
|
-
200: {
|
|
700
|
-
content: {
|
|
701
|
-
"application/json": {
|
|
171
|
+
};
|
|
172
|
+
/** @description Paginated list of teams */
|
|
173
|
+
TeamPage: {
|
|
702
174
|
/** @description Current page number of the result set. */
|
|
703
175
|
page?: number;
|
|
704
176
|
/** @description Number of items per page. */
|
|
705
177
|
page_size?: number;
|
|
706
178
|
/** @description Total number of items available. */
|
|
707
179
|
total_count?: number;
|
|
708
|
-
/** @description The
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
deletedAt?: string;
|
|
180
|
+
/** @description The teams of the teampage. */
|
|
181
|
+
teams?: {
|
|
182
|
+
/**
|
|
183
|
+
* Format: uuid
|
|
184
|
+
* @description Team ID
|
|
185
|
+
*/
|
|
186
|
+
id: string;
|
|
187
|
+
/** @description Team name */
|
|
188
|
+
name: string;
|
|
189
|
+
/** @description Team description */
|
|
190
|
+
description?: string;
|
|
191
|
+
/**
|
|
192
|
+
* Format: uuid
|
|
193
|
+
* @description User ID of the owner of the team
|
|
194
|
+
*/
|
|
195
|
+
owner?: string;
|
|
196
|
+
/** @description Additional metadata for the team */
|
|
197
|
+
metadata?: Record<string, never>;
|
|
198
|
+
/**
|
|
199
|
+
* Format: date-time
|
|
200
|
+
* @description Timestamp when the team was created.
|
|
201
|
+
*/
|
|
202
|
+
createdAt: string;
|
|
203
|
+
/**
|
|
204
|
+
* Format: date-time
|
|
205
|
+
* @description Timestamp when the team was last updated.
|
|
206
|
+
*/
|
|
207
|
+
updatedAt: string;
|
|
208
|
+
/**
|
|
209
|
+
* Format: date-time
|
|
210
|
+
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
211
|
+
*/
|
|
212
|
+
deletedAt?: string;
|
|
742
213
|
}[];
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
/** Invalid request body or request param */
|
|
747
|
-
400: {
|
|
748
|
-
content: {
|
|
749
|
-
"text/plain": string;
|
|
750
|
-
};
|
|
751
|
-
};
|
|
752
|
-
/** Expired JWT token used or insufficient privilege */
|
|
753
|
-
401: {
|
|
754
|
-
content: {
|
|
755
|
-
"text/plain": string;
|
|
756
|
-
};
|
|
757
|
-
};
|
|
758
|
-
/** Result not found */
|
|
759
|
-
404: {
|
|
760
|
-
content: {
|
|
761
|
-
"text/plain": string;
|
|
762
|
-
};
|
|
763
|
-
};
|
|
764
|
-
/** Internal server error */
|
|
765
|
-
500: {
|
|
766
|
-
content: {
|
|
767
|
-
"text/plain": string;
|
|
768
|
-
};
|
|
769
|
-
};
|
|
770
|
-
};
|
|
771
|
-
};
|
|
772
|
-
/** Assigns a user to a team */
|
|
773
|
-
addUserToTeam: {
|
|
774
|
-
parameters: {
|
|
775
|
-
path: {
|
|
776
|
-
/** Organization ID */
|
|
777
|
-
orgId: string;
|
|
778
|
-
/** Team ID */
|
|
779
|
-
teamId: string;
|
|
780
|
-
/** User ID */
|
|
781
|
-
userId: string;
|
|
782
|
-
};
|
|
783
|
-
};
|
|
784
|
-
responses: {
|
|
785
|
-
/** User added to team */
|
|
786
|
-
201: {
|
|
787
|
-
content: {
|
|
788
|
-
"application/json": {
|
|
214
|
+
};
|
|
215
|
+
/** @description Join row between users and teams. The schema name is `UsersTeamsMapping` (rather than `TeamsUsersMapping`) so that pop's tableize default produces the live DB table name `users_teams_mappings`, eliminating the need for an explicit `TableName()` helper on the generated Go struct. */
|
|
216
|
+
UsersTeamsMapping: {
|
|
789
217
|
/** Format: uuid */
|
|
790
218
|
id?: string;
|
|
791
219
|
/**
|
|
@@ -818,100 +246,63 @@ export interface operations {
|
|
|
818
246
|
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
819
247
|
*/
|
|
820
248
|
deletedAt?: string;
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
};
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
404: {
|
|
879
|
-
content: {
|
|
880
|
-
"text/plain": string;
|
|
881
|
-
};
|
|
882
|
-
};
|
|
883
|
-
/** Internal server error */
|
|
884
|
-
500: {
|
|
885
|
-
content: {
|
|
886
|
-
"text/plain": string;
|
|
887
|
-
};
|
|
888
|
-
};
|
|
889
|
-
};
|
|
890
|
-
};
|
|
891
|
-
listUsersNotInTeam: {
|
|
892
|
-
parameters: {
|
|
893
|
-
path: {
|
|
894
|
-
/** Organization ID */
|
|
895
|
-
orgId: string;
|
|
896
|
-
/** Team ID */
|
|
897
|
-
teamId: string;
|
|
898
|
-
};
|
|
899
|
-
query: {
|
|
900
|
-
/** Get responses that match search param value */
|
|
901
|
-
search?: string;
|
|
902
|
-
/** Get ordered responses */
|
|
903
|
-
order?: string;
|
|
904
|
-
/** Get responses by page */
|
|
905
|
-
page?: string;
|
|
906
|
-
/** Get responses by pagesize */
|
|
907
|
-
pagesize?: string;
|
|
908
|
-
};
|
|
909
|
-
};
|
|
910
|
-
responses: {
|
|
911
|
-
/** Users not currently in the team */
|
|
912
|
-
200: {
|
|
913
|
-
content: {
|
|
914
|
-
"application/json": {
|
|
249
|
+
};
|
|
250
|
+
/** @description Paginated list of user-team mappings */
|
|
251
|
+
UsersTeamsMappingPage: {
|
|
252
|
+
/** @description Current page number of the result set. */
|
|
253
|
+
page?: number;
|
|
254
|
+
/** @description Number of items per page. */
|
|
255
|
+
page_size?: number;
|
|
256
|
+
/** @description Total number of items available. */
|
|
257
|
+
total_count?: number;
|
|
258
|
+
/** @description The user-team mappings on the current page. */
|
|
259
|
+
usersTeamsMapping?: {
|
|
260
|
+
/** Format: uuid */
|
|
261
|
+
id?: string;
|
|
262
|
+
/**
|
|
263
|
+
* Format: uuid
|
|
264
|
+
* @description Team ID
|
|
265
|
+
*/
|
|
266
|
+
teamId?: string;
|
|
267
|
+
/**
|
|
268
|
+
* Format: uuid
|
|
269
|
+
* @description User ID
|
|
270
|
+
*/
|
|
271
|
+
userId?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Format: uuid
|
|
274
|
+
* @description Optional role assigned to this team membership. Nullable because a membership may exist without an explicit role (e.g., team-admin assignments are stamped on insert; non-owner adds may leave `role_id` null until a role is assigned). References `roles.id`.
|
|
275
|
+
*/
|
|
276
|
+
roleId?: string;
|
|
277
|
+
/**
|
|
278
|
+
* Format: date-time
|
|
279
|
+
* @description Timestamp when the mapping was created.
|
|
280
|
+
*/
|
|
281
|
+
createdAt?: string;
|
|
282
|
+
/**
|
|
283
|
+
* Format: date-time
|
|
284
|
+
* @description Timestamp when the mapping was last updated.
|
|
285
|
+
*/
|
|
286
|
+
updatedAt?: string;
|
|
287
|
+
/**
|
|
288
|
+
* Format: date-time
|
|
289
|
+
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
290
|
+
*/
|
|
291
|
+
deletedAt?: string;
|
|
292
|
+
}[];
|
|
293
|
+
};
|
|
294
|
+
/** @description A user who is a prospective or existing team member. Returned by the "list users in team" endpoint. `joinedAt` is the first canonicalised projection field — other user fields (`id`, `firstName`, `lastName`, `email`, `avatarUrl`) continue to flow through `additionalProperties` pending migration of the user schema to the canonical-casing contract. See meshery/schemas#832 for the per-field roadmap. */
|
|
295
|
+
TeamMember: {
|
|
296
|
+
/**
|
|
297
|
+
* Format: date-time
|
|
298
|
+
* @description Timestamp when the user joined the team. Server-computed from the earliest matching row in `users_teams_mapping` for this (team, user) pair. Server-managed; clients cannot set this.
|
|
299
|
+
*/
|
|
300
|
+
joinedAt?: string;
|
|
301
|
+
} & {
|
|
302
|
+
[key: string]: unknown;
|
|
303
|
+
};
|
|
304
|
+
/** @description Paginated list of team members. */
|
|
305
|
+
TeamMembersPage: {
|
|
915
306
|
/** @description Current page number of the result set. */
|
|
916
307
|
page?: number;
|
|
917
308
|
/** @description Number of items per page. */
|
|
@@ -920,41 +311,916 @@ export interface operations {
|
|
|
920
311
|
total_count?: number;
|
|
921
312
|
/** @description The data of the teammemberspage. */
|
|
922
313
|
data?: ({
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
} & {
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
};
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
314
|
+
/**
|
|
315
|
+
* Format: date-time
|
|
316
|
+
* @description Timestamp when the user joined the team. Server-computed from the earliest matching row in `users_teams_mapping` for this (team, user) pair. Server-managed; clients cannot set this.
|
|
317
|
+
*/
|
|
318
|
+
joinedAt?: string;
|
|
319
|
+
} & {
|
|
320
|
+
[key: string]: unknown;
|
|
321
|
+
})[];
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
responses: {
|
|
325
|
+
/** @description ok */
|
|
326
|
+
200: {
|
|
327
|
+
headers: {
|
|
328
|
+
[name: string]: unknown;
|
|
329
|
+
};
|
|
330
|
+
content: {
|
|
331
|
+
"text/plain": string;
|
|
332
|
+
};
|
|
333
|
+
};
|
|
334
|
+
/** @description Invalid request body or request param */
|
|
335
|
+
400: {
|
|
336
|
+
headers: {
|
|
337
|
+
[name: string]: unknown;
|
|
338
|
+
};
|
|
339
|
+
content: {
|
|
340
|
+
"text/plain": string;
|
|
341
|
+
};
|
|
342
|
+
};
|
|
343
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
344
|
+
401: {
|
|
345
|
+
headers: {
|
|
346
|
+
[name: string]: unknown;
|
|
347
|
+
};
|
|
348
|
+
content: {
|
|
349
|
+
"text/plain": string;
|
|
350
|
+
};
|
|
351
|
+
};
|
|
352
|
+
/** @description Result not found */
|
|
353
|
+
404: {
|
|
354
|
+
headers: {
|
|
355
|
+
[name: string]: unknown;
|
|
356
|
+
};
|
|
357
|
+
content: {
|
|
358
|
+
"text/plain": string;
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
/** @description Internal server error */
|
|
362
|
+
500: {
|
|
363
|
+
headers: {
|
|
364
|
+
[name: string]: unknown;
|
|
365
|
+
};
|
|
366
|
+
content: {
|
|
367
|
+
"text/plain": string;
|
|
368
|
+
};
|
|
369
|
+
};
|
|
370
|
+
};
|
|
371
|
+
parameters: {
|
|
372
|
+
/** @description Team ID */
|
|
373
|
+
teamId: string;
|
|
374
|
+
/** @description Organization ID */
|
|
375
|
+
orgId: string;
|
|
376
|
+
/** @description User ID */
|
|
377
|
+
userId: string;
|
|
378
|
+
/** @description Get responses that match search param value */
|
|
379
|
+
search: string;
|
|
380
|
+
/** @description Get ordered responses */
|
|
381
|
+
order: string;
|
|
382
|
+
/** @description Get responses by page */
|
|
383
|
+
page: string;
|
|
384
|
+
/** @description Get responses by pagesize */
|
|
385
|
+
pagesize: string;
|
|
386
|
+
};
|
|
387
|
+
requestBodies: {
|
|
388
|
+
/** @description Body for creating a team */
|
|
389
|
+
teamPayload: {
|
|
390
|
+
content: {
|
|
391
|
+
"application/json": {
|
|
392
|
+
/** @description Team name. Provide a meaningful name that represents this team. */
|
|
393
|
+
name: string;
|
|
394
|
+
/** @description A detailed description of the team's purpose and responsibilities. */
|
|
395
|
+
description?: string;
|
|
396
|
+
};
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
/** @description Body for updating a team */
|
|
400
|
+
teamUpdatePayload: {
|
|
401
|
+
content: {
|
|
402
|
+
"application/json": {
|
|
403
|
+
/** @description Updated team name */
|
|
404
|
+
name?: string;
|
|
405
|
+
/** @description Updated team description */
|
|
406
|
+
description?: string;
|
|
407
|
+
};
|
|
408
|
+
};
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
headers: never;
|
|
412
|
+
pathItems: never;
|
|
413
|
+
}
|
|
414
|
+
export type $defs = Record<string, never>;
|
|
415
|
+
export interface operations {
|
|
416
|
+
getTeams: {
|
|
417
|
+
parameters: {
|
|
418
|
+
query?: {
|
|
419
|
+
/** @description Get responses that match search param value */
|
|
420
|
+
search?: string;
|
|
421
|
+
/** @description Get ordered responses */
|
|
422
|
+
order?: string;
|
|
423
|
+
/** @description Get responses by page */
|
|
424
|
+
page?: string;
|
|
425
|
+
/** @description Get responses by pagesize */
|
|
426
|
+
pagesize?: string;
|
|
427
|
+
};
|
|
428
|
+
header?: never;
|
|
429
|
+
path: {
|
|
430
|
+
/** @description Organization ID */
|
|
431
|
+
orgId: string;
|
|
432
|
+
};
|
|
433
|
+
cookie?: never;
|
|
434
|
+
};
|
|
435
|
+
requestBody?: never;
|
|
436
|
+
responses: {
|
|
437
|
+
/** @description Teams */
|
|
438
|
+
200: {
|
|
439
|
+
headers: {
|
|
440
|
+
[name: string]: unknown;
|
|
441
|
+
};
|
|
442
|
+
content: {
|
|
443
|
+
"application/json": {
|
|
444
|
+
/** @description Current page number of the result set. */
|
|
445
|
+
page?: number;
|
|
446
|
+
/** @description Number of items per page. */
|
|
447
|
+
page_size?: number;
|
|
448
|
+
/** @description Total number of items available. */
|
|
449
|
+
total_count?: number;
|
|
450
|
+
/** @description The teams of the teampage. */
|
|
451
|
+
teams?: {
|
|
452
|
+
/**
|
|
453
|
+
* Format: uuid
|
|
454
|
+
* @description Team ID
|
|
455
|
+
*/
|
|
456
|
+
id: string;
|
|
457
|
+
/** @description Team name */
|
|
458
|
+
name: string;
|
|
459
|
+
/** @description Team description */
|
|
460
|
+
description?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Format: uuid
|
|
463
|
+
* @description User ID of the owner of the team
|
|
464
|
+
*/
|
|
465
|
+
owner?: string;
|
|
466
|
+
/** @description Additional metadata for the team */
|
|
467
|
+
metadata?: Record<string, never>;
|
|
468
|
+
/**
|
|
469
|
+
* Format: date-time
|
|
470
|
+
* @description Timestamp when the team was created.
|
|
471
|
+
*/
|
|
472
|
+
createdAt: string;
|
|
473
|
+
/**
|
|
474
|
+
* Format: date-time
|
|
475
|
+
* @description Timestamp when the team was last updated.
|
|
476
|
+
*/
|
|
477
|
+
updatedAt: string;
|
|
478
|
+
/**
|
|
479
|
+
* Format: date-time
|
|
480
|
+
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
481
|
+
*/
|
|
482
|
+
deletedAt?: string;
|
|
483
|
+
}[];
|
|
484
|
+
};
|
|
485
|
+
};
|
|
486
|
+
};
|
|
487
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
488
|
+
401: {
|
|
489
|
+
headers: {
|
|
490
|
+
[name: string]: unknown;
|
|
491
|
+
};
|
|
492
|
+
content: {
|
|
493
|
+
"text/plain": string;
|
|
494
|
+
};
|
|
495
|
+
};
|
|
496
|
+
/** @description Result not found */
|
|
497
|
+
404: {
|
|
498
|
+
headers: {
|
|
499
|
+
[name: string]: unknown;
|
|
500
|
+
};
|
|
501
|
+
content: {
|
|
502
|
+
"text/plain": string;
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
/** @description Internal server error */
|
|
506
|
+
500: {
|
|
507
|
+
headers: {
|
|
508
|
+
[name: string]: unknown;
|
|
509
|
+
};
|
|
510
|
+
content: {
|
|
511
|
+
"text/plain": string;
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
};
|
|
515
|
+
};
|
|
516
|
+
createTeam: {
|
|
517
|
+
parameters: {
|
|
518
|
+
query?: never;
|
|
519
|
+
header?: never;
|
|
520
|
+
path: {
|
|
521
|
+
/** @description Organization ID */
|
|
522
|
+
orgId: string;
|
|
523
|
+
};
|
|
524
|
+
cookie?: never;
|
|
525
|
+
};
|
|
526
|
+
/** @description Body for creating a team */
|
|
527
|
+
requestBody: {
|
|
528
|
+
content: {
|
|
529
|
+
"application/json": {
|
|
530
|
+
/** @description Team name. Provide a meaningful name that represents this team. */
|
|
531
|
+
name: string;
|
|
532
|
+
/** @description A detailed description of the team's purpose and responsibilities. */
|
|
533
|
+
description?: string;
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
};
|
|
537
|
+
responses: {
|
|
538
|
+
/** @description Created team */
|
|
539
|
+
201: {
|
|
540
|
+
headers: {
|
|
541
|
+
[name: string]: unknown;
|
|
542
|
+
};
|
|
543
|
+
content: {
|
|
544
|
+
"application/json": {
|
|
545
|
+
/**
|
|
546
|
+
* Format: uuid
|
|
547
|
+
* @description Team ID
|
|
548
|
+
*/
|
|
549
|
+
id: string;
|
|
550
|
+
/** @description Team name */
|
|
551
|
+
name: string;
|
|
552
|
+
/** @description Team description */
|
|
553
|
+
description?: string;
|
|
554
|
+
/**
|
|
555
|
+
* Format: uuid
|
|
556
|
+
* @description User ID of the owner of the team
|
|
557
|
+
*/
|
|
558
|
+
owner?: string;
|
|
559
|
+
/** @description Additional metadata for the team */
|
|
560
|
+
metadata?: Record<string, never>;
|
|
561
|
+
/**
|
|
562
|
+
* Format: date-time
|
|
563
|
+
* @description Timestamp when the team was created.
|
|
564
|
+
*/
|
|
565
|
+
createdAt: string;
|
|
566
|
+
/**
|
|
567
|
+
* Format: date-time
|
|
568
|
+
* @description Timestamp when the team was last updated.
|
|
569
|
+
*/
|
|
570
|
+
updatedAt: string;
|
|
571
|
+
/**
|
|
572
|
+
* Format: date-time
|
|
573
|
+
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
574
|
+
*/
|
|
575
|
+
deletedAt?: string;
|
|
576
|
+
};
|
|
577
|
+
};
|
|
578
|
+
};
|
|
579
|
+
/** @description Invalid request body or request param */
|
|
580
|
+
400: {
|
|
581
|
+
headers: {
|
|
582
|
+
[name: string]: unknown;
|
|
583
|
+
};
|
|
584
|
+
content: {
|
|
585
|
+
"text/plain": string;
|
|
586
|
+
};
|
|
587
|
+
};
|
|
588
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
589
|
+
401: {
|
|
590
|
+
headers: {
|
|
591
|
+
[name: string]: unknown;
|
|
592
|
+
};
|
|
593
|
+
content: {
|
|
594
|
+
"text/plain": string;
|
|
595
|
+
};
|
|
596
|
+
};
|
|
597
|
+
/** @description Result not found */
|
|
598
|
+
404: {
|
|
599
|
+
headers: {
|
|
600
|
+
[name: string]: unknown;
|
|
601
|
+
};
|
|
602
|
+
content: {
|
|
603
|
+
"text/plain": string;
|
|
604
|
+
};
|
|
605
|
+
};
|
|
606
|
+
/** @description Internal server error */
|
|
607
|
+
500: {
|
|
608
|
+
headers: {
|
|
609
|
+
[name: string]: unknown;
|
|
610
|
+
};
|
|
611
|
+
content: {
|
|
612
|
+
"text/plain": string;
|
|
613
|
+
};
|
|
614
|
+
};
|
|
615
|
+
};
|
|
616
|
+
};
|
|
617
|
+
getTeamById: {
|
|
618
|
+
parameters: {
|
|
619
|
+
query?: never;
|
|
620
|
+
header?: never;
|
|
621
|
+
path: {
|
|
622
|
+
/** @description Organization ID */
|
|
623
|
+
orgId: string;
|
|
624
|
+
/** @description Team ID */
|
|
625
|
+
teamId: string;
|
|
626
|
+
};
|
|
627
|
+
cookie?: never;
|
|
628
|
+
};
|
|
629
|
+
requestBody?: never;
|
|
630
|
+
responses: {
|
|
631
|
+
/** @description Team */
|
|
632
|
+
200: {
|
|
633
|
+
headers: {
|
|
634
|
+
[name: string]: unknown;
|
|
635
|
+
};
|
|
636
|
+
content: {
|
|
637
|
+
"application/json": {
|
|
638
|
+
/**
|
|
639
|
+
* Format: uuid
|
|
640
|
+
* @description Team ID
|
|
641
|
+
*/
|
|
642
|
+
id: string;
|
|
643
|
+
/** @description Team name */
|
|
644
|
+
name: string;
|
|
645
|
+
/** @description Team description */
|
|
646
|
+
description?: string;
|
|
647
|
+
/**
|
|
648
|
+
* Format: uuid
|
|
649
|
+
* @description User ID of the owner of the team
|
|
650
|
+
*/
|
|
651
|
+
owner?: string;
|
|
652
|
+
/** @description Additional metadata for the team */
|
|
653
|
+
metadata?: Record<string, never>;
|
|
654
|
+
/**
|
|
655
|
+
* Format: date-time
|
|
656
|
+
* @description Timestamp when the team was created.
|
|
657
|
+
*/
|
|
658
|
+
createdAt: string;
|
|
659
|
+
/**
|
|
660
|
+
* Format: date-time
|
|
661
|
+
* @description Timestamp when the team was last updated.
|
|
662
|
+
*/
|
|
663
|
+
updatedAt: string;
|
|
664
|
+
/**
|
|
665
|
+
* Format: date-time
|
|
666
|
+
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
667
|
+
*/
|
|
668
|
+
deletedAt?: string;
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
/** @description Invalid request body or request param */
|
|
673
|
+
400: {
|
|
674
|
+
headers: {
|
|
675
|
+
[name: string]: unknown;
|
|
676
|
+
};
|
|
677
|
+
content: {
|
|
678
|
+
"text/plain": string;
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
682
|
+
401: {
|
|
683
|
+
headers: {
|
|
684
|
+
[name: string]: unknown;
|
|
685
|
+
};
|
|
686
|
+
content: {
|
|
687
|
+
"text/plain": string;
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
/** @description Result not found */
|
|
691
|
+
404: {
|
|
692
|
+
headers: {
|
|
693
|
+
[name: string]: unknown;
|
|
694
|
+
};
|
|
695
|
+
content: {
|
|
696
|
+
"text/plain": string;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
/** @description Internal server error */
|
|
700
|
+
500: {
|
|
701
|
+
headers: {
|
|
702
|
+
[name: string]: unknown;
|
|
703
|
+
};
|
|
704
|
+
content: {
|
|
705
|
+
"text/plain": string;
|
|
706
|
+
};
|
|
707
|
+
};
|
|
708
|
+
};
|
|
709
|
+
};
|
|
710
|
+
updateTeam: {
|
|
711
|
+
parameters: {
|
|
712
|
+
query?: never;
|
|
713
|
+
header?: never;
|
|
714
|
+
path: {
|
|
715
|
+
/** @description Organization ID */
|
|
716
|
+
orgId: string;
|
|
717
|
+
/** @description Team ID */
|
|
718
|
+
teamId: string;
|
|
719
|
+
};
|
|
720
|
+
cookie?: never;
|
|
721
|
+
};
|
|
722
|
+
/** @description Body for updating a team */
|
|
723
|
+
requestBody: {
|
|
724
|
+
content: {
|
|
725
|
+
"application/json": {
|
|
726
|
+
/** @description Updated team name */
|
|
727
|
+
name?: string;
|
|
728
|
+
/** @description Updated team description */
|
|
729
|
+
description?: string;
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
};
|
|
733
|
+
responses: {
|
|
734
|
+
/** @description Updated team */
|
|
735
|
+
200: {
|
|
736
|
+
headers: {
|
|
737
|
+
[name: string]: unknown;
|
|
738
|
+
};
|
|
739
|
+
content: {
|
|
740
|
+
"application/json": {
|
|
741
|
+
/**
|
|
742
|
+
* Format: uuid
|
|
743
|
+
* @description Team ID
|
|
744
|
+
*/
|
|
745
|
+
id: string;
|
|
746
|
+
/** @description Team name */
|
|
747
|
+
name: string;
|
|
748
|
+
/** @description Team description */
|
|
749
|
+
description?: string;
|
|
750
|
+
/**
|
|
751
|
+
* Format: uuid
|
|
752
|
+
* @description User ID of the owner of the team
|
|
753
|
+
*/
|
|
754
|
+
owner?: string;
|
|
755
|
+
/** @description Additional metadata for the team */
|
|
756
|
+
metadata?: Record<string, never>;
|
|
757
|
+
/**
|
|
758
|
+
* Format: date-time
|
|
759
|
+
* @description Timestamp when the team was created.
|
|
760
|
+
*/
|
|
761
|
+
createdAt: string;
|
|
762
|
+
/**
|
|
763
|
+
* Format: date-time
|
|
764
|
+
* @description Timestamp when the team was last updated.
|
|
765
|
+
*/
|
|
766
|
+
updatedAt: string;
|
|
767
|
+
/**
|
|
768
|
+
* Format: date-time
|
|
769
|
+
* @description Timestamp when the team was soft-deleted, if applicable.
|
|
770
|
+
*/
|
|
771
|
+
deletedAt?: string;
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
/** @description Invalid request body or request param */
|
|
776
|
+
400: {
|
|
777
|
+
headers: {
|
|
778
|
+
[name: string]: unknown;
|
|
779
|
+
};
|
|
780
|
+
content: {
|
|
781
|
+
"text/plain": string;
|
|
782
|
+
};
|
|
783
|
+
};
|
|
784
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
785
|
+
401: {
|
|
786
|
+
headers: {
|
|
787
|
+
[name: string]: unknown;
|
|
788
|
+
};
|
|
789
|
+
content: {
|
|
790
|
+
"text/plain": string;
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
/** @description Result not found */
|
|
794
|
+
404: {
|
|
795
|
+
headers: {
|
|
796
|
+
[name: string]: unknown;
|
|
797
|
+
};
|
|
798
|
+
content: {
|
|
799
|
+
"text/plain": string;
|
|
800
|
+
};
|
|
801
|
+
};
|
|
802
|
+
/** @description Internal server error */
|
|
803
|
+
500: {
|
|
804
|
+
headers: {
|
|
805
|
+
[name: string]: unknown;
|
|
806
|
+
};
|
|
807
|
+
content: {
|
|
808
|
+
"text/plain": string;
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
};
|
|
813
|
+
deleteTeam: {
|
|
814
|
+
parameters: {
|
|
815
|
+
query?: never;
|
|
816
|
+
header?: never;
|
|
817
|
+
path: {
|
|
818
|
+
/** @description Organization ID */
|
|
819
|
+
orgId: string;
|
|
820
|
+
/** @description Team ID */
|
|
821
|
+
teamId: string;
|
|
822
|
+
};
|
|
823
|
+
cookie?: never;
|
|
824
|
+
};
|
|
825
|
+
requestBody?: never;
|
|
826
|
+
responses: {
|
|
827
|
+
/** @description Team deleted */
|
|
828
|
+
204: {
|
|
829
|
+
headers: {
|
|
830
|
+
[name: string]: unknown;
|
|
831
|
+
};
|
|
832
|
+
content?: never;
|
|
833
|
+
};
|
|
834
|
+
/** @description Invalid request body or request param */
|
|
835
|
+
400: {
|
|
836
|
+
headers: {
|
|
837
|
+
[name: string]: unknown;
|
|
838
|
+
};
|
|
839
|
+
content: {
|
|
840
|
+
"text/plain": string;
|
|
841
|
+
};
|
|
842
|
+
};
|
|
843
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
844
|
+
401: {
|
|
845
|
+
headers: {
|
|
846
|
+
[name: string]: unknown;
|
|
847
|
+
};
|
|
848
|
+
content: {
|
|
849
|
+
"text/plain": string;
|
|
850
|
+
};
|
|
851
|
+
};
|
|
852
|
+
/** @description Result not found */
|
|
853
|
+
404: {
|
|
854
|
+
headers: {
|
|
855
|
+
[name: string]: unknown;
|
|
856
|
+
};
|
|
857
|
+
content: {
|
|
858
|
+
"text/plain": string;
|
|
859
|
+
};
|
|
860
|
+
};
|
|
861
|
+
/** @description Internal server error */
|
|
862
|
+
500: {
|
|
863
|
+
headers: {
|
|
864
|
+
[name: string]: unknown;
|
|
865
|
+
};
|
|
866
|
+
content: {
|
|
867
|
+
"text/plain": string;
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
};
|
|
871
|
+
};
|
|
872
|
+
getTeamUsers: {
|
|
873
|
+
parameters: {
|
|
874
|
+
query?: {
|
|
875
|
+
/** @description Get responses that match search param value */
|
|
876
|
+
search?: string;
|
|
877
|
+
/** @description Get ordered responses */
|
|
878
|
+
order?: string;
|
|
879
|
+
/** @description Get responses by page */
|
|
880
|
+
page?: string;
|
|
881
|
+
/** @description Get responses by pagesize */
|
|
882
|
+
pagesize?: string;
|
|
883
|
+
};
|
|
884
|
+
header?: never;
|
|
885
|
+
path: {
|
|
886
|
+
/** @description Team ID */
|
|
887
|
+
teamId: string;
|
|
888
|
+
};
|
|
889
|
+
cookie?: never;
|
|
890
|
+
};
|
|
891
|
+
requestBody?: never;
|
|
892
|
+
responses: {
|
|
893
|
+
/** @description Team users mapping */
|
|
894
|
+
200: {
|
|
895
|
+
headers: {
|
|
896
|
+
[name: string]: unknown;
|
|
897
|
+
};
|
|
898
|
+
content: {
|
|
899
|
+
"application/json": {
|
|
900
|
+
/** @description Current page number of the result set. */
|
|
901
|
+
page?: number;
|
|
902
|
+
/** @description Number of items per page. */
|
|
903
|
+
page_size?: number;
|
|
904
|
+
/** @description Total number of items available. */
|
|
905
|
+
total_count?: number;
|
|
906
|
+
/** @description The user-team mappings on the current page. */
|
|
907
|
+
usersTeamsMapping?: {
|
|
908
|
+
/** Format: uuid */
|
|
909
|
+
id?: string;
|
|
910
|
+
/**
|
|
911
|
+
* Format: uuid
|
|
912
|
+
* @description Team ID
|
|
913
|
+
*/
|
|
914
|
+
teamId?: string;
|
|
915
|
+
/**
|
|
916
|
+
* Format: uuid
|
|
917
|
+
* @description User ID
|
|
918
|
+
*/
|
|
919
|
+
userId?: string;
|
|
920
|
+
/**
|
|
921
|
+
* Format: uuid
|
|
922
|
+
* @description Optional role assigned to this team membership. Nullable because a membership may exist without an explicit role (e.g., team-admin assignments are stamped on insert; non-owner adds may leave `role_id` null until a role is assigned). References `roles.id`.
|
|
923
|
+
*/
|
|
924
|
+
roleId?: string;
|
|
925
|
+
/**
|
|
926
|
+
* Format: date-time
|
|
927
|
+
* @description Timestamp when the mapping was created.
|
|
928
|
+
*/
|
|
929
|
+
createdAt?: string;
|
|
930
|
+
/**
|
|
931
|
+
* Format: date-time
|
|
932
|
+
* @description Timestamp when the mapping was last updated.
|
|
933
|
+
*/
|
|
934
|
+
updatedAt?: string;
|
|
935
|
+
/**
|
|
936
|
+
* Format: date-time
|
|
937
|
+
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
938
|
+
*/
|
|
939
|
+
deletedAt?: string;
|
|
940
|
+
}[];
|
|
941
|
+
};
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
/** @description Invalid request body or request param */
|
|
945
|
+
400: {
|
|
946
|
+
headers: {
|
|
947
|
+
[name: string]: unknown;
|
|
948
|
+
};
|
|
949
|
+
content: {
|
|
950
|
+
"text/plain": string;
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
954
|
+
401: {
|
|
955
|
+
headers: {
|
|
956
|
+
[name: string]: unknown;
|
|
957
|
+
};
|
|
958
|
+
content: {
|
|
959
|
+
"text/plain": string;
|
|
960
|
+
};
|
|
961
|
+
};
|
|
962
|
+
/** @description Result not found */
|
|
963
|
+
404: {
|
|
964
|
+
headers: {
|
|
965
|
+
[name: string]: unknown;
|
|
966
|
+
};
|
|
967
|
+
content: {
|
|
968
|
+
"text/plain": string;
|
|
969
|
+
};
|
|
970
|
+
};
|
|
971
|
+
/** @description Internal server error */
|
|
972
|
+
500: {
|
|
973
|
+
headers: {
|
|
974
|
+
[name: string]: unknown;
|
|
975
|
+
};
|
|
976
|
+
content: {
|
|
977
|
+
"text/plain": string;
|
|
978
|
+
};
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
addUserToTeam: {
|
|
983
|
+
parameters: {
|
|
984
|
+
query?: never;
|
|
985
|
+
header?: never;
|
|
986
|
+
path: {
|
|
987
|
+
/** @description Organization ID */
|
|
988
|
+
orgId: string;
|
|
989
|
+
/** @description Team ID */
|
|
990
|
+
teamId: string;
|
|
991
|
+
/** @description User ID */
|
|
992
|
+
userId: string;
|
|
993
|
+
};
|
|
994
|
+
cookie?: never;
|
|
995
|
+
};
|
|
996
|
+
requestBody?: never;
|
|
997
|
+
responses: {
|
|
998
|
+
/** @description User added to team */
|
|
999
|
+
201: {
|
|
1000
|
+
headers: {
|
|
1001
|
+
[name: string]: unknown;
|
|
1002
|
+
};
|
|
1003
|
+
content: {
|
|
1004
|
+
"application/json": {
|
|
1005
|
+
/** Format: uuid */
|
|
1006
|
+
id?: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* Format: uuid
|
|
1009
|
+
* @description Team ID
|
|
1010
|
+
*/
|
|
1011
|
+
teamId?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* Format: uuid
|
|
1014
|
+
* @description User ID
|
|
1015
|
+
*/
|
|
1016
|
+
userId?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Format: uuid
|
|
1019
|
+
* @description Optional role assigned to this team membership. Nullable because a membership may exist without an explicit role (e.g., team-admin assignments are stamped on insert; non-owner adds may leave `role_id` null until a role is assigned). References `roles.id`.
|
|
1020
|
+
*/
|
|
1021
|
+
roleId?: string;
|
|
1022
|
+
/**
|
|
1023
|
+
* Format: date-time
|
|
1024
|
+
* @description Timestamp when the mapping was created.
|
|
1025
|
+
*/
|
|
1026
|
+
createdAt?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* Format: date-time
|
|
1029
|
+
* @description Timestamp when the mapping was last updated.
|
|
1030
|
+
*/
|
|
1031
|
+
updatedAt?: string;
|
|
1032
|
+
/**
|
|
1033
|
+
* Format: date-time
|
|
1034
|
+
* @description Timestamp when the mapping was soft-deleted, if applicable.
|
|
1035
|
+
*/
|
|
1036
|
+
deletedAt?: string;
|
|
1037
|
+
};
|
|
1038
|
+
};
|
|
1039
|
+
};
|
|
1040
|
+
/** @description Invalid request body or request param */
|
|
1041
|
+
400: {
|
|
1042
|
+
headers: {
|
|
1043
|
+
[name: string]: unknown;
|
|
1044
|
+
};
|
|
1045
|
+
content: {
|
|
1046
|
+
"text/plain": string;
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1050
|
+
401: {
|
|
1051
|
+
headers: {
|
|
1052
|
+
[name: string]: unknown;
|
|
1053
|
+
};
|
|
1054
|
+
content: {
|
|
1055
|
+
"text/plain": string;
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
/** @description Result not found */
|
|
1059
|
+
404: {
|
|
1060
|
+
headers: {
|
|
1061
|
+
[name: string]: unknown;
|
|
1062
|
+
};
|
|
1063
|
+
content: {
|
|
1064
|
+
"text/plain": string;
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
/** @description Internal server error */
|
|
1068
|
+
500: {
|
|
1069
|
+
headers: {
|
|
1070
|
+
[name: string]: unknown;
|
|
1071
|
+
};
|
|
1072
|
+
content: {
|
|
1073
|
+
"text/plain": string;
|
|
1074
|
+
};
|
|
1075
|
+
};
|
|
1076
|
+
};
|
|
1077
|
+
};
|
|
1078
|
+
removeUserFromTeam: {
|
|
1079
|
+
parameters: {
|
|
1080
|
+
query?: never;
|
|
1081
|
+
header?: never;
|
|
1082
|
+
path: {
|
|
1083
|
+
/** @description Organization ID */
|
|
1084
|
+
orgId: string;
|
|
1085
|
+
/** @description Team ID */
|
|
1086
|
+
teamId: string;
|
|
1087
|
+
/** @description User ID */
|
|
1088
|
+
userId: string;
|
|
1089
|
+
};
|
|
1090
|
+
cookie?: never;
|
|
1091
|
+
};
|
|
1092
|
+
requestBody?: never;
|
|
1093
|
+
responses: {
|
|
1094
|
+
/** @description User removed from team */
|
|
1095
|
+
204: {
|
|
1096
|
+
headers: {
|
|
1097
|
+
[name: string]: unknown;
|
|
1098
|
+
};
|
|
1099
|
+
content?: never;
|
|
1100
|
+
};
|
|
1101
|
+
/** @description Invalid request body or request param */
|
|
1102
|
+
400: {
|
|
1103
|
+
headers: {
|
|
1104
|
+
[name: string]: unknown;
|
|
1105
|
+
};
|
|
1106
|
+
content: {
|
|
1107
|
+
"text/plain": string;
|
|
1108
|
+
};
|
|
1109
|
+
};
|
|
1110
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1111
|
+
401: {
|
|
1112
|
+
headers: {
|
|
1113
|
+
[name: string]: unknown;
|
|
1114
|
+
};
|
|
1115
|
+
content: {
|
|
1116
|
+
"text/plain": string;
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
/** @description Result not found */
|
|
1120
|
+
404: {
|
|
1121
|
+
headers: {
|
|
1122
|
+
[name: string]: unknown;
|
|
1123
|
+
};
|
|
1124
|
+
content: {
|
|
1125
|
+
"text/plain": string;
|
|
1126
|
+
};
|
|
1127
|
+
};
|
|
1128
|
+
/** @description Internal server error */
|
|
1129
|
+
500: {
|
|
1130
|
+
headers: {
|
|
1131
|
+
[name: string]: unknown;
|
|
1132
|
+
};
|
|
1133
|
+
content: {
|
|
1134
|
+
"text/plain": string;
|
|
1135
|
+
};
|
|
1136
|
+
};
|
|
1137
|
+
};
|
|
1138
|
+
};
|
|
1139
|
+
listUsersNotInTeam: {
|
|
1140
|
+
parameters: {
|
|
1141
|
+
query?: {
|
|
1142
|
+
/** @description Get responses that match search param value */
|
|
1143
|
+
search?: string;
|
|
1144
|
+
/** @description Get ordered responses */
|
|
1145
|
+
order?: string;
|
|
1146
|
+
/** @description Get responses by page */
|
|
1147
|
+
page?: string;
|
|
1148
|
+
/** @description Get responses by pagesize */
|
|
1149
|
+
pagesize?: string;
|
|
1150
|
+
};
|
|
1151
|
+
header?: never;
|
|
1152
|
+
path: {
|
|
1153
|
+
/** @description Organization ID */
|
|
1154
|
+
orgId: string;
|
|
1155
|
+
/** @description Team ID */
|
|
1156
|
+
teamId: string;
|
|
1157
|
+
};
|
|
1158
|
+
cookie?: never;
|
|
1159
|
+
};
|
|
1160
|
+
requestBody?: never;
|
|
1161
|
+
responses: {
|
|
1162
|
+
/** @description Users not currently in the team */
|
|
1163
|
+
200: {
|
|
1164
|
+
headers: {
|
|
1165
|
+
[name: string]: unknown;
|
|
1166
|
+
};
|
|
1167
|
+
content: {
|
|
1168
|
+
"application/json": {
|
|
1169
|
+
/** @description Current page number of the result set. */
|
|
1170
|
+
page?: number;
|
|
1171
|
+
/** @description Number of items per page. */
|
|
1172
|
+
page_size?: number;
|
|
1173
|
+
/** @description Total number of items available. */
|
|
1174
|
+
total_count?: number;
|
|
1175
|
+
/** @description The data of the teammemberspage. */
|
|
1176
|
+
data?: ({
|
|
1177
|
+
/**
|
|
1178
|
+
* Format: date-time
|
|
1179
|
+
* @description Timestamp when the user joined the team. Server-computed from the earliest matching row in `users_teams_mapping` for this (team, user) pair. Server-managed; clients cannot set this.
|
|
1180
|
+
*/
|
|
1181
|
+
joinedAt?: string;
|
|
1182
|
+
} & {
|
|
1183
|
+
[key: string]: unknown;
|
|
1184
|
+
})[];
|
|
1185
|
+
};
|
|
1186
|
+
};
|
|
1187
|
+
};
|
|
1188
|
+
/** @description Invalid request body or request param */
|
|
1189
|
+
400: {
|
|
1190
|
+
headers: {
|
|
1191
|
+
[name: string]: unknown;
|
|
1192
|
+
};
|
|
1193
|
+
content: {
|
|
1194
|
+
"text/plain": string;
|
|
1195
|
+
};
|
|
1196
|
+
};
|
|
1197
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1198
|
+
401: {
|
|
1199
|
+
headers: {
|
|
1200
|
+
[name: string]: unknown;
|
|
1201
|
+
};
|
|
1202
|
+
content: {
|
|
1203
|
+
"text/plain": string;
|
|
1204
|
+
};
|
|
1205
|
+
};
|
|
1206
|
+
/** @description Result not found */
|
|
1207
|
+
404: {
|
|
1208
|
+
headers: {
|
|
1209
|
+
[name: string]: unknown;
|
|
1210
|
+
};
|
|
1211
|
+
content: {
|
|
1212
|
+
"text/plain": string;
|
|
1213
|
+
};
|
|
1214
|
+
};
|
|
1215
|
+
/** @description Internal server error */
|
|
1216
|
+
500: {
|
|
1217
|
+
headers: {
|
|
1218
|
+
[name: string]: unknown;
|
|
1219
|
+
};
|
|
1220
|
+
content: {
|
|
1221
|
+
"text/plain": string;
|
|
1222
|
+
};
|
|
1223
|
+
};
|
|
1224
|
+
};
|
|
956
1225
|
};
|
|
957
|
-
};
|
|
958
1226
|
}
|
|
959
|
-
|
|
960
|
-
export interface external {}
|