From e4d572624abc367cbdf5b282a68e394f8cfc9798 Mon Sep 17 00:00:00 2001 From: DenisGNoonan Date: Thu, 9 May 2024 17:54:26 +0100 Subject: [PATCH] A1PMS - Add API Docs Change-Id: Ib479e4549684e3e793d1bc8f98af2f154b7a1398 Signed-off-by: DenisGNoonan --- .readthedocs.yaml | 4 ++++ docs/api-docs.rst | 17 +++++++++++++++++ docs/conf.py | 5 +++++ docs/index.rst | 2 ++ .../offeredapis/pms-api/{index.html => pms-api.html} | 0 docs/release-notes.rst | 6 +++--- pom.xml | 4 ++-- 7 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 docs/api-docs.rst rename docs/offeredapis/openapitoolgen/offeredapis/pms-api/{index.html => pms-api.html} (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 311a67c..26aaa65 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,5 +1,6 @@ # ============LICENSE_START=============================================== # Copyright (C) 2020-2023 Nordix Foundation. All rights reserved. +# Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. # ======================================================================== # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -25,6 +26,9 @@ build: os: ubuntu-22.04 tools: python: "3.11" + jobs: + post_build: + - cp -v docs/offeredapis/openapitoolgen/offeredapis/pms-api/pms-api.html $READTHEDOCS_OUTPUT/html python: install: diff --git a/docs/api-docs.rst b/docs/api-docs.rst new file mode 100644 index 0000000..24f66b3 --- /dev/null +++ b/docs/api-docs.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2024 OpenInfra Foundation Europe + +.. _api_docs: + +======== +API Docs +======== + +To view the Open API specification for A1 PMS, please see the following. + +.. raw:: html + + diff --git a/docs/conf.py b/docs/conf.py index adbae5d..51a61b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,6 @@ # ============LICENSE_START=============================================== # Copyright (C) 2021-2022 Nordix Foundation. All rights reserved. +# Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. # ======================================================================== # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -30,6 +31,10 @@ linkcheck_ignore = [ extensions = ['sphinx.ext.intersphinx',] +html_extra_path = [ + 'offeredapis/openapitoolgen/offeredapis/pms-api' +] + #intershpinx mapping with other projects intersphinx_mapping = {} diff --git a/docs/index.rst b/docs/index.rst index 0b5d96a..9a71178 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2023 Nordix +.. Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. Non-RT RIC A1 Policy Management Service ======================================= @@ -13,3 +14,4 @@ Non-RT RIC A1 Policy Management Service ./developer-guide.rst ./installation-guide.rst ./release-notes.rst + ./api-docs.rst diff --git a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/pms-api.html similarity index 100% rename from docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html rename to docs/offeredapis/openapitoolgen/offeredapis/pms-api/pms-api.html diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 2c60148..ff523a3 100755 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,17 +1,17 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2021 Nordix. All rights reserved. -.. Copyright (C) 2023 OpenInfra Foundation Europe. All rights reserved. +.. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. ============= -Release-Notes +Release Notes ============= This document provides the release notes for the release of the Non-RT RIC A1 Policy Management Service. -Version history A1 Policy Management Service (A1 Policy Agent) +Version history A1 Policy Management Service (A1 Policy Agent) ============================================================== +------------+----------+------------------+--------------------+ diff --git a/pom.xml b/pom.xml index ba524d1..309c95a 100644 --- a/pom.xml +++ b/pom.xml @@ -348,7 +348,7 @@ ONAP CCSDK A1 Policy Management Service https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP Copyright (C) 2020-2023 Nordix Foundation. Licensed - under the Apache License, and Copyright (C) 2024 OpenInfra + under the Apache License, and Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. http://www.apache.org/licenses/LICENSE-2.0 @@ -432,7 +432,7 @@ ${project.basedir}/api/pms-api - index.html + pms-api.html -- 2.16.6