feat: [FC-0044] certificates API DRF

[ruzniaievdm]

Settings

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

Description

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

How to configure certificates:

• open edX - https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/set_up_course/studio_add_course_information/studio_creating_certificates.html
• RG instructions - https://raccoongang.atlassian.net/wiki/external/Y2I2MGJkMjYxYmExNGUwYWEzNTYxNjBlYjg2MjY2M2M

Certificate Pages:

1. Legacy cms - http://localhost:18010/certificates/{location}.
2. MFE - http://localhost:2001/course/{location}/certificates.

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/certificates/{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 Certificates Page feature by adding a waffle flag contentstore.new_studio_mfe.use_new_certificates_page on the http://localhost:18010/admin/waffle/flag/
4. Go to http://localhost:2001/course/{location}/certificates.

Related PR's:

• certificate waffle flag for MFE - feat: [FC-0044] add waffle flag support #34338
• MFE certificate page - feat: [FC-0044] Certificates page frontend-app-authoring#872

Certificate issue

openedx/platform-roadmap#317

[openedx-webhooks]

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.

[arbrandes]

Can you please include in the description the complete steps, from scratch, on how to test this properly? Including how to enable the feature, how to use the waffle flags, and how to create a certificate?

[ruzniaievdm]

@arbrandes I've updated the description with new links to the certificate configuration for the course including enabling the feature for certificate MFE page.

[KristinAoki]

Is this url supposed to start with three forward slashes?

[ruzniaievdm]

Original method for this field is get_lms_link_for_certificate_web_view here which contains return "//{certificate_web_base}/certificates/course/{course_id}?preview={mode}".format(). Therefore I can assume that this is the real value for the certificate_web_view_url field.

[openedx-webhooks]

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

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

[edx-pipeline-bot]

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

[edx-pipeline-bot]

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