Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Proper Role Descriptions with a 255-Character Limit #57

Open
2 tasks
sanjaysah101 opened this issue Sep 18, 2024 · 0 comments
Open
2 tasks

Add Proper Role Descriptions with a 255-Character Limit #57

sanjaysah101 opened this issue Sep 18, 2024 · 0 comments
Labels
ansopedia documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest

Comments

@sanjaysah101
Copy link
Collaborator

sanjaysah101 commented Sep 18, 2024

Description

We need to ensure that each role in the rbac.constant.ts file has a description field that accurately describes the role, limited to 255 characters.

Key Details:

  • The update is only required in the rbac.constant.ts file.
  • No changes are needed to any other files or logic.
  • Ensure the description field for each role is updated to provide a clear understanding of the role's purpose and permissions.

Content of rbac.constant.ts:

export const defaultRoles: createRole[] = [
  {
    name: ROLES.SUPER_ADMIN,
    description: 'Super Administrator with all permissions',
    isSystemRole: true,
    createdBy: systemUserObjectId,
    isDeleted: false,
  },
  {
    name: ROLES.ADMIN,
    description: 'Administrator with limited permissions',
    isSystemRole: true,
    createdBy: systemUserObjectId,
    isDeleted: false,
  },
  {
    name: ROLES.USER,
    description: 'Regular user with basic permissions',
    isSystemRole: true,
    createdBy: systemUserObjectId,
    isDeleted: false,
  },
];

Tasks:

  • Update role descriptions in rbac.constant.ts file to ensure they provide meaningful summaries.
  • Ensure descriptions do not exceed 255 characters otherwise you get a validation error.
@sanjaysah101 sanjaysah101 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ansopedia documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant