docs: define the static authorization schema

[mariajgrimaldi]

Description

Static roles, permissions, and their display information are currently spread across Python, Casbin policy files, and frontend code. As a result, an application that adds a role or permission must update several representations and may also need changes in openedx-authz and the frontend.

This ADR defines one versioned YAML schema for static authorization definitions. Applications can declare permissions, categories, roles, role extensions, scopes, and UI metadata with stable identifiers, while deployment compiles those definitions into the rows Casbin needs.

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]

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[rodmgwgu]

Looking good, just added a couple of points for discussion. Thanks!

[BryanttV]

Thanks for this @mariajgrimaldi!

[BryanttV]

What happens to the current role and permission definitions in the Python modules? Will we keep using them? If I want to create a new permission, do I have to add it to the YAML and the Python constants file? Or will we do something different?

[mariajgrimaldi]

We'd need to entirely migrate to a configuration file to avoid having definitions scattered across multiple places

[mariajgrimaldi]

I made some changes: 917b782

[BryanttV]

Thanks! I agree that we should proceed with the migration.

However, by removing the Python files containing the roles and permissions constants, we wouldn't have a way to import a specific permission from another application. For example, in openedx-platform we currently do:

from openedx_authz.constants.permissions import COURSES_VIEW_COURSE

We would need to find a way to solve this without having to update openedx-authz for every new permission created via an extension. What do you think?

[rodmgwgu]

Ideally, the roles and permissions definitions would be defined in the module that uses them, in that case, the courses permissions should be moved out of openedx-authz and into the relevant module in openedx-platform, then, the owner module would define constants within itself.

[mariajgrimaldi]

I like that, @rodmgwgu! Much simpler of what I was thinking of turning permissions from .yml definition files into constants during runtime andi injecting them somewhere so they become available

[rodmgwgu]

Looks good, thanks!

[BryanttV]

Thanks for the hard work! LGTM