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) 2021 Nordix
   4
   5 .. _api_docs:
   6
   7
   8 ========
   9 API-Docs
  10 ========
  11
  12 Here we describe the APIs to access the Non-RT RIC functions.
  13
  14 The core Non-RT RIC consists of several parts, with available APIs described in the sections below:
  15
  16 * K8S Helm Chart LCM Manager (Initial) **<ToDo>**
  17
  18 K8S Helm Chart LCM Manager (Initial)
  19 ====================================
  20
  21 **<ToDo>**
  22
  23 See Also: Non-RT RIC Control Panel
  24 ==================================
  25
  26 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
  27
  28 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/>`_.
  29
  30 It can be downloaded from here: ::
  31
  32   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
  33
  34 See Also: A1 / Near-RT RIC simulator
  35 ====================================
  36
  37 The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
  38
  39 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/>`_.
  40
  41 It can be downloaded from here: ::
  42
  43   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"