@meshery/schemas 0.8.133 → 0.8.134
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/README.md +119 -0
- package/dist/cloudApi.d.mts +5011 -2369
- package/dist/cloudApi.d.ts +5011 -2369
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/badge/Badge.d.mts +37 -18
- package/dist/constructs/v1beta1/badge/Badge.d.ts +37 -18
- package/dist/constructs/v1beta1/badge/BadgeSchema.js +1 -1
- package/dist/constructs/v1beta1/badge/BadgeSchema.mjs +1 -1
- package/dist/constructs/v1beta1/category/Category.d.mts +1 -0
- package/dist/constructs/v1beta1/category/Category.d.ts +1 -0
- package/dist/constructs/v1beta1/category/CategorySchema.js +1 -1
- package/dist/constructs/v1beta1/category/CategorySchema.mjs +1 -1
- package/dist/constructs/v1beta1/component/Component.d.mts +12 -4
- package/dist/constructs/v1beta1/component/Component.d.ts +12 -4
- package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
- package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
- package/dist/constructs/v1beta1/connection/Connection.d.mts +84 -42
- package/dist/constructs/v1beta1/connection/Connection.d.ts +84 -42
- package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta1/environment/Environment.d.mts +65 -22
- package/dist/constructs/v1beta1/environment/Environment.d.ts +65 -22
- package/dist/constructs/v1beta1/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta1/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.mts +48 -16
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +48 -16
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +8 -8
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +8 -8
- package/dist/constructs/v1beta1/event/Event.d.mts +5 -3
- package/dist/constructs/v1beta1/event/Event.d.ts +5 -3
- package/dist/constructs/v1beta1/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta1/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta1/invitation/Invitation.d.mts +56 -54
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +56 -54
- package/dist/constructs/v1beta1/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta1/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta1/key/Key.d.mts +3 -3
- package/dist/constructs/v1beta1/key/Key.d.ts +3 -3
- package/dist/constructs/v1beta1/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta1/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta1/keychain/Keychain.d.mts +12 -36
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +12 -36
- package/dist/constructs/v1beta1/keychain/KeychainSchema.js +1 -1
- package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +1 -1
- package/dist/constructs/v1beta1/model/Model.d.mts +14 -6
- package/dist/constructs/v1beta1/model/Model.d.ts +14 -6
- package/dist/constructs/v1beta1/model/ModelSchema.js +2 -2
- package/dist/constructs/v1beta1/model/ModelSchema.mjs +2 -2
- package/dist/constructs/v1beta1/organization/Organization.d.mts +884 -9
- package/dist/constructs/v1beta1/organization/Organization.d.ts +884 -9
- package/dist/constructs/v1beta1/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta1/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta1/pattern/Pattern.d.mts +113 -39
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +113 -39
- package/dist/constructs/v1beta1/pattern/PatternSchema.js +18 -18
- package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +18 -18
- package/dist/constructs/v1beta1/role/Role.d.mts +17 -17
- package/dist/constructs/v1beta1/role/Role.d.ts +17 -17
- package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta1/team/Team.d.mts +16 -16
- package/dist/constructs/v1beta1/team/Team.d.ts +16 -16
- package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta1/user/User.d.mts +1238 -169
- package/dist/constructs/v1beta1/user/User.d.ts +1238 -169
- package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta1/workspace/Workspace.d.mts +35 -12
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +35 -12
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +4 -4
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +4 -4
- package/dist/index.js +25 -25
- package/dist/index.mjs +25 -25
- package/dist/mesheryApi.d.mts +4226 -1565
- package/dist/mesheryApi.d.ts +4226 -1565
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -3,6 +3,20 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
interface paths {
|
|
6
|
+
"/api/identity/orgs/{orgId}/users": {
|
|
7
|
+
/** Returns organization users, optionally filtered by team membership. */
|
|
8
|
+
get: operations["getUsersForOrg"];
|
|
9
|
+
};
|
|
10
|
+
"/api/users": {
|
|
11
|
+
/** Returns publicly viewable user records. */
|
|
12
|
+
get: operations["getUsers"];
|
|
13
|
+
};
|
|
14
|
+
"/api/identity/users/profile/{id}": {
|
|
15
|
+
get: operations["getUserProfileById"];
|
|
16
|
+
};
|
|
17
|
+
"/api/identity/users/profile": {
|
|
18
|
+
get: operations["getUser"];
|
|
19
|
+
};
|
|
6
20
|
}
|
|
7
21
|
interface components {
|
|
8
22
|
schemas: {
|
|
@@ -102,158 +116,7 @@ interface components {
|
|
|
102
116
|
anonymousUsageStats: boolean;
|
|
103
117
|
anonymousPerfResults: boolean;
|
|
104
118
|
/** Format: date-time */
|
|
105
|
-
updated_at
|
|
106
|
-
dashboardPreferences: {
|
|
107
|
-
[key: string]: unknown;
|
|
108
|
-
};
|
|
109
|
-
selectedOrganizationID: string;
|
|
110
|
-
selectedWorkspaceForOrganizations: {
|
|
111
|
-
[key: string]: string;
|
|
112
|
-
};
|
|
113
|
-
usersExtensionPreferences: {
|
|
114
|
-
[key: string]: unknown;
|
|
115
|
-
};
|
|
116
|
-
remoteProviderPreferences?: {
|
|
117
|
-
[key: string]: unknown;
|
|
118
|
-
};
|
|
119
|
-
} & {
|
|
120
|
-
updatedAt: unknown;
|
|
121
|
-
RemoteProviderPreferences: unknown;
|
|
122
|
-
};
|
|
123
|
-
/**
|
|
124
|
-
* Format: date-time
|
|
125
|
-
* @description Timestamp when user accepted terms and conditions
|
|
126
|
-
*/
|
|
127
|
-
accepted_terms_at?: string;
|
|
128
|
-
/**
|
|
129
|
-
* Format: date-time
|
|
130
|
-
* @description Timestamp of user's first login
|
|
131
|
-
*/
|
|
132
|
-
first_login_time?: string;
|
|
133
|
-
/**
|
|
134
|
-
* Format: date-time
|
|
135
|
-
* @description Timestamp of user's most recent login
|
|
136
|
-
*/
|
|
137
|
-
last_login_time: string;
|
|
138
|
-
/**
|
|
139
|
-
* Format: date-time
|
|
140
|
-
* @description Timestamp when the user record was created
|
|
141
|
-
*/
|
|
142
|
-
created_at: string;
|
|
143
|
-
/**
|
|
144
|
-
* Format: date-time
|
|
145
|
-
* @description Timestamp when the user record was last updated
|
|
146
|
-
*/
|
|
147
|
-
updated_at: string;
|
|
148
|
-
/** @description Various online profiles associated with the user account */
|
|
149
|
-
socials?: {
|
|
150
|
-
site: string;
|
|
151
|
-
/** Format: uri */
|
|
152
|
-
link: string;
|
|
153
|
-
}[];
|
|
154
|
-
/**
|
|
155
|
-
* Format: date-time
|
|
156
|
-
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
157
|
-
*/
|
|
158
|
-
deleted_at: string | null;
|
|
159
|
-
};
|
|
160
|
-
/** @description Response schema for getting user information, includes user data with roles, teams, and organizations */
|
|
161
|
-
GetUserResponse: {
|
|
162
|
-
/**
|
|
163
|
-
* Format: uuid
|
|
164
|
-
* @description Unique identifier for the user
|
|
165
|
-
*/
|
|
166
|
-
id: string;
|
|
167
|
-
/** @description User identifier (username or external ID) */
|
|
168
|
-
user_id: string;
|
|
169
|
-
/**
|
|
170
|
-
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
171
|
-
* @example [
|
|
172
|
-
* "local",
|
|
173
|
-
* "github",
|
|
174
|
-
* "google",
|
|
175
|
-
* "twitter"
|
|
176
|
-
* ]
|
|
177
|
-
*/
|
|
178
|
-
provider: string;
|
|
179
|
-
/**
|
|
180
|
-
* Format: email
|
|
181
|
-
* @description User's email address
|
|
182
|
-
*/
|
|
183
|
-
email: string;
|
|
184
|
-
/** @description User's first name */
|
|
185
|
-
first_name: string;
|
|
186
|
-
/** @description User's last name */
|
|
187
|
-
last_name: string;
|
|
188
|
-
/**
|
|
189
|
-
* Format: uri
|
|
190
|
-
* @description URL to user's avatar image
|
|
191
|
-
*/
|
|
192
|
-
avatar_url?: string;
|
|
193
|
-
/**
|
|
194
|
-
* @description User account status
|
|
195
|
-
* @enum {string}
|
|
196
|
-
*/
|
|
197
|
-
status: "active" | "inactive" | "pending" | "anonymous";
|
|
198
|
-
/**
|
|
199
|
-
* @description User's biography or description
|
|
200
|
-
* @default
|
|
201
|
-
*/
|
|
202
|
-
bio?: string;
|
|
203
|
-
/** @description User's country information stored as JSONB */
|
|
204
|
-
country?: {
|
|
205
|
-
[key: string]: unknown;
|
|
206
|
-
};
|
|
207
|
-
/** @description User's region information stored as JSONB */
|
|
208
|
-
region?: {
|
|
209
|
-
[key: string]: unknown;
|
|
210
|
-
};
|
|
211
|
-
/** @description User preferences stored as JSONB */
|
|
212
|
-
preferences?: {
|
|
213
|
-
meshAdapters?: {
|
|
214
|
-
[key: string]: unknown;
|
|
215
|
-
}[];
|
|
216
|
-
grafana?: {
|
|
217
|
-
grafanaURL?: string;
|
|
218
|
-
grafanaAPIKey?: string;
|
|
219
|
-
selectedBoardsConfigs?: {
|
|
220
|
-
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
221
|
-
board?: {
|
|
222
|
-
[key: string]: unknown;
|
|
223
|
-
};
|
|
224
|
-
panels?: {
|
|
225
|
-
[key: string]: unknown;
|
|
226
|
-
}[];
|
|
227
|
-
templateVars?: string[];
|
|
228
|
-
}[];
|
|
229
|
-
};
|
|
230
|
-
prometheus?: {
|
|
231
|
-
prometheusURL?: string;
|
|
232
|
-
selectedPrometheusBoardsConfigs?: {
|
|
233
|
-
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
234
|
-
board?: {
|
|
235
|
-
[key: string]: unknown;
|
|
236
|
-
};
|
|
237
|
-
panels?: {
|
|
238
|
-
[key: string]: unknown;
|
|
239
|
-
}[];
|
|
240
|
-
templateVars?: string[];
|
|
241
|
-
}[];
|
|
242
|
-
};
|
|
243
|
-
loadTestPrefs?: {
|
|
244
|
-
/** @description Concurrent requests */
|
|
245
|
-
c?: number;
|
|
246
|
-
/** @description Queries per second */
|
|
247
|
-
qps?: number;
|
|
248
|
-
/** @description Duration */
|
|
249
|
-
t?: string;
|
|
250
|
-
/** @description Load generator */
|
|
251
|
-
gen?: string;
|
|
252
|
-
};
|
|
253
|
-
anonymousUsageStats: boolean;
|
|
254
|
-
anonymousPerfResults: boolean;
|
|
255
|
-
/** Format: date-time */
|
|
256
|
-
updated_at?: string;
|
|
119
|
+
updated_at: string;
|
|
257
120
|
dashboardPreferences: {
|
|
258
121
|
[key: string]: unknown;
|
|
259
122
|
};
|
|
@@ -264,12 +127,9 @@ interface components {
|
|
|
264
127
|
usersExtensionPreferences: {
|
|
265
128
|
[key: string]: unknown;
|
|
266
129
|
};
|
|
267
|
-
remoteProviderPreferences
|
|
130
|
+
remoteProviderPreferences: {
|
|
268
131
|
[key: string]: unknown;
|
|
269
132
|
};
|
|
270
|
-
} & {
|
|
271
|
-
updatedAt: unknown;
|
|
272
|
-
RemoteProviderPreferences: unknown;
|
|
273
133
|
};
|
|
274
134
|
/**
|
|
275
135
|
* Format: date-time
|
|
@@ -307,17 +167,11 @@ interface components {
|
|
|
307
167
|
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
308
168
|
*/
|
|
309
169
|
deleted_at: string | null;
|
|
310
|
-
} & {
|
|
311
170
|
/**
|
|
312
171
|
* @description List of global roles assigned to the user
|
|
313
172
|
* @example [
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
* "meshmap"
|
|
317
|
-
* ],
|
|
318
|
-
* [
|
|
319
|
-
* "user"
|
|
320
|
-
* ]
|
|
173
|
+
* "admin",
|
|
174
|
+
* "meshmap"
|
|
321
175
|
* ]
|
|
322
176
|
*/
|
|
323
177
|
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
@@ -336,6 +190,356 @@ interface components {
|
|
|
336
190
|
total_count?: number;
|
|
337
191
|
};
|
|
338
192
|
};
|
|
193
|
+
/** @description Paginated list of users with organization and team role context */
|
|
194
|
+
UsersPageForAdmin: {
|
|
195
|
+
page?: number;
|
|
196
|
+
page_size?: number;
|
|
197
|
+
total_count?: number;
|
|
198
|
+
data?: {
|
|
199
|
+
/**
|
|
200
|
+
* Format: uuid
|
|
201
|
+
* @description Unique identifier for the user
|
|
202
|
+
*/
|
|
203
|
+
id: string;
|
|
204
|
+
/** @description User identifier (username or external ID) */
|
|
205
|
+
user_id: string;
|
|
206
|
+
/**
|
|
207
|
+
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
208
|
+
* @example [
|
|
209
|
+
* "local",
|
|
210
|
+
* "github",
|
|
211
|
+
* "google",
|
|
212
|
+
* "twitter"
|
|
213
|
+
* ]
|
|
214
|
+
*/
|
|
215
|
+
provider: string;
|
|
216
|
+
/**
|
|
217
|
+
* Format: email
|
|
218
|
+
* @description User's email address
|
|
219
|
+
*/
|
|
220
|
+
email: string;
|
|
221
|
+
/** @description User's first name */
|
|
222
|
+
first_name: string;
|
|
223
|
+
/** @description User's last name */
|
|
224
|
+
last_name: string;
|
|
225
|
+
/**
|
|
226
|
+
* Format: uri
|
|
227
|
+
* @description URL to user's avatar image
|
|
228
|
+
*/
|
|
229
|
+
avatar_url?: string;
|
|
230
|
+
/**
|
|
231
|
+
* @description User account status
|
|
232
|
+
* @enum {string}
|
|
233
|
+
*/
|
|
234
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
235
|
+
/**
|
|
236
|
+
* @description User's biography or description
|
|
237
|
+
* @default
|
|
238
|
+
*/
|
|
239
|
+
bio?: string;
|
|
240
|
+
/** @description User's country information stored as JSONB */
|
|
241
|
+
country?: {
|
|
242
|
+
[key: string]: unknown;
|
|
243
|
+
};
|
|
244
|
+
/** @description User's region information stored as JSONB */
|
|
245
|
+
region?: {
|
|
246
|
+
[key: string]: unknown;
|
|
247
|
+
};
|
|
248
|
+
/** @description User preferences stored as JSONB */
|
|
249
|
+
preferences?: {
|
|
250
|
+
meshAdapters?: {
|
|
251
|
+
[key: string]: unknown;
|
|
252
|
+
}[];
|
|
253
|
+
grafana?: {
|
|
254
|
+
grafanaURL?: string;
|
|
255
|
+
grafanaAPIKey?: string;
|
|
256
|
+
selectedBoardsConfigs?: {
|
|
257
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
258
|
+
board?: {
|
|
259
|
+
[key: string]: unknown;
|
|
260
|
+
};
|
|
261
|
+
panels?: {
|
|
262
|
+
[key: string]: unknown;
|
|
263
|
+
}[];
|
|
264
|
+
templateVars?: string[];
|
|
265
|
+
}[];
|
|
266
|
+
};
|
|
267
|
+
prometheus?: {
|
|
268
|
+
prometheusURL?: string;
|
|
269
|
+
selectedPrometheusBoardsConfigs?: {
|
|
270
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
271
|
+
board?: {
|
|
272
|
+
[key: string]: unknown;
|
|
273
|
+
};
|
|
274
|
+
panels?: {
|
|
275
|
+
[key: string]: unknown;
|
|
276
|
+
}[];
|
|
277
|
+
templateVars?: string[];
|
|
278
|
+
}[];
|
|
279
|
+
};
|
|
280
|
+
loadTestPrefs?: {
|
|
281
|
+
/** @description Concurrent requests */
|
|
282
|
+
c?: number;
|
|
283
|
+
/** @description Queries per second */
|
|
284
|
+
qps?: number;
|
|
285
|
+
/** @description Duration */
|
|
286
|
+
t?: string;
|
|
287
|
+
/** @description Load generator */
|
|
288
|
+
gen?: string;
|
|
289
|
+
};
|
|
290
|
+
anonymousUsageStats: boolean;
|
|
291
|
+
anonymousPerfResults: boolean;
|
|
292
|
+
/** Format: date-time */
|
|
293
|
+
updated_at: string;
|
|
294
|
+
dashboardPreferences: {
|
|
295
|
+
[key: string]: unknown;
|
|
296
|
+
};
|
|
297
|
+
selectedOrganizationID: string;
|
|
298
|
+
selectedWorkspaceForOrganizations: {
|
|
299
|
+
[key: string]: string;
|
|
300
|
+
};
|
|
301
|
+
usersExtensionPreferences: {
|
|
302
|
+
[key: string]: unknown;
|
|
303
|
+
};
|
|
304
|
+
remoteProviderPreferences: {
|
|
305
|
+
[key: string]: unknown;
|
|
306
|
+
};
|
|
307
|
+
};
|
|
308
|
+
/**
|
|
309
|
+
* Format: date-time
|
|
310
|
+
* @description Timestamp when user accepted terms and conditions
|
|
311
|
+
*/
|
|
312
|
+
accepted_terms_at?: string;
|
|
313
|
+
/**
|
|
314
|
+
* Format: date-time
|
|
315
|
+
* @description Timestamp of user's first login
|
|
316
|
+
*/
|
|
317
|
+
first_login_time?: string;
|
|
318
|
+
/**
|
|
319
|
+
* Format: date-time
|
|
320
|
+
* @description Timestamp of user's most recent login
|
|
321
|
+
*/
|
|
322
|
+
last_login_time: string;
|
|
323
|
+
/**
|
|
324
|
+
* Format: date-time
|
|
325
|
+
* @description Timestamp when the user record was created
|
|
326
|
+
*/
|
|
327
|
+
created_at: string;
|
|
328
|
+
/**
|
|
329
|
+
* Format: date-time
|
|
330
|
+
* @description Timestamp when the user record was last updated
|
|
331
|
+
*/
|
|
332
|
+
updated_at: string;
|
|
333
|
+
/** @description Various online profiles associated with the user account */
|
|
334
|
+
socials?: {
|
|
335
|
+
site: string;
|
|
336
|
+
/** Format: uri */
|
|
337
|
+
link: string;
|
|
338
|
+
}[];
|
|
339
|
+
/**
|
|
340
|
+
* Format: date-time
|
|
341
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
342
|
+
*/
|
|
343
|
+
deleted_at: string | null;
|
|
344
|
+
/**
|
|
345
|
+
* @description List of global roles assigned to the user
|
|
346
|
+
* @example [
|
|
347
|
+
* "admin",
|
|
348
|
+
* "meshmap"
|
|
349
|
+
* ]
|
|
350
|
+
*/
|
|
351
|
+
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
352
|
+
/** @description Teams the user belongs to with role information */
|
|
353
|
+
teams?: {
|
|
354
|
+
teams_with_roles?: {
|
|
355
|
+
[key: string]: unknown;
|
|
356
|
+
}[];
|
|
357
|
+
total_count?: number;
|
|
358
|
+
};
|
|
359
|
+
/** @description Organizations the user belongs to with role information */
|
|
360
|
+
organizations?: {
|
|
361
|
+
organizations_with_roles?: {
|
|
362
|
+
[key: string]: unknown;
|
|
363
|
+
}[];
|
|
364
|
+
total_count?: number;
|
|
365
|
+
};
|
|
366
|
+
}[];
|
|
367
|
+
};
|
|
368
|
+
/** @description Paginated list of public user records */
|
|
369
|
+
UsersPageForNonAdmin: {
|
|
370
|
+
page?: number;
|
|
371
|
+
page_size?: number;
|
|
372
|
+
total_count?: number;
|
|
373
|
+
data?: {
|
|
374
|
+
/**
|
|
375
|
+
* Format: uuid
|
|
376
|
+
* @description Unique identifier for the user
|
|
377
|
+
*/
|
|
378
|
+
id: string;
|
|
379
|
+
/** @description User identifier (username or external ID) */
|
|
380
|
+
user_id: string;
|
|
381
|
+
/**
|
|
382
|
+
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
383
|
+
* @example [
|
|
384
|
+
* "local",
|
|
385
|
+
* "github",
|
|
386
|
+
* "google",
|
|
387
|
+
* "twitter"
|
|
388
|
+
* ]
|
|
389
|
+
*/
|
|
390
|
+
provider: string;
|
|
391
|
+
/**
|
|
392
|
+
* Format: email
|
|
393
|
+
* @description User's email address
|
|
394
|
+
*/
|
|
395
|
+
email: string;
|
|
396
|
+
/** @description User's first name */
|
|
397
|
+
first_name: string;
|
|
398
|
+
/** @description User's last name */
|
|
399
|
+
last_name: string;
|
|
400
|
+
/**
|
|
401
|
+
* Format: uri
|
|
402
|
+
* @description URL to user's avatar image
|
|
403
|
+
*/
|
|
404
|
+
avatar_url?: string;
|
|
405
|
+
/**
|
|
406
|
+
* @description User account status
|
|
407
|
+
* @enum {string}
|
|
408
|
+
*/
|
|
409
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
410
|
+
/**
|
|
411
|
+
* @description User's biography or description
|
|
412
|
+
* @default
|
|
413
|
+
*/
|
|
414
|
+
bio?: string;
|
|
415
|
+
/** @description User's country information stored as JSONB */
|
|
416
|
+
country?: {
|
|
417
|
+
[key: string]: unknown;
|
|
418
|
+
};
|
|
419
|
+
/** @description User's region information stored as JSONB */
|
|
420
|
+
region?: {
|
|
421
|
+
[key: string]: unknown;
|
|
422
|
+
};
|
|
423
|
+
/** @description User preferences stored as JSONB */
|
|
424
|
+
preferences?: {
|
|
425
|
+
meshAdapters?: {
|
|
426
|
+
[key: string]: unknown;
|
|
427
|
+
}[];
|
|
428
|
+
grafana?: {
|
|
429
|
+
grafanaURL?: string;
|
|
430
|
+
grafanaAPIKey?: string;
|
|
431
|
+
selectedBoardsConfigs?: {
|
|
432
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
433
|
+
board?: {
|
|
434
|
+
[key: string]: unknown;
|
|
435
|
+
};
|
|
436
|
+
panels?: {
|
|
437
|
+
[key: string]: unknown;
|
|
438
|
+
}[];
|
|
439
|
+
templateVars?: string[];
|
|
440
|
+
}[];
|
|
441
|
+
};
|
|
442
|
+
prometheus?: {
|
|
443
|
+
prometheusURL?: string;
|
|
444
|
+
selectedPrometheusBoardsConfigs?: {
|
|
445
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
446
|
+
board?: {
|
|
447
|
+
[key: string]: unknown;
|
|
448
|
+
};
|
|
449
|
+
panels?: {
|
|
450
|
+
[key: string]: unknown;
|
|
451
|
+
}[];
|
|
452
|
+
templateVars?: string[];
|
|
453
|
+
}[];
|
|
454
|
+
};
|
|
455
|
+
loadTestPrefs?: {
|
|
456
|
+
/** @description Concurrent requests */
|
|
457
|
+
c?: number;
|
|
458
|
+
/** @description Queries per second */
|
|
459
|
+
qps?: number;
|
|
460
|
+
/** @description Duration */
|
|
461
|
+
t?: string;
|
|
462
|
+
/** @description Load generator */
|
|
463
|
+
gen?: string;
|
|
464
|
+
};
|
|
465
|
+
anonymousUsageStats: boolean;
|
|
466
|
+
anonymousPerfResults: boolean;
|
|
467
|
+
/** Format: date-time */
|
|
468
|
+
updated_at: string;
|
|
469
|
+
dashboardPreferences: {
|
|
470
|
+
[key: string]: unknown;
|
|
471
|
+
};
|
|
472
|
+
selectedOrganizationID: string;
|
|
473
|
+
selectedWorkspaceForOrganizations: {
|
|
474
|
+
[key: string]: string;
|
|
475
|
+
};
|
|
476
|
+
usersExtensionPreferences: {
|
|
477
|
+
[key: string]: unknown;
|
|
478
|
+
};
|
|
479
|
+
remoteProviderPreferences: {
|
|
480
|
+
[key: string]: unknown;
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* Format: date-time
|
|
485
|
+
* @description Timestamp when user accepted terms and conditions
|
|
486
|
+
*/
|
|
487
|
+
accepted_terms_at?: string;
|
|
488
|
+
/**
|
|
489
|
+
* Format: date-time
|
|
490
|
+
* @description Timestamp of user's first login
|
|
491
|
+
*/
|
|
492
|
+
first_login_time?: string;
|
|
493
|
+
/**
|
|
494
|
+
* Format: date-time
|
|
495
|
+
* @description Timestamp of user's most recent login
|
|
496
|
+
*/
|
|
497
|
+
last_login_time: string;
|
|
498
|
+
/**
|
|
499
|
+
* Format: date-time
|
|
500
|
+
* @description Timestamp when the user record was created
|
|
501
|
+
*/
|
|
502
|
+
created_at: string;
|
|
503
|
+
/**
|
|
504
|
+
* Format: date-time
|
|
505
|
+
* @description Timestamp when the user record was last updated
|
|
506
|
+
*/
|
|
507
|
+
updated_at: string;
|
|
508
|
+
/** @description Various online profiles associated with the user account */
|
|
509
|
+
socials?: {
|
|
510
|
+
site: string;
|
|
511
|
+
/** Format: uri */
|
|
512
|
+
link: string;
|
|
513
|
+
}[];
|
|
514
|
+
/**
|
|
515
|
+
* Format: date-time
|
|
516
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
517
|
+
*/
|
|
518
|
+
deleted_at: string | null;
|
|
519
|
+
/**
|
|
520
|
+
* @description List of global roles assigned to the user
|
|
521
|
+
* @example [
|
|
522
|
+
* "admin",
|
|
523
|
+
* "meshmap"
|
|
524
|
+
* ]
|
|
525
|
+
*/
|
|
526
|
+
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
527
|
+
/** @description Teams the user belongs to with role information */
|
|
528
|
+
teams?: {
|
|
529
|
+
teams_with_roles?: {
|
|
530
|
+
[key: string]: unknown;
|
|
531
|
+
}[];
|
|
532
|
+
total_count?: number;
|
|
533
|
+
};
|
|
534
|
+
/** @description Organizations the user belongs to with role information */
|
|
535
|
+
organizations?: {
|
|
536
|
+
organizations_with_roles?: {
|
|
537
|
+
[key: string]: unknown;
|
|
538
|
+
}[];
|
|
539
|
+
total_count?: number;
|
|
540
|
+
};
|
|
541
|
+
}[];
|
|
542
|
+
};
|
|
339
543
|
Preference: {
|
|
340
544
|
meshAdapters?: {
|
|
341
545
|
[key: string]: unknown;
|
|
@@ -380,7 +584,7 @@ interface components {
|
|
|
380
584
|
anonymousUsageStats: boolean;
|
|
381
585
|
anonymousPerfResults: boolean;
|
|
382
586
|
/** Format: date-time */
|
|
383
|
-
updated_at
|
|
587
|
+
updated_at: string;
|
|
384
588
|
dashboardPreferences: {
|
|
385
589
|
[key: string]: unknown;
|
|
386
590
|
};
|
|
@@ -391,12 +595,9 @@ interface components {
|
|
|
391
595
|
usersExtensionPreferences: {
|
|
392
596
|
[key: string]: unknown;
|
|
393
597
|
};
|
|
394
|
-
remoteProviderPreferences
|
|
598
|
+
remoteProviderPreferences: {
|
|
395
599
|
[key: string]: unknown;
|
|
396
600
|
};
|
|
397
|
-
} & {
|
|
398
|
-
updatedAt: unknown;
|
|
399
|
-
RemoteProviderPreferences: unknown;
|
|
400
601
|
};
|
|
401
602
|
/** @description Placeholder for Adapter struct definition. */
|
|
402
603
|
Adapter: {
|
|
@@ -464,8 +665,876 @@ interface components {
|
|
|
464
665
|
link: string;
|
|
465
666
|
};
|
|
466
667
|
};
|
|
668
|
+
responses: {
|
|
669
|
+
/** Invalid request body or request param */
|
|
670
|
+
400: {
|
|
671
|
+
content: {
|
|
672
|
+
"text/plain": string;
|
|
673
|
+
};
|
|
674
|
+
};
|
|
675
|
+
/** Expired JWT token used or insufficient privilege */
|
|
676
|
+
401: {
|
|
677
|
+
content: {
|
|
678
|
+
"text/plain": string;
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
/** Result not found */
|
|
682
|
+
404: {
|
|
683
|
+
content: {
|
|
684
|
+
"text/plain": string;
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
/** Internal server error */
|
|
688
|
+
500: {
|
|
689
|
+
content: {
|
|
690
|
+
"text/plain": string;
|
|
691
|
+
};
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
parameters: {
|
|
695
|
+
/** @description User ID */
|
|
696
|
+
id: string;
|
|
697
|
+
/** @description Organization ID */
|
|
698
|
+
orgId: string;
|
|
699
|
+
/** @description Get responses by page */
|
|
700
|
+
page: string;
|
|
701
|
+
/** @description Get responses by pagesize */
|
|
702
|
+
pagesize: string;
|
|
703
|
+
/** @description Get responses that match search param value */
|
|
704
|
+
search: string;
|
|
705
|
+
/** @description Get ordered responses */
|
|
706
|
+
order: string;
|
|
707
|
+
/** @description Get filtered reponses */
|
|
708
|
+
filter: string;
|
|
709
|
+
/** @description Optional team filter when listing organization users */
|
|
710
|
+
teamID: string;
|
|
711
|
+
};
|
|
467
712
|
}
|
|
468
713
|
interface operations {
|
|
714
|
+
/** Returns organization users, optionally filtered by team membership. */
|
|
715
|
+
getUsersForOrg: {
|
|
716
|
+
parameters: {
|
|
717
|
+
path: {
|
|
718
|
+
/** Organization ID */
|
|
719
|
+
orgId: string;
|
|
720
|
+
};
|
|
721
|
+
query: {
|
|
722
|
+
/** Get responses by page */
|
|
723
|
+
page?: string;
|
|
724
|
+
/** Get responses by pagesize */
|
|
725
|
+
pagesize?: string;
|
|
726
|
+
/** Get responses that match search param value */
|
|
727
|
+
search?: string;
|
|
728
|
+
/** Get ordered responses */
|
|
729
|
+
order?: string;
|
|
730
|
+
/** Get filtered reponses */
|
|
731
|
+
filter?: string;
|
|
732
|
+
/** Optional team filter when listing organization users */
|
|
733
|
+
teamID?: string;
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
responses: {
|
|
737
|
+
/** Paginated list of organization users */
|
|
738
|
+
200: {
|
|
739
|
+
content: {
|
|
740
|
+
"application/json": {
|
|
741
|
+
page?: number;
|
|
742
|
+
page_size?: number;
|
|
743
|
+
total_count?: number;
|
|
744
|
+
data?: {
|
|
745
|
+
/**
|
|
746
|
+
* Format: uuid
|
|
747
|
+
* @description Unique identifier for the user
|
|
748
|
+
*/
|
|
749
|
+
id: string;
|
|
750
|
+
/** @description User identifier (username or external ID) */
|
|
751
|
+
user_id: string;
|
|
752
|
+
/**
|
|
753
|
+
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
754
|
+
* @example [
|
|
755
|
+
* "local",
|
|
756
|
+
* "github",
|
|
757
|
+
* "google",
|
|
758
|
+
* "twitter"
|
|
759
|
+
* ]
|
|
760
|
+
*/
|
|
761
|
+
provider: string;
|
|
762
|
+
/**
|
|
763
|
+
* Format: email
|
|
764
|
+
* @description User's email address
|
|
765
|
+
*/
|
|
766
|
+
email: string;
|
|
767
|
+
/** @description User's first name */
|
|
768
|
+
first_name: string;
|
|
769
|
+
/** @description User's last name */
|
|
770
|
+
last_name: string;
|
|
771
|
+
/**
|
|
772
|
+
* Format: uri
|
|
773
|
+
* @description URL to user's avatar image
|
|
774
|
+
*/
|
|
775
|
+
avatar_url?: string;
|
|
776
|
+
/**
|
|
777
|
+
* @description User account status
|
|
778
|
+
* @enum {string}
|
|
779
|
+
*/
|
|
780
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
781
|
+
/**
|
|
782
|
+
* @description User's biography or description
|
|
783
|
+
* @default
|
|
784
|
+
*/
|
|
785
|
+
bio?: string;
|
|
786
|
+
/** @description User's country information stored as JSONB */
|
|
787
|
+
country?: {
|
|
788
|
+
[key: string]: unknown;
|
|
789
|
+
};
|
|
790
|
+
/** @description User's region information stored as JSONB */
|
|
791
|
+
region?: {
|
|
792
|
+
[key: string]: unknown;
|
|
793
|
+
};
|
|
794
|
+
/** @description User preferences stored as JSONB */
|
|
795
|
+
preferences?: {
|
|
796
|
+
meshAdapters?: {
|
|
797
|
+
[key: string]: unknown;
|
|
798
|
+
}[];
|
|
799
|
+
grafana?: {
|
|
800
|
+
grafanaURL?: string;
|
|
801
|
+
grafanaAPIKey?: string;
|
|
802
|
+
selectedBoardsConfigs?: {
|
|
803
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
804
|
+
board?: {
|
|
805
|
+
[key: string]: unknown;
|
|
806
|
+
};
|
|
807
|
+
panels?: {
|
|
808
|
+
[key: string]: unknown;
|
|
809
|
+
}[];
|
|
810
|
+
templateVars?: string[];
|
|
811
|
+
}[];
|
|
812
|
+
};
|
|
813
|
+
prometheus?: {
|
|
814
|
+
prometheusURL?: string;
|
|
815
|
+
selectedPrometheusBoardsConfigs?: {
|
|
816
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
817
|
+
board?: {
|
|
818
|
+
[key: string]: unknown;
|
|
819
|
+
};
|
|
820
|
+
panels?: {
|
|
821
|
+
[key: string]: unknown;
|
|
822
|
+
}[];
|
|
823
|
+
templateVars?: string[];
|
|
824
|
+
}[];
|
|
825
|
+
};
|
|
826
|
+
loadTestPrefs?: {
|
|
827
|
+
/** @description Concurrent requests */
|
|
828
|
+
c?: number;
|
|
829
|
+
/** @description Queries per second */
|
|
830
|
+
qps?: number;
|
|
831
|
+
/** @description Duration */
|
|
832
|
+
t?: string;
|
|
833
|
+
/** @description Load generator */
|
|
834
|
+
gen?: string;
|
|
835
|
+
};
|
|
836
|
+
anonymousUsageStats: boolean;
|
|
837
|
+
anonymousPerfResults: boolean;
|
|
838
|
+
/** Format: date-time */
|
|
839
|
+
updated_at: string;
|
|
840
|
+
dashboardPreferences: {
|
|
841
|
+
[key: string]: unknown;
|
|
842
|
+
};
|
|
843
|
+
selectedOrganizationID: string;
|
|
844
|
+
selectedWorkspaceForOrganizations: {
|
|
845
|
+
[key: string]: string;
|
|
846
|
+
};
|
|
847
|
+
usersExtensionPreferences: {
|
|
848
|
+
[key: string]: unknown;
|
|
849
|
+
};
|
|
850
|
+
remoteProviderPreferences: {
|
|
851
|
+
[key: string]: unknown;
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
/**
|
|
855
|
+
* Format: date-time
|
|
856
|
+
* @description Timestamp when user accepted terms and conditions
|
|
857
|
+
*/
|
|
858
|
+
accepted_terms_at?: string;
|
|
859
|
+
/**
|
|
860
|
+
* Format: date-time
|
|
861
|
+
* @description Timestamp of user's first login
|
|
862
|
+
*/
|
|
863
|
+
first_login_time?: string;
|
|
864
|
+
/**
|
|
865
|
+
* Format: date-time
|
|
866
|
+
* @description Timestamp of user's most recent login
|
|
867
|
+
*/
|
|
868
|
+
last_login_time: string;
|
|
869
|
+
/**
|
|
870
|
+
* Format: date-time
|
|
871
|
+
* @description Timestamp when the user record was created
|
|
872
|
+
*/
|
|
873
|
+
created_at: string;
|
|
874
|
+
/**
|
|
875
|
+
* Format: date-time
|
|
876
|
+
* @description Timestamp when the user record was last updated
|
|
877
|
+
*/
|
|
878
|
+
updated_at: string;
|
|
879
|
+
/** @description Various online profiles associated with the user account */
|
|
880
|
+
socials?: {
|
|
881
|
+
site: string;
|
|
882
|
+
/** Format: uri */
|
|
883
|
+
link: string;
|
|
884
|
+
}[];
|
|
885
|
+
/**
|
|
886
|
+
* Format: date-time
|
|
887
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
888
|
+
*/
|
|
889
|
+
deleted_at: string | null;
|
|
890
|
+
/**
|
|
891
|
+
* @description List of global roles assigned to the user
|
|
892
|
+
* @example [
|
|
893
|
+
* "admin",
|
|
894
|
+
* "meshmap"
|
|
895
|
+
* ]
|
|
896
|
+
*/
|
|
897
|
+
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
898
|
+
/** @description Teams the user belongs to with role information */
|
|
899
|
+
teams?: {
|
|
900
|
+
teams_with_roles?: {
|
|
901
|
+
[key: string]: unknown;
|
|
902
|
+
}[];
|
|
903
|
+
total_count?: number;
|
|
904
|
+
};
|
|
905
|
+
/** @description Organizations the user belongs to with role information */
|
|
906
|
+
organizations?: {
|
|
907
|
+
organizations_with_roles?: {
|
|
908
|
+
[key: string]: unknown;
|
|
909
|
+
}[];
|
|
910
|
+
total_count?: number;
|
|
911
|
+
};
|
|
912
|
+
}[];
|
|
913
|
+
};
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
/** Invalid request body or request param */
|
|
917
|
+
400: {
|
|
918
|
+
content: {
|
|
919
|
+
"text/plain": string;
|
|
920
|
+
};
|
|
921
|
+
};
|
|
922
|
+
/** Expired JWT token used or insufficient privilege */
|
|
923
|
+
401: {
|
|
924
|
+
content: {
|
|
925
|
+
"text/plain": string;
|
|
926
|
+
};
|
|
927
|
+
};
|
|
928
|
+
/** Internal server error */
|
|
929
|
+
500: {
|
|
930
|
+
content: {
|
|
931
|
+
"text/plain": string;
|
|
932
|
+
};
|
|
933
|
+
};
|
|
934
|
+
};
|
|
935
|
+
};
|
|
936
|
+
/** Returns publicly viewable user records. */
|
|
937
|
+
getUsers: {
|
|
938
|
+
parameters: {
|
|
939
|
+
query: {
|
|
940
|
+
/** Get responses by page */
|
|
941
|
+
page?: string;
|
|
942
|
+
/** Get responses by pagesize */
|
|
943
|
+
pagesize?: string;
|
|
944
|
+
/** Get responses that match search param value */
|
|
945
|
+
search?: string;
|
|
946
|
+
/** Get ordered responses */
|
|
947
|
+
order?: string;
|
|
948
|
+
/** Get filtered reponses */
|
|
949
|
+
filter?: string;
|
|
950
|
+
};
|
|
951
|
+
};
|
|
952
|
+
responses: {
|
|
953
|
+
/** Paginated list of public users */
|
|
954
|
+
200: {
|
|
955
|
+
content: {
|
|
956
|
+
"application/json": {
|
|
957
|
+
page?: number;
|
|
958
|
+
page_size?: number;
|
|
959
|
+
total_count?: number;
|
|
960
|
+
data?: {
|
|
961
|
+
/**
|
|
962
|
+
* Format: uuid
|
|
963
|
+
* @description Unique identifier for the user
|
|
964
|
+
*/
|
|
965
|
+
id: string;
|
|
966
|
+
/** @description User identifier (username or external ID) */
|
|
967
|
+
user_id: string;
|
|
968
|
+
/**
|
|
969
|
+
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
970
|
+
* @example [
|
|
971
|
+
* "local",
|
|
972
|
+
* "github",
|
|
973
|
+
* "google",
|
|
974
|
+
* "twitter"
|
|
975
|
+
* ]
|
|
976
|
+
*/
|
|
977
|
+
provider: string;
|
|
978
|
+
/**
|
|
979
|
+
* Format: email
|
|
980
|
+
* @description User's email address
|
|
981
|
+
*/
|
|
982
|
+
email: string;
|
|
983
|
+
/** @description User's first name */
|
|
984
|
+
first_name: string;
|
|
985
|
+
/** @description User's last name */
|
|
986
|
+
last_name: string;
|
|
987
|
+
/**
|
|
988
|
+
* Format: uri
|
|
989
|
+
* @description URL to user's avatar image
|
|
990
|
+
*/
|
|
991
|
+
avatar_url?: string;
|
|
992
|
+
/**
|
|
993
|
+
* @description User account status
|
|
994
|
+
* @enum {string}
|
|
995
|
+
*/
|
|
996
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
997
|
+
/**
|
|
998
|
+
* @description User's biography or description
|
|
999
|
+
* @default
|
|
1000
|
+
*/
|
|
1001
|
+
bio?: string;
|
|
1002
|
+
/** @description User's country information stored as JSONB */
|
|
1003
|
+
country?: {
|
|
1004
|
+
[key: string]: unknown;
|
|
1005
|
+
};
|
|
1006
|
+
/** @description User's region information stored as JSONB */
|
|
1007
|
+
region?: {
|
|
1008
|
+
[key: string]: unknown;
|
|
1009
|
+
};
|
|
1010
|
+
/** @description User preferences stored as JSONB */
|
|
1011
|
+
preferences?: {
|
|
1012
|
+
meshAdapters?: {
|
|
1013
|
+
[key: string]: unknown;
|
|
1014
|
+
}[];
|
|
1015
|
+
grafana?: {
|
|
1016
|
+
grafanaURL?: string;
|
|
1017
|
+
grafanaAPIKey?: string;
|
|
1018
|
+
selectedBoardsConfigs?: {
|
|
1019
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1020
|
+
board?: {
|
|
1021
|
+
[key: string]: unknown;
|
|
1022
|
+
};
|
|
1023
|
+
panels?: {
|
|
1024
|
+
[key: string]: unknown;
|
|
1025
|
+
}[];
|
|
1026
|
+
templateVars?: string[];
|
|
1027
|
+
}[];
|
|
1028
|
+
};
|
|
1029
|
+
prometheus?: {
|
|
1030
|
+
prometheusURL?: string;
|
|
1031
|
+
selectedPrometheusBoardsConfigs?: {
|
|
1032
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1033
|
+
board?: {
|
|
1034
|
+
[key: string]: unknown;
|
|
1035
|
+
};
|
|
1036
|
+
panels?: {
|
|
1037
|
+
[key: string]: unknown;
|
|
1038
|
+
}[];
|
|
1039
|
+
templateVars?: string[];
|
|
1040
|
+
}[];
|
|
1041
|
+
};
|
|
1042
|
+
loadTestPrefs?: {
|
|
1043
|
+
/** @description Concurrent requests */
|
|
1044
|
+
c?: number;
|
|
1045
|
+
/** @description Queries per second */
|
|
1046
|
+
qps?: number;
|
|
1047
|
+
/** @description Duration */
|
|
1048
|
+
t?: string;
|
|
1049
|
+
/** @description Load generator */
|
|
1050
|
+
gen?: string;
|
|
1051
|
+
};
|
|
1052
|
+
anonymousUsageStats: boolean;
|
|
1053
|
+
anonymousPerfResults: boolean;
|
|
1054
|
+
/** Format: date-time */
|
|
1055
|
+
updated_at: string;
|
|
1056
|
+
dashboardPreferences: {
|
|
1057
|
+
[key: string]: unknown;
|
|
1058
|
+
};
|
|
1059
|
+
selectedOrganizationID: string;
|
|
1060
|
+
selectedWorkspaceForOrganizations: {
|
|
1061
|
+
[key: string]: string;
|
|
1062
|
+
};
|
|
1063
|
+
usersExtensionPreferences: {
|
|
1064
|
+
[key: string]: unknown;
|
|
1065
|
+
};
|
|
1066
|
+
remoteProviderPreferences: {
|
|
1067
|
+
[key: string]: unknown;
|
|
1068
|
+
};
|
|
1069
|
+
};
|
|
1070
|
+
/**
|
|
1071
|
+
* Format: date-time
|
|
1072
|
+
* @description Timestamp when user accepted terms and conditions
|
|
1073
|
+
*/
|
|
1074
|
+
accepted_terms_at?: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* Format: date-time
|
|
1077
|
+
* @description Timestamp of user's first login
|
|
1078
|
+
*/
|
|
1079
|
+
first_login_time?: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* Format: date-time
|
|
1082
|
+
* @description Timestamp of user's most recent login
|
|
1083
|
+
*/
|
|
1084
|
+
last_login_time: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* Format: date-time
|
|
1087
|
+
* @description Timestamp when the user record was created
|
|
1088
|
+
*/
|
|
1089
|
+
created_at: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* Format: date-time
|
|
1092
|
+
* @description Timestamp when the user record was last updated
|
|
1093
|
+
*/
|
|
1094
|
+
updated_at: string;
|
|
1095
|
+
/** @description Various online profiles associated with the user account */
|
|
1096
|
+
socials?: {
|
|
1097
|
+
site: string;
|
|
1098
|
+
/** Format: uri */
|
|
1099
|
+
link: string;
|
|
1100
|
+
}[];
|
|
1101
|
+
/**
|
|
1102
|
+
* Format: date-time
|
|
1103
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
1104
|
+
*/
|
|
1105
|
+
deleted_at: string | null;
|
|
1106
|
+
/**
|
|
1107
|
+
* @description List of global roles assigned to the user
|
|
1108
|
+
* @example [
|
|
1109
|
+
* "admin",
|
|
1110
|
+
* "meshmap"
|
|
1111
|
+
* ]
|
|
1112
|
+
*/
|
|
1113
|
+
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
1114
|
+
/** @description Teams the user belongs to with role information */
|
|
1115
|
+
teams?: {
|
|
1116
|
+
teams_with_roles?: {
|
|
1117
|
+
[key: string]: unknown;
|
|
1118
|
+
}[];
|
|
1119
|
+
total_count?: number;
|
|
1120
|
+
};
|
|
1121
|
+
/** @description Organizations the user belongs to with role information */
|
|
1122
|
+
organizations?: {
|
|
1123
|
+
organizations_with_roles?: {
|
|
1124
|
+
[key: string]: unknown;
|
|
1125
|
+
}[];
|
|
1126
|
+
total_count?: number;
|
|
1127
|
+
};
|
|
1128
|
+
}[];
|
|
1129
|
+
};
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1132
|
+
/** Invalid request body or request param */
|
|
1133
|
+
400: {
|
|
1134
|
+
content: {
|
|
1135
|
+
"text/plain": string;
|
|
1136
|
+
};
|
|
1137
|
+
};
|
|
1138
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1139
|
+
401: {
|
|
1140
|
+
content: {
|
|
1141
|
+
"text/plain": string;
|
|
1142
|
+
};
|
|
1143
|
+
};
|
|
1144
|
+
/** Internal server error */
|
|
1145
|
+
500: {
|
|
1146
|
+
content: {
|
|
1147
|
+
"text/plain": string;
|
|
1148
|
+
};
|
|
1149
|
+
};
|
|
1150
|
+
};
|
|
1151
|
+
};
|
|
1152
|
+
getUserProfileById: {
|
|
1153
|
+
parameters: {
|
|
1154
|
+
path: {
|
|
1155
|
+
/** User ID */
|
|
1156
|
+
id: string;
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
responses: {
|
|
1160
|
+
/** User profile for the requested ID */
|
|
1161
|
+
200: {
|
|
1162
|
+
content: {
|
|
1163
|
+
"application/json": {
|
|
1164
|
+
/**
|
|
1165
|
+
* Format: uuid
|
|
1166
|
+
* @description Unique identifier for the user
|
|
1167
|
+
*/
|
|
1168
|
+
id: string;
|
|
1169
|
+
/** @description User identifier (username or external ID) */
|
|
1170
|
+
user_id: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
1173
|
+
* @example [
|
|
1174
|
+
* "local",
|
|
1175
|
+
* "github",
|
|
1176
|
+
* "google",
|
|
1177
|
+
* "twitter"
|
|
1178
|
+
* ]
|
|
1179
|
+
*/
|
|
1180
|
+
provider: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* Format: email
|
|
1183
|
+
* @description User's email address
|
|
1184
|
+
*/
|
|
1185
|
+
email: string;
|
|
1186
|
+
/** @description User's first name */
|
|
1187
|
+
first_name: string;
|
|
1188
|
+
/** @description User's last name */
|
|
1189
|
+
last_name: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* Format: uri
|
|
1192
|
+
* @description URL to user's avatar image
|
|
1193
|
+
*/
|
|
1194
|
+
avatar_url?: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* @description User account status
|
|
1197
|
+
* @enum {string}
|
|
1198
|
+
*/
|
|
1199
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
1200
|
+
/**
|
|
1201
|
+
* @description User's biography or description
|
|
1202
|
+
* @default
|
|
1203
|
+
*/
|
|
1204
|
+
bio?: string;
|
|
1205
|
+
/** @description User's country information stored as JSONB */
|
|
1206
|
+
country?: {
|
|
1207
|
+
[key: string]: unknown;
|
|
1208
|
+
};
|
|
1209
|
+
/** @description User's region information stored as JSONB */
|
|
1210
|
+
region?: {
|
|
1211
|
+
[key: string]: unknown;
|
|
1212
|
+
};
|
|
1213
|
+
/** @description User preferences stored as JSONB */
|
|
1214
|
+
preferences?: {
|
|
1215
|
+
meshAdapters?: {
|
|
1216
|
+
[key: string]: unknown;
|
|
1217
|
+
}[];
|
|
1218
|
+
grafana?: {
|
|
1219
|
+
grafanaURL?: string;
|
|
1220
|
+
grafanaAPIKey?: string;
|
|
1221
|
+
selectedBoardsConfigs?: {
|
|
1222
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1223
|
+
board?: {
|
|
1224
|
+
[key: string]: unknown;
|
|
1225
|
+
};
|
|
1226
|
+
panels?: {
|
|
1227
|
+
[key: string]: unknown;
|
|
1228
|
+
}[];
|
|
1229
|
+
templateVars?: string[];
|
|
1230
|
+
}[];
|
|
1231
|
+
};
|
|
1232
|
+
prometheus?: {
|
|
1233
|
+
prometheusURL?: string;
|
|
1234
|
+
selectedPrometheusBoardsConfigs?: {
|
|
1235
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1236
|
+
board?: {
|
|
1237
|
+
[key: string]: unknown;
|
|
1238
|
+
};
|
|
1239
|
+
panels?: {
|
|
1240
|
+
[key: string]: unknown;
|
|
1241
|
+
}[];
|
|
1242
|
+
templateVars?: string[];
|
|
1243
|
+
}[];
|
|
1244
|
+
};
|
|
1245
|
+
loadTestPrefs?: {
|
|
1246
|
+
/** @description Concurrent requests */
|
|
1247
|
+
c?: number;
|
|
1248
|
+
/** @description Queries per second */
|
|
1249
|
+
qps?: number;
|
|
1250
|
+
/** @description Duration */
|
|
1251
|
+
t?: string;
|
|
1252
|
+
/** @description Load generator */
|
|
1253
|
+
gen?: string;
|
|
1254
|
+
};
|
|
1255
|
+
anonymousUsageStats: boolean;
|
|
1256
|
+
anonymousPerfResults: boolean;
|
|
1257
|
+
/** Format: date-time */
|
|
1258
|
+
updated_at: string;
|
|
1259
|
+
dashboardPreferences: {
|
|
1260
|
+
[key: string]: unknown;
|
|
1261
|
+
};
|
|
1262
|
+
selectedOrganizationID: string;
|
|
1263
|
+
selectedWorkspaceForOrganizations: {
|
|
1264
|
+
[key: string]: string;
|
|
1265
|
+
};
|
|
1266
|
+
usersExtensionPreferences: {
|
|
1267
|
+
[key: string]: unknown;
|
|
1268
|
+
};
|
|
1269
|
+
remoteProviderPreferences: {
|
|
1270
|
+
[key: string]: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
/**
|
|
1274
|
+
* Format: date-time
|
|
1275
|
+
* @description Timestamp when user accepted terms and conditions
|
|
1276
|
+
*/
|
|
1277
|
+
accepted_terms_at?: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* Format: date-time
|
|
1280
|
+
* @description Timestamp of user's first login
|
|
1281
|
+
*/
|
|
1282
|
+
first_login_time?: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* Format: date-time
|
|
1285
|
+
* @description Timestamp of user's most recent login
|
|
1286
|
+
*/
|
|
1287
|
+
last_login_time: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* Format: date-time
|
|
1290
|
+
* @description Timestamp when the user record was created
|
|
1291
|
+
*/
|
|
1292
|
+
created_at: string;
|
|
1293
|
+
/**
|
|
1294
|
+
* Format: date-time
|
|
1295
|
+
* @description Timestamp when the user record was last updated
|
|
1296
|
+
*/
|
|
1297
|
+
updated_at: string;
|
|
1298
|
+
/** @description Various online profiles associated with the user account */
|
|
1299
|
+
socials?: {
|
|
1300
|
+
site: string;
|
|
1301
|
+
/** Format: uri */
|
|
1302
|
+
link: string;
|
|
1303
|
+
}[];
|
|
1304
|
+
/**
|
|
1305
|
+
* Format: date-time
|
|
1306
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
1307
|
+
*/
|
|
1308
|
+
deleted_at: string | null;
|
|
1309
|
+
/**
|
|
1310
|
+
* @description List of global roles assigned to the user
|
|
1311
|
+
* @example [
|
|
1312
|
+
* "admin",
|
|
1313
|
+
* "meshmap"
|
|
1314
|
+
* ]
|
|
1315
|
+
*/
|
|
1316
|
+
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
1317
|
+
/** @description Teams the user belongs to with role information */
|
|
1318
|
+
teams?: {
|
|
1319
|
+
teams_with_roles?: {
|
|
1320
|
+
[key: string]: unknown;
|
|
1321
|
+
}[];
|
|
1322
|
+
total_count?: number;
|
|
1323
|
+
};
|
|
1324
|
+
/** @description Organizations the user belongs to with role information */
|
|
1325
|
+
organizations?: {
|
|
1326
|
+
organizations_with_roles?: {
|
|
1327
|
+
[key: string]: unknown;
|
|
1328
|
+
}[];
|
|
1329
|
+
total_count?: number;
|
|
1330
|
+
};
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
};
|
|
1334
|
+
/** Invalid request body or request param */
|
|
1335
|
+
400: {
|
|
1336
|
+
content: {
|
|
1337
|
+
"text/plain": string;
|
|
1338
|
+
};
|
|
1339
|
+
};
|
|
1340
|
+
/** Internal server error */
|
|
1341
|
+
500: {
|
|
1342
|
+
content: {
|
|
1343
|
+
"text/plain": string;
|
|
1344
|
+
};
|
|
1345
|
+
};
|
|
1346
|
+
};
|
|
1347
|
+
};
|
|
1348
|
+
getUser: {
|
|
1349
|
+
responses: {
|
|
1350
|
+
/** Current user profile and role context */
|
|
1351
|
+
200: {
|
|
1352
|
+
content: {
|
|
1353
|
+
"application/json": {
|
|
1354
|
+
/**
|
|
1355
|
+
* Format: uuid
|
|
1356
|
+
* @description Unique identifier for the user
|
|
1357
|
+
*/
|
|
1358
|
+
id: string;
|
|
1359
|
+
/** @description User identifier (username or external ID) */
|
|
1360
|
+
user_id: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* @description Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
|
|
1363
|
+
* @example [
|
|
1364
|
+
* "local",
|
|
1365
|
+
* "github",
|
|
1366
|
+
* "google",
|
|
1367
|
+
* "twitter"
|
|
1368
|
+
* ]
|
|
1369
|
+
*/
|
|
1370
|
+
provider: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* Format: email
|
|
1373
|
+
* @description User's email address
|
|
1374
|
+
*/
|
|
1375
|
+
email: string;
|
|
1376
|
+
/** @description User's first name */
|
|
1377
|
+
first_name: string;
|
|
1378
|
+
/** @description User's last name */
|
|
1379
|
+
last_name: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* Format: uri
|
|
1382
|
+
* @description URL to user's avatar image
|
|
1383
|
+
*/
|
|
1384
|
+
avatar_url?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* @description User account status
|
|
1387
|
+
* @enum {string}
|
|
1388
|
+
*/
|
|
1389
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
1390
|
+
/**
|
|
1391
|
+
* @description User's biography or description
|
|
1392
|
+
* @default
|
|
1393
|
+
*/
|
|
1394
|
+
bio?: string;
|
|
1395
|
+
/** @description User's country information stored as JSONB */
|
|
1396
|
+
country?: {
|
|
1397
|
+
[key: string]: unknown;
|
|
1398
|
+
};
|
|
1399
|
+
/** @description User's region information stored as JSONB */
|
|
1400
|
+
region?: {
|
|
1401
|
+
[key: string]: unknown;
|
|
1402
|
+
};
|
|
1403
|
+
/** @description User preferences stored as JSONB */
|
|
1404
|
+
preferences?: {
|
|
1405
|
+
meshAdapters?: {
|
|
1406
|
+
[key: string]: unknown;
|
|
1407
|
+
}[];
|
|
1408
|
+
grafana?: {
|
|
1409
|
+
grafanaURL?: string;
|
|
1410
|
+
grafanaAPIKey?: string;
|
|
1411
|
+
selectedBoardsConfigs?: {
|
|
1412
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1413
|
+
board?: {
|
|
1414
|
+
[key: string]: unknown;
|
|
1415
|
+
};
|
|
1416
|
+
panels?: {
|
|
1417
|
+
[key: string]: unknown;
|
|
1418
|
+
}[];
|
|
1419
|
+
templateVars?: string[];
|
|
1420
|
+
}[];
|
|
1421
|
+
};
|
|
1422
|
+
prometheus?: {
|
|
1423
|
+
prometheusURL?: string;
|
|
1424
|
+
selectedPrometheusBoardsConfigs?: {
|
|
1425
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
1426
|
+
board?: {
|
|
1427
|
+
[key: string]: unknown;
|
|
1428
|
+
};
|
|
1429
|
+
panels?: {
|
|
1430
|
+
[key: string]: unknown;
|
|
1431
|
+
}[];
|
|
1432
|
+
templateVars?: string[];
|
|
1433
|
+
}[];
|
|
1434
|
+
};
|
|
1435
|
+
loadTestPrefs?: {
|
|
1436
|
+
/** @description Concurrent requests */
|
|
1437
|
+
c?: number;
|
|
1438
|
+
/** @description Queries per second */
|
|
1439
|
+
qps?: number;
|
|
1440
|
+
/** @description Duration */
|
|
1441
|
+
t?: string;
|
|
1442
|
+
/** @description Load generator */
|
|
1443
|
+
gen?: string;
|
|
1444
|
+
};
|
|
1445
|
+
anonymousUsageStats: boolean;
|
|
1446
|
+
anonymousPerfResults: boolean;
|
|
1447
|
+
/** Format: date-time */
|
|
1448
|
+
updated_at: string;
|
|
1449
|
+
dashboardPreferences: {
|
|
1450
|
+
[key: string]: unknown;
|
|
1451
|
+
};
|
|
1452
|
+
selectedOrganizationID: string;
|
|
1453
|
+
selectedWorkspaceForOrganizations: {
|
|
1454
|
+
[key: string]: string;
|
|
1455
|
+
};
|
|
1456
|
+
usersExtensionPreferences: {
|
|
1457
|
+
[key: string]: unknown;
|
|
1458
|
+
};
|
|
1459
|
+
remoteProviderPreferences: {
|
|
1460
|
+
[key: string]: unknown;
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
/**
|
|
1464
|
+
* Format: date-time
|
|
1465
|
+
* @description Timestamp when user accepted terms and conditions
|
|
1466
|
+
*/
|
|
1467
|
+
accepted_terms_at?: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Format: date-time
|
|
1470
|
+
* @description Timestamp of user's first login
|
|
1471
|
+
*/
|
|
1472
|
+
first_login_time?: string;
|
|
1473
|
+
/**
|
|
1474
|
+
* Format: date-time
|
|
1475
|
+
* @description Timestamp of user's most recent login
|
|
1476
|
+
*/
|
|
1477
|
+
last_login_time: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* Format: date-time
|
|
1480
|
+
* @description Timestamp when the user record was created
|
|
1481
|
+
*/
|
|
1482
|
+
created_at: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* Format: date-time
|
|
1485
|
+
* @description Timestamp when the user record was last updated
|
|
1486
|
+
*/
|
|
1487
|
+
updated_at: string;
|
|
1488
|
+
/** @description Various online profiles associated with the user account */
|
|
1489
|
+
socials?: {
|
|
1490
|
+
site: string;
|
|
1491
|
+
/** Format: uri */
|
|
1492
|
+
link: string;
|
|
1493
|
+
}[];
|
|
1494
|
+
/**
|
|
1495
|
+
* Format: date-time
|
|
1496
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
1497
|
+
*/
|
|
1498
|
+
deleted_at: string | null;
|
|
1499
|
+
/**
|
|
1500
|
+
* @description List of global roles assigned to the user
|
|
1501
|
+
* @example [
|
|
1502
|
+
* "admin",
|
|
1503
|
+
* "meshmap"
|
|
1504
|
+
* ]
|
|
1505
|
+
*/
|
|
1506
|
+
role_names?: ("admin" | "meshmap" | "curator" | "team admin" | "workspace admin" | "workspace manager" | "organization admin" | "user")[];
|
|
1507
|
+
/** @description Teams the user belongs to with role information */
|
|
1508
|
+
teams?: {
|
|
1509
|
+
teams_with_roles?: {
|
|
1510
|
+
[key: string]: unknown;
|
|
1511
|
+
}[];
|
|
1512
|
+
total_count?: number;
|
|
1513
|
+
};
|
|
1514
|
+
/** @description Organizations the user belongs to with role information */
|
|
1515
|
+
organizations?: {
|
|
1516
|
+
organizations_with_roles?: {
|
|
1517
|
+
[key: string]: unknown;
|
|
1518
|
+
}[];
|
|
1519
|
+
total_count?: number;
|
|
1520
|
+
};
|
|
1521
|
+
};
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
/** Expired JWT token used or insufficient privilege */
|
|
1525
|
+
401: {
|
|
1526
|
+
content: {
|
|
1527
|
+
"text/plain": string;
|
|
1528
|
+
};
|
|
1529
|
+
};
|
|
1530
|
+
/** Internal server error */
|
|
1531
|
+
500: {
|
|
1532
|
+
content: {
|
|
1533
|
+
"text/plain": string;
|
|
1534
|
+
};
|
|
1535
|
+
};
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
469
1538
|
}
|
|
470
1539
|
interface external {
|
|
471
1540
|
}
|