Skip to content

[FC-0018] feat: Standardize HomePageCoursesViewV2#38367

Open
taimoor-ahmed-1 wants to merge 1 commit intoopenedx:feat/axim-api_improvementsfrom
edly-io:feat/contentstore_v2_home_serializer_standardization
Open

[FC-0018] feat: Standardize HomePageCoursesViewV2#38367
taimoor-ahmed-1 wants to merge 1 commit intoopenedx:feat/axim-api_improvementsfrom
edly-io:feat/contentstore_v2_home_serializer_standardization

Conversation

@taimoor-ahmed-1
Copy link
Copy Markdown
Contributor

@taimoor-ahmed-1 taimoor-ahmed-1 commented Apr 15, 2026

Description:

The FC-0118 initiative introduces a comprehensive standardization of APIs across the platform, guided by 15 newly defined Architectural Decision Records (ADRs). These ADRs collectively establish consistent patterns for serializers, permissions, error handling, pagination, filtering, authentication, versioning, and overall API design. Through this effort, existing endpoints are being refactored and aligned to ensure uniformity, improved developer experience, and long-term maintainability, while also reducing redundancy and inconsistencies across services.

Checklist:

  • 0025 – Standardize Serializer Usage
  • 0026 – Standardize Permission Classes
  • 0027 – Standardize API Documentation & Schema Coverage
  • 0028 – Standardize RESTful API Endpoints using DRF ViewSets
  • 0029 – Standardize Error Responses
  • 0030 – Ensure GET Requests are Idempotent
  • 0031 – Merge Similar Endpoints
  • 0032 – Standardize Pagination Usage
  • 0033 – Standardize Filter & Sort using django-filter
  • 0034 – Unify Auth (OAuth2 v2)
  • 0035 – Port Legacy Django Views to DRF
  • 0036 – Normalize Deeply Nested JSON APIs
  • 0037 – API Versioning Strategy
  • 0038 - Introduce Row level Security Layer
  • 0039 – Modulestore CRUD APIs with Custom Serializers
  • 0040 – Document & Consolidate Internal APIs used by MFEs

Declare serializer_class = CourseHomeTabSerializerV2 on
HomePageCoursesViewV2 so the serializer contract is explicit and
discoverable by drf-spectacular, per ADR 0025.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @taimoor-ahmed-1!

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:

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.

Comment on lines 144 to 147
serializer = CourseHomeTabSerializerV2({
'courses': courses_page,
'in_process_course_actions': in_process_course_actions,
})
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can we add self.serializer_class instead of hardcoding the serializer? as we are already adding it above.

@taimoor-ahmed-1 taimoor-ahmed-1 changed the title [FC-0018] feat: add serializer_class to HomePageCoursesViewV2 (ADR 0025) [FC-0018] feat: Standardize HomePageCoursesViewV2 Apr 15, 2026
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Apr 16, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

4 participants