docs: define static role extensions - #430
Conversation
|
Thanks for the pull request, @mariajgrimaldi! 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. |
f3b7e19 to
5aa8163
Compare
3c762ed to
e84691b
Compare
e84691b to
b38b81f
Compare
b38b81f to
da4039c
Compare
BryanttV
left a comment
There was a problem hiding this comment.
LGTM! just a couple of comments
| .. code-block:: yaml | ||
|
|
||
| schema_version: "1.0" | ||
| priority: 200 | ||
|
|
||
| role_extensions: | ||
| - role: course_editor | ||
| add_permissions: | ||
| - courses.export_course | ||
| remove_permissions: | ||
| - courses.manage_tags | ||
| display_name: Course author | ||
| description: Creates and exports course content. | ||
| - role: course_auditor | ||
| hidden: true |
There was a problem hiding this comment.
I know YAML files are still used for patches, but since Python modules are now recommended, can we update the example?
|
|
||
| Fields that are not present keep their current value. An extension cannot change the role ID or replace its complete definition. | ||
|
|
||
| 2. Hiding a role |
There was a problem hiding this comment.
Does hiding a static role using hidden: true free up its name so that an admin can create a dynamic role with the same ID? I don't think so, but perhaps we should clarify it.
Description
Operators may need to adapt a static role for their deployment without copying and replacing the complete definition shipped by an application. They may need to add or remove permissions, change the display metadata, or hide a role that does not apply to their site.
This ADR defines the supported
role_extensionsfields, validation and priority behavior, and what hiding a role means. It also shows how a Tutor operator can provide an extension through anopenedx-authz-schemapatch and verify the resulting permissions with the existingenforcementmanagement command.Merge checklist:
Check off if complete or not applicable: