X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=db23bcaf7213d130a751a821d74e3bfdce7e9215;hb=b2ef1d832b94af02c7a3acefb4c8c5e4db03242b;hp=ed0cc79a42cfe183fac478bf57cc9c92c817933d;hpb=e8cc7ee89c17cb18c0802bd3a6afe8031217b2ab;p=nonrtric.git
diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index ed0cc79a..db23bcaf 100644
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -1,75 +1,34 @@
.. 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:
-.. |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.
-
-The Non-RT RIC consists of three parts, described in the sections below:
- * The Policy Agent
- * The Enrichment Coordinator Service
- * The rAPP Catalogue
-
-
-Policy Agent
-============
-
-For information about the The Policy Agent that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
-
-.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
-.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
-
-Enrichment Coordinator Service
-==============================
-
-See `ECS API <./ecs-api.html>`_ for how to use the API.
-
-.. csv-table::
- :header: "API name", "|swagger-icon|"
- :widths: 10,5
+Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions.
- "ECS API", ":download:`link <./offeredapis/swagger/ecs-api.json>`"
+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.
-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.
+Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel `_.
+It can be downloaded from here: ::
-.. csv-table::
- :header: "API name", "|swagger-icon|", "|yaml-icon|"
- :widths: 10,5, 5
+ git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
- "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
+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"