X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=ef234a5661f603c785a6530598865c737fea4b4c;hb=2445c936d194565d989e196299dd8dd27183a5cd;hp=a98672addc4fcfc42ba5935931396aa12100f087;hpb=f700867fa65c7172cee7fca229eb10f2ecdf77dd;p=nonrtric.git

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index a98672ad..ef234a56 100644
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,48 +1,86 @@
 .. 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.
+Here we describe the APIs to access the Non-RT RIC functions.
+
+The core Non-RT RIC consists of several parts, with available APIs described in the sections below:
+
+* The A1 Policy Management Service
+* The Enrichment Coordinator Service
+* The Non-RT-RIC App Catalogue
+* K8S Helm Chart LCM Manager (Initial) **<ToDo>**
+
+A1 Policy Management Service
+============================
+
+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>`_.
+
+Enrichment Coordinator Service
+==============================
+
+See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of 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
+
+   "A1 Enrichment Information Coordination Service API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
+
+Non-RT-RIC App Catalogue (Initial)
+==================================
+
+The Service Catalogue provides a way for services to register themselves for other services to discover.
+
+See `Service Catalogue API <./rac-api.html>`_ for full details of the API.
+
+The API is also described in Swagger-JSON and YAML:
+
 
-.. contents::
-   :depth: 3
-   :local:
+.. csv-table::
+   :header: "API name", "|swagger-icon|", "|yaml-icon|"
+   :widths: 10,5, 5
 
-The Non-RT RIC consists of two parts, described in the sections below:
- * The Policy Agent
- * The SDNC A1 Controller
+   "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
 
+K8S Helm Chart LCM Manager (Initial)
+====================================
 
-Policy Agent
-============
+**<ToDo>**
 
-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.
+See Also: Non-RT RIC Control Panel
+==================================
 
-See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
+The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
 
-API Functions
--------------
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
+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/>`_.
 
-SDNC A1 Controller
-==================
+It can be downloaded from here: ::
 
-An ONAP SDNC Controller for the A1 interface.
+  git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
 
-See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
+See Also: A1 / Near-RT RIC simulator
+====================================
 
-Complementary tools
-===================
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
 
-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.
+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/>`_.
 
-The Non-RT RIC Control panel provides a user interface that allows the user to interact with the Non-RT RIC.
-It can be downloaded using: git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel"
+It can be downloaded from here: ::
 
-The Near-RT RIC simulator does what its name suggests, and can be downloaded here: git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"
+  git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"