Skip to content

[docs] Document RBAC role: concept, flows, and reference update - #67

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/access-governance-role-a2bc034b40d2498f
Draft

[docs] Document RBAC role: concept, flows, and reference update#67
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/access-governance-role-a2bc034b40d2498f

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Ezhuthachan

Documents the RBAC role primitive for access-governance/role, as requested in #62. <doc-types> was omitted, so all three layers are covered.

Added

  • concepts/access-governance/role.mdx — plain-language concept: what a role holds, contexts, system vs custom roles, how a role reaches a user.
  • flows/access-governance/create-a-role.mdx — create a custom role from the admin RBAC page.
  • flows/access-governance/edit-a-role.mdx — edit a custom role, and clone any role (including a system role).
  • flows/access-governance/_category_.json — new flow domain folder.

Both flows are listed in the manual flow sidebar for each version.

Changed (rewritten sections, not whole files)

  • references/access-governance/role.mdx — added a ## Viewset section (authorization is superuser-only for writes, filters, permission replacement on update, delete guard) and a ## Permission and role sync section for sync_permissions_roles. Corrected the claim that a user with "the right permission" can delete a custom role: the viewset requires is_superuser. Added concept and flow links.
  • concepts/access-governance/access-control.mdx — added links to the new concept and flow. No other line changed.

All files are mirrored byte-identical to version-3.0 and version-3.1, along with both sidebar files.

Traced to

  • care/security/models/role.py, care/security/models/permission.py
  • care/security/api/viewsets/roles.py, care/security/utils/permission_class.py
  • care/emr/resources/role/spec.py
  • care/security/roles/role.py, care/security/permissions/base.py, care/security/permissions/constants.py
  • care/security/management/commands/sync_permissions_roles.py
  • care_fe: src/Routers/routes/adminRoutes.tsx, src/components/ui/sidebar/admin-nav.tsx, src/pages/Admin/Roles/RolesIndex.tsx, src/pages/Admin/Roles/RoleForm.tsx, src/types/emr/role/role.ts, public/locale/en.json

Left out

  • The flow ## Permissions tables state the account type, not a permission name. The role viewset has no permission slug: permissions_controller returns True for read and request.user.is_superuser for every write.
  • No keyboard shortcut is documented. src/config/keyboardShortcuts.json defines none for the roles page.
  • No delete-a-role flow. The roles page offers only Edit and Clone, although the API supports delete.

Validation

npm run build[SUCCESS] for en and ml, exit code 0. Corruption scan clean.

Generated by Ezhuthachan for #62 · opus50 · 367.7 AIC · ⌖ 14 AIC · ⊞ 14.4K ·
Comment /document to run again

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Aug 10, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploying coredocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9c69f3e
Status: ✅  Deploy successful!
Preview URL: https://29bbd5f9.coredocs.pages.dev
Branch Preview URL: https://docs-access-governance-role.coredocs.pages.dev

View logs

@github-actions github-actions Bot mentioned this pull request Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants