.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 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 Information Coordinator Service
+* DMaaP Adaptor
+* 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>`_.
+
+Information Coordinator Service
+===============================
+
+See `A1 Information Information Coordination Service API <./ics-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
-.. contents::
- :depth: 3
- :local:
+ "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`"
-The Non-RT RIC consists of two parts, described in the sections below:
- * The Policy Agent
- * The SDNC A1 Controller
+DMaaP Adaptor
+=============
+The DMaaP Adaptor provides support for push delivery of any data received from DMaap or Kafka.
-Policy Agent
-============
+See `DMaaP Adaptor API <./dmaap-adaptor-api.html>`_ for full details of the API.
-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.
+The API is also described in Swagger-JSON and 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.
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
-API Functions
--------------
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
+ "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`"
-SDNC A1 Controller
-==================
+Non-RT-RIC App Catalogue (Initial)
+==================================
-An ONAP SDNC Controller for the A1 interface.
+The Service Catalogue provides a way for services to register themselves for other services to discover.
-See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
+See `Service Catalogue API <./rac-api.html>`_ for full details of the API.
-Complementary tools
-===================
+The API is also described in Swagger-JSON and YAML:
-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.
+
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
+
+ "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)
+====================================
+
+**<ToDo>**
+
+See Also: Non-RT RIC Control Panel
+==================================
The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
-Documentation for the Control Panel can be found here:
-:doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
+
+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/>`_.
+
It can be downloaded from here: ::
git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
-The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
-here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
+See Also: A1 / Near-RT RIC simulator
+====================================
+
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
+
+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/>`_.
+
+It can be downloaded from here: ::
git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"
Code Review / nonrtric.git / blobdiff