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

[kotlin-spring] Adds useFlowForArrayReturnType option for reactive mode (#16130) #20409

Conversation

hu553in
Copy link
Contributor

@hu553in hu553in commented Jan 7, 2025

Issue #16130

We want to use suspend functions for methods returning single objects, but also we want to use common return types (e.g. List) for methods returning collections.

Our UI can not work with JSON streams at the moment.

On Spring 5 Flow was collected to List internally when Content-Type is application/json, but in Spring 6 this functionality is removed, so we need to return List explicitly.

Added option useFlowForArrayReturnType which will turn on/off using Flow. Default value is true to not break any old behavior. This option is considered only if reactive is set to true.

Technical committees

@dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m @stefankoppier @e5l

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.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
danharrin Dan Harrin
@wing328
Copy link
Member

wing328 commented Jan 8, 2025

thanks for the PR

can you please create a new config file to test the new option based on https://github.com/OpenAPITools/openapi-generator/blob/master/bin/configs/kotlin-spring-boot-reactive.yaml?

(for inputSpec, please use modules/openapi-generator/src/test/resources/3_0/petstore.yaml as we're moving away from 2.0 spec for testing)

then regenerate the samples twice

and add the new output folder to the CI workflows:

@hu553in
Copy link
Contributor Author

hu553in commented Jan 9, 2025

@wing328 thanks for review, done!

@wing328 wing328 merged commit 358e8af into OpenAPITools:master Jan 11, 2025
46 checks passed
@wing328
Copy link
Member

wing328 commented Jan 11, 2025

FYI Merged #20445 with various enhancements (e.g. code format, etc)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants