feat: implement authz schema loading pipeline - #446
Conversation
Adds the schema discovery, compilation, validation, rendering and loading pipeline, the load_authz_schema management command, schema models and migration, and supporting tests. Part 3 of the stack.
openedx-webhooks
added
open-source-contribution
|
Thanks for the pull request, @rodmgwgu! 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. 🔘 Update the status of your PRYour PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate. 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
2 participants
Problem
Authorization schema definitions need to be discovered, compiled, validated, rendered, and loaded into the database, with a management command and persistence models to support it.
Approach
Implements the full pipeline and supporting code:
openedx_authz/engine/schema/— discovery, compilation, validation, loading, pipeline, types, exceptionsopenedx_authz/engine/renderer.py— schema renderingopenedx_authz/management/commands/load_authz_schema.py— management commandopenedx_authz/models/schema.py+ migration0011_authz_schema_definitions.pyMANIFEST.in/setup.pypackaging updates for the YAML data filesopenedx_authz/tests/schema/Rollback plan
Revert this PR to remove the pipeline; the schema YAML files (PR 2) and ADR (PR 1) remain but are inert without this code. The new migration is additive; roll back by reverting and running the reverse migration if applied.
Stack (3/3):
rod/authz-schema-files)Merge checklist: