Improve media type serialization examples (3.0.4) #3864
Merged
Conversation
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
* Replace the outdated "model" terminology with "schema" * Remove the outdated `text/plain` array example, which does not correlate with current OAS requirements * Rather than replacing the `text/plain` example direclty, enhance the example of serializing `application/json` content in `application/x-www-form-urlencoeded` request bodies.
handrews
added
clarification
handrews
changed the title
ralfhandl
reviewed
May 29, 2024
Co-authored-by: Ralf Handl <[email protected]>
notEthan
reviewed
Jun 3, 2024
ralfhandl
approved these changes
Jun 4, 2024
notEthan
approved these changes
Jun 5, 2024
handrews
added
the
examples
miqui
approved these changes
Jun 9, 2024
|
Two TSC approvals - merging. |
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.
I know I said I was done with PRs until the current ones and/or some blocking issues are resolved, but I realized I forgot to post this one.
Fixes:
"body parameter" example in 3.x does not fit how Request Body Objects work #3761
Some other issue asking about
form-urlencodedbodies and application/json values that I cannot for the life of me find right nowReplace the outdated "model" terminology with "schema"
Remove the outdated
text/plainarray example, which does not correlate with current OAS requirementsRather than replacing the
text/plainexample direclty, enhance the example of serializingapplication/jsoncontent inapplication/x-www-form-urlencoededrequest bodies.