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] [Retrofit2] [Coroutines] [Client] Option to remove Response<> wrapper in operation return types #20613

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

Conversation

lsuski
Copy link

@lsuski lsuski commented Feb 7, 2025

Fixes (#15491)

Add option useResponseAsReturnType to disable generating of Response<T> return type in suspend retrofit2 api methods

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.

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

@lsuski lsuski force-pushed the feature/15491-Add-option-to-remove-retrofit-Response-wrapper-from-suspend-api-methods branch from ad4eb93 to 0563ce7 Compare February 7, 2025 14:10
@4brunu
Copy link
Contributor

4brunu commented Feb 7, 2025

Hi, could you please check the CI errors? Thanks

@lsuski
Copy link
Author

lsuski commented Feb 7, 2025

Should be fixed now. Too eager refactoring by Intellij :)

@lsuski lsuski force-pushed the feature/15491-Add-option-to-remove-retrofit-Response-wrapper-from-suspend-api-methods branch from 2e4b0e3 to 48e90cf Compare February 10, 2025 09:33
@lsuski lsuski force-pushed the feature/15491-Add-option-to-remove-retrofit-Response-wrapper-from-suspend-api-methods branch from 48e90cf to d8bdbf9 Compare February 10, 2025 09:55
@4brunu
Copy link
Contributor

4brunu commented Feb 11, 2025

Could you please add this flag to an existing sample project?
For example this one?
https://github.com/OpenAPITools/openapi-generator/blob/master/bin/configs/kotlin-bigdecimal-default-okhttp4.yaml
Thanks

@lsuski
Copy link
Author

lsuski commented Feb 11, 2025

IMHO this one https://github.com/OpenAPITools/openapi-generator/blob/master/bin/configs/unmaintained/kotlin-jvm-retrofit2-coroutines.yaml would be the best one. useResponseAsReturnType requires jvm-retrofit2 and useCoroutines to work. However this sample is unmaintained for some reason. Also keep in mind that flag changes the api response return type so maybe it will be worth to create separate sample for this

@4brunu
Copy link
Contributor

4brunu commented Feb 11, 2025

You are right. I don't know why that's unmaintained, maybe @wing328 can add some more information on why it's unmaintained.

@wing328
Copy link
Member

wing328 commented Feb 11, 2025

if i remember correctly, the build fails but no one has time to look into it

can you try building the sample locally to see if it builds fine for you?

@lsuski
Copy link
Author

lsuski commented Feb 11, 2025

Sure, I will take a look tomorrow

@lsuski
Copy link
Author

lsuski commented Feb 12, 2025

Indeed this sample does not compile but I changed inputSpec to petstore and it works, I moved it to bin/config

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.

3 participants