fix(openapi): default explode to true for form and cookie style param…#7891
Open
Roemerdt wants to merge 5 commits intoapi-platform:4.3from
Open
fix(openapi): default explode to true for form and cookie style param…#7891Roemerdt wants to merge 5 commits intoapi-platform:4.3from
Roemerdt wants to merge 5 commits intoapi-platform:4.3from
Conversation
…eters per OpenAPI 3.2 spec
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
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.
The
Parameterclass defaultsexplodetofalsefor all parameters. Per the OpenAPI 3.1 spec (section 4.8.12), the default forexplodedepends onstyle:trueforform,falsefor all other styles. OpenAPI 3.2 extends this to also include the newcookiestyle.The class already derives
stylefrominwhen not explicitly set (defaulting toformfor query/cookie parameters). This fix applies the same pattern toexplode: when not explicitly set, it defaults totrueforformandcookiestyles,falsefor everything else.Current wrong behaviour: Array query parameters (like
PropertyFilter'sproperties[]) are serialised withexplode: falsein the generated spec, causing Swagger UI to join multiple values with commas (properties[]=name,description) instead of repeating the parameter (properties[]=name&properties[]=description).Fix: Make
$explodenullable, default tonull, then resolve based onstylein the constructor, matching the OpenAPI spec defaults.(Came across this while following the DragonTreasure API tutorial from @weaverryan and decided to dive into it.)