docs: add authorization schema reference

[mariajgrimaldi]

Description

Developers and site operators need one practical reference for building and extending the Open edX Authorization schema. This PR documents the schema fields, naming conventions, application and Tutor examples, and the command used to check the resulting permissions. It also links the reference from ADR 0017 and ADR 0023 so readers can move from the decisions to the configuration details.

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.

[BryanttV]

Thanks for adding this reference, it's very comprehensive and really useful. My only suggestion would be to use Python modules instead of YAML for the Tutor plugin example.

[mariajgrimaldi]

@rodmgwgu: I wanted to generate the sample schema as an example of the schema we'd be using but it wasn't as readable as is. I made some changes so it renders better:

https://docsopenedxorg--431.org.readthedocs.build/projects/openedx-authz/en/431/references/authorization-schema.html#machine-readable-schema

Could you take a look? Thanks! :)

[rodmgwgu]

@rodmgwgu: I wanted to generate the sample schema as an example of the schema we'd be using but it wasn't as readable as is. I made some changes so it renders better:

https://docsopenedxorg--431.org.readthedocs.build/projects/openedx-authz/en/431/references/authorization-schema.html#machine-readable-schema

Could you take a look? Thanks! :)

Looks much better now, thanks!