X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;h=47d67207e1e2e401a1d9f0559bef78914d012e7b;hb=4a0b93332b6765f604d4394ea34efb0f2ecb4364;hp=5177088b2c602d8dfa0c294811248a2f309b9120;hpb=448c3841f395c0927d83c7297491475e027f23c5;p=nonrtric.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 5177088b..47d67207 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -1,87 +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: - -The Non-RT RIC consists of four parts, described in the sections below: - * The Dashboard - * The Policy Agent - * The Near-RT RIC simulator - * The Sdnc A1 Controller - -Dashboard -========= - -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. - -See the README.md file in the nonrtric/dashboard repo for info about how to use it. - -API Functions -------------- - -To run the dashboard locally, you can follow these steps: - -- Fetch the latest code from `gerrit`_ - -.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric - -- 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. - -.. image:: ./images/non-RT_RIC_dashboard.png - -Policy Agent -============ -The Policy Agent provides common functionality useful for R-Apps, for instance: - * A repository of available Near-T RICs, their policy types and policy instances. - * An A1 connection to he Near-RT RICs. - -See the README.md file in the nonrtric/policy-agent repo for info about how to use it. - -API Functins ------------- -See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.doc. - -Near-RT RIC Simulator -===================== -A simulator that simulates a Near-RT RIC, with a termination of the A1 interface. It also provides an administrative API to manage types and instances so it can be programatically set up for use in tests. - -See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it. - -API Functions -------------- -See the admnistrative API in: nonrtric/near-rt-ric-simulator/ric-plt/a1/main.py. - -Sdnc A1 Controller -================== -An ONAP SDNC Controller for the A1 interface. - -See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it. +Descriptions of the APIs to the Non-RT RIC functions can be found in the repos for the functions. +* DMaaP Mediator Producer :doc:`API Docs `. +* Helm Manager :doc:`API Docs `. +* A1 Policy Management Service :doc:`API Docs `. +* Information Coordinator Service :doc:`API Docs `. +* rApp Catalogue :doc:`API Docs `. +* rApp Manager Service :doc:`API Docs `. \ No newline at end of file