Repository navigation
fix: correct the SDK-facing schema for the transcript check and deprecated addresses - #39270
Open
Faraz32123 wants to merge 2 commits into
Open
Faraz32123 wants to merge 2 commits into
Faraz32123 wants to merge 2 commits into
Conversation
The check was routed to the viewset's list action, so the schema described its response as an array. It returns a single report, and clients generated from the schema failed to parse it. Routing it to retrieve fixes the schema; the address and behaviour are unchanged.
A legacy address kept for its deprecation window shares its view with the replacement, so it inherited the openedx-platform-sdk tag and the SDK generated a client for it. A post-processing hook now drops that tag from every deprecated operation, in both services.
3 tasks
taimoor-ahmed-1
approved these changes
Oct 21, 2026
This branch has not been deployed
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
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.
Two schema fixes that show up in the generated SDK: edly-io/openedx-platform-sdk#6, generated from the current schema, types the transcript check as a list and adds
*_legacyand old-address functions for deprecated endpoints.The YouTube transcript check is documented as returning a list.
GET /api/authoring/v1/courses/{course_key}/youtube_transcript_checks/was routed to the viewset'slistaction, so drf-spectacular described its 200 response as an array. It returns one report, so generated clients failed to parse it. It is now routed toretrieve. The address, URL name and behaviour are unchanged; the operationId becomesv1_courses_youtube_transcript_checks_retrieve.Deprecated addresses are still tagged for the SDK. A legacy address kept for its deprecation window shares its view with the replacement, so it inherits the
openedx-platform-sdktag, and the SDK generates functions for it (*_legacy, the old/api/contentstore/...and slashless enrollment addresses). A new post-processing hook,openedx.core.apidocs.untag_deprecated_operations, drops that tag from every operation markeddeprecated: true. It is registered last in the CMS and LMS hook lists, after the hooks that mark operations deprecated, so it covers future migrations without a path list.Testing
generate_openapi_schemas.ymldoes:/api/authoring/...operations do./api/enrollment/v2/...operations do.test_youtube_transcripts.py,cms/lib/tests/test_spectacular.py,views/tests/test_transcripts.py,cms/tests.py,lms/tests.py: all pass.