Fix review suggestions

ballerina-platform · Jun 12, 2024 · d1287ca · d1287ca
1 parent 1ab1215
commit d1287ca
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 7 deletions.
diff --git a/ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/Constants.java b/ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/Constants.java
@@ -326,6 +326,8 @@ public String toString() {
     public static final String FALSE = "false";
     public static final String SLASH = "/";
     public static final String HYPHEN = "-";
+
+    //`@openapi:ServiceInfo` annotation constants
     public static final String CONTRACT = "contract";
     public static final String VERSION = "version";
     public static final String TITLE = "title";
@@ -334,7 +336,6 @@ public String toString() {
     public static final String CONTACT_NAME = "contactName";
     public static final String CONTACT_URL = "contactURL";
     public static final String LICENSE_NAME = "licenseName";
-
     public static final String LICENSE_URL = "licenseURL";
     public static final String TERMS_OF_SERVICE = "termsOfService";
     public static final String OPENAPI_ANNOTATION = "openapi:ServiceInfo";

diff --git a/ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/InfoMapper.java b/ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/InfoMapper.java
@@ -214,13 +214,13 @@ private static OASResult parseServiceInfoAnnotationAttachmentDetails(List<OpenAP
 
         Location location = annotation.location();
         OpenAPI openAPI = new OpenAPI();
-        Optional<MappingConstructorExpressionNode> contentOpt = annotation.annotValue();
+        Optional<MappingConstructorExpressionNode> svcInfoAnnotationValue = annotation.annotValue();
 
-        if (contentOpt.isEmpty()) {
+        if (svcInfoAnnotationValue.isEmpty()) {
             return new OASResult(openAPI, diagnostics);
         }
 
-        SeparatedNodeList<MappingFieldNode> fields = contentOpt.get().fields();
+        SeparatedNodeList<MappingFieldNode> fields = svcInfoAnnotationValue.get().fields();
         if (fields.isEmpty()) {
             return new OASResult(openAPI, diagnostics);
         }

diff --git a/module-ballerina-openapi/Ballerina.toml b/module-ballerina-openapi/Ballerina.toml
@@ -7,4 +7,4 @@ version= "@toml.version@"
 path = "../openapi-validator/build/libs/[email protected]@.jar"
 groupId = "ballerina"
 artifactId = "openapi"
-version = "@project.version@"
+version = "@project.version@"
diff --git a/...api-integration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPITests.java b/...api-integration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPITests.java
@@ -146,7 +146,8 @@ public void nonOpenAPIAnnotationWithWithoutBasePath() throws IOException, Interr
                 "project_non_openapi_annotation_without_base_path/result.yaml");
     }
 
-    @Test(description = "Service is with openapi annotation include all oas infor section details")
+    //TODO enable after resolving dependency issue
+    @Test(description = "Service is with openapi annotation include all oas infor section details", enabled = false)
     public void openAPInForSectionTest() throws IOException, InterruptedException {
         executeCommand("project_openapi_info/service_file.bal", "info_openapi.yaml",
                 "project_openapi_info/result.yaml");

diff --git a/openapi-integration-tests/src/test/resources/ballerina_sources/project_10/result.yaml b/openapi-integration-tests/src/test/resources/ballerina_sources/project_10/result.yaml
@@ -1,6 +1,15 @@
 openapi: 3.0.1
 info:
   title: Mock File
+  description: API system description
+  termsOfService: http://mock-api-doc
+  contact:
+    name: sumudu
+    url: http://mock-api-contact
+    email: [email protected]
+  license:
+    name: ABC
+    url: http://abc.com
   version: 0.1.0
 servers:
   - url: "{server}:{port}/titleBase"

diff --git a/openapi-integration-tests/src/test/resources/ballerina_sources/project_10/service.bal b/openapi-integration-tests/src/test/resources/ballerina_sources/project_10/service.bal
@@ -2,7 +2,14 @@ import ballerina/http;
 import ballerina/openapi;
 
 @openapi:ServiceInfo {
-    title: "Mock file"
+    title: "Mock file",
+    description: "API system description",
+    email: "[email protected]",
+    contactName: "sumudu",
+    contactURL: "http://mock-api-contact",
+    termsOfService: "http://mock-api-doc",
+    licenseName: "ABC",
+    licenseURL: "http://abc.com"
 }
 service /titleBase on new http:Listener(9090) {
     resource function get title() returns string {