docs: add ADR for standardizing permissions usage#38187
docs: add ADR for standardizing permissions usage#38187taimoor-ahmed-1 wants to merge 1 commit intoopenedx:docs/ADRs-axim_api_improvementsfrom
Conversation
|
Thanks for the pull request, @taimoor-ahmed-1! 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. |
Currently, authorization logic is implemented inconsistently across views, serializers, and custom access checks. This ADR will define a consistent approach using DRF permission classes, object-level permissions, and queryset scoping where appropriate.
bb75b17 to
1326aeb
Compare
|
My initial thoughts: Although I'm not very familiar with DRF permission classes, this seems like a good approach, I just want to bring some points to the table: My team is currently working on the RBAC AuthZ project, which aims to improve roles and permissions handling across Open edX, see: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/5364121605/PRD+AuthZ+for+Course+Authoring We are currently implementing the new permissions system over the CMS, specifically on Course Authoring features. For now, we are focusing on direct replacements on old permission checks, we recently merged a decorator that is a direct replacement for a legacy one, which supports validating a permission either on the new system or the old one depending on a feature flag: #38156 I think we could probably implement the same thing with this approach (I'll do some reading on it). However, there are some more involved cases, like the xblock endpoint being implemented here: #38179, where more granular permissions mean that different checks need to be done depending on the request params, I wonder if DRF permission classes could handle this, or we would need to refactor the endpoint (may not be feasible at least for this specific endpoint), or doing an exception. Thanks for the proposal, I'll do some reading to get more familiar with DRF permissions so we can start using it in our project. |
Description
Currently, authorization logic is implemented inconsistently across views, serializers, and custom access checks. This ADR will define a consistent approach using DRF permission classes, object-level permissions, and queryset scoping where appropriate.
Issue: #38177