.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2020 Nordix
+.. _api_docs:
-========
-API-Docs
-========
-
-This is the API-docs of Non-RT RIC.
-
-.. contents::
- :depth: 3
- :local:
+.. |swagger-icon| image:: ./images/swagger.png
+ :width: 40px
-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
+.. |yaml-icon| image:: ./images/yaml_logo.png
+ :width: 40px
-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
--------------
+========
+API-Docs
+========
-To run the dashboard locally, you can follow these steps:
+Here we describe the APIs to access the Non-RT RIC functions.
-- Fetch the latest code from `gerrit`_
+The core Non-RT RIC consists of several parts, with available APIs described in the sections below:
-.. _gerrit: https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric
+* The A1 Policy Management Service
+* The Enrichment Coordinator Service
+* The Non-RT-RIC App Catalogue
+* K8S Helm Chart LCM Manager (Initial) **<ToDo>**
-- Before compiling, run the following commands::
+A1 Policy Management Service
+============================
- git submodule init
+For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_ and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
- git submodule update
+Enrichment Coordinator Service
+==============================
-- Start the backend (you might have to build it first)::
+See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of the API.
- mvn clean install
+The API is also described in Swagger-JSON and YAML:
- mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5,5
+ "A1 Enrichment Information Coordination Service API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
-- Now you can open URL: `localhost:8080`_ in a browser.
+Non-RT-RIC App Catalogue (Initial)
+==================================
-.. _localhost:8080: localhost:8080
+The Service Catalogue provides a way for services to register themselves for other services to discover.
-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.
+See `Service Catalogue API <./rac-api.html>`_ for full details of the API.
-When the instances are listed, it is possible to edit or delete each instance from the expanded view.
+The API is also described in Swagger-JSON and YAML:
-.. image:: ./images/non-RT_RIC_dashboard.png
-Policy Agent
-============
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
-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.
+ "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
-See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
+K8S Helm Chart LCM Manager (Initial)
+====================================
-API Functions
--------------
+**<ToDo>**
-See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.doc.
+See Also: Non-RT RIC Control Panel
+==================================
-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.
-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.
+Documentation for the Control Panel can be found here: `Non-RT RIC Control Panel <https://docs.o-ran-sc.org/projects/o-ran-sc-portal-nonrtric-controlpanel/en/latest/>`_.
-See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it.
+It can be downloaded from here: ::
-API Functions
--------------
+ git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
-See the admnistrative API in: nonrtric/near-rt-ric-simulator/ric-plt/a1/main.py.
+See Also: A1 / Near-RT RIC simulator
+====================================
-Sdnc A1 Controller
-==================
+The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
-An ONAP SDNC Controller for the A1 interface.
+Documentation for the simulator can be found here: `A1 Interface Simulator <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/>`_.
-See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
+It can be downloaded from here: ::
+ git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"
Code Review / nonrtric.git / blobdiff