Skip to content

docs: define static role extensions - #430

Open
mariajgrimaldi wants to merge 4 commits into
MJG/authz-schema/implicationsfrom
MJG/authz-schema/role-extensions
Open

docs: define static role extensions#430
mariajgrimaldi wants to merge 4 commits into
MJG/authz-schema/implicationsfrom
MJG/authz-schema/role-extensions

Conversation

@mariajgrimaldi

@mariajgrimaldi mariajgrimaldi commented Sep 1, 2026

Copy link
Copy Markdown
Member

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_extensions fields, validation and priority behavior, and what hiding a role means. It also shows how a Tutor operator can provide an extension through an openedx-authz-schema patch and verify the resulting permissions with the existing enforcement management command.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Sep 1, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Sep 1, 2026
@mariajgrimaldi mariajgrimaldi changed the title MJG/authz schema/role extensions docs: define static role extensions Sep 1, 2026
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/authz-schema/role-extensions branch from f3b7e19 to 5aa8163 Compare September 1, 2026 16:03
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/authz-schema/role-extensions branch 2 times, most recently from 3c762ed to e84691b Compare September 1, 2026 16:21
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/authz-schema/role-extensions branch from e84691b to b38b81f Compare September 1, 2026 16:27
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/authz-schema/role-extensions branch from b38b81f to da4039c Compare September 1, 2026 16:37

@BryanttV BryanttV left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! just a couple of comments

Comment on lines +31 to +45
.. 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants