v3.2: Bug fix: deepObject explode default behavior. #4818
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
The `explode` field defaults to `false` with `style: deepObject`, but the behavior of that combination is undefined in 3.0 and 3.1. For 3.2, define it to behave the same as `style: deepObject, explode: true`, which maintains compatibility (by defining previously undefined behavior rather than changing the defined default value) and produces intuitive results.
karenetheridge
previously approved these changes
Aug 3, 2025
mikekistler
previously approved these changes
Aug 4, 2025
ralfhandl
reviewed
Aug 7, 2025
src/oas.md
Outdated
| @@ -1236,7 +1236,7 @@ The following table shows serialized examples, as would be shown with the `seria | |||
| | spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | | |||
| | pipeDelimited | false | _n/a_ | _n/a_ | <span style="white-space: nowrap;">color=blue%7Cblack%7Cbrown</span> | <span style="white-space: nowrap;">color=R%7C100%7CG%7C200%7CB%7C150</span> | | |||
| | pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | | |||
| | deepObject | false | _n/a_ | _n/a_ | _n/a_ | _n/a_ | | |||
| | deepObject | false | _n/a_ | _n/a_ | _n/a_ | <span style="white-space: nowrap;">color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150</span> | | |||
There was a problem hiding this comment.
Can we express that with one table line where the "explode" column says "false or true"? Then readers don't have to mentally diff the values in the two table lines.
handrews
dismissed stale reviews from mikekistler and karenetheridge
via
533c6d3
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 #4816.
The
explodefield defaults tofalsewithstyle: deepObject, but the behavior of that combination is undefined in 3.0 and 3.1.For 3.2, define it to behave the same as
style: deepObject, explode: true, which maintains compatibility (by defining previously undefined behavior rather than changing the defined default value) and produces intuitive results.Note that there is no need to update the Header Object because it does not allow
style: deepObject.