[FC-0118] docs: add ADR for modulestore crud api with custom serializers#38302
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. |
|
Please correct the file name from "ADR-039-modulestore-crud-apis-with-custom-serializers.rst" to "ADR-0039-modulestore-crud-apis-with-custom-serializers.rst" to maintain consistent numbering format. |
42d7241 to
c353c48
Compare
Description
Adds ADR-039 proposing the pattern for exposing modulestore CRUD operations (courses and blocks) via Django REST Framework.
Since modulestore is backed by MongoDB/split rather than Django ORM models, standard ModelSerializer patterns don't apply. This ADR documents the decision to use explicit, non-model DRF serializers paired with a service layer for authorization and business logic, and custom get_object/get_queryset implementations in ViewSets that delegate to modulestore() calls.