feat: apply ADR standardization to AuthorGrading apis#38726
feat: apply ADR standardization to AuthorGrading apis#38726taimoor-ahmed-1 wants to merge 1 commit into
Conversation
openedx-webhooks
added
the
open-source-contribution
|
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. |
taimoor-ahmed-1
force-pushed
the
feat/author_grading_adr_standardization
branch
from
39a5a99 to
3873eb0
Compare
taimoor-ahmed-1
force-pushed
the
feat/author_grading_adr_standardization
branch
from
3873eb0 to
2c99e33
Compare
taimoor-ahmed-1
force-pushed
the
feat/author_grading_adr_standardization
branch
from
2c99e33 to
57c9593
Compare
| from openedx.core.lib.api.mixins import StandardizedErrorMixin | ||
|
|
||
| _COURSE_ID_PARAMETER = OpenApiParameter( | ||
| name="course_id", |
taimoor-ahmed-1
force-pushed
the
feat/author_grading_adr_standardization
branch
from
57c9593 to
e6775d5
Compare
| def _resolve_course_key(course_key_string: str) -> CourseKey: | ||
| """ | ||
| Parse ``course_key_string`` into a ``CourseKey`` and verify the course exists. | ||
|
|
||
| Raises ``NotFound`` for both unparseable keys and missing courses, which | ||
| the ADR 0029 envelope renders as a structured 404. Replaces the legacy | ||
| ``@verify_course_exists()`` decorator and avoids relying on | ||
| ``DeveloperErrorViewMixin``. | ||
| """ | ||
| try: | ||
| course_key = CourseKey.from_string(course_key_string) | ||
| except InvalidKeyError as exc: | ||
| raise NotFound("The provided course key cannot be parsed.") from exc | ||
| if not CourseOverview.course_exists(course_key): | ||
| raise NotFound(f"Course {course_key_string} not found.") | ||
| return course_key |
There was a problem hiding this comment.
we have this function being added to pull/38708 as well. Can also move common func to utils and handle course_id there as well and change it to course_key.
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.