feat: [FC-86] extend courseware api with new fields #36845

andrii-hantkovskyi · 2025-06-03T14:42:29Z

Extend Courseware API with New Fields

This PR extends the Courseware API with several new fields to enhance the course metadata provided to API consumers.
The changes include updates to the serializer, model properties, and comprehensive tests to ensure the correct behavior of each new field.

Key changes:

Adds the following fields to the CourseInfoSerializer:
- show_courseware_link
- is_course_full
- can_enroll
- invitation_only
- is_shib_course
- allow_anonymous
- ecommerce_checkout
- single_paid_mode
- ecommerce_checkout_link
- course_image_urls
- start_date_is_still_default
- advertised_start
- course_price
- pre_requisite_courses
- sidebar_html_enabled
- course_about_section_html
Implements corresponding properties on the CoursewareMeta class to provide these fields' values.
Adds and updates unit tests to verify that each new field is correctly returned by the API.

These changes provide richer and more detailed course metadata to frontend clients, supporting improved user experiences and new UI features.

Unit and integration tests cover all new fields and confirm correct values based on various course and user scenarios.

openedx-webhooks · 2025-06-03T14:42:33Z

Thanks for the pull request, @andrii-hantkovskyi!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To 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:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where 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:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

andrii-hantkovskyi · 2025-06-11T17:34:55Z

Hi @diana-villalvazo-wgu, would you have a chance to review this PR when you have a moment?

kdmccormick · 2025-06-11T17:44:21Z

Hi @andrii-hantkovskyi , why are you tagging me for review on all of these PRs?

By the way, thank you for making detailed pull request descriptions--they are very helpful--but you should not call them "ADRs". An ADR is separate piece of documentation which you'd write if you were making some decisions that you wanted to record more formally than a PR descrption. ADR info.

andrii-hantkovskyi · 2025-06-11T17:47:01Z

@kdmccormick, sorry for tagging, I thought you were a reviewer for this project as well, have already changed, so sorry

Thank you for the clarification about ADR

kdmccormick · 2025-06-11T17:50:43Z

No problem @andrii-hantkovskyi . Glad to see these pages getting converted, best of luck.

PKulkoRaccoonGang · 2025-06-16T09:36:04Z

openedx/core/djangoapps/courseware_api/serializers.py

+    advertised_start = serializers.CharField()
+    course_price = serializers.CharField()
+    pre_requisite_courses = serializers.ListField(
+        child=serializers.CharField(),


Can we add a PrerequisiteCourseSerializer that will return serialized data instead of a string with a tuple?

class PrerequisiteCourseSerializer(serializers.Serializer): """ Serializer for prerequisite course data with key and display name. """ key = serializers.CharField() display = serializers.CharField()

Suggested change

child=serializers.CharField(),

child=PrerequisiteCourseSerializer(),

PKulkoRaccoonGang · 2025-06-16T09:37:43Z

openedx/core/djangoapps/courseware_api/serializers.py

+        allow_blank=True,
+        allow_null=True,
+        default=None,
+    )


Please add a new field display_number_with_default

display_number_with_default = serializers.CharField()

PKulkoRaccoonGang · 2025-06-16T09:39:50Z

openedx/core/djangoapps/courseware_api/serializers.py

+        allow_blank=True,
+        allow_null=True,
+        default=None,
+    )


Let's add display_org_with_default

org = serializers.CharField(source='display_org_with_default')

PKulkoRaccoonGang · 2025-06-16T09:43:20Z

openedx/core/djangoapps/courseware_api/views.py

+

 @method_decorator(transaction.non_atomic_requests, name='dispatch')
 class CoursewareInformation(RetrieveAPIView):


Please update the docstring and check if all API fields are actually in it

I found the following fields for which the op is missing:

* content_type_gating_enabled: Whether the content type gating is enabled for the course * show_calculator: Whether the calculator should be shown in the course details page * can_access_proctored_exams: Whether the user is eligible to access proctored exams * notes: An object containing note settings for the course * enabled: Boolean indicating whether edxnotes feature is enabled for the course * visible: Boolean indicating whether notes are visible in the course * marketing_url: The marketing URL for the course

Please remember to update this docstring after the final version of the API content is approved

openedx/core/djangoapps/courseware_api/views.py

PKulkoRaccoonGang · 2025-06-24T06:08:50Z

openedx/core/djangoapps/courseware_api/views.py

+        * ocw_links: A list of OpenCourseWare links for the course
+        * prerequisites: A list of prerequisite courses for the course


I managed to get data for the prerequisites field through the settings on the Schedule & Details, but on the legacy page nothing is displayed in the sidebar. This may indicate that the API is returning data in an incorrect format. Could you check this?

Template

"prerequisites": [ "course-v1:openedx2+123+2024" ]

PKulkoRaccoonGang · 2025-06-24T06:11:02Z

openedx/core/djangoapps/courseware_api/views.py

+        * studio_url: The URL to the course in Studio, if the user is staff
+        * is_cosmetic_price_enabled: Boolean indicating whether the cosmetic price feature is enabled
+        * overview: The overview HTML content for the course
+        * ocw_links: A list of OpenCourseWare links for the course


Could you please add some test instructions or an explanation of how to get the data for ocw_links? I'm not entirely sure where the data for ocw_links comes from.

ocw_links is a part of the course about section, but as far as I see, it's not configurable right now

openedx/core/djangoapps/courseware_api/serializers.py

PKulkoRaccoonGang

I reviewed this PR and left some comments. Some fields in this API need additional validation (as per Brian's question in [DEPR]: Deprecation of Prerequisites and OCW Links sections) and Catalog About Page API Design.

PKulkoRaccoonGang · 2025-09-01T10:17:55Z

openedx/core/djangoapps/courseware_api/serializers.py

+        allow_blank=True,
+        allow_null=True,
+        default=None,
+    )


PKulkoRaccoonGang · 2025-09-01T10:37:41Z

openedx/core/djangoapps/courseware_api/serializers.py

+    advertised_start = serializers.CharField()
+    course_price = serializers.CharField()
+    pre_requisite_courses = serializers.ListField(
+        child=serializers.CharField(),


PKulkoRaccoonGang · 2025-09-01T10:41:25Z

openedx/core/djangoapps/courseware_api/serializers.py

+    start_date_is_still_default = serializers.BooleanField()
+    advertised_start = serializers.CharField()
+    course_price = serializers.CharField()
+    pre_requisite_courses = serializers.ListField(


We have DEPR for fields prerequisites and ocw_links, we need to:

ensure that these fields really do not have corresponding BE logic

reply to the comment left in this DEPR

remove unnecessary fields from this serializer

After some investigation, I can confirm that there is no BE logic that would populate these two fields. I left a reply in the DEPR and updated this PR accordingly.

PKulkoRaccoonGang · 2025-09-01T10:47:20Z

openedx/core/djangoapps/courseware_api/serializers.py

+        allow_blank=True,
+        allow_null=True,
+        default=None,
+    )


PKulkoRaccoonGang · 2025-09-01T10:50:00Z

openedx/core/djangoapps/courseware_api/views.py

+        return get_course_about_section(self.request, self.course, "overview")
+
+    @property
+    def ocw_links(self):


Regarding the prerequisites and ocw_links fields, we will need to decide whether we leave them in this view after discussions in this DEPR

I left a reply in the DEPR concerning theses two fields - it looks like we can remove them. I updated the PR accordingly.

PKulkoRaccoonGang · 2025-09-01T10:52:28Z

openedx/core/djangoapps/courseware_api/views.py

+        return get_prerequisite_courses_display(self.course)
+
+    @property
+    def about_sidebar_html(self):


According to the discussions in Catalog About Page API Design, it was decided to change sidebar_html_enabled (WaffleSwitch "course_experience.enable_about_sidebar_html) sidebar content via frontend plugin slots. It seems that we don't need this field in the serializer anymore.

openedx/core/djangoapps/courseware_api/serializers.py

PKulkoRaccoonGang · 2025-09-01T11:47:17Z

openedx/core/djangoapps/courseware_api/views.py

+

 @method_decorator(transaction.non_atomic_requests, name='dispatch')
 class CoursewareInformation(RetrieveAPIView):


Please remember to update this docstring after the final version of the API content is approved

feanil · 2025-09-02T14:01:36Z

Once the DEPR related work is done, do you need me to merge this or does someone on your team have merge rights?

sarina · 2025-09-03T11:48:02Z

@feanil looks like it would be great if you could provide the merge when this is ready

sarina · 2025-09-03T11:56:31Z

@Serj-N looks like the tests weren't updated after the last two commits, could you address?

Serj-N · 2025-09-04T09:24:42Z

@Serj-N looks like the tests weren't updated after the last two commits, could you address?

@sarina Sure thing, the tests have been fixed now.

sarina · 2025-09-04T11:59:01Z

@PKulkoRaccoonGang @NiedielnitsevIvan are your concerns addressed?

The comments from the review have been resolved.

edx-pipeline-bot · 2025-09-04T15:15:28Z

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

edx-pipeline-bot · 2025-09-04T15:35:19Z

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

edx-pipeline-bot · 2025-09-04T15:35:20Z

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

nsprenkle · 2025-09-09T16:23:20Z

Hey 👋 just writing to say that I've identified a bug with this PR.

I have a resolution here #37338 that I'm rushing out since it is currently causing production outages for us but I'd like to ask your help updating the test suites to cover those cases that weren't caught in unit testing

@andrii-hantkovskyi / @PKulkoRaccoonGang

cmltaWt0 · 2025-09-09T16:52:19Z

Hey 👋 just writing to say that I've identified a bug with this PR.

I have a resolution here #37338 that I'm rushing out since it is currently causing production outages for us but I'd like to ask your help updating the test suites to cover those cases that weren't caught in unit testing

@andrii-hantkovskyi / @PKulkoRaccoonGang

Hey @nsprenkle.
Sad to hear that. Is adding additional tests blocks the fix PR to be merged?
We will definitely help to add new tests, just asking about timing.

sarina · 2025-09-09T17:04:05Z

@nsprenkle am I correct that what broke was the ecommerce service that is deprecated on the Open edX side? If so I'm not entirely sure how we would even go about testing this.

feanil · 2025-09-12T20:42:33Z

@cmltaWt0 I think we can add the tests after the fact for possible null values for that field. Especially since it's from a deprecated system, that makes sense that it could be null sometimes. The bug fix has already merged so I think we just need to get the tests landed.

It looks like the bug is in this test. We should split this into to tests and explicitly make sure we allow null values like the upstream objects could produce.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 3, 2025

openedx-webhooks added this to Contributions Jun 3, 2025

github-project-automation bot moved this to Needs Triage in Contributions Jun 3, 2025

feat: extend courseware api with new fields

c43e1be

andrii-hantkovskyi force-pushed the rg/axm-course-catalog-extend-courseware-api branch from f389467 to c43e1be Compare June 3, 2025 15:17

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 3, 2025

andrii-hantkovskyi requested a review from kdmccormick June 11, 2025 17:24

andrii-hantkovskyi self-assigned this Jun 11, 2025

andrii-hantkovskyi marked this pull request as ready for review June 11, 2025 17:24

andrii-hantkovskyi requested review from diana-villalvazo-wgu and removed request for kdmccormick June 11, 2025 17:40

PKulkoRaccoonGang suggested changes Jun 16, 2025

View reviewed changes

PKulkoRaccoonGang mentioned this pull request Jun 16, 2025

feat: added org field in CourseInfoSerializer raccoongang/edx-platform#2652

Closed

feanil reviewed Jun 17, 2025

View reviewed changes

openedx/core/djangoapps/courseware_api/views.py Show resolved Hide resolved

andrii-hantkovskyi changed the title ~~feat: extend courseware api with new fields~~ feat: [FC-86] extend courseware api with new fields Jun 18, 2025

refactor: add some fields to serailizer for FE & update API docstring

ca43788

andrii-hantkovskyi force-pushed the rg/axm-course-catalog-extend-courseware-api branch from cbc169b to ca43788 Compare June 19, 2025 14:55

PKulkoRaccoonGang reviewed Jun 24, 2025

View reviewed changes

refactor: fix prerequisites source

3c47f1c

andrii-hantkovskyi force-pushed the rg/axm-course-catalog-extend-courseware-api branch from 0e1aa04 to 3c47f1c Compare June 24, 2025 12:07

NiedielnitsevIvan previously requested changes Jun 26, 2025

View reviewed changes

openedx/core/djangoapps/courseware_api/serializers.py Outdated Show resolved Hide resolved

openedx/core/djangoapps/courseware_api/serializers.py Outdated Show resolved Hide resolved

openedx/core/djangoapps/courseware_api/serializers.py Outdated Show resolved Hide resolved

PKulkoRaccoonGang reviewed Jun 27, 2025

View reviewed changes

openedx/core/djangoapps/courseware_api/serializers.py Outdated Show resolved Hide resolved

PKulkoRaccoonGang reviewed Jun 27, 2025

View reviewed changes

openedx/core/djangoapps/courseware_api/serializers.py Show resolved Hide resolved

PKulkoRaccoonGang reviewed Jun 27, 2025

View reviewed changes

openedx/core/djangoapps/courseware_api/serializers.py Show resolved Hide resolved

PKulkoRaccoonGang assigned Serj-N Sep 1, 2025

PKulkoRaccoonGang previously requested changes Sep 1, 2025

View reviewed changes

fix: remove unused fields 'prerequisites', 'ocw_links'

ed69cb5

Serj-N force-pushed the rg/axm-course-catalog-extend-courseware-api branch from 447f071 to 84f0690 Compare September 3, 2025 10:05

Serj-N force-pushed the rg/axm-course-catalog-extend-courseware-api branch 2 times, most recently from c98fd28 to a41dcb7 Compare September 4, 2025 08:58

Serj-N force-pushed the rg/axm-course-catalog-extend-courseware-api branch from a41dcb7 to ed69cb5 Compare September 4, 2025 11:09

feanil merged commit 06b54e7 into openedx:master Sep 4, 2025
89 of 97 checks passed

github-project-automation bot moved this from Waiting on Author to Done in Contributions Sep 4, 2025

PKulkoRaccoonGang mentioned this pull request Sep 9, 2025

feat: [FC-86] Home page course list section openedx/frontend-app-catalog#18

Merged

nsprenkle mentioned this pull request Sep 9, 2025

fix: fix bad serialization of courseware metadata #37338

Merged

This was referenced Oct 6, 2025

feat: [FC-86] Created Intro section for Course About page openedx/frontend-app-catalog#30

Merged

feat: [FC-86] Added DataTable for Course Catalog page openedx/frontend-app-catalog#31

Merged

This was referenced Oct 15, 2025

feat: [FC-86] Added filtration for Catalog page openedx/frontend-app-catalog#33

Merged

feat: [FC-86] Added Course About sidebar openedx/frontend-app-catalog#38

Merged

PKulkoRaccoonGang mentioned this pull request Oct 23, 2025

feat: [FC-86] Course search for catalog page openedx/frontend-app-catalog#42

Merged

	child=serializers.CharField(),
	child=PrerequisiteCourseSerializer(),



		@method_decorator(transaction.non_atomic_requests, name='dispatch')
		class CoursewareInformation(RetrieveAPIView):

		* ocw_links: A list of OpenCourseWare links for the course
		* prerequisites: A list of prerequisite courses for the course

feat: [FC-86] extend courseware api with new fields #36845

feat: [FC-86] extend courseware api with new fields #36845

Uh oh!

Conversation

andrii-hantkovskyi commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Extend Courseware API with New Fields

Uh oh!

openedx-webhooks commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andrii-hantkovskyi commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kdmccormick commented Jun 11, 2025

Uh oh!

andrii-hantkovskyi commented Jun 11, 2025

Uh oh!

kdmccormick commented Jun 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

PKulkoRaccoonGang Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrii-hantkovskyi commented Jun 3, 2025 •

edited

Loading

openedx-webhooks commented Jun 3, 2025 •

edited

Loading

andrii-hantkovskyi commented Jun 11, 2025 •

edited

Loading

PKulkoRaccoonGang Jun 24, 2025 •

edited

Loading

nsprenkle commented Sep 9, 2025 •

edited

Loading