Merge "Name alignment, agent to a1pms, in test env"

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

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 0f17936..7c6b6c2 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 .. _api_docs:
 
@@ -15,61 +15,72 @@
 API-Docs
 ========
 
-This is the API-docs of Non-RT RIC.
+Here we describe the APIs to access the Non-RT RIC functions.
 
-The Non-RT RIC consists of three parts, described in the sections below:
- * The Policy Agent
- * The Enrichment Coordinator Service
- * The rAPP Catalogue
+The core Non-RT RIC consists of several parts, with available APIs described in the sections below:
 
+* The A1 Policy Management Service
+* The Information Coordinator Service
+* DMaaP Adaptor
+* K8S Helm Chart LCM Manager (Initial) **<ToDo>**
 
-Policy Agent
-============
+A1 Policy Management Service
+============================
 
-For information about the The Policy Agent that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
+For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_ and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
 
-.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
-.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
+Information Coordinator Service
+===============================
 
-Enrichment Coordinator Service
-==============================
+See `A1 Information Information Coordination Service API <./ics-api.html>`_ for full details of the API.
 
-See `ECS API <./ecs-api.html>`_ for how to use the API.
+The API is also described in Swagger-JSON and YAML:
 
 .. csv-table::
    :header: "API name", "|swagger-icon|", "|yaml-icon|"
    :widths: 10,5,5
 
-   "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
+   "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`"
 
+DMaaP Adaptor
+=============
 
-rAPP Catalogue
-==============
+The DMaaP Adaptor provides support for push delivery of any data received from DMaaP or Kafka.
 
-The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
+See `DMaaP Adaptor API <./dmaap-adaptor-api.html>`_ for full details of the API.
 
-See `RAC API <./rac-api.html>`_ for how to use the API.
+The API is also described in Swagger-JSON and YAML:
 
 
 .. 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>`"
+   "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`"
 
-Complementary tools
-===================
+K8S Helm Chart LCM Manager (Initial)
+====================================
 
-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.
+**<ToDo>**
+
+See Also: Non-RT RIC Control Panel
+==================================
 
 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>`.
+
+Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel <https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/latest/>`_.
+
 It can be downloaded from here: ::
 
   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
 
-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: ::
+See Also: A1 / Near-RT RIC simulator
+====================================
+
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
+
+Documentation for the simulator can be found here: `A1 Interface Simulator <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/>`_.
+
+It can be downloaded from here: ::
 
   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"