Add comments to operation methods (#641)

* Add comments to operation methods * Adjust templates
quarkiverse · Jan 29, 2024 · 0dd27cd · 0dd27cd
1 parent 94bb20b
commit 0dd27cd
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 10 deletions.
diff --git a/...ava/io/quarkiverse/openapi/generator/deployment/template/QuteTemplatingEngineAdapter.java b/...ava/io/quarkiverse/openapi/generator/deployment/template/QuteTemplatingEngineAdapter.java
@@ -30,7 +30,8 @@ public class QuteTemplatingEngineAdapter extends AbstractTemplatingEngineAdapter
             "auth/compositeAuthenticationProvider.qute",
             "auth/headersFactory.qute",
             "multipartFormdataPojo.qute",
-            "pojoAdditionalProperties.qute"
+            "pojoAdditionalProperties.qute",
+            "operationJavaDoc.qute"
     };
     public final Engine engine;
 

diff --git a/deployment/src/main/resources/templates/libraries/microprofile/api.qute b/deployment/src/main/resources/templates/libraries/microprofile/api.qute
@@ -45,16 +45,9 @@ public interface {classname} {
 
     {#for op in operations.operation}
     {#if !op.isDeprecated || openapi:genDeprecatedApiAttr(package, classname, classes-codegen)}
-    {#if op.summary}
-    /**
-     * {op.summary}
-     *
-     {#if op.notes}
-     * {op.notes}
-     *
-     {/if}
+     /**
+    {#include operationJavaDoc.qute op=op/}
      */
-    {/if}
     @{op.httpMethod}
     {#if op.subresourceOperation}
     @Path("{op.path}")

diff --git a/deployment/src/main/resources/templates/libraries/microprofile/operationJavaDoc.qute b/deployment/src/main/resources/templates/libraries/microprofile/operationJavaDoc.qute
@@ -0,0 +1,20 @@
+     {#if op.summary}
+     * {op.summary}
+     *
+     {/if}
+     {#if op.notes}
+     * {op.notes}
+     *
+     {/if}
+     {#for p in op.pathParams}
+     * @param {p.paramName} {p.description}
+     {/for}
+     {#for p in op.queryParams}
+     * @param {p.paramName} {p.description}
+     {/for}
+     {#for p in op.bodyParams}
+     * @param {p.paramName} {p.description}
+     {/for}
+     {#for p in op.headerParams}
+     * @param {p.paramName} {p.description}
+     {/for}