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 9416940..77bbd0d 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -4,6 +4,12 @@
 
 .. _api_docs:
 
+.. |swagger-icon| image:: ./images/swagger.png
+                  :width: 40px
+
+.. |yaml-icon| image:: ./images/yaml_logo.png
+                  :width: 40px
+
 
 ========
 API-Docs
@@ -11,59 +17,45 @@ 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 Policy Agent
- * The SDNC A1 Controller
+ * The A1 Policy Management Service
+ * The Enrichment Coordinator Service
  * The rAPP Catalogue
 
 
-Policy Agent
-============
-
-The Policy Agent provides common functionality useful for R-Apps, for instance:
- * A repository of available Near-RT RICs, their policy types and policy instances.
- * An A1 connection to the Near-RT RICs.
+A1 Policy Management Service
+============================
 
-See :ref:`policy-agent-api` for how to use the API.
+For information about the A1 Policy Management Service that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
 
-See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
+.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
+.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
 
-API Functions
--------------
-See the following document for the Policy Agent API: nonrtric/onap/oran/docs/offeredapis/swagger/pms-api.yaml
+Enrichment Coordinator Service
+==============================
 
-SDNC A1 Controller
-==================
+See `ECS API <./ecs-api.html>`_ for how to use the API.
 
-An ONAP SDNC Controller for the A1 interface.
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5,5
 
-See :ref:`sdnc-a1-controller-api` for how to use the API.
+   "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
 
-See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
 
-rAPP Catalogue
-==============
+Service 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
+See `SC API <./rac-api.html>`_ for how to use the API.
 
 
 .. 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>`"
+   "SC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
 
 Complementary tools
 ===================