Skip to content

Conversation

@zamzterz
Copy link
Contributor

@zamzterz zamzterz commented Jun 5, 2025

Add configuration option generateGenericResponseEntity for Spring generator to allow generating generic ResponseEntity<?> controller-method return type.

Fixes #1096, fixes #17520

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 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.
  • 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: @cachescrubber @welshm @MelleD @atextor @manedev79 @javisst @borsch @banlevente @Zomzog @martin-mfg

@wing328
Copy link
Member

wing328 commented Jul 2, 2025

did a test and here is the change using the example spec mentioned in the issue

 @Validated
 @Tag(name = "example", description = "the example API")
 public interface ExampleApi {
@@ -67,7 +67,7 @@ public interface ExampleApi {
         produces = { "application/json" }
     )

-    default ResponseEntity<Object> examples(
+    default ResponseEntity<?> examples(

     ) {
         getRequest().ifPresent(request -> {

@wing328
Copy link
Member

wing328 commented Jul 2, 2025

thanks for the PR

let's give it a try

@wing328 wing328 merged commit 65773a9 into OpenAPITools:master Jul 2, 2025
14 checks passed
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.

[REQ] [SPRING] Return generic ResponseEntity from generated controllers [Spring] can't handle multiple responses

2 participants