Skip to content

feat: add authz schema definition files - #445

Merged
rodmgwgu merged 4 commits into
mainfrom
rod/authz-schema-files
Sep 17, 2026
Merged

rodmgwgu merged 4 commits into
mainfrom
rod/authz-schema-files

Conversation

@rodmgwgu

@rodmgwgu rodmgwgu commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Problem

The schema loading pipeline needs the actual authorization schema definitions (course and library roles/permissions) available in the package before the loader can consume them.

Approach

Adds the schema YAML files under openedx_authz/authz/schema/:

  • course_roles.yaml, course_permissions.yaml
  • library_roles.yaml, library_permissions.yaml
  • get_schema_resources interface implemented in openedx_authz/authz/__init__.py

Rollback plan

Additive-only (new files under a new package dir). Revert the commit to remove them; nothing else references these files until PR 3 lands.

AI Usage

Kiro was used to translate the existing roles and permissions, using the existing descriptions in the frontend code over the policy definition as source of truth, with human guidance and validation.


Stack (2/3):

  1. docs: add ADR for authorization schema source tracking #444 — ADR doc
  2. This PR — authz schema YAML files (base: rod/authz-schema-adr)
  3. rod/authz-schema-loader — schema loading pipeline (base: this branch)

Base is the PR 1 branch; review only the incremental diff. Merge after #444.

Merge checklist:

  • 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 — depends on docs: add ADR for authorization schema source tracking #444

@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 10, 2026
@openedx-webhooks

openedx-webhooks commented Sep 10, 2026

Copy link
Copy Markdown

Thanks for the pull request, @rodmgwgu!

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 10, 2026
@rodmgwgu
rodmgwgu marked this pull request as draft September 10, 2026 18:36
@rodmgwgu
rodmgwgu added this pull request to stack #447 September 10, 2026 18:40
@BryanttV BryanttV linked an issue Sep 11, 2026 that may be closed by this pull request
@rodmgwgu
rodmgwgu force-pushed the rod/authz-schema-files branch from 5480556 to cca7c2f Compare September 11, 2026 17:00
@rodmgwgu
rodmgwgu marked this pull request as ready for review September 11, 2026 17:54
Comment thread openedx_authz/authz/__init__.py
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Sep 17, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Sep 17, 2026
Base automatically changed from rod/authz-schema-adr to main September 17, 2026 15:30
Adds the course and library role/permission schema YAML files under
openedx_authz/authz/. Part 2 of the schema loading pipeline stack.
Relocate the four platform-default schema files into openedx_authz/authz/schema
and drop the .authz filename infix. Update the schema-provider entry point
resource paths and the test that pins them. No loader/discovery implementation
is included; get_schema_resources still returns individual resource paths.
@rodmgwgu
rodmgwgu force-pushed the rod/authz-schema-files branch from 7a47780 to 3c127c1 Compare September 17, 2026 15:30

@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.

Code looks good! I just wanted to note that we should probably include the .yaml files in the MANIFEST.in to prevent them from being excluded from the final package.

@rodmgwgu

Copy link
Copy Markdown
Contributor Author

Code looks good! I just wanted to note that we should probably include the .yaml files in the MANIFEST.in to prevent them from being excluded from the final package.

Added, had that on the next PR in the stack but forgot to put it here too, thanks!

@rodmgwgu
rodmgwgu merged commit a910842 into main Sep 17, 2026
8 checks passed
@rodmgwgu
rodmgwgu deleted the rod/authz-schema-files branch September 17, 2026 18:51
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). mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Core Loader, Compilation, and Definition Validation

5 participants