Enable getting the ORU-ODU map from policy config

[nonrtric.git] / docs / api-docs.rst

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 193a828..77bbd0d 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,51 +1,75 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2020 Nordix
 
+.. _api_docs:
 
+.. |swagger-icon| image:: ./images/swagger.png
+                  :width: 40px
 
+.. |yaml-icon| image:: ./images/yaml_logo.png
+                  :width: 40px
+
+
+========
 API-Docs
 ========
 
 This is the API-docs of Non-RT RIC.
 
-.. contents::
-   :depth: 3
-   :local:
+The Non-RT RIC consists of three parts, described in the sections below:
+ * The A1 Policy Management Service
+ * The Enrichment Coordinator Service
+ * The rAPP Catalogue
+
+
+A1 Policy Management Service
+============================
 
-API Introduction
------------------
+For information about the A1 Policy Management Service that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
 
-The Non-RT RIC dashboard is an interface that allows human users to create, edit and delete policy instances, for each existing policy type. The policy types are owned by the Near-RT RIC, Non-RT RIC can just query them, so it's not possible to act on them.
+.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
+.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
 
+Enrichment Coordinator Service
+==============================
 
-API Functions
--------------
+See `ECS API <./ecs-api.html>`_ for how to use the API.
 
-To run the dashboard locally, you can follow these steps:
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5,5
 
-- Fetch the latest code from `gerrit`_
+   "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
 
-.. _gerrit: https://gerrit.nordix.org/c/oransc/nonrtric/+/2747/
 
-- Before compiling, run the following commands::
+Service Catalogue
+=================
 
-    git submodule init
+The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
 
-    git submodule update
+See `SC API <./rac-api.html>`_ for how to use the API.
 
-- Start the backend (you might have to build it first)::
 
-    mvn clean install
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5, 5
 
-    mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
+   "SC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
 
+Complementary tools
+===================
 
-- Now you can open URL:  `localhost:8080`_ in a browser.
+There are two additional tools that can be used together with the Non-RT RIC, namely the Control Panel and the Near-RT RIC simulator.
 
-.. _localhost:8080: localhost:8080
+The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
+Documentation for the Control Panel can be found here:
+:doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
+It can be downloaded from here: ::
 
-From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each existing policy type.
+  git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
 
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
+here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
 
-.. image:: ./images/non-RT_RIC_dashboard.png
\ No newline at end of file
+  git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"