Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !13202

[swift5] explode query params only if necessary

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/Jonas1893/fix/explode-query-params-swift into master Aug 16, 2022
  • Overview 5
  • Commits 2
  • Pipelines 0
  • Changes 58

Created by: Jonas1893

This fixes https://github.com/OpenAPITools/openapi-generator/issues/10944

Current generator version always explodes query params ([...]?paramX=42&paramX=44&paramX=88) even if

  • explode: false is specified in OpenAPI spec 3 (https://swagger.io/docs/specification/serialization/) or
  • collectionFormat: csv is specified in OpenAPI spec 2 (https://swagger.io/specification/v2/) This is wrong, as in those cases query params should rather be comma-seperated behind a single key: ([...]?paramX=42,44,88)

This PR adopts the common templates to propagate the explode parameter to APIHelpers mapValuesToQueryItems where it will be handled accordingly.

To be a 100% correct we would additionally need to evaluate the style option in OpenAPI spec 3 (or other collectionFormats besides csv and multi in OpenAPI spec 2) to account for all possible separators like tabs or pipes. This has been omitted in this PR for the sake of simplicity

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.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. -> @4brunu

Declaration

The program was tested solely for our own use cases, which might differ from yours.

Link to provider information

https://github.com/mercedes-benz

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/Jonas1893/fix/explode-query-params-swift