From b4ed3335140dcc69949c051321e954ed716f42b6 Mon Sep 17 00:00:00 2001 From: "halil.cakal" Date: Fri, 20 Jan 2023 12:14:08 +0000 Subject: [PATCH] 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 --- a1-policy-management/pom.xml | 18 ++++++++++++++---- docs/offeredapis/offeredapis.rst | 2 +- 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 @@ - io.swagger.codegen.v3 - swagger-codegen-maven-plugin - ${swagger-codegen-maven-plugin.version} + org.openapitools + openapi-generator-maven-plugin + 6.0.0 + html2 test generate ${project.basedir}/api/pms-api.json - openapi-yaml + html2 + false ${project.basedir}/api + false + false + The O-RAN Non-RT RIC Policy Management Service provides a REST API for managing O-RAN A1 Policies. + ONAP CCSDK A1 Policy Management Service + https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP + Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License. + http://www.apache.org/licenses/LICENSE-2.0 pms-api.yaml @@ -363,6 +372,7 @@ ${project.basedir}/api pms-api.* + index.html 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: -- 2.16.6