Skip to content

feat: apply ADRs standardization to enrollment apis#38724

Open
taimoor-ahmed-1 wants to merge 1 commit into
openedx:feat/axim-api_improvementsfrom
edly-io:feat/enrollment_adr_standardization
Open

feat: apply ADRs standardization to enrollment apis#38724
taimoor-ahmed-1 wants to merge 1 commit into
openedx:feat/axim-api_improvementsfrom
edly-io:feat/enrollment_adr_standardization

Conversation

@taimoor-ahmed-1

@taimoor-ahmed-1 taimoor-ahmed-1 commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Description

Introduces /api/enrollment/v2/ as a parallel new version of the enrollment API, applying the FC-0118 ADRs from the start. v1 endpoints at /api/enrollment/v1/ are unchanged — clients migrate at their own pace.

What's new
openedx/core/djangoapps/enrollments/v2/ — viewsets, service layer, paginator, forms, serializers, tests
EnrollmentViewSet consolidates v1's EnrollmentListView + UnenrollmentView + EnrollmentAllowedView into a single router-registered ViewSet (actions: list, create, unenroll, allowed)
EnrollmentRetrieveView, UserRolesView, CourseEnrollmentDetailView, EnrollmentsAdminListView for endpoints with URL shapes that don't fit a router
EnrollmentOperationsService centralizes business logic and raises DRF exceptions (modern ADR 0029 pattern)
StandardizedErrorMixin promoted from cms/.../rest_api/mixins.py to openedx/core/lib/api/mixins.py so non-contentstore apps can use it

@taimoor-ahmed-1 taimoor-ahmed-1 requested a review from a team as a code owner June 8, 2026 06:42
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 8, 2026
@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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jun 8, 2026
@taimoor-ahmed-1 taimoor-ahmed-1 self-assigned this Jun 8, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 8, 2026
@taimoor-ahmed-1 taimoor-ahmed-1 force-pushed the feat/enrollment_adr_standardization branch from 9318985 to 053ba22 Compare June 8, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants