@meshery/schemas 0.8.133 → 0.8.135
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/{Core-BiYtFM4v.d.mts → Core-B0SJO-By.d.mts} +4 -1
- package/dist/{Core-BiYtFM4v.d.ts → Core-B0SJO-By.d.ts} +4 -1
- 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/v1alpha1/core/Core.d.mts +1 -1
- package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.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 +19 -5
- package/dist/constructs/v1beta1/component/Component.d.ts +19 -5
- 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 +126 -48
- package/dist/constructs/v1beta1/connection/Connection.d.ts +126 -48
- package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta1/credential/Credential.d.mts +32 -8
- package/dist/constructs/v1beta1/credential/Credential.d.ts +32 -8
- package/dist/constructs/v1beta1/credential/CredentialSchema.js +8 -8
- package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +8 -8
- package/dist/constructs/v1beta1/environment/Environment.d.mts +81 -23
- package/dist/constructs/v1beta1/environment/Environment.d.ts +81 -23
- 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 +76 -20
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +76 -20
- 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 +27 -9
- package/dist/constructs/v1beta1/key/Key.d.ts +27 -9
- 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 +40 -43
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +40 -43
- 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 +21 -7
- package/dist/constructs/v1beta1/model/Model.d.ts +21 -7
- 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 +176 -48
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +176 -48
- 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 +53 -26
- package/dist/constructs/v1beta1/role/Role.d.ts +53 -26
- 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 +60 -27
- package/dist/constructs/v1beta1/team/Team.d.ts +60 -27
- 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 +56 -15
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +56 -15
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +4 -4
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +4 -4
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- 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
|
@@ -11,7 +11,7 @@ interface paths {
|
|
|
11
11
|
/** Removes a role assignment by ID. */
|
|
12
12
|
delete: operations["deleteRole"];
|
|
13
13
|
};
|
|
14
|
-
"/api/identity/orgs/{
|
|
14
|
+
"/api/identity/orgs/{orgId}/roles": {
|
|
15
15
|
/** Returns all roles defined for the specified organization. */
|
|
16
16
|
get: operations["getAllRoles"];
|
|
17
17
|
/** Updates role assignments for multiple users in the organization. */
|
|
@@ -19,11 +19,11 @@ interface paths {
|
|
|
19
19
|
/** Creates or updates a role for the specified organization. */
|
|
20
20
|
post: operations["upsertRole"];
|
|
21
21
|
};
|
|
22
|
-
"/api/identity/orgs/{
|
|
22
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains": {
|
|
23
23
|
/** Returns all keychains assigned to the specified role. */
|
|
24
24
|
get: operations["getRoleKeychains"];
|
|
25
25
|
};
|
|
26
|
-
"/api/identity/orgs/{
|
|
26
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}": {
|
|
27
27
|
/** Associates a keychain with the specified role. */
|
|
28
28
|
post: operations["assignKeychainToRole"];
|
|
29
29
|
/** Removes the association between a keychain and a role. */
|
|
@@ -53,7 +53,10 @@ interface components {
|
|
|
53
53
|
* @description Timestamp when the resource was updated.
|
|
54
54
|
*/
|
|
55
55
|
updated_at?: string;
|
|
56
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* Format: date-time
|
|
58
|
+
* @description Timestamp when the role was soft-deleted.
|
|
59
|
+
*/
|
|
57
60
|
deleted_at?: string;
|
|
58
61
|
};
|
|
59
62
|
/** @description A paginated list of roles. */
|
|
@@ -84,7 +87,10 @@ interface components {
|
|
|
84
87
|
* @description Timestamp when the resource was updated.
|
|
85
88
|
*/
|
|
86
89
|
updated_at?: string;
|
|
87
|
-
/**
|
|
90
|
+
/**
|
|
91
|
+
* Format: date-time
|
|
92
|
+
* @description Timestamp when the role was soft-deleted.
|
|
93
|
+
*/
|
|
88
94
|
deleted_at?: string;
|
|
89
95
|
}[];
|
|
90
96
|
};
|
|
@@ -115,7 +121,10 @@ interface components {
|
|
|
115
121
|
* @description Timestamp when the resource was updated.
|
|
116
122
|
*/
|
|
117
123
|
updated_at: string;
|
|
118
|
-
/**
|
|
124
|
+
/**
|
|
125
|
+
* Format: date-time
|
|
126
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
127
|
+
*/
|
|
119
128
|
deleted_at?: string;
|
|
120
129
|
};
|
|
121
130
|
/** @description Request body for assigning a role to a user. */
|
|
@@ -151,7 +160,10 @@ interface components {
|
|
|
151
160
|
created_at?: string;
|
|
152
161
|
/** Format: date-time */
|
|
153
162
|
updated_at?: string;
|
|
154
|
-
/**
|
|
163
|
+
/**
|
|
164
|
+
* Format: date-time
|
|
165
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
166
|
+
*/
|
|
155
167
|
deleted_at?: string;
|
|
156
168
|
};
|
|
157
169
|
/** @description User notification preferences. */
|
|
@@ -192,11 +204,11 @@ interface components {
|
|
|
192
204
|
/** @description Role ID */
|
|
193
205
|
id: string;
|
|
194
206
|
/** @description Organization ID */
|
|
195
|
-
|
|
207
|
+
orgId: string;
|
|
196
208
|
/** @description Role ID */
|
|
197
|
-
|
|
209
|
+
roleId: string;
|
|
198
210
|
/** @description Keychain ID */
|
|
199
|
-
|
|
211
|
+
keychainId: string;
|
|
200
212
|
/** @description Get responses by page */
|
|
201
213
|
page: string;
|
|
202
214
|
/** @description Get responses by pagesize */
|
|
@@ -294,7 +306,7 @@ interface operations {
|
|
|
294
306
|
parameters: {
|
|
295
307
|
path: {
|
|
296
308
|
/** Organization ID */
|
|
297
|
-
|
|
309
|
+
orgId: string;
|
|
298
310
|
};
|
|
299
311
|
query: {
|
|
300
312
|
/** Get responses by page */
|
|
@@ -344,7 +356,10 @@ interface operations {
|
|
|
344
356
|
* @description Timestamp when the resource was updated.
|
|
345
357
|
*/
|
|
346
358
|
updated_at?: string;
|
|
347
|
-
/**
|
|
359
|
+
/**
|
|
360
|
+
* Format: date-time
|
|
361
|
+
* @description Timestamp when the role was soft-deleted.
|
|
362
|
+
*/
|
|
348
363
|
deleted_at?: string;
|
|
349
364
|
}[];
|
|
350
365
|
};
|
|
@@ -369,7 +384,7 @@ interface operations {
|
|
|
369
384
|
parameters: {
|
|
370
385
|
path: {
|
|
371
386
|
/** Organization ID */
|
|
372
|
-
|
|
387
|
+
orgId: string;
|
|
373
388
|
};
|
|
374
389
|
};
|
|
375
390
|
responses: {
|
|
@@ -418,7 +433,10 @@ interface operations {
|
|
|
418
433
|
created_at?: string;
|
|
419
434
|
/** Format: date-time */
|
|
420
435
|
updated_at?: string;
|
|
421
|
-
/**
|
|
436
|
+
/**
|
|
437
|
+
* Format: date-time
|
|
438
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
439
|
+
*/
|
|
422
440
|
deleted_at?: string;
|
|
423
441
|
}[];
|
|
424
442
|
};
|
|
@@ -429,7 +447,7 @@ interface operations {
|
|
|
429
447
|
parameters: {
|
|
430
448
|
path: {
|
|
431
449
|
/** Organization ID */
|
|
432
|
-
|
|
450
|
+
orgId: string;
|
|
433
451
|
};
|
|
434
452
|
};
|
|
435
453
|
responses: {
|
|
@@ -456,7 +474,10 @@ interface operations {
|
|
|
456
474
|
* @description Timestamp when the resource was updated.
|
|
457
475
|
*/
|
|
458
476
|
updated_at?: string;
|
|
459
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* Format: date-time
|
|
479
|
+
* @description Timestamp when the role was soft-deleted.
|
|
480
|
+
*/
|
|
460
481
|
deleted_at?: string;
|
|
461
482
|
};
|
|
462
483
|
};
|
|
@@ -502,7 +523,10 @@ interface operations {
|
|
|
502
523
|
* @description Timestamp when the resource was updated.
|
|
503
524
|
*/
|
|
504
525
|
updated_at?: string;
|
|
505
|
-
/**
|
|
526
|
+
/**
|
|
527
|
+
* Format: date-time
|
|
528
|
+
* @description Timestamp when the role was soft-deleted.
|
|
529
|
+
*/
|
|
506
530
|
deleted_at?: string;
|
|
507
531
|
};
|
|
508
532
|
};
|
|
@@ -513,9 +537,9 @@ interface operations {
|
|
|
513
537
|
parameters: {
|
|
514
538
|
path: {
|
|
515
539
|
/** Organization ID */
|
|
516
|
-
|
|
540
|
+
orgId: string;
|
|
517
541
|
/** Role ID */
|
|
518
|
-
|
|
542
|
+
roleId: string;
|
|
519
543
|
};
|
|
520
544
|
query: {
|
|
521
545
|
/** Get responses by page */
|
|
@@ -559,7 +583,10 @@ interface operations {
|
|
|
559
583
|
* @description Timestamp when the resource was updated.
|
|
560
584
|
*/
|
|
561
585
|
updated_at: string;
|
|
562
|
-
/**
|
|
586
|
+
/**
|
|
587
|
+
* Format: date-time
|
|
588
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
589
|
+
*/
|
|
563
590
|
deleted_at?: string;
|
|
564
591
|
}[];
|
|
565
592
|
};
|
|
@@ -590,11 +617,11 @@ interface operations {
|
|
|
590
617
|
parameters: {
|
|
591
618
|
path: {
|
|
592
619
|
/** Organization ID */
|
|
593
|
-
|
|
620
|
+
orgId: string;
|
|
594
621
|
/** Role ID */
|
|
595
|
-
|
|
622
|
+
roleId: string;
|
|
596
623
|
/** Keychain ID */
|
|
597
|
-
|
|
624
|
+
keychainId: string;
|
|
598
625
|
};
|
|
599
626
|
};
|
|
600
627
|
responses: {
|
|
@@ -625,11 +652,11 @@ interface operations {
|
|
|
625
652
|
parameters: {
|
|
626
653
|
path: {
|
|
627
654
|
/** Organization ID */
|
|
628
|
-
|
|
655
|
+
orgId: string;
|
|
629
656
|
/** Role ID */
|
|
630
|
-
|
|
657
|
+
roleId: string;
|
|
631
658
|
/** Keychain ID */
|
|
632
|
-
|
|
659
|
+
keychainId: string;
|
|
633
660
|
};
|
|
634
661
|
};
|
|
635
662
|
responses: {
|
|
@@ -11,7 +11,7 @@ interface paths {
|
|
|
11
11
|
/** Removes a role assignment by ID. */
|
|
12
12
|
delete: operations["deleteRole"];
|
|
13
13
|
};
|
|
14
|
-
"/api/identity/orgs/{
|
|
14
|
+
"/api/identity/orgs/{orgId}/roles": {
|
|
15
15
|
/** Returns all roles defined for the specified organization. */
|
|
16
16
|
get: operations["getAllRoles"];
|
|
17
17
|
/** Updates role assignments for multiple users in the organization. */
|
|
@@ -19,11 +19,11 @@ interface paths {
|
|
|
19
19
|
/** Creates or updates a role for the specified organization. */
|
|
20
20
|
post: operations["upsertRole"];
|
|
21
21
|
};
|
|
22
|
-
"/api/identity/orgs/{
|
|
22
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains": {
|
|
23
23
|
/** Returns all keychains assigned to the specified role. */
|
|
24
24
|
get: operations["getRoleKeychains"];
|
|
25
25
|
};
|
|
26
|
-
"/api/identity/orgs/{
|
|
26
|
+
"/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}": {
|
|
27
27
|
/** Associates a keychain with the specified role. */
|
|
28
28
|
post: operations["assignKeychainToRole"];
|
|
29
29
|
/** Removes the association between a keychain and a role. */
|
|
@@ -53,7 +53,10 @@ interface components {
|
|
|
53
53
|
* @description Timestamp when the resource was updated.
|
|
54
54
|
*/
|
|
55
55
|
updated_at?: string;
|
|
56
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* Format: date-time
|
|
58
|
+
* @description Timestamp when the role was soft-deleted.
|
|
59
|
+
*/
|
|
57
60
|
deleted_at?: string;
|
|
58
61
|
};
|
|
59
62
|
/** @description A paginated list of roles. */
|
|
@@ -84,7 +87,10 @@ interface components {
|
|
|
84
87
|
* @description Timestamp when the resource was updated.
|
|
85
88
|
*/
|
|
86
89
|
updated_at?: string;
|
|
87
|
-
/**
|
|
90
|
+
/**
|
|
91
|
+
* Format: date-time
|
|
92
|
+
* @description Timestamp when the role was soft-deleted.
|
|
93
|
+
*/
|
|
88
94
|
deleted_at?: string;
|
|
89
95
|
}[];
|
|
90
96
|
};
|
|
@@ -115,7 +121,10 @@ interface components {
|
|
|
115
121
|
* @description Timestamp when the resource was updated.
|
|
116
122
|
*/
|
|
117
123
|
updated_at: string;
|
|
118
|
-
/**
|
|
124
|
+
/**
|
|
125
|
+
* Format: date-time
|
|
126
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
127
|
+
*/
|
|
119
128
|
deleted_at?: string;
|
|
120
129
|
};
|
|
121
130
|
/** @description Request body for assigning a role to a user. */
|
|
@@ -151,7 +160,10 @@ interface components {
|
|
|
151
160
|
created_at?: string;
|
|
152
161
|
/** Format: date-time */
|
|
153
162
|
updated_at?: string;
|
|
154
|
-
/**
|
|
163
|
+
/**
|
|
164
|
+
* Format: date-time
|
|
165
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
166
|
+
*/
|
|
155
167
|
deleted_at?: string;
|
|
156
168
|
};
|
|
157
169
|
/** @description User notification preferences. */
|
|
@@ -192,11 +204,11 @@ interface components {
|
|
|
192
204
|
/** @description Role ID */
|
|
193
205
|
id: string;
|
|
194
206
|
/** @description Organization ID */
|
|
195
|
-
|
|
207
|
+
orgId: string;
|
|
196
208
|
/** @description Role ID */
|
|
197
|
-
|
|
209
|
+
roleId: string;
|
|
198
210
|
/** @description Keychain ID */
|
|
199
|
-
|
|
211
|
+
keychainId: string;
|
|
200
212
|
/** @description Get responses by page */
|
|
201
213
|
page: string;
|
|
202
214
|
/** @description Get responses by pagesize */
|
|
@@ -294,7 +306,7 @@ interface operations {
|
|
|
294
306
|
parameters: {
|
|
295
307
|
path: {
|
|
296
308
|
/** Organization ID */
|
|
297
|
-
|
|
309
|
+
orgId: string;
|
|
298
310
|
};
|
|
299
311
|
query: {
|
|
300
312
|
/** Get responses by page */
|
|
@@ -344,7 +356,10 @@ interface operations {
|
|
|
344
356
|
* @description Timestamp when the resource was updated.
|
|
345
357
|
*/
|
|
346
358
|
updated_at?: string;
|
|
347
|
-
/**
|
|
359
|
+
/**
|
|
360
|
+
* Format: date-time
|
|
361
|
+
* @description Timestamp when the role was soft-deleted.
|
|
362
|
+
*/
|
|
348
363
|
deleted_at?: string;
|
|
349
364
|
}[];
|
|
350
365
|
};
|
|
@@ -369,7 +384,7 @@ interface operations {
|
|
|
369
384
|
parameters: {
|
|
370
385
|
path: {
|
|
371
386
|
/** Organization ID */
|
|
372
|
-
|
|
387
|
+
orgId: string;
|
|
373
388
|
};
|
|
374
389
|
};
|
|
375
390
|
responses: {
|
|
@@ -418,7 +433,10 @@ interface operations {
|
|
|
418
433
|
created_at?: string;
|
|
419
434
|
/** Format: date-time */
|
|
420
435
|
updated_at?: string;
|
|
421
|
-
/**
|
|
436
|
+
/**
|
|
437
|
+
* Format: date-time
|
|
438
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
439
|
+
*/
|
|
422
440
|
deleted_at?: string;
|
|
423
441
|
}[];
|
|
424
442
|
};
|
|
@@ -429,7 +447,7 @@ interface operations {
|
|
|
429
447
|
parameters: {
|
|
430
448
|
path: {
|
|
431
449
|
/** Organization ID */
|
|
432
|
-
|
|
450
|
+
orgId: string;
|
|
433
451
|
};
|
|
434
452
|
};
|
|
435
453
|
responses: {
|
|
@@ -456,7 +474,10 @@ interface operations {
|
|
|
456
474
|
* @description Timestamp when the resource was updated.
|
|
457
475
|
*/
|
|
458
476
|
updated_at?: string;
|
|
459
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* Format: date-time
|
|
479
|
+
* @description Timestamp when the role was soft-deleted.
|
|
480
|
+
*/
|
|
460
481
|
deleted_at?: string;
|
|
461
482
|
};
|
|
462
483
|
};
|
|
@@ -502,7 +523,10 @@ interface operations {
|
|
|
502
523
|
* @description Timestamp when the resource was updated.
|
|
503
524
|
*/
|
|
504
525
|
updated_at?: string;
|
|
505
|
-
/**
|
|
526
|
+
/**
|
|
527
|
+
* Format: date-time
|
|
528
|
+
* @description Timestamp when the role was soft-deleted.
|
|
529
|
+
*/
|
|
506
530
|
deleted_at?: string;
|
|
507
531
|
};
|
|
508
532
|
};
|
|
@@ -513,9 +537,9 @@ interface operations {
|
|
|
513
537
|
parameters: {
|
|
514
538
|
path: {
|
|
515
539
|
/** Organization ID */
|
|
516
|
-
|
|
540
|
+
orgId: string;
|
|
517
541
|
/** Role ID */
|
|
518
|
-
|
|
542
|
+
roleId: string;
|
|
519
543
|
};
|
|
520
544
|
query: {
|
|
521
545
|
/** Get responses by page */
|
|
@@ -559,7 +583,10 @@ interface operations {
|
|
|
559
583
|
* @description Timestamp when the resource was updated.
|
|
560
584
|
*/
|
|
561
585
|
updated_at: string;
|
|
562
|
-
/**
|
|
586
|
+
/**
|
|
587
|
+
* Format: date-time
|
|
588
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
589
|
+
*/
|
|
563
590
|
deleted_at?: string;
|
|
564
591
|
}[];
|
|
565
592
|
};
|
|
@@ -590,11 +617,11 @@ interface operations {
|
|
|
590
617
|
parameters: {
|
|
591
618
|
path: {
|
|
592
619
|
/** Organization ID */
|
|
593
|
-
|
|
620
|
+
orgId: string;
|
|
594
621
|
/** Role ID */
|
|
595
|
-
|
|
622
|
+
roleId: string;
|
|
596
623
|
/** Keychain ID */
|
|
597
|
-
|
|
624
|
+
keychainId: string;
|
|
598
625
|
};
|
|
599
626
|
};
|
|
600
627
|
responses: {
|
|
@@ -625,11 +652,11 @@ interface operations {
|
|
|
625
652
|
parameters: {
|
|
626
653
|
path: {
|
|
627
654
|
/** Organization ID */
|
|
628
|
-
|
|
655
|
+
orgId: string;
|
|
629
656
|
/** Role ID */
|
|
630
|
-
|
|
657
|
+
roleId: string;
|
|
631
658
|
/** Keychain ID */
|
|
632
|
-
|
|
659
|
+
keychainId: string;
|
|
633
660
|
};
|
|
634
661
|
};
|
|
635
662
|
responses: {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
'use strict';var e={openapi:"3.0.0",info:{title:"role",description:"Documentation for Meshery Cloud REST APIs for Roles",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"},version:"v1beta1"},servers:[{url:"https://cloud.layer5.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.layer5.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"roles",description:"Operations related to roles and role assignments"}],paths:{"/api/identity/roles":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Add role holder",operationId:"addRoleHolder",description:"Assigns a role to a user identified by email.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Request body for assigning a role to a user.",required:["email","role_names"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1},role_names:{type:"array",items:{type:"string"},description:"List of role names to assign.","x-order":2}}}}}},responses:{200:{description:"Role holder added successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/roles/{id}":{delete:{"x-internal":["cloud"],tags:["roles"],summary:"Delete role",operationId:"deleteRole",description:"Removes a role assignment by ID.",parameters:[{name:"id",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Role deleted successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgID}/roles":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get organization roles",operationId:"getAllRoles",description:"Returns all roles defined for the specified organization.",parameters:[{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string"}},{name:"teamID",in:"query",description:"Team ID used when selector is team.",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Roles fetched successfully",content:{"application/json":{schema:{type:"object",description:"A paginated list of roles.",required:["page","page_size","total_count","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1},page_size:{type:"integer",description:"Number of roles per page.","x-order":2},total_count:{type:"integer",description:"Total number of roles across all pages.","x-order":3},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},"x-order":4}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["roles"],summary:"Upsert organization role",operationId:"upsertRole",description:"Creates or updates a role for the specified organization.",parameters:[{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}}}}},responses:{200:{description:"Role upserted successfully",content:{"application/json":{schema:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["roles"],summary:"Bulk edit role holders",operationId:"bulkEditRoleHolder",description:"Updates role assignments for multiple users in the organization.",parameters:[{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"array",items:{type:"object",description:"Request to update role assignments for a user.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1},user_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2},username:{type:"string","x-order":3},email:{type:"string",format:"email","x-order":4},first_name:{type:"string","x-order":5},last_name:{type:"string","x-order":6},status:{type:"string","x-order":7},role_names:{type:"array",items:{type:"string"},"x-order":8},created_at:{"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-order":11,description:"SQL null Timestamp to handle null values of time.","x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}}}}}},responses:{200:{description:"Role holders updated successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgID}/roles/{roleID}/keychains":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get keychains for role",operationId:"getRoleKeychains",description:"Returns all keychains assigned to the specified role.",parameters:[{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"roleID",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}}],responses:{200:{description:"Keychains fetched successfully",content:{"application/json":{schema:{type:"object",required:["page","page_size","total_count","keychains"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keychains:{type:"array",items:{type:"object",description:"Represents a collection of keys.",required:["id","name","owner","created_at","updated_at"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1},name:{type:"string",description:"Name of the keychain.","x-oapi-codegen-extra-tags":{db:"name"},"x-order":2},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"},"x-order":3},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":6,description:"SQL null Timestamp to handle null values of time.","x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},"x-order":4}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgID}/roles/{roleID}/keychains/{keychainID}":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Assign keychain to role",operationId:"assignKeychainToRole",description:"Associates a keychain with the specified role.",parameters:[{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"roleID",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keychainID",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Keychain assigned to role successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["roles"],summary:"Unassign keychain from role",operationId:"unassignKeychainFromRole",description:"Removes the association between a keychain and a role.",parameters:[{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"roleID",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keychainID",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Keychain unassigned from role successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{id:{name:"id",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},orgID:{name:"orgID",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},roleID:{name:"roleID",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},keychainID:{name:"keychainID",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},all:{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},selector:{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string"}},teamID:{name:"teamID",in:"query",description:"Team ID used when selector is team.",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{Role:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},RolesPage:{type:"object",description:"A paginated list of roles.",required:["page","page_size","total_count","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1},page_size:{type:"integer",description:"Number of roles per page.","x-order":2},total_count:{type:"integer",description:"Total number of roles across all pages.","x-order":3},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},"x-order":4}}},RolesKeychainsMapping:{type:"object",description:"Mapping between a role and a keychain.",required:["id","keychain_id","role_id","created_at","updated_at"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},keychain_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2,"x-oapi-codegen-extra-tags":{db:"keychain_id"}},role_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":3,"x-oapi-codegen-extra-tags":{db:"role_id"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},description:"SQL null Timestamp to handle null values of time.","x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},RoleHolderRequest:{type:"object",description:"Request body for assigning a role to a user.",required:["email","role_names"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1},role_names:{type:"array",items:{type:"string"},description:"List of role names to assign.","x-order":2}}},UserRoleUpdateRequest:{type:"object",description:"Request to update role assignments for a user.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1},user_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2},username:{type:"string","x-order":3},email:{type:"string",format:"email","x-order":4},first_name:{type:"string","x-order":5},last_name:{type:"string","x-order":6},status:{type:"string","x-order":7},role_names:{type:"array",items:{type:"string"},"x-order":8},created_at:{"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-order":11,description:"SQL null Timestamp to handle null values of time.","x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},Preference:{type:"object",description:"User notification preferences.",required:["welcome_email","notify_role_change"],properties:{welcome_email:{type:"boolean",description:"Whether to send a welcome email to new users.","x-order":1},notify_role_change:{type:"boolean",description:"Whether to notify the user of role changes.","x-order":2}}}}}},t=e;
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"role",description:"Documentation for Meshery Cloud REST APIs for Roles",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"},version:"v1beta1"},servers:[{url:"https://cloud.layer5.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.layer5.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"roles",description:"Operations related to roles and role assignments"}],paths:{"/api/identity/roles":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Add role holder",operationId:"addRoleHolder",description:"Assigns a role to a user identified by email.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Request body for assigning a role to a user.",required:["email","role_names"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1},role_names:{type:"array",items:{type:"string"},description:"List of role names to assign.","x-order":2}}}}}},responses:{200:{description:"Role holder added successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/roles/{id}":{delete:{"x-internal":["cloud"],tags:["roles"],summary:"Delete role",operationId:"deleteRole",description:"Removes a role assignment by ID.",parameters:[{name:"id",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Role deleted successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgId}/roles":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get organization roles",operationId:"getAllRoles",description:"Returns all roles defined for the specified organization.",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string"}},{name:"teamID",in:"query",description:"Team ID used when selector is team.",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Roles fetched successfully",content:{"application/json":{schema:{type:"object",description:"A paginated list of roles.",required:["page","page_size","total_count","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1},page_size:{type:"integer",description:"Number of roles per page.","x-order":2},total_count:{type:"integer",description:"Total number of roles across all pages.","x-order":3},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["roles"],summary:"Upsert organization role",operationId:"upsertRole",description:"Creates or updates a role for the specified organization.",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},responses:{200:{description:"Role upserted successfully",content:{"application/json":{schema:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["roles"],summary:"Bulk edit role holders",operationId:"bulkEditRoleHolder",description:"Updates role assignments for multiple users in the organization.",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"array",items:{type:"object",description:"Request to update role assignments for a user.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1},user_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2},username:{type:"string","x-order":3},email:{type:"string",format:"email","x-order":4},first_name:{type:"string","x-order":5},last_name:{type:"string","x-order":6},status:{type:"string","x-order":7},role_names:{type:"array",items:{type:"string"},"x-order":8},created_at:{"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-order":11,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},responses:{200:{description:"Role holders updated successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgId}/roles/{roleId}/keychains":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get keychains for role",operationId:"getRoleKeychains",description:"Returns all keychains assigned to the specified role.",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"roleId",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}}],responses:{200:{description:"Keychains fetched successfully",content:{"application/json":{schema:{type:"object",required:["page","page_size","total_count","keychains"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","created_at","updated_at"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1},name:{type:"string",description:"Name of the keychain.","x-oapi-codegen-extra-tags":{db:"name"},"x-order":2},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"},"x-order":3},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":6,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Assign keychain to role",operationId:"assignKeychainToRole",description:"Associates a keychain with the specified role.",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"roleId",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Keychain assigned to role successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["roles"],summary:"Unassign keychain from role",operationId:"unassignKeychainFromRole",description:"Removes the association between a keychain and a role.",parameters:[{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"roleId",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Keychain unassigned from role successfully"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{id:{name:"id",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},orgId:{name:"orgId",in:"path",description:"Organization ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},roleId:{name:"roleId",in:"path",description:"Role ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},keychainId:{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},all:{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},selector:{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string"}},teamID:{name:"teamID",in:"query",description:"Team ID used when selector is team.",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{Role:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},RolesPage:{type:"object",description:"A paginated list of roles.",required:["page","page_size","total_count","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1},page_size:{type:"integer",description:"Number of roles per page.","x-order":2},total_count:{type:"integer",description:"Total number of roles across all pages.","x-order":3},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["role_name","description"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},role_name:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name"}},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{description:"Timestamp when the role was soft-deleted.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4}}},RolesKeychainsMapping:{type:"object",description:"Mapping between a role and a keychain.",required:["id","keychain_id","role_id","created_at","updated_at"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{db:"id"}},keychain_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2,"x-oapi-codegen-extra-tags":{db:"keychain_id"}},role_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":3,"x-oapi-codegen-extra-tags":{db:"role_id"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at"},description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},RoleHolderRequest:{type:"object",description:"Request body for assigning a role to a user.",required:["email","role_names"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1},role_names:{type:"array",items:{type:"string"},description:"List of role names to assign.","x-order":2}}},UserRoleUpdateRequest:{type:"object",description:"Request to update role assignments for a user.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1},user_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2},username:{type:"string","x-order":3},email:{type:"string",format:"email","x-order":4},first_name:{type:"string","x-order":5},last_name:{type:"string","x-order":6},status:{type:"string","x-order":7},role_names:{type:"array",items:{type:"string"},"x-order":8},created_at:{"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-order":11,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},Preference:{type:"object",description:"User notification preferences.",required:["welcome_email","notify_role_change"],properties:{welcome_email:{type:"boolean",description:"Whether to send a welcome email to new users.","x-order":1},notify_role_change:{type:"boolean",description:"Whether to notify the user of role changes.","x-order":2}}}}}},t=e;
|
|
2
2
|
module.exports=t;
|