feat(adr-0027): add @extend_schema to Xblock v1 viewset#38834
feat(adr-0027): add @extend_schema to Xblock v1 viewset#38834taimoor-ahmed-1 wants to merge 1 commit into
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. |
Follow-up from PR openedx#38773 review: Xblock v1 previously had no OpenAPI schema decoration, which was flagged as a pre-existing gap. This adds drf-spectacular @extend_schema to all five viewset actions (create, retrieve, update, partial_update, destroy) so the endpoints show up with proper request/response bodies, path/query parameters, and error codes in the generated OpenAPI 3.x schema. Notes: - Documents the ADR 0036 ``?view=minimal`` query parameter in the schema (enum=["minimal"]) so consumers can discover it. - Documents the legacy ``?fields=`` selector (graderType / ancestorInfo / customReadToken) as ``deprecated=True`` — its semantics are pass-through / type-of-response, not the ADR 0036 CSV subset convention. - Shared parameter and response building blocks are declared at module scope to keep the per-action decorators readable. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
48d5c2e to
f5dbc31
Compare
Summary
Follow-up from #38773 review comment: Xblock v1 previously had no OpenAPI schema decoration, which was flagged as a pre-existing gap and deferred to a separate PR. This closes that loop.
@extend_schemato all fiveXblockViewSetactions (create,retrieve,update,partial_update,destroy) so the endpoints appear with proper request/response bodies, path/query parameters, and error codes in the generated OpenAPI 3.x schema.?view=minimalpreset in the schema (enum=["minimal"]) so consumers (Swagger UI, generated SDK clients) can discover it.?fields=selector (graderType/ancestorInfo/customReadToken) asdeprecated=True. Its semantics are pass-through / type-of-response, not the ADR 0036 CSV subset convention — new callers should use?view=minimalinstead.No behavior change — this is a documentation-only PR from the runtime's perspective.
Test plan
ruff checkpasses on the modified filepython -c "import ast; ast.parse(open(...).read())"parses cleanlymanage.py spectacular(or equivalent) picks up the new decorators without warnings🤖 Generated with Claude Code