Repository navigation
docs: add ADR 0028 Tutor Implementation for authz schema discovery - #519
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @carlos-marquez-wgu! 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. DetailsWhere 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. |
9011dc1 to
0b554ba
Compare
|
|
||
| We will implement the Tutor integration as a new plugin in `openedx-tutor-plugins`_. The plugin will: | ||
|
|
||
| * define the ``openedx-authz-schema`` patch and render its content to a single YAML file, separating contributions with ``---`` so each remains an independent document; |
There was a problem hiding this comment.
Who will be responsible of adding the separators? the plugin itself? or the patch authors?
Would we add validation to make sure the yaml syntax for each contribution is correct and we don't get duplicated separators?
There was a problem hiding this comment.
The plugin itself will be responsible of adding the separators, it can be done with something like this:
{{ patch('openedx-authz-schema', separator='\n---\n') }}
For validation, the method yaml.safe_load_all() will render duplicated separators as None (empty documents), for syntax validation in individual documents will throw an error and be covered by the existing code (both validation step and just when trying to read the yaml, a malformed doc will error and stop the process)
I updated the ADR to clarify both points
0b554ba to
48964de
Compare
48964de to
3cc4788
Compare
3 participants
Description
Adds ADR-0028 which defines how the Tutor implementation for authorization schema discovery works.
Authorization schema discovery already proposed a Tutor patch route in ADR 0019 and ADR 0023. This ADR fills the gap of how we feed the resulting authz schema YAML file to be discoverable.
The proposal includes adding a new Django setting for discovery to find the file, which needs to be an absolute filesystem path, and then using a Tutor plugin to place the rendered patch (
openedx-authz-schema) where it can be found by this setting.I also include two rejected alternatives: riding an existing installed package that Tutor already mounts files to, and scanning
/openedx/config/which already contains unrelated YAML configurations shipped by Tutor.Key decisions
OPENEDX_AUTHZ_SCHEMA_FILESdiscovery.py(filesystem paths) andloading.py(multi-document parsing)Merge checklist:
Check off if complete or not applicable: