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 67f3cee..77bbd0d 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -2,44 +2,60 @@
 .. 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
+============================
+
+For information about the A1 Policy Management Service that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
+
+.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
+.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
 
-The Non-RT RIC consists of two parts, described in the sections below:
- * The Policy Agent
- * The SDNC A1 Controller
+Enrichment Coordinator Service
+==============================
 
+See `ECS API <./ecs-api.html>`_ for how to use the API.
 
-Policy Agent
-============
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5,5
 
-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.
+   "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
 
-See :ref:`policy-agent-api` for how to use the API.
 
-See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
+Service Catalogue
+=================
 
-API Functions
--------------
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
+The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
 
-SDNC A1 Controller
-==================
+See `SC API <./rac-api.html>`_ for how to use the API.
 
-An ONAP SDNC Controller for the A1 interface.
 
-See :ref:`sdnc-a1-controller-api` for how to use the API.
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5, 5
 
-See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
+   "SC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
 
 Complementary tools
 ===================