Skip to content

feat(adr-0027): add @extend_schema to Xblock v1 viewset#38834

Open
taimoor-ahmed-1 wants to merge 1 commit into
openedx:feat/axim-api_improvementsfrom
edly-io:feat/xblock_v1_openapi_schema
Open

feat(adr-0027): add @extend_schema to Xblock v1 viewset#38834
taimoor-ahmed-1 wants to merge 1 commit into
openedx:feat/axim-api_improvementsfrom
edly-io:feat/xblock_v1_openapi_schema

Conversation

@taimoor-ahmed-1

Copy link
Copy Markdown
Contributor

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.

  • Adds drf-spectacular @extend_schema to all five XblockViewSet actions (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.
  • Documents the ADR 0036 ?view=minimal preset in the schema (enum=["minimal"]) so consumers (Swagger UI, generated SDK clients) 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 — new callers should use ?view=minimal instead.
  • Shared parameter and response building blocks are declared at module scope to keep the per-action decorators readable.

No behavior change — this is a documentation-only PR from the runtime's perspective.

Test plan

  • ruff check passes on the modified file
  • python -c "import ast; ast.parse(open(...).read())" parses cleanly
  • Existing xblock v1 tests continue to pass in CI
  • manage.py spectacular (or equivalent) picks up the new decorators without warnings

🤖 Generated with Claude Code

@taimoor-ahmed-1 taimoor-ahmed-1 requested a review from a team as a code owner July 1, 2026 07:18
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 1, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @taimoor-ahmed-1!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 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>
@taimoor-ahmed-1 taimoor-ahmed-1 force-pushed the feat/xblock_v1_openapi_schema branch from 48d5c2e to f5dbc31 Compare July 1, 2026 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants