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

[BUG] Set the default values for style and explode properties according to the oas V3 #20169

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

CaptainAye
Copy link
Contributor

Pr aims to set the default values of style and explode properties on the parameter.
According to the specification, the default style values depend on the in property in the following way:

In style
query form
path simple
header simple
cookie form

Explode property defaults to true if the style is form, false otherwise.

At the moment, explode defaults to false for query param (at least in java generator), causing the array query params to be generated always as CSV in case explode is not directly set, which is not correct according to the spec.

The pr sets the default values of style and explode directly in the DefaultCodegen class, to avoid forcing each of the language specific generators from handling the defaults on their own.

The pr fixes #20127

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@CaptainAye CaptainAye force-pushed the 20127-properly-set-default-style-and-explode branch from b51dc03 to 46e61dd Compare November 24, 2024 12:08
@CaptainAye CaptainAye force-pushed the 20127-properly-set-default-style-and-explode branch from 46e61dd to 97aac23 Compare November 24, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][JAVA][webclient] query param of type array handled as non explode
1 participant