mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-06 00:07:44 +01:00
95f4f641b5
https://linear.app/unleash/issue/2-1136/custom-root-roles-documentation - [Adds documentation referencing custom root roles](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/reference/rbac); - [Adds a "How to create and assign custom root roles" how-to guide](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/how-to/how-to-create-and-assign-custom-root-roles); - Standardizes "global" roles to "root" roles; - Standardizes "standard" roles to "predefined" roles to better reflect their behavior and what is shown in our UI; - Updates predefined role descriptions and makes them consistent; - Updates the side panel description of the user form; - Includes some boy scouting with some tiny fixes of things identified along the way (e.g. the role form was persisting old data when closed and re-opened); Questions: - Is it worth expanding the "Assigning custom root roles" section in the "How to create and assign custom root roles" guide to include the steps for assigning a root role for each entity (user, service account, group)? - Should this PR include an update to the existing "How to create and assign custom project roles" guide? We've since updated the UI; --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
37 lines
1.0 KiB
TypeScript
37 lines
1.0 KiB
TypeScript
import { FromSchema } from 'json-schema-to-ts';
|
|
import { userSchema } from './user-schema';
|
|
import { roleSchema } from './role-schema';
|
|
|
|
export const usersSchema = {
|
|
$id: '#/components/schemas/usersSchema',
|
|
type: 'object',
|
|
additionalProperties: false,
|
|
description: 'Users and root roles',
|
|
required: ['users'],
|
|
properties: {
|
|
users: {
|
|
type: 'array',
|
|
description: 'A list of users in the Unleash instance.',
|
|
items: {
|
|
$ref: '#/components/schemas/userSchema',
|
|
},
|
|
},
|
|
rootRoles: {
|
|
type: 'array',
|
|
description:
|
|
'A list of [root roles](https://docs.getunleash.io/reference/rbac#predefined-roles) in the Unleash instance.',
|
|
items: {
|
|
$ref: '#/components/schemas/roleSchema',
|
|
},
|
|
},
|
|
},
|
|
components: {
|
|
schemas: {
|
|
userSchema,
|
|
roleSchema,
|
|
},
|
|
},
|
|
} as const;
|
|
|
|
export type UsersSchema = FromSchema<typeof usersSchema>;
|