Add docker-compose file for odu-app
[nonrtric.git] / 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 .. |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 Information Coordinator Service
24 * DMaaP Adaptor
25 * The Non-RT-RIC App Catalogue
26 * K8S Helm Chart LCM Manager (Initial) **<ToDo>**
27
28 A1 Policy Management Service
29 ============================
30
31 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>`_.
32
33 Information Coordinator Service
34 ===============================
35
36 See `A1 Information Information Coordination Service API <./ics-api.html>`_ for full details of the API.
37
38 The API is also described in Swagger-JSON and YAML:
39
40 .. csv-table::
41    :header: "API name", "|swagger-icon|", "|yaml-icon|"
42    :widths: 10,5,5
43
44    "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`"
45
46 DMaaP Adaptor
47 =============
48
49 The DMaaP Adaptor provides support for push delivery of any data received from DMaaP or Kafka.
50
51 See `DMaaP Adaptor API <./dmaap-adaptor-api.html>`_ for full details of the API.
52
53 The API is also described in Swagger-JSON and YAML:
54
55
56 .. csv-table::
57    :header: "API name", "|swagger-icon|", "|yaml-icon|"
58    :widths: 10,5, 5
59
60    "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`"
61
62 DMaaP Mediator Producer
63 =======================
64
65 The DMaaP Mediator Producer provides support for push delivery of any data received from DMaaP or Kafka.
66
67 See `DMaaP Mediator Producer API <./dmaap-mediator-producer-api.html>`_ for full details of the API.
68
69 The API is also described in Swagger-JSON and YAML:
70
71
72 .. csv-table::
73    :header: "API name", "|swagger-icon|", "|yaml-icon|"
74    :widths: 10,5, 5
75
76    "DMaaP Mediator Producer API", ":download:`link <../dmaap-mediator-producer/api/swagger.json>`", ":download:`link <../dmaap-mediator-producer/api/swagger.yaml>`"
77
78 Non-RT-RIC App Catalogue (Initial)
79 ==================================
80
81 The Service Catalogue provides a way for services to register themselves for other services to discover.
82
83 See `Service Catalogue API <./rac-api.html>`_ for full details of the API.
84
85 The API is also described in Swagger-JSON and YAML:
86
87
88 .. csv-table::
89    :header: "API name", "|swagger-icon|", "|yaml-icon|"
90    :widths: 10,5, 5
91
92    "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
93
94 K8S Helm Chart LCM Manager (Initial)
95 ====================================
96
97 **<ToDo>**
98
99 See Also: Non-RT RIC Control Panel
100 ==================================
101
102 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
103
104 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/>`_.
105
106 It can be downloaded from here: ::
107
108   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
109
110 See Also: A1 / Near-RT RIC simulator
111 ====================================
112
113 The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
114
115 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/>`_.
116
117 It can be downloaded from here: ::
118
119   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"