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

[JAVA] [WebClient] Handle list of String special case in WebClient generator #14125

Closed
wants to merge 4 commits into from

Conversation

GavinWu1991
Copy link
Contributor

@GavinWu1991 GavinWu1991 commented Nov 26, 2022

When describing an operation that returns an array of strings, the openapi-generator for java-webclient generates an API returning the array of strings in a single string.

Recommended solution by Spring developers (see spring-projects/spring-framework#22662 and https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#webflux-codecs-jackson) is to use a Mono for string arrays.

The PR contains the change that will generate the API client of the operation that returns an array of strings to Mono<List> instead of Flux.

Close: #7118

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.3.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.

@GavinWu1991
Copy link
Contributor Author

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)

thomaskrause added a commit to korpling/ANNIS that referenced this pull request Dec 9, 2022
…of strings as mono.

If OpenAPITools/openapi-generator#14125 gets merged, we won't need this workaround anymore
@domizei385
Copy link

Please follow through with this. Trying to push reactive at my current customer and this issue has been causing a lot of push-back.

@tildedave
Copy link

As someone whose team just ran into this, we'd love to see this merged.

@wing328
Copy link
Member

wing328 commented Aug 15, 2023

merged via #16326 instead with an additional fix in api_test.mustache

@wing328 wing328 closed this Aug 15, 2023
@wing328
Copy link
Member

wing328 commented Aug 15, 2023

@domizei385 @tildedave feel free to sponsor @GavinWu1991 directly for this fix 🙏

Thanks @GavinWu1991 again for the PR.

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.

[REQ] Handle list of String special case in webclient generator
4 participants