-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: [FC-0044] Unit page API as DRF #34036
feat: [FC-0044] Unit page API as DRF #34036
Conversation
Thanks for the pull request, @ruzniaievdm! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
736df64
to
26477c1
Compare
26477c1
to
ff8d3ea
Compare
@ruzniaievdm, can you add a brief description of the motivation behind this PR, and a summary of the potential risks if this is merged? For example, what kind of impact surface area are we talking about? Are these views used everywhere in Studio, or is it a new thing? It would also be good to have a brief set of instructions on how to test this manually. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've read the code: the logic seems solid. I've also tested this locally on a Tutor nightly dev enviroment running on latest master. Everything seems to work fine.
Can't object in principle, either: more DRF = more good. ;)
@ruzniaievdm 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
2U Release Notice: This PR has been deployed to the edX production environment. |
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
2U Release Notice: This PR has been deployed to the edX production environment. |
Description
This PR addresses a need in the development of the Course Unit Page feature within the frontend-app-course-authoring repository. The core objective is the implement of a DRF endpoint designed to render and deliver data within the unit.
The existing data structure can be explored in the
edx-platform/cms/templates/container.html.
To promote code reusability and avoid duplications, the decision was made to centralize common logic within a
utils.py
. This approach simplifies code maintenance.This PR includes additional modifications to various files to prevent errors on the api-docs page and resolving issues related to circular imports.
Testing instructions
make dev.up.lms+cms
and make checkout on this branch.http://localhost:18010/api-docs
./api/contentstore/v1/container_handler/{usage_key_string}
.http://localhost:18010/container/{usage_key_string}
and make sure nothing has changed.usage_key_string
from previous step and paste it to required API endpoint to get data for unit.