Experimenting with HTML-2 API documentation generator 71/132971/3
authorhalil.cakal <halil.cakal@est.tech>
Fri, 20 Jan 2023 12:14:08 +0000 (12:14 +0000)
committerhalil.cakal <halil.cakal@est.tech>
Wed, 1 Feb 2023 09:59:03 +0000 (09:59 +0000)
Check-in only HTML and update rst,
try to remove index.html

Issue-ID: CCSDK-3842
Change-Id: I0ddc3dbc189d553c718ea473129e9c08dd11dede
Signed-off-by: halil.cakal <halil.cakal@est.tech>
a1-policy-management/pom.xml
docs/offeredapis/offeredapis.rst

index eedc514..cbbbdbe 100644 (file)
                 </executions>
             </plugin>
             <plugin>
-                <groupId>io.swagger.codegen.v3</groupId>
-                <artifactId>swagger-codegen-maven-plugin</artifactId>
-                <version>${swagger-codegen-maven-plugin.version}</version>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <version>6.0.0</version>
                 <executions>
                     <execution>
+                        <id>html2</id>
                         <phase>test</phase>
                         <goals>
                             <goal>generate</goal>
                         </goals>
                         <configuration>
                             <inputSpec>${project.basedir}/api/pms-api.json</inputSpec>
-                            <language>openapi-yaml</language>
+                            <generatorName>html2</generatorName>
+                            <verbose>false</verbose>
                             <output>${project.basedir}/api</output>
+                            <skipOperationExample>false</skipOperationExample>
+                            <strictSpec>false</strictSpec>
                             <configOptions>
+                                <appDescription>The O-RAN Non-RT RIC Policy Management Service provides a REST API for managing O-RAN A1 Policies.</appDescription>
+                                <appName>ONAP CCSDK A1 Policy Management Service</appName>
+                                <infoUrl>https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP</infoUrl>
+                                <licenseInfo>Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.</licenseInfo>
+                                <licenseUrl>http://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
                                 <outputFile>pms-api.yaml</outputFile>
                             </configOptions>
                         </configuration>
                                     <directory>${project.basedir}/api</directory>
                                     <includes>
                                         <include>pms-api.*</include>
+                                        <include>index.html</include>
                                     </includes>
                                 </resource>
                             </resources>
index fd65ebf..cbd3c86 100644 (file)
@@ -56,7 +56,7 @@ API Table
 A1 Policy Management Service API
 ................................
 
-The A1 Policy Management Service API is described in more detail in `A1 Policy Management Service API (html) <./pms-api.html>`_
+The A1 Policy Management Service API is described in more detail in `A1 Policy Management Service API (html) <./index.html>`_
 
 
 .. _a1_adapter_api: