[DEPR]: Remove HomePageCourses API v1

[BryanttV]

Proposal Date

2025-01-28

Target Ticket Acceptance Date

2025-02-11

Earliest Open edX Named Release Without This Functionality

Teak - 2025-04

Rationale

The HomePageCourses API v1 will be replaced by v2, which offers improvements including pagination, filtering, and sorting. As of Sumac, v2 is the default API used to query the course listing from Studio.

Removal

To completely remove the API v1 in edx-platform it’s necessary:

• Remove the URL from the urls.py file.
• Remove the View from the home.py file.
• Remove the View import from the __init__.py file.
• Remove the Serializer from the serializers.py file.
• Remove the Serializer import from the __init__py file.
• Remove the Tests from the test_home.py file.

Also, it's necessary to remove all references to API v1 in the Authoring MFE. This work is in progress:

• [WIP] refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 frontend-app-authoring#1611

Replacement

API v2 completely replaces API v1. The PRs related to functionality are as follows:

• feat: add paginated HomePageCoursesV2 view with filtering & ordering edx-platform#34173
• feat: add pagination to the HomePageCoursesV2 API edx-platform#34175
• fix: return empty list when no courses are found for request edx-platform#35942

Deprecation

No response

Migration

No response

Additional Info

No response

Task List

• Remove API v1 from edx-platform
• Remove API v1 references from frontend-app-authoring (WIP)

[BryanttV]

Hi @mariajgrimaldi @feanil @bradenmacdonald. Could you check this proposal?

[bradenmacdonald]

Removing v1 from the authoring MFE ASAP makes sense. On the platform side, I'm just wondering if we need to mark it as deprecated in Teak and then remove it in the next release, to give API consumers more time to adjust.

[BryanttV]

Thanks for your comment @bradenmacdonald. Yeah, I think it's better to mark the code as deprecated for Teak, and finally, in Ulmo remove it. I can update the proposal, what do you think? @mariajgrimaldi @feanil