Repository navigation
Document JSON query parameters using content - #1078
Open
Sanjays2402 wants to merge 2 commits into
Open
Sanjays2402 wants to merge 2 commits into
Sanjays2402 wants to merge 2 commits into
Conversation
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
1 participant
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 to #922.
Add a complete OpenAPI 3 example for a JSON query parameter using an explicit parameter component with
content. The example registers a Marshmallow schema, resolves it insideapplication/json, and references the reusable parameter from a GET operation. Explain the schema/content exclusivity rule, the single media type requirement, and the distinction from parameters generated directly from a Marshmallow schema.This documents the existing explicit dictionary API and does not change Marshmallow parameter hooks.
Validation: executed the exact documentation code block, validated the resulting document with
openapi-spec-validator, and checked both component references. The Sphinx HTML build passed with warnings treated as errors; all 636 existing tests passed (6 skipped). Prepared with Codex.