Merge pull request #1718 from lnash94/2.0.x_add_example_to_oas

[2.0.x] Add OpenAPI resource annotation for the mapping example details into OAS

ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/Constants.java

@@ -345,4 +345,12 @@ public String toString() {
     public static final String JSON_EXTENSION = ".json";
     public static final String YML_EXTENSION = ".yml";
     public static final String UNDERSCORE = "_";
+
+    //openapi:ResourceInFo annotation
+    public static final String OPENAPI_RESOURCE_INFO = "openapi:ResourceInfo";
+    public static final String TAGS = "tags";
+    public static final String SUMMARY = "summary";
+    public static final String EXAMPLES = "examples";
+    public static final String OPERATION_ID = "operationId";
+    public static final String RESPONSE_ATTRIBUTE = "response";
 }

ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/ServiceMapperFactory.java

@@ -36,6 +36,8 @@
 import io.ballerina.openapi.service.mapper.interceptor.model.RequestParameterInfo;
 import io.ballerina.openapi.service.mapper.interceptor.model.ResponseInfo;
 import io.ballerina.openapi.service.mapper.interceptor.pipeline.InterceptorPipeline;
+import io.ballerina.openapi.service.mapper.metainfo.MetaInfoMapper;
+import io.ballerina.openapi.service.mapper.metainfo.MetaInfoMapperImpl;
 import io.ballerina.openapi.service.mapper.model.AdditionalData;
 import io.ballerina.openapi.service.mapper.model.ModuleMemberVisitor;
 import io.ballerina.openapi.service.mapper.model.OperationInventory;
@@ -81,6 +83,7 @@ public class ServiceMapperFactory {
     private final ConstraintMapper constraintMapper;
     private final HateoasMapper hateoasMapper;
     private final InterceptorPipeline interceptorPipeline;
+    private final MetaInfoMapper metaInfoMapper;
 
     public ServiceMapperFactory(OpenAPI openAPI, SemanticModel semanticModel, ModuleMemberVisitor moduleMemberVisitor,
                                 List<OpenAPIMapperDiagnostic> diagnostics, ServiceDeclarationNode serviceDefinition) {
@@ -92,6 +95,7 @@ public ServiceMapperFactory(OpenAPI openAPI, SemanticModel semanticModel, Module
         this.typeMapper = new TypeMapperImpl(getComponents(openAPI), additionalData);
         this.constraintMapper = new ConstraintMapperImpl(openAPI, moduleMemberVisitor, diagnostics);
         this.hateoasMapper = new HateoasMapperImpl();
+        this.metaInfoMapper = new MetaInfoMapperImpl();
     }
 
     public ServersMapper getServersMapper(Set<ListenerDeclarationNode> endpoints, ServiceDeclarationNode serviceNode) {
@@ -162,6 +166,10 @@ public HateoasMapper getHateoasMapper() {
         return hateoasMapper;
     }
 
+    public MetaInfoMapper getMetaInfoMapper() {
+            return metaInfoMapper;
+    }
+
     private Components getComponents(OpenAPI openAPI) {
         Components components = openAPI.getComponents();
         if (Objects.isNull(components)) {

ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/ServiceToOpenAPIMapper.java

@@ -33,6 +33,7 @@
 import io.ballerina.openapi.service.mapper.diagnostic.ExceptionDiagnostic;
 import io.ballerina.openapi.service.mapper.diagnostic.OpenAPIMapperDiagnostic;
 import io.ballerina.openapi.service.mapper.hateoas.HateoasMapper;
+import io.ballerina.openapi.service.mapper.metainfo.MetaInfoMapper;
 import io.ballerina.openapi.service.mapper.model.ModuleMemberVisitor;
 import io.ballerina.openapi.service.mapper.model.OASGenerationMetaInfo;
 import io.ballerina.openapi.service.mapper.model.OASResult;
@@ -206,6 +207,9 @@ public static OASResult generateOAS(OASGenerationMetaInfo oasGenerationMetaInfo)
                 HateoasMapper hateoasMapper = serviceMapperFactory.getHateoasMapper();
                 hateoasMapper.setOpenApiLinks(serviceDefinition, openapi);
 
+                MetaInfoMapper metaInfoMapper = serviceMapperFactory.getMetaInfoMapper();
+                metaInfoMapper.setResourceMetaData(openapi, serviceDefinition);
+
                 if (openapi.getComponents().getSchemas().isEmpty()) {
                     openapi.setComponents(null);
                 }

ballerina-to-openapi/src/main/java/io/ballerina/openapi/service/mapper/metainfo/MetaInfoMapper.java

@@ -0,0 +1,31 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
+ *
+ *  WSO2 LLC. licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except
+ *  in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+package io.ballerina.openapi.service.mapper.metainfo;
+
+import io.ballerina.compiler.syntax.tree.ServiceDeclarationNode;
+import io.swagger.v3.oas.models.OpenAPI;
+
+/**
+ * Interface for Meta information mapper.
+ *
+ * @since 2.0.1
+ */
+public interface MetaInfoMapper {
+    void setResourceMetaData(OpenAPI openAPI, ServiceDeclarationNode serviceNode);
+}