Test FTC100 fails since A1-SIM update
[nonrtric.git] / docs / api-docs.rst
index 67f3cee..47d6720 100644 (file)
@@ -1,59 +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:
+
 
 ========
 API-Docs
 ========
 
-This is the API-docs of Non-RT RIC.
-
-.. contents::
-   :depth: 3
-   :local:
-
-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
-
-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.
-
-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