Test FTC100 fails since A1-SIM update
[nonrtric.git] / docs / api-docs.rst
index a296460..47d6720 100644 (file)
@@ -1,51 +1,20 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. 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:
-
-API Introduction
------------------
-
-The Non-RT RIC dashboard is an interface that allows human users to create, edit and delete policy instances, for each existing policy type. The policy types are owned by the Near-RT RIC, Non-RT RIC can just query them, so it's not possible to act on them.
-
-
-API Functions
--------------
-
-To run the dashboard locally, you can follow these steps:
-
-- Fetch the latest code from `gerrit`_
-
-.. _gerrit: https://gerrit.nordix.org/c/oransc/nonrtric/+/2747/
-
-- Before compiling, run the following commands::
-
-    git submodule init
-
-    git submodule update
-
-- Start the backend (you might have to build it first)::
-
-    mvn clean install
-
-    mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
-
-
-- Now you can open URL:  `localhost:8080`_ in a browser. 
-
-.. _localhost:8080: localhost:8080
-
-From the main page, click on the "Policy Control" card. From here, it is possible to create or list instances for each existing policy type.
-
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions.
 
-.. image:: ./images/non-RT_RIC_dashboard.png
\ No newline at end of file
+* 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