Release v3.1.1 #4082
Draft
Release v3.1.1 #4082
+4,644
−1
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
Co-authored-by: Mike Kistler <[email protected]>
These should have the parameter name in the resulting string (see issue #3737).
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Limit interoperable parsing expectations (avoid type conflicts)
Be more clear about `format` support (3.1.1)
The "undefined" wording was chosen to allow implementations that make a good-faith effort to accommodate non-string values to remain compliant. However, new implementations are not expected to implement any sort of type coersion, and this guides API designers away from that expectation.
The previous wording could be read to only restrict what sort of request bodies could use an Encoding Object, while allowing that it could be used with other entities that use a Media Type Object. This emphasizes that it is only relevant to Request Body Objects, and within that, only for specific media types.
The OAS does not define how to avoid collisions between parameter values and style delimiters. Mostly, this is straightforward, but the need to URL encode space characters introduces extra confusion. Make it clear that managing this occurs outside of the use of style, and is the responsibility of users.
JSON Schema draft 2020-12 includes numerous keywords that require parsing the entire document prior to deeming a reference unresolvable. This makes that more clear and outlines several approaches. The practice of embedding OpenAPI fragments in other formats is deemed to have implementation-defined (non-interoperable) behavior, as the potential complications that might arise are not predictable.
Also, remove the example that goes against the advice in the updated binary-handling section.
Clarify how to model binary data in 3.1
Clarify `openIdConnectUrl` #3630
Correctly escape example operationRef URLs (3.1.1 port of #3731)
Non-string discriminator values (3.1.1 port of #3728)
Clarify spaceDelimited with spaces in values (3.1.1 port of #3723)
Clarify wording on encoding field (3.1.1 port of #3724)
If no Encoding Object is provided, the behavior is the same as an empty Encoding Object, as none of its fields are required.
Also make the translation from 3.0 binary modeling a subsection, as otherwise the line about streaming either feels randomly inserted into the middle of the section, or feels disconnected when placed after the conversion table.
Per post-TDC call with Darrel.
Co-authored-by: Ralf Handl <[email protected]>
Fix Document vs Description terminology (3.1.1, port of #4100)
|
I might have missed something here. But wanted to make sure this wasn't forgotten before the release goes out. This release still contains plenty of links to json schema draft 00 from ben hutton. I thought we meant to correct them to draft 12? |
That draft is draft 2020-12. The IETF draft numbers and the metaschema dates are not related. |
As this is a proper patch release, all of the "changes" here actually also apply to 3.1.0. We're just making them more clear. The generic data structures thing is something some JSON Schema folks figured out you can do with As for merging, I'm hoping we'll put 3.0.4 and 3.1.1 in the final week-long voting period in the TDC call today. |
darrelmiller
previously approved these changes
Oct 17, 2024
miqui
previously approved these changes
Oct 17, 2024
|
Looks good to me (approved) |
lornajane
previously approved these changes
Oct 17, 2024
earth2marsh
previously approved these changes
Oct 17, 2024
3.1.1: set release date
ralfhandl
dismissed stale reviews from earth2marsh, lornajane, miqui, and darrelmiller
via
f333b89
Add 3.0.4 release date to 3.1.1
earth2marsh
approved these changes
Oct 22, 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.
This PR will merge
v3.1.1-devintomain.Still to do: