New EI Consumer API, aligned to ORAN WG2

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

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index a98672a..12ff516 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,5 +1,8 @@
 .. 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:
 
 
 ========
@@ -24,6 +27,8 @@ 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 :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.
 
 API Functions
@@ -35,14 +40,23 @@ SDNC A1 Controller
 
 An ONAP SDNC Controller for the A1 interface.
 
+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.
 
 Complementary tools
 ===================
 
-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.
+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.
+
+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>`.
+It can be downloaded from here: ::
+
+  git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
 
-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"
+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: ::
 
-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"