Introduce rAPP Catalogue API
Change-Id: I0128c5b6405d2efd4de49d4ced200cd9fed6cf96
Issue-ID: NONRTRIC-287
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
diff --git a/docs/.project b/docs/.project
deleted file mode 100644
index e248a4f..0000000
--- a/docs/.project
+++ /dev/null
@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
- <name>docs</name>
- <comment></comment>
- <projects>
- </projects>
- <buildSpec>
- </buildSpec>
- <natures>
- </natures>
-</projectDescription>
diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 12ff516..9b0608a 100644
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -15,9 +15,10 @@
:depth: 3
:local:
-The Non-RT RIC consists of two parts, described in the sections below:
+The Non-RT RIC consists of three parts, described in the sections below:
* The Policy Agent
* The SDNC A1 Controller
+ * The rAPP Catalogue
Policy Agent
@@ -44,6 +45,26 @@
See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
+rAPP Catalogue
+==============
+
+The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
+
+See `RAC API <./rac-api.html>`_ for how to use the API.
+
+.. |swagger-icon| image:: ./images/swagger.png
+ :width: 40px
+
+.. |yaml-icon| image:: ./images/yaml_logo.png
+ :width: 40px
+
+
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
+
+ "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
+
Complementary tools
===================
diff --git a/docs/conf.py b/docs/conf.py
index d620289..a6ae7f9 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,9 +7,23 @@
linkcheck_ignore = [
'http://localhost.*',
'http://127.0.0.1.*',
- 'https://gerrit.o-ran-sc.org.*'
+ 'https://gerrit.o-ran-sc.org.*',
+ './rac-api.html' #Generated file that doesn't exist at link check.
]
+extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
+
+redoc = [
+ {
+ 'name': 'RAC API',
+ 'page': 'rac-api',
+ 'spec': '../r-app-catalogue/api/rac-api.json',
+ 'embed': True,
+ }
+ ]
+
+redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
+
#intershpinx mapping with other projects
intersphinx_mapping = {}
diff --git a/docs/images/swagger.png b/docs/images/swagger.png
new file mode 100644
index 0000000..f5a9e0c
--- /dev/null
+++ b/docs/images/swagger.png
Binary files differ
diff --git a/docs/images/yaml_logo.png b/docs/images/yaml_logo.png
new file mode 100644
index 0000000..0492eb4
--- /dev/null
+++ b/docs/images/yaml_logo.png
Binary files differ
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 09a0c1c..78db685 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,5 +1,12 @@
-sphinx
-sphinx-rtd-theme
-sphinxcontrib-httpdomain
-recommonmark
-lfdocs-conf
+tox
+Sphinx>=2,<4
+doc8
+docutils
+setuptools
+six
+sphinx_rtd_theme>=0.4.3
+sphinxcontrib-needs>=0.2.3
+sphinxcontrib-swaggerdoc
+sphinx_bootstrap_theme
+sphinxcontrib-redoc
+lfdocs-conf
\ No newline at end of file
