rename annotation

Author: SentryMan

http-api/src/main/java/io/avaje/http/api/OpenAPIReturns.java renamed to http-api/src/main/java/io/avaje/http/api/OpenAPIResponse.java

@@ -23,8 +23,8 @@
  */
 @Target(value = METHOD)
 @Retention(value = RUNTIME)
-@Repeatable(OpenAPIReturnsContainer.class)
-public @interface OpenAPIReturns {
+@Repeatable(OpenAPIResponses.class)
+public @interface OpenAPIResponse {
 
   /** the http status code of this response */
   String responseCode();

http-api/src/main/java/io/avaje/http/api/OpenAPIReturnsContainer.java renamed to http-api/src/main/java/io/avaje/http/api/OpenAPIResponses.java

@@ -6,9 +6,13 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
-/** a container for the OpenAPIReturns annotation to make it repeatable */
+/**
+ * Container for repeatable {@link OpenAPIResponse} annotation
+ *
+ * @see OpenAPIResponse
+ */
 @Target(value = METHOD)
 @Retention(value = RUNTIME)
-public @interface OpenAPIReturnsContainer {
-  OpenAPIReturns[] value();
+public @interface OpenAPIResponses {
+  OpenAPIResponse[] value();
 }

http-generator-core/src/main/java/io/avaje/http/generator/core/MethodReader.java

@@ -2,7 +2,11 @@
 
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import javax.lang.model.element.Element;
 import javax.lang.model.element.ExecutableElement;
@@ -15,7 +19,8 @@
 import io.avaje.http.api.Delete;
 import io.avaje.http.api.Form;
 import io.avaje.http.api.Get;
-import io.avaje.http.api.OpenAPIReturns;
+import io.avaje.http.api.OpenAPIResponse;
+import io.avaje.http.api.OpenAPIResponses;
 import io.avaje.http.api.Patch;
 import io.avaje.http.api.Post;
 import io.avaje.http.api.Produces;
@@ -49,7 +54,7 @@ public class MethodReader {
 
   private final String produces;
 
-  private final OpenAPIReturns[] apiResponses;
+  private final List<OpenAPIResponse> apiResponses;
 
   private final ExecutableType actualExecutable;
   private final List<? extends TypeMirror> actualParams;
@@ -128,12 +133,20 @@ public Javadoc javadoc() {
   }
 
   private String produces(ControllerReader bean) {
-    final Produces produces = findAnnotation(Produces.class);
+    final var produces = findAnnotation(Produces.class);
     return (produces != null) ? produces.value() : bean.produces();
   }
 
-  private OpenAPIReturns[] getApiResponses() {
-    return element.getAnnotationsByType(OpenAPIReturns.class);
+  private List<OpenAPIResponse> getApiResponses() {
+    final var container =
+        Optional.ofNullable(findAnnotation(OpenAPIResponses.class)).stream()
+            .map(OpenAPIResponses::value)
+            .flatMap(Arrays::stream);
+
+    return Stream.concat(container, Arrays.stream(element.getAnnotationsByType(OpenAPIResponse.class)))
+        .collect(Collectors.toList());
+
+
   }
 
   public <A extends Annotation> A findAnnotation(Class<A> type) {
@@ -230,7 +243,7 @@ public String produces() {
     return produces;
   }
 
-  public OpenAPIReturns[] apiResponses() {
+  public List<OpenAPIResponse> apiResponses() {
     return apiResponses;
   }
 
@@ -291,5 +304,4 @@ public String bodyName() {
     }
     return "body";
   }
-
 }

tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/test/OpenAPIController.java

@@ -5,7 +5,8 @@
 import io.avaje.http.api.Controller;
 import io.avaje.http.api.Get;
 import io.avaje.http.api.MediaType;
-import io.avaje.http.api.OpenAPIReturns;
+import io.avaje.http.api.OpenAPIResponse;
+import io.avaje.http.api.OpenAPIResponses;
 import io.avaje.http.api.Path;
 import io.avaje.http.api.Post;
 import io.avaje.http.api.Produces;
@@ -32,7 +33,7 @@ public class OpenAPIController {
    */
   @Get("/get")
   @Produces(MediaType.TEXT_PLAIN)
-  @OpenAPIReturns(responseCode = "200", type = String.class)
+  @OpenAPIResponse(responseCode = "200", type = String.class)
   void ctxEndpoint(Context ctx) {
     ctx.contentType(MediaType.TEXT_PLAIN).result("healthlmao");
   }
@@ -45,12 +46,12 @@ void ctxEndpoint(Context ctx) {
    */
   @Post("/post")
   @Tag(name = "tag1", description = "this is added to openapi tags")
-  @OpenAPIReturns(responseCode = "200", description = "overrides @return javadoc description")
-  @OpenAPIReturns(responseCode = "201")
-  @OpenAPIReturns(
+  @OpenAPIResponse(responseCode = "200", description = "overrides @return javadoc description")
+  @OpenAPIResponse(responseCode = "201")
+  @OpenAPIResponse(
       responseCode = "400",
       description = "User not found (Will not have an associated response schema)")
-  @OpenAPIReturns(
+  @OpenAPIResponse(
       responseCode = "500",
       description = "Some other Error (Will have this error class as the response class)",
       type = ErrorResponse.class)
@@ -66,6 +67,13 @@ Person testPost(Person b) {
    */
   @Deprecated
   @Post("/post1")
+  @OpenAPIResponses({
+    @OpenAPIResponse(responseCode = "400", description = "User not found"),
+    @OpenAPIResponse(
+        responseCode = "500",
+        description = "Some other Error",
+        type = ErrorResponse.class)
+  })
   Person testPostl(List<Person> m) {
 
     return new Person(0, "baby");

tests/test-javalin-jsonb/src/test/java/io/avaje/http/generator/expectedOpenApi.json

@@ -106,6 +106,19 @@
           "required": true
         },
         "responses": {
+          "400": {
+            "description": "User not found"
+          },
+          "500": {
+            "description": "Some other Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
           "201": {
             "description": "the response body (from javadoc)",
             "content": {