Repository navigation
Document multipart form data and image request bodies - #1087
Open
hugosmoreira wants to merge 1 commit into
Open
hugosmoreira wants to merge 1 commit into
hugosmoreira wants to merge 1 commit 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
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.
Closes #874.
Add a complete OpenAPI 3.1 multipart request-body example using the existing dictionary API, including the issue's five properties and a registered Address component. Show how to describe raw PNG bytes separately from a base64-encoded image string. The change is limited to the special-topics documentation and contributor credit.
Validation on Windows: both examples extracted from the documentation passed on Python 3.10, 3.12 and 3.14, including property/reference assertions, specification validation and JSON/YAML round trips. Negative controls detected missing image encoding, a missing Address component and an omitted second
spec.pathregistration. The full suite passed with 636 tests and 6 Marshmallow-version skips on each of those Python versions. All eight pre-commit hooks, a clean Sphinx build with warnings treated as errors, and package build/metadata checks passed.Linux/macOS, Python 3.11/3.13, alternate Marshmallow configurations and actual HTTP uploads were not tested for this revision.