Adding ONAP PMS as a submodule.
[nonrtric.git] / docs / api-docs.rst
index 67f3cee..9416940 100644 (file)
@@ -2,6 +2,9 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright (C) 2020 Nordix
 
+.. _api_docs:
+
+
 ========
 API-Docs
 ========
@@ -12,9 +15,10 @@ This is the API-docs of Non-RT RIC.
    :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 rAPP Catalogue
 
 
 Policy Agent
@@ -30,7 +34,7 @@ See the README.md file in the nonrtric/policy-agent repo for info about how to u
 
 API Functions
 -------------
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
+See the following document for the Policy Agent API: nonrtric/onap/oran/docs/offeredapis/swagger/pms-api.yaml
 
 SDNC A1 Controller
 ==================
@@ -41,6 +45,26 @@ See :ref:`sdnc-a1-controller-api` for how to use the API.
 
 See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
 
+rAPP 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
+
+
+.. 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>`"
+
 Complementary tools
 ===================