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 three parts, described in the sections below:
  19  * The Policy Agent
  20  * The SDNC A1 Controller
  21  * The rAPP Catalogue
  22
  23
  24 Policy Agent
  25 ============
  26
  27 The Policy Agent provides common functionality useful for R-Apps, for instance:
  28  * A repository of available Near-RT RICs, their policy types and policy instances.
  29  * An A1 connection to the Near-RT RICs.
  30
  31 See :ref:`policy-agent-api` for how to use the API.
  32
  33 See the README.md file in the nonrtric/policy-agent repo for info about how to use it.
  34
  35 API Functions
  36 -------------
  37 See the following document for the Policy Agent API: nonrtric/onap/oran/docs/offeredapis/swagger/pms-api.yaml
  38
  39 SDNC A1 Controller
  40 ==================
  41
  42 An ONAP SDNC Controller for the A1 interface.
  43
  44 See :ref:`sdnc-a1-controller-api` for how to use the API.
  45
  46 See the README.md file in the nonrtric/sdnc-a1-controller repo for info about how to use it.
  47
  48 rAPP Catalogue
  49 ==============
  50
  51 The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
  52
  53 See `RAC API <./rac-api.html>`_ for how to use the API.
  54
  55 .. |swagger-icon| image:: ./images/swagger.png
  56                   :width: 40px
  57
  58 .. |yaml-icon| image:: ./images/yaml_logo.png
  59                   :width: 40px
  60
  61
  62 .. csv-table::
  63    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  64    :widths: 10,5, 5
  65
  66    "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
  67
  68 Complementary tools
  69 ===================
  70
  71 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.
  72
  73 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
  74 Documentation for the Control Panel can be found here:
  75 :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
  76 It can be downloaded from here: ::
  77
  78   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
  79
  80 The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
  81 here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
  82
  83   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"