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 .. Copyright (C) 2020 Nordix
   4
   5 .. _api_docs:
   6
   7
   8 ========
   9 API-Docs
  10 ========
  11
  12 This is the API-docs of Non-RT RIC.
  13
  14 .. contents::
  15    :depth: 3
  16    :local:
  17
  18 The Non-RT RIC consists of two parts, described in the sections below:
  19  * The Policy Agent
  20  * The SDNC A1 Controller
  21
  22
  23 Policy Agent
  24 ============
  25
  26 The Policy Agent provides common functionality useful for R-Apps, for instance:
  27  * A repository of available Near-RT RICs, their policy types and policy instances.
  28  * An A1 connection to the Near-RT RICs.
  29
  30 See :ref:`policy-agent-api` for how to use the API.
  31
  32 See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
  33
  34 API Functions
  35 -------------
  36 See the following document for the Policy Agent API: nonrtric/policy-agent/docs/api.yaml
  37
  38 SDNC A1 Controller
  39 ==================
  40
  41 An ONAP SDNC Controller for the A1 interface.
  42
  43 See :ref:`sdnc-a1-controller-api` for how to use the API.
  44
  45 See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
  46
  47 Complementary tools
  48 ===================
  49
  50 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.
  51
  52 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
  53 Documentation for the Control Panel can be found here:
  54 :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
  55 It can be downloaded from here: ::
  56
  57   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
  58
  59 The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
  60 here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
  61
  62   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"