Skip to content
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] textbooks API DRF #34388

Merged

Conversation

ruzniaievdm
Copy link
Contributor

@ruzniaievdm ruzniaievdm commented Mar 19, 2024

Settings

TUTOR_GROVE_WAFFLE_FLAGS:
  - name: contentstore.new_studio_mfe.use_new_textbooks_page
    everyone: true

Description

This PR addresses a need in the development of the Course Textbooks Page feature within the frontend-app-course-authoring repository. The core objective is the implement of a DRF endpoint designed to render and deliver textbooks data for course.

Learn about textbooks:

Textbooks Pages:

  1. Legacy cms - http://localhost:18010/textbooks/{location}.
  2. MFE - http://localhost:2001/course/{location}/pages-and-resources/textbooks.

Testing API instructions:

  1. Run master devstack.
  2. Start platform make dev.up.lms+cms and make checkout on this branch.
  3. Go to http://localhost:18010/api-docs.
  4. Find the required API endpoint /api/contentstore/v1/textbooks/{location}.

Testing MFE instructions:

  1. Run master devstack.
  2. Start platform make dev.up.lms+cms+frontend-app-course-authoring and make checkout on this branch.
  3. Enable the MFE Textbooks Page feature by adding a waffle flag contentstore.new_studio_mfe.use_new_textbooks_page on the http://localhost:18010/admin/waffle/flag/
  4. Go to http://localhost:2001/course/{location}/pages-and-resources/textbooks.

Related PR's:

Textbooks issue

openedx/platform-roadmap#319

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 19, 2024
@openedx-webhooks
Copy link

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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

Serializer for representing course's textbooks.
"""

textbooks = serializers.ListField()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
textbooks = serializers.ListField()
textbooks = serializers.ListField(
child=CourseTextbookItemSerializer()
)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, added, thanks

@ruzniaievdm ruzniaievdm force-pushed the ruzniaievdm/feat/textbooks-api branch from 7e02672 to ab40c07 Compare March 20, 2024 19:39
@ruzniaievdm ruzniaievdm requested a review from KristinAoki March 20, 2024 19:39
@ruzniaievdm ruzniaievdm force-pushed the ruzniaievdm/feat/textbooks-api branch from ab40c07 to 08a987d Compare March 21, 2024 15:49
@KristinAoki KristinAoki merged commit 3ecc4bf into openedx:master Mar 21, 2024
67 checks passed
@openedx-webhooks
Copy link

@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.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants