Repository navigation
fix(apidocs): Correct schema declarations on unpublished endpoints - #129568
Merged
Merged
Conversation
These methods declare responses or request bodies that drf-spectacular can't describe correctly. The published build skips them, being unpublished, but a build that describes every method gets an invalid spec from the csrf endpoint, whose responses are keyed by field names, and wrong or untyped shapes from the rest: a request body sharing another's component name, a response type that isn't a TypedDict, a bare object response, and a TypedDict passed where an inline response serializer belongs.
github-actions
Bot
added
the
Scope: Backend
billyvg
added a commit
that referenced
this pull request
Nov 2, 2026
They're in #129568, which lands first; the internal build needs its csrf fix to pass --validate.
This was referenced Nov 2, 2026
billyvg
marked this pull request as ready for review
November 2, 2026 22:20
cvxluo
approved these changes
Nov 2, 2026
This branch was successfully 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.
Why?
Five unpublished methods declare responses or request bodies that drf-spectacular can't describe. The published build skips unpublished methods, so nothing has caught them. A build that describes every method does: the csrf endpoint makes its spec invalid, and the other four come out wrong or untyped. This is split out of the internal-spec PR below, which needs it first, so each endpoint's owners can review their change on its own.
How?
Each declaration now keys responses by status code and describes TypedDicts through an inline response serializer, as published endpoints do. The SCIM replace body gets its own component name. The published spec is byte-identical.
Generated with Claude Code