Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve media type serialization examples (3.0.4) #3864

Merged
merged 3 commits into from
Jun 10, 2024

Conversation

handrews
Copy link
Member

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-urlencoded bodies and application/json values that I cannot for the life of me find right now

  • 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.

* 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 handrews added clarification requests to clarify, but not change, part of the spec media and encoding Issues regarding media type support and how to encode data (outside of query/path params) labels May 28, 2024
@handrews handrews added this to the v3.0.4 milestone May 28, 2024
@handrews handrews requested a review from a team May 28, 2024 20:57
@handrews handrews changed the title Improve media type encoding examples (3.0.4) Improve media type serialization examples (3.0.4) May 28, 2024
versions/3.0.4.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, one typo

Co-authored-by: Ralf Handl <[email protected]>
versions/3.0.4.md Outdated Show resolved Hide resolved
@ralfhandl ralfhandl requested a review from notEthan June 4, 2024 08:38
@handrews handrews added the examples requests for more or better examples in the specification label Jun 5, 2024
@handrews
Copy link
Member Author

Two TSC approvals - merging.

@handrews handrews merged commit 95910fc into OAI:v3.0.4-dev Jun 10, 2024
1 check passed
@handrews handrews deleted the request-examples-304 branch June 10, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification requests to clarify, but not change, part of the spec examples requests for more or better examples in the specification media and encoding Issues regarding media type support and how to encode data (outside of query/path params)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants