Clarify the use of "binary" and "byte" formats #3187
Merged
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
Add a brief explanation as a subsection of Data Types, and update the relevant examples. Specifically: * Don't use `format: byte` for a whole message body * Fix `multipart/mixed` example to be `multipart/form-data` (because `multipart/mixed` does not name its parts and therefore cannot be represented with an object schema) * Add an `application/x-www-form-urlencoded` example, which is where `format: byte` needs to be used
handrews
force-pushed
the
using-byte-binary
branch
from
df9ac29
to
0a28d2d
Compare
CALIFAS95
approved these changes
Mar 6, 2023
ralfhandl
approved these changes
Mar 9, 2023
darrelmiller
approved these changes
Mar 9, 2023
This was referenced Apr 20, 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.
Fixes #1544 and #3175.
Add a brief explanation as a subsection of Data Types, and update the relevant examples. Specifically:
format: bytefor a whole message bodymultipart/mixedexample to bemultipart/form-data(becausemultipart/mixeddoes not name its parts and therefore cannot be represented with an object schema)application/x-www-form-urlencodedexample, which is whereformat: byteneeds to be used