Fix copy-paste "format: binary" error #4294
Merged
+16
−20
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
These examples got copied from 3.0.4 and apparently I forgot to adjust them for 3.1.1 and no one else noticed.
handrews
added
bug
examples
ralfhandl
reviewed
Jan 10, 2025
|
Lgtm |
ralfhandl
approved these changes
Jan 10, 2025
mikekistler
approved these changes
Jan 10, 2025
There was a problem hiding this comment.
Looks good. 👍
I left some comments to add contentEncoding in places where I thought it added clarity. When I first read this line:
default for a string without
contentEncodingistext/plain
my thought was "default what"? So my changes are intended to fix that but I'll defer to your judgement to decide if this is necessary.
| @@ -1800,17 +1800,17 @@ requestBody: | |||
| schema: | |||
| type: object | |||
| properties: | |||
| # default for a string without `contentEncoding` is `text/plain` | |||
There was a problem hiding this comment.
Could we instead say:
Suggested change
| # default for a string without `contentEncoding` is `text/plain` | |
| # default `contentEncoding` for a string is `text/plain` |
| # default for a schema without `type` is `application/octet-stream` | ||
| profileImage: {} | ||
|
|
||
| # default for arrays is based on the type in the `items` |
There was a problem hiding this comment.
and
Suggested change
| # default for arrays is based on the type in the `items` | |
| # default `contentEncoding` for arrays is based on the type in the `items` |
| @@ -1828,31 +1828,27 @@ requestBody: | |||
| schema: | |||
| type: object | |||
| properties: | |||
| # No Encoding Object, so use default `text/plain` | |||
There was a problem hiding this comment.
and
Suggested change
| # No Encoding Object, so use default `text/plain` | |
| # No Encoding Object, so use default `contentEncoding` `text/plain` |
| type: string | ||
| format: uuid | ||
|
|
||
| # Encoding Object overrides the default `application/json` |
There was a problem hiding this comment.
and maybe
Suggested change
| # Encoding Object overrides the default `application/json` | |
| # Encoding Object overrides the default `contentEncoding` `application/json` |
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 #4293
These examples got copied from 3.0.4 and apparently I forgot to adjust them for 3.1.1 and no one else noticed.