summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorhalil.cakal <halil.cakal@est.tech>2023-01-20 12:14:08 +0000
committerhalil.cakal <halil.cakal@est.tech>2023-02-01 09:59:03 +0000
commitb4ed3335140dcc69949c051321e954ed716f42b6 (patch)
tree75a23a3c32a759b12cca2acbf3c30412652bca29
parentaee111025016696c6aa5ffe1f86acdb731a7ff0f (diff)
Experimenting with HTML-2 API documentation generator
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>
-rw-r--r--a1-policy-management/pom.xml18
-rw-r--r--docs/offeredapis/offeredapis.rst2
2 files changed, 15 insertions, 5 deletions
diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml
index eedc5143..cbbbdbe6 100644
--- a/a1-policy-management/pom.xml
+++ b/a1-policy-management/pom.xml
@@ -327,20 +327,29 @@
</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>
@@ -363,6 +372,7 @@
<directory>${project.basedir}/api</directory>
<includes>
<include>pms-api.*</include>
+ <include>index.html</include>
</includes>
</resource>
</resources>
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index fd65ebf9..cbd3c867 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -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: