X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=db23bcaf7213d130a751a821d74e3bfdce7e9215;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=12ff5167ceed2a5827da049fec2735bbb2dabdf7;hpb=0d271849258e914690dd6d6239580e42d8f266ff;p=nonrtric.git
diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 12ff5167..db23bcaf 100644
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
.. _api_docs:
@@ -9,54 +9,26 @@
API-Docs
========
-This is the API-docs of Non-RT RIC.
+Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions.
-.. contents::
- :depth: 3
- :local:
+See Also: Non-RT RIC Control Panel
+==================================
-The Non-RT RIC consists of two parts, described in the sections below:
- * The Policy Agent
- * The SDNC A1 Controller
-
-
-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.
-
-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
--------------
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
+The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
-SDNC A1 Controller
-==================
+Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_.
-An ONAP SDNC Controller for the A1 interface.
+It can be downloaded from here: ::
-See :ref:`sdnc-a1-controller-api` for how to use the API.
+ 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 `_.
-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 `.
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 `. It can be downloaded from here: ::
-
git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"