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 .. |swagger-icon| image:: ./images/swagger.png
   8                   :width: 40px
   9
  10 .. |yaml-icon| image:: ./images/yaml_logo.png
  11                   :width: 40px
  12
  13
  14 ========
  15 API-Docs
  16 ========
  17
  18 This is the API-docs of Non-RT RIC.
  19
  20 The Non-RT RIC consists of three parts, described in the sections below:
  21  * The A1 Policy Management Service
  22  * The Enrichment Coordinator Service
  23  * The rAPP Catalogue
  24
  25
  26 A1 Policy Management Service
  27 ============================
  28
  29 For information about the A1 Policy Management Service that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
  30
  31 .. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
  32 .. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
  33
  34 Enrichment Coordinator Service
  35 ==============================
  36
  37 See `ECS API <./ecs-api.html>`_ for how to use the API.
  38
  39 .. csv-table::
  40    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  41    :widths: 10,5,5
  42
  43    "ECS API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
  44
  45
  46 rAPP Catalogue
  47 ==============
  48
  49 The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
  50
  51 See `RAC API <./rac-api.html>`_ for how to use the API.
  52
  53
  54 .. csv-table::
  55    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  56    :widths: 10,5, 5
  57
  58    "RAC API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
  59
  60 Complementary tools
  61 ===================
  62
  63 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.
  64
  65 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
  66 Documentation for the Control Panel can be found here:
  67 :doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
  68 It can be downloaded from here: ::
  69
  70   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
  71
  72 The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
  73 here: :doc:`A1 Interface Simulator <sim-a1-interface:index>`. It can be downloaded from here: ::
  74
  75   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"