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 Here we describe the APIs to access the Non-RT RIC functions.
  19
  20 The core Non-RT RIC consists of several parts, with available APIs described in the sections below:
  21
  22 * The A1 Policy Management Service
  23 * The Enrichment Coordinator Service
  24 * The Non-RT-RIC App Catalogue
  25 * K8S Helm Chart LCM Manager (Initial) **<ToDo>**
  26
  27 A1 Policy Management Service
  28 ============================
  29
  30 For information about the A1 Policy Management Service that is implemented in ONAP, see `ONAP docs <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_ and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
  31
  32 Enrichment Coordinator Service
  33 ==============================
  34
  35 See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of the API.
  36
  37 The API is also described in Swagger-JSON and YAML:
  38
  39 .. csv-table::
  40    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  41    :widths: 10,5,5
  42
  43    "A1 Enrichment Information Coordination Service API", ":download:`link <../enrichment-coordinator-service/api/ecs-api.json>`", ":download:`link <../enrichment-coordinator-service/api/ecs-api.yaml>`"
  44
  45 Non-RT-RIC App Catalogue (Initial)
  46 ==================================
  47
  48 The Service Catalogue provides a way for services to register themselves for other services to discover.
  49
  50 See `Service Catalogue API <./rac-api.html>`_ for full details of the API.
  51
  52 The API is also described in Swagger-JSON and YAML:
  53
  54
  55 .. csv-table::
  56    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  57    :widths: 10,5, 5
  58
  59    "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
  60
  61 K8S Helm Chart LCM Manager (Initial)
  62 ====================================
  63
  64 **<ToDo>**
  65
  66 See Also: Non-RT RIC Control Panel
  67 ==================================
  68
  69 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
  70
  71 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/>`_.
  72
  73 It can be downloaded from here: ::
  74
  75   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
  76
  77 See Also: A1 / Near-RT RIC simulator
  78 ====================================
  79
  80 The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
  81
  82 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/>`_.
  83
  84 It can be downloaded from here: ::
  85
  86   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"