docs/api-docs.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5
   6 API-Docs
   7 ========
   8
   9 This is the API-docs of Non-RT RIC.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15 API Introduction
  16 -----------------
  17
  18 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.
  19
  20
  21 API Functions
  22 -------------
  23
  24 To run the dashboard locally, you can follow these steps:
  25
  26 - Fetch the latest code from `gerrit`_
  27
  28 .. _gerrit: https://gerrit.nordix.org/c/oransc/nonrtric/+/2747/
  29
  30 - Before compiling, run the following commands::
  31
  32     git submodule init
  33
  34     git submodule update
  35
  36 - Start the backend (you might have to build it first)::
  37
  38     mvn clean install
  39
  40     mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer -DfailIfNoTests=false test
  41
  42
  43 - Now you can open URL:  `localhost:8080`_ in a browser.
  44
  45 .. _localhost:8080: localhost:8080
  46
  47 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.
  48
  49 When the instances are listed, it is possible to edit or delete each instance from the expanded view.
  50
  51 .. image:: ./images/non-RT_RIC_dashboard.png