ONAP CCSDK ORAN A1PMS - Add API Docs

Issue-ID: CCSDK-4011
Change-Id: I7ea39878770e6ee9a2f626daebf29547d94ba5cd
Signed-off-by: DenisGNoonan <denis.noonan@est.tech>

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index f56b3b7..557892d 100644 (file)
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,3 +1,21 @@
+#  ============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.
+#  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.
+#  ============LICENSE_END=================================================
+#
+
 ---
 # .readthedocs.yml
 # Read the Docs configuration file
@@ -6,9 +24,13 @@
 
 version: 2
 build:
-  os: ubuntu-20.04
+  os: "ubuntu-20.04"
   tools:
     python: "3.8"
+  jobs:
+    post_build:
+      - mkdir -p ${READTHEDOCS_OUTPUT}html/openapi
+      - cp -v docs/offeredapis/openapitoolgen/offeredapis/pms-api/* ${READTHEDOCS_OUTPUT}html/openapi
 
 python:
   install:

diff --git a/docs/conf.py b/docs/conf.py
index f53b9f4..07f9c67 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,3 +1,21 @@
+#  ============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.
+#  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.
+#  ============LICENSE_END=================================================
+#
+
 project = "onap"
 release = "master"
 version = "master"
@@ -58,6 +76,10 @@ exclude_patterns = ['.tox']
 spelling_word_list_filename='spelling_wordlist.txt'
 spelling_lang = "en_GB"
 
+html_extra_path = [
+    'offeredapis/openapitoolgen/offeredapis/pms-api'
+]
+
 #
 # Example:
 # intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)

diff --git a/docs/guide/developer-guide.rst b/docs/guide/developer-guide.rst
index 2230c0f..bb73744 100644 (file)
--- a/docs/guide/developer-guide.rst
+++ b/docs/guide/developer-guide.rst
@@ -51,7 +51,7 @@ dependency management tool (see *pom.xml* file at root level) :
 - Swagger annotations
 - `Spring Framework <https://github.com/spring-projects/spring-boot>`_
 - `SpringDoc and OpenAPI <https://springdoc.org/>`_ Automated JSON API documentation for APIs built with Spring
-- `Lombok <https://github.com/rzwitserloot/lombok>`_ to generate code, such as getters and setters
+- `Lombok <https://github.com/projectlombok/lombok>`_ to generate code, such as getters and setters
 - `Awaitility <https://github.com/awaitility/awaitility>`_ to test asynchronous functionality
 
 

diff --git a/docs/tox.ini b/docs/tox.ini
index 3efa947..cf813e1 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -22,7 +22,6 @@ allowlist_externals =
 [testenv:docs-linkcheck]
 basepython = python3.8
 deps = -r{toxinidir}/requirements-docs.txt
-#commands = echo "Link Checking not enforced"
 commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
 allowlist_externals = echo
 
@@ -34,6 +33,3 @@ deps =
     -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
 commands =
     sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
-
-
-