Add support for multiline parameter descriptions

ballerina-platform · May 2, 2023 · d75508b · d75508b
1 parent da48a64
commit d75508b
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 4 deletions.
diff --git a/...src/main/java/io/ballerina/openapi/core/generators/client/FunctionSignatureGenerator.java b/...src/main/java/io/ballerina/openapi/core/generators/client/FunctionSignatureGenerator.java
@@ -23,6 +23,7 @@
 import io.ballerina.compiler.syntax.tree.FunctionSignatureNode;
 import io.ballerina.compiler.syntax.tree.IdentifierToken;
 import io.ballerina.compiler.syntax.tree.LiteralValueToken;
+import io.ballerina.compiler.syntax.tree.MarkdownDocumentationNode;
 import io.ballerina.compiler.syntax.tree.MarkdownParameterDocumentationLineNode;
 import io.ballerina.compiler.syntax.tree.NilLiteralNode;
 import io.ballerina.compiler.syntax.tree.Node;
@@ -191,8 +192,8 @@ private void setFunctionParameters(Operation operation, List<Node> parameterList
         if (parameters != null) {
             for (Parameter parameter : parameters) {
                 if (parameter.getDescription() != null && !parameter.getDescription().isBlank()) {
-                    MarkdownParameterDocumentationLineNode paramAPIDoc =
-                            DocCommentsGenerator.createAPIParamDoc(getValidName(
+                    MarkdownDocumentationNode paramAPIDoc =
+                            DocCommentsGenerator.createAPIParamDocFromSring(getValidName(
                                     parameter.getName(), false), parameter.getDescription());
                     remoteFunctionDoc.add(paramAPIDoc);
                 }
@@ -542,8 +543,8 @@ private void setRequestBodyParameters(String operationId, RequestBody requestBod
                 RequiredParameterNode payload = createRequiredParameterNode(
                         createNodeList(annotationNodes), typeName, paramNameToken);
                 if (requestBody.getDescription() != null && !requestBody.getDescription().isBlank()) {
-                    MarkdownParameterDocumentationLineNode paramAPIDoc =
-                            DocCommentsGenerator.createAPIParamDoc(escapeIdentifier(paramName),
+                    MarkdownDocumentationNode paramAPIDoc =
+                            DocCommentsGenerator.createAPIParamDocFromSring(escapeIdentifier(paramName),
                                     requestBody.getDescription().split("\n")[0]);
                     requestBodyDoc.add(paramAPIDoc);
                 }

diff --git a/...ore/src/main/java/io/ballerina/openapi/core/generators/document/DocCommentsGenerator.java b/...ore/src/main/java/io/ballerina/openapi/core/generators/document/DocCommentsGenerator.java
@@ -22,12 +22,17 @@
 import io.ballerina.compiler.syntax.tree.BasicLiteralNode;
 import io.ballerina.compiler.syntax.tree.MappingConstructorExpressionNode;
 import io.ballerina.compiler.syntax.tree.MarkdownDocumentationLineNode;
+import io.ballerina.compiler.syntax.tree.MarkdownDocumentationNode;
 import io.ballerina.compiler.syntax.tree.MarkdownParameterDocumentationLineNode;
+import io.ballerina.compiler.syntax.tree.MetadataNode;
+import io.ballerina.compiler.syntax.tree.ModuleMemberDeclarationNode;
 import io.ballerina.compiler.syntax.tree.Node;
+import io.ballerina.compiler.syntax.tree.NodeParser;
 import io.ballerina.compiler.syntax.tree.SimpleNameReferenceNode;
 import io.ballerina.compiler.syntax.tree.SpecificFieldNode;
 import io.ballerina.compiler.syntax.tree.SyntaxKind;
 import io.ballerina.compiler.syntax.tree.Token;
+import io.ballerina.compiler.syntax.tree.TypeDefinitionNode;
 import io.ballerina.openapi.core.GeneratorConstants;
 import io.ballerina.openapi.core.GeneratorUtils;
 
@@ -164,6 +169,24 @@ public static List<MarkdownDocumentationLineNode> createAPIDescriptionDoc(String
         return documentElements;
     }
 
+    public static MarkdownDocumentationNode createAPIParamDocFromSring(String paramName, String description) {
+        String[] paramDescriptionLines = description.split(System.lineSeparator());
+        StringBuilder docComment = new StringBuilder("# + " + paramName + " - " +
+                paramDescriptionLines[0] + System.lineSeparator());
+        for (int i = 1; i < paramDescriptionLines.length; i++) {
+            String line = paramDescriptionLines[i].replaceAll("[\\r\\n\\t]", "");
+            if (!line.isBlank()) {
+                docComment.append("# ").append(line + System.lineSeparator());
+            }
+        }
+        docComment.append("\n type a A;");
+        ModuleMemberDeclarationNode moduleMemberDeclarationNode =
+                NodeParser.parseModuleMemberDeclaration(docComment.toString());
+        TypeDefinitionNode typeDefinitionNode = (TypeDefinitionNode) moduleMemberDeclarationNode;
+        MetadataNode metadataNode = typeDefinitionNode.metadata().get();
+        return (MarkdownDocumentationNode) metadataNode.children().get(0);
+    }
+
     public static MarkdownParameterDocumentationLineNode createAPIParamDoc(String paramName, String description) {
         String[] paramDescriptionLines = description.split("\n");
         List<Node> documentElements = new ArrayList<>();