Test FTC100 fails since A1-SIM update
[nonrtric.git] / docs / api-docs.rst
index 0f17936..47d6720 100644 (file)
@@ -1,75 +1,20 @@
 .. 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-2023 Nordix Foundation. All rights Reserved
+.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved
 
 .. _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|", "|yaml-icon|"
-   :widths: 10,5,5
-
-   "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
-
-
-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.
-
-
-.. 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
-===================
-
-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 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: ::
+Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions.
 
-  git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"
+* DMaaP Mediator Producer :doc:`API Docs <dmaapmediatorproducer:api-docs>`.
+* Helm Manager :doc:`API Docs <helmmanager:api-docs>`.
+* A1 Policy Management Service :doc:`API Docs <onapa1policymanagementservice:offeredapis/offeredapis>`.
+* Information Coordinator Service :doc:`API Docs <informationcoordinatorservice:api-docs>`.
+* rApp Catalogue :doc:`API Docs <rappcatalogue:api-docs>`.
+* rApp Manager Service :doc:`API Docs <rappmanager:api-docs>`.
\ No newline at end of file