Merge "Add docker-compose.yaml file for r-app-catalogue"

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

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 12ff516..ed0cc79 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,38 +17,45 @@ API-Docs
 
 This is the API-docs of Non-RT RIC.
 
-.. contents::
-   :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 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.
+For information about the The Policy Agent 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
+
+Enrichment Coordinator Service
+==============================
+
+See `ECS API <./ecs-api.html>`_ for how to use the API.
+
+.. csv-table::
+   :header: "API name", "|swagger-icon|"
+   :widths: 10,5
+
+   "ECS API", ":download:`link <./offeredapis/swagger/ecs-api.json>`"
 
-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.
+rAPP 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 `RAC 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.
+   "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
 
 Complementary tools
 ===================