27cd338eb5a506643044dc60c4307ea86878bd35
[nonrtric.git] / 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 * K8S Helm Chart LCM Manager (Initial) **<ToDo>**
25
26 A1 Policy Management Service
27 ============================
28
29 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>`_.
30
31 Information Coordinator Service
32 ===============================
33
34 See `A1 Information Information Coordination Service API <./ics-api.html>`_ for full details of the API.
35
36 The API is also described in Swagger-JSON and YAML:
37
38 .. csv-table::
39    :header: "API name", "|swagger-icon|", "|yaml-icon|"
40    :widths: 10,5,5
41
42    "A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`"
43
44 K8S Helm Chart LCM Manager (Initial)
45 ====================================
46
47 **<ToDo>**
48
49 See Also: Non-RT RIC Control Panel
50 ==================================
51
52 The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
53
54 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/>`_.
55
56 It can be downloaded from here: ::
57
58   git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
59
60 See Also: A1 / Near-RT RIC simulator
61 ====================================
62
63 The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
64
65 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/>`_.
66
67 It can be downloaded from here: ::
68
69   git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"