Skip to content

[JAVA] [SPRING] Handle list of String special case in reactive generator#24078

Open
TMRGZ wants to merge 3 commits into
OpenAPITools:masterfrom
TMRGZ:fix/spring-string-list-return
Open

[JAVA] [SPRING] Handle list of String special case in reactive generator#24078
TMRGZ wants to merge 3 commits into
OpenAPITools:masterfrom
TMRGZ:fix/spring-string-list-return

Conversation

@TMRGZ

@TMRGZ TMRGZ commented Jun 20, 2026

Copy link
Copy Markdown

Related: #24077

PR checklist

  • Read the contribution guidelines.
  • 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 WSL)
    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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes reactive Spring return types for string[] responses by returning Mono<List> or Mono<Set> instead of Flux. Applies to spring-boot and spring-http-interface, including SSE, and aligns generated code with the schema.

  • Bug Fixes
    • Added x-reactive-return-except-list-of-string to VendorExtension.
    • In SpringCodegen, auto-set the extension for reactive string[] returns in spring-boot and spring-http-interface.
    • Updated responseType.mustache to emit Mono<ResponseEntity<List<String>>>/Mono<ResponseEntity<Set<String>>> (or Mono<List<String>>/Mono<Set<String>> when useResponseEntity is false), including SSE.
    • Added tests for both libraries with useResponseEntity on/off to verify the new signatures.

Written for commit f4784ea. Summary will update on new commits.

Review in cubic

@TMRGZ

TMRGZ commented Jun 20, 2026

Copy link
Copy Markdown
Author

The Kotlin Spring generator could need a similar fix but I am not used to code in Kotlin, feel free to add it to this PR

@Picazsoo

Copy link
Copy Markdown
Contributor

I only reviewed on mobile so far, but do I understand correctly that you are hiding the 'now correct' behavior behind a config option and by default it will still produce the incorrect code?

I would expect it to be either

  • a) just a straightforward fix with no fallback. If someone depends on the wrong behavior, they should go and fix their code. They will be probably forced to anyway as the code will not compile after upgrading...
  • b) inverted behavior - default to the fix and allow custom config to get the 'wrong' behavior back.

As I mentioned this is based on a very quick skimming of the changes in the PR.

Note: I am not in any way a maintainer of this project - just providing my proverbial 2 cents of feedback (-:

@TMRGZ

TMRGZ commented Jun 21, 2026

Copy link
Copy Markdown
Author

Hi @Picazsoo, thanks for the feedback.

Just to note, the feature flag for the fix is enabled by default and the PR is and adaptation of this other https://github.com/OpenAPITools/openapi-generator/pull/16326/changes.

I guess that the fallback was created just in case someone wants to stay with the original behaviour.

@Picazsoo

Copy link
Copy Markdown
Contributor

If no one picks it up for kotlin-spring before next week, I will see what I can do. I think that reactor is limited to spring http interface there...

@TMRGZ TMRGZ force-pushed the fix/spring-string-list-return branch from b07ba00 to a50bf72 Compare June 29, 2026 19:37
@TMRGZ TMRGZ marked this pull request as ready for review June 29, 2026 19:37

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 4 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

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.

2 participants