feat: add ResponseStatus annotation for non-200 success codes in Quarkus library

Author: Ignacio-Vidal

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaJAXRSSpecServerCodegen.java

@@ -346,7 +346,7 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
         if (QUARKUS_LIBRARY.equals(library) && !returnResponse && !returnJbossResponse) {
             for (CodegenOperation op : objs.getOperations().getOperation()) {
                 op.responses.stream()
-                    .filter(r -> (r.is2xx || r.is3xx) && !"200".equals(r.code))
+                    .filter(r -> r.is2xx || r.is3xx)
                     .findFirst()
                     .ifPresent(r -> op.vendorExtensions.put("x-java-success-response-code", r.code));
             }

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java

@@ -1308,13 +1308,13 @@ public void testGenerateJsonNullableListFieldsHelperMethodReferences_issue23251(
     }
 
     /**
-     * Verify that when using the quarkus library with interfaceOnly=true and a non-200 success response,
-     * the generated interface method is annotated with
-     * {@code @org.jboss.resteasy.reactive.ResponseStatus(<code>)}.
-     * ping.yaml has a 201 response, so the annotation must appear.
+     * Verify that when using the quarkus library with interfaceOnly=true, the generated interface
+     * method is always annotated with {@code @ResponseStatus(<code>)} for any 2xx or 3xx response,
+     * including 200, for explicit documentation purposes.
+     * ping.yaml has a 201 response.
      */
     @Test
-    public void generateQuarkusInterfaceAddsResponseStatusAnnotationForNon200SuccessCode() throws Exception {
+    public void generateQuarkusInterfaceAddsResponseStatusAnnotationForSuccessCode() throws Exception {
         final File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
         output.deleteOnExit();
 
@@ -1343,21 +1343,20 @@ public void generateQuarkusInterfaceAddsResponseStatusAnnotationForNon200Success
     }
 
     /**
-     * Verify that the {@code @ResponseStatus} annotation is NOT emitted when returnResponse=true,
-     * because the user controls the status code via the {@code Response} builder in that mode.
+     * Verify that {@code @ResponseStatus(200)} IS emitted even for the default 200 status code,
+     * for explicit documentation purposes.
      */
     @Test
-    public void generateQuarkusInterfaceDoesNotAddResponseStatusAnnotationWhenReturnResponse() throws Exception {
+    public void generateQuarkusInterfaceAddsResponseStatusAnnotationFor200Response() throws Exception {
         final File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
         output.deleteOnExit();
 
         final OpenAPI openAPI = new OpenAPIParser()
-                .readLocation("src/test/resources/3_0/ping.yaml", null, new ParseOptions()).getOpenAPI();
+                .readLocation("src/test/resources/3_0/petstore.yaml", null, new ParseOptions()).getOpenAPI();
 
         codegen.setOutputDir(output.getAbsolutePath());
         codegen.setLibrary(QUARKUS_LIBRARY);
         codegen.additionalProperties().put(INTERFACE_ONLY, true);
-        codegen.additionalProperties().put(RETURN_RESPONSE, true); //Given returnResponse is true
 
         final ClientOptInput input = new ClientOptInput()
                 .openAPI(openAPI)
@@ -1368,28 +1367,29 @@ public void generateQuarkusInterfaceDoesNotAddResponseStatusAnnotationWhenReturn
 
         validateJavaSourceFiles(files);
 
-        //Then the annotation must NOT appear
-        TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/PingApi.java");
-        assertFileNotContains(output.toPath().resolve("src/gen/java/org/openapitools/api/PingApi.java"),
-                "@ResponseStatus",
-                "import org.jboss.resteasy.reactive.ResponseStatus");
+        //Then @ResponseStatus(200) IS present for explicit documentation
+        TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/PetApi.java");
+        assertFileContains(output.toPath().resolve("src/gen/java/org/openapitools/api/PetApi.java"),
+                "import org.jboss.resteasy.reactive.ResponseStatus;",
+                "@ResponseStatus(200)");
     }
 
     /**
-     * Verify that the {@code @ResponseStatus} annotation is NOT emitted when the sole success
-     * response code is 200, since that is the RESTEasy Reactive default.
+     * Verify that the {@code @ResponseStatus} annotation is NOT emitted when returnResponse=true,
+     * because the user controls the status code via the {@code Response} builder in that mode.
      */
     @Test
-    public void generateQuarkusInterfaceDoesNotAddResponseStatusAnnotationFor200Response() throws Exception {
+    public void generateQuarkusInterfaceDoesNotAddResponseStatusAnnotationWhenReturnResponse() throws Exception {
         final File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
         output.deleteOnExit();
 
         final OpenAPI openAPI = new OpenAPIParser()
-                .readLocation("src/test/resources/3_0/petstore.yaml", null, new ParseOptions()).getOpenAPI();
+                .readLocation("src/test/resources/3_0/ping.yaml", null, new ParseOptions()).getOpenAPI();
 
         codegen.setOutputDir(output.getAbsolutePath());
         codegen.setLibrary(QUARKUS_LIBRARY);
         codegen.additionalProperties().put(INTERFACE_ONLY, true);
+        codegen.additionalProperties().put(RETURN_RESPONSE, true); //Given returnResponse is true
 
         final ClientOptInput input = new ClientOptInput()
                 .openAPI(openAPI)
@@ -1400,9 +1400,9 @@ public void generateQuarkusInterfaceDoesNotAddResponseStatusAnnotationFor200Resp
 
         validateJavaSourceFiles(files);
 
-        //Then the annotation must NOT appear (petstore only uses 200 for success)
-        TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/PetApi.java");
-        assertFileNotContains(output.toPath().resolve("src/gen/java/org/openapitools/api/PetApi.java"),
+        //Then the annotation must NOT appear
+        TestUtils.ensureContainsFile(files, output, "src/gen/java/org/openapitools/api/PingApi.java");
+        assertFileNotContains(output.toPath().resolve("src/gen/java/org/openapitools/api/PingApi.java"),
                 "@ResponseStatus",
                 "import org.jboss.resteasy.reactive.ResponseStatus");
     }