Repository navigation
docs: add ADR for hidden permission categories and permissions - #633
Conversation
|
Thanks for the pull request, @BryanttV! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
a9dd178 to
0a5e9c0
Compare
0a5e9c0 to
8f7e5bf
Compare
There was a problem hiding this comment.
Can we also update https://github.com/openedx/openedx-authz/blob/main/src/openedx_authz/engine/schema/authz-schema-v1.json adding the new field? Thanks!
EDIT: I see we did it in #634
mariajgrimaldi
left a comment
There was a problem hiding this comment.
This makes sense to me! Since the hidden field is only meant to control visibility and doesn't affect authorization behavior, I think it makes sense for hiding a category to also hide all its permissions.
Looks good to me!
33036d4 to
3d7d667
Compare
Document the optional `hidden` flag for permission categories and permissions, and update the schema references and the role catalog and role extension ADRs. Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
3d7d667 to
ad066f8
Compare
rodmgwgu
left a comment
There was a problem hiding this comment.
Thanks for this!, it's consistent with what we discussed, so all good here!
Description
ADR 0023 lets a role be hidden with the
hiddenflag, but permission categories and permissions have no equivalent. Compatibility permissions, such as thelegacy_*permissions in thecourse_legacycategory, must keep working but should not be offered when an administrator builds a custom role, nor listed in the permissions of the roles that grant them.This PR adds ADR 0038, which proposes an optional
hiddenboolean (defaultfalse) on permission categories and permissions:hidden: trueor when its category does.permissionslist and of each role'spermissionslist. Thecategorieslist only contains non-hidden categories that still have a visible permission.permissionslist.hidden; it is set only where the category or permission is defined.Related docs updated:
docs/decisions/0023-extend-static-roles.rst: addendum extending "Hiding a role" to categories and permissions.docs/decisions/0028-api-contract-for-role-catalog.rst: addendum amending thepermissions,roles, andcategoriesresponse rules.docs/references/authorization-schema.rst: documents thehiddenfield for categories and permissions.Affected roles: Developers and operators who define schemas; administrators using the Custom Roles feature (no behavior change until the implementation lands).
Supporting Information
docs/decisions/0038-hidden-permission-categories-and-permissions.rstTesting Instructions
Deadline
Willow
Other Information
This PR is documentation only; the schema models, migration, and catalog changes are in #634