Clarify how to model binary data (3.2.0 port of #3727 and #3729 #3770
Conversation
This file contains 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
This reorganizes binary data-related guidance into a "Working With Binary Data" section, as has already been done in 3.0.4. This includes more detailed guidance on when various approaches to binary data make sense (e.g. you cannot stuff raw binary into JSON no matter what you put in your Schema Object, and while you can base64-encode entire message bodies, it takes up a lot more space for no clear benefit). An example that contradicts this guidance has been removed. The lack of and HTTP header for base64 encoding is now explicitly called out. Also note that only `multipart` media types with named parts are supported, as they are modeled as an object.
handrews
added
clarification
ralfhandl
approved these changes
May 2, 2024
miqui
approved these changes
May 9, 2024
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.
Content-EncodingHTTP header field andcontentEncoding#2476First commit message
This reorganizes binary data-related guidance into a
"Working With Binary Data" section, as has already been
done in 3.0.4.
This includes more detailed guidance on when various
approaches to binary data make sense (e.g. you cannot
stuff raw binary into JSON no matter what you put in your
Schema Object, and while you can base64-encode entire
message bodies, it takes up a lot more space for no clear
benefit). An example that contradicts this guidance has
been removed.
The lack of and HTTP header for base64 encoding is now
explicitly called out.
Also note that only
multipartmedia types with named partsare supported, as they are modeled as an object.
Second commit message
Clarify how to model streaming binary data