[FC-0118] feat: Standardize Enrollment Views#38265
[FC-0118] feat: Standardize Enrollment Views#38265taimoor-ahmed-1 wants to merge 1 commit intoopenedx:feat/axim-api_improvementsfrom
Conversation
|
Thanks for the pull request, @taimoor-ahmed-1! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
…lowedView (ADR 0025) Migrate EnrollmentView and EnrollmentAllowedView to explicit DRF serializer usage for both input validation and response formatting, per the decision recorded in docs/decisions/0025-standardize-serializer-usage.rst.
taimoor-ahmed-1
force-pushed
the
feat/enrollment_allowed_api_serializer_usage
branch
from
2324b93 to
79bea46
Compare
| }, | ||
| ) | ||
|
|
||
| serializer = CourseEnrollmentSerializer(enrollment) |
There was a problem hiding this comment.
can we use self.serializer_class here?
| "is_staff": request.user.is_staff, | ||
| } | ||
| ) | ||
| serializer = UserRolesResponseSerializer({ |
There was a problem hiding this comment.
can we use self.serializer_class here?
| data={"message": f"No course found for course ID '{course_id}'"}, | ||
| ) | ||
| include_expired = bool(request.GET.get("include_expired", "")) | ||
| serializer = CourseSerializer(course_overview, include_expired=include_expired) |
There was a problem hiding this comment.
Can we do it wherever we added a serializer_class.
taimoor-ahmed-1
changed the title
4 participants
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: