fix: v2 endpoint to get courses list correctly like v1

[jesusbalderramawgu]

Description

In redwood, the studio home shows the “Course number display string” this is what maps to the pams section. This is how most people know and refer to as the course name.

Ulmo (Currently showing Course number)

After some digging I found that now that we use the authoring MFE it hits a v2 endpoint which is different to the legacy Django-rendered Studio Home.

in the version 1 (legacy django view) the serializer just passes those dict keys through, so the response reflects the correct display values.

but in v2 API used by authoring MFE the view HomePageCoursesViewV2 hands raw CourseOverview objects directly to CouseCommonSerializerV2 and the serializer is responsible for pulling the right attribute off each object.

Because the MFE hits the v2 endpoint and the legacy UI hits v1, the bug only manifests in the MFE.

in cms/djangoapps/contentstore/rest_api/v2/serializers/home.py the number field was declared without a source so the DRF resolves the field not in the expected way, in this case the raw course-key segment rather than the configured display number

Testing instructions

with the Course number display string as empty in the advanced settings we should see the course number

adding a value in Course number display string in the advanced settings we should see that value in the studio home

before the fix it was always showing the course number, now it shows the correct value when it's overridden

[openedx-webhooks]

Thanks for the pull request, @jesusbalderramawgu!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[bradenmacdonald]

We should not be confusing number and display_number ; they should be put into separate fields.

I believe there is also a display_org, so we should handle that too:

openedx-platform/xmodule/course_block.py

Lines 1462 to 1496 in 62d4625

	@property
	def number(self):
	"""
	Returns this course's number.
	This is a "number" in the sense of the "course numbers" that you see at
	lots of universities. For example, given a course
	"Intro to Computer Science" with the course key "edX/CS-101/2014", the
	course number would be "CS-101"
	"""
	return course_metadata_utils.number_for_course_location(self.location)
	@property
	def display_number_with_default(self):
	"""
	Return a display course number if it has been specified, otherwise return the 'course' that is in the location
	"""
	if self.display_coursenumber:
	return self.display_coursenumber
	return self.number
	@property
	def org(self):
	return self.location.org
	@property
	def display_org_with_default(self):
	"""
	Return a display organization if it has been specified, otherwise return the 'org' that is in the location
	"""
	if self.display_organization:
	return self.display_organization
	return self.org

[jesusbalderramawgu]

Thank you @bradenmacdonald, I have updated the PR. Once this is merged I need to update authoring to use display_number if is required because right now always renders the property number.