[FC-0118] docs: add ADR for standardizing filtering/sorting parameters - #38303
Merged
Faraz32123 merged 4 commits intoMay 5, 2026
Merged
Conversation
Faraz32123
force-pushed
the
docs/ADR-standardize_filtering_parameters
branch
from
April 8, 2026 10:33
c9ccf05 to
e69e24c
Compare
Faraz32123
requested review from
Abdul-Muqadim-Arbisoft,
feanil and
taimoor-ahmed-1
April 8, 2026 11:36
Faraz32123
changed the title
Faraz32123
force-pushed
the
docs/ADR-standardize_filtering_parameters
branch
from
April 16, 2026 10:38
e69e24c to
1ec34ed
Compare
feanil
reviewed
Apr 21, 2026
feanil
left a comment
feanil
left a comment
Contributor
There was a problem hiding this comment.
Generally looks good, just one small update and then I think this is good to merge.
| References | ||
| ========== | ||
|
|
||
| * “Missing Filter/Sort Consistency” recommendation in the Open edX REST API standardization notes. |
Contributor
There was a problem hiding this comment.
Is there a reason to not provide a link to the existing notes?
Contributor
Author
There was a problem hiding this comment.
Done, I have added the link.
|
|
||
| class CourseEntitlementFilter(filters.FilterSet): | ||
| course = filters.CharFilter(field_name='course_uuid') # old param | ||
| course_uuid = filters.UUIDFilter(field_name='course_uuid') # new param |
Contributor
There was a problem hiding this comment.
The Decision section says "use course_id consistently," but the Backward Compatibility example then introduces course_uuid as the new standardized name
Contributor
There was a problem hiding this comment.
Oh right, that reminds me: based on the recently-confirmed OEP-68, the course identifier parameter should be called course_key if it's an opaque key string like course-v1:..., not course_id.
Faraz32123
requested review from
Abdul-Muqadim-Arbisoft,
bradenmacdonald and
feanil
April 27, 2026 10:06
feanil
approved these changes
Apr 30, 2026
feanil
left a comment
feanil
left a comment
Contributor
There was a problem hiding this comment.
One small change but I don't need to review again.
| 2. **Deprecation Warnings**: Return HTTP headers warning about deprecated parameters: | ||
|
|
||
| * Deprecation: Parameter 'course' is deprecated. Use 'course_key' instead. | ||
| * Support will be removed in release 'quince'. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Support will be removed in release 'quince'. | |
| * Support will be removed in release '<release_name>'. |
Let's make it clear that the release name is a placeholder.
Faraz32123
force-pushed
the
docs/ADR-standardize_filtering_parameters
branch
from
May 5, 2026 07:30
74280ce to
8f0dbf5
Compare
Faraz32123
merged commit May 5, 2026
151d827
into
docs/ADRs-axim_api_improvements
100 of 105 checks passed
16 tasks
Faraz32123
added a commit
that referenced
this pull request
Jun 10, 2026
Faraz32123
added a commit
that referenced
this pull request
Jun 10, 2026
Faraz32123
added a commit
that referenced
this pull request
Jun 24, 2026
Faraz32123
added a commit
that referenced
this pull request
Jun 24, 2026
* docs: add ADR for standardizing serializer usage (#38139) * docs: explicitly mention API versioning incase of backwards incompatible change (#38188) Co-authored-by: Muhammad Faraz Maqsood <faraz.maqsood@A006-01130.local> * docs: add ADR for standardizing permissions usage (#38187) Currently, authorization logic is implemented inconsistently across views, serializers, and custom access checks. This ADR will define a consistent approach using DRF permission classes, object-level permissions, and queryset scoping where appropriate. Co-authored-by: Taimoor Ahmed <taimoor.ahmed@A006-01711.local> * docs: minor change in ADR language * fix: add s back * docs: migrate restful & legacy django api endpoints to standard drf viewsets (#38191) * docs: Add ADR for ensuring GET requests are idempotent Add edx-platform/docs/decisions/0030-ensure-get-requests-are-idempotent.rst as an accepted ADR. Define policy that GET endpoints must be strictly read-only, with side effects moved to explicit write endpoints or async event pipelines. Include edx-platform relevance, anti-pattern vs preferred code examples, and rollout guidance for testing and migration. * docs: add ADR for standardizing API documentation and schema coverage - Propose adoption of drf-spectacular across Open edX services - Require @extend_schema decorators for all API endpoints - Document request/response schemas, status codes, and error conditions * docs: remove incorrect ADR number * docs: address api-doc-tools deprecation in ADR per review feedback - Add context explaining what api-doc-tools is and its relationship to drf-yasg - Document deprecation and archival of api-doc-tools as a consequence - Add migration guide mapping api-doc-tools decorators and URL helpers to their drf-spectacular equivalents - Add rejected alternative for updating api-doc-tools internals - Add rollout step for final archival cutover Closes review comment by @feanil * docs: expand ADR-0027 with api-doc-tools deprecation and drf-yasg incompatibility analysis Address review feedback on FC-0118 ADR 0027: - Add context paragraph explaining what api-doc-tools is (drf-yasg shim, decorators it provides, schema view, OpenAPI 2.0 output) - Document deprecation of api-doc-tools and drf-yasg as a consequence, including transition-window behavior - Add detailed 8-point incompatibility analysis explaining why drf-yasg cannot be replaced with drf-spectacular inside api-doc-tools (recorded in the ADR itself for future reference) - Add migration plan for existing api-doc-tools consumers with concrete decorator/import/setting mapping - Update Rollout Plan to track api-doc-tools removal - Add references to drf-spectacular migration guide, drf-yasg upstream status, and api-doc-tools repository * chore: fix edx-mantained to edX-platform * docs: add ADR for standardizing pagination across APIs (#38300) * docs: add ADR for api versioning strategy (#38304) * docs: add ADR for standardizing filtering/sorting parameters (#38303) * docs: add ADR-0029 standardized error responses decision (#38246) * docs: add ADR for merging similar endpoints (#38262) * docs: ADR for normalizing nested json apis (#38305) * docs: add separate example for input & output serializers * docs: ADR for documenting and consolidating internal MFE APIs (#38309) * docs: ADR for documenting and consolidating internal MFE APIs Define a plan to document all undocumented internal LMS APIs consumed by MFEs into stable, OpenAPI-described contracts. Introduces a consolidated config endpoint pattern with optional course/user context, authentication boundaries, and a rollout plan following OEP-21 DEPR process. * docs: add ADR for canonical MFE configuration endpoint Record that /api/frontend_site_config/v1/ is the canonical endpoint for MFE/front-end runtime configuration (frontend-base SiteConfig, OEP-65) and that /api/mfe_config/v1 is legacy, on the DEPR path tracked in #37255 and added, and that user-context data (roles, permissions) belongs on resource-oriented endpoints rather than on a configuration payload. Documentation/schema coverage is deferred to the API Documentation & Schema Coverage ADR (#38189). Partially supersedes ADR 0001 (MFE Config API). Part of FC-0118 Open edX REST API standardization (#38137). Refs #38280 * docs: add ADR for standardizing authentication patterns (#38301) * docs: add ADR for standardizing authentication patterns * docs: resolve confusion & update the ADR based on OEP-0042 * docs: support multiple valid auth schemes & deprecate BearerAuthentication * docs: change wording for decisions a bit. * docs: add real examples in accordance with our updated decisions * docs: sync ADR with edx-drf-extensions issue 284 openedx/edx-drf-extensions#284 * docs: make doc more explicit & address comments * docs: move Bearer auth depr plan out of ADR Move BearerAuthentication depr plan out of this doc So that it resides in single place i.e. to its deprecation ticket. * docs: add a pointer file in oauth_dispatch for this ADR * docs: make decision more clear * docs: make authentication_classes usage more clearer * docs: adress the comment related to session authentication * chore: correct file number w.r.t order of the ADRs --------- Co-authored-by: Muhammad Faraz Maqsood <faraz.maqsood@A006-01130.local> Co-authored-by: Taimoor Ahmed <68893403+taimoor-ahmed-1@users.noreply.github.com> Co-authored-by: Taimoor Ahmed <taimoor.ahmed@A006-01711.local> Co-authored-by: Robert Raposa <rraposa@edx.org> Co-authored-by: Abdul Muqadim <abdul.muqadim@A006-01811.local> Co-authored-by: Abdul Muqadim <abdul.muqadim@192.168.1.7> Co-authored-by: Abdul-Muqadim-Arbisoft <139064778+Abdul-Muqadim-Arbisoft@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
related issue: #38279