blob: ed0cc79a42cfe183fac478bf57cc9c92c817933d [file] [log] [blame]
maximessone6b4d272019-10-31 13:26:13 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
elinuxhenrik7f93fb62020-04-08 17:02:40 +02003.. Copyright (C) 2020 Nordix
maximessone6b4d272019-10-31 13:26:13 +01004
elinuxhenrik0d271842020-10-19 10:17:28 +02005.. _api_docs:
6
elinuxhenrik6208ce82020-11-18 15:15:07 +01007.. |swagger-icon| image:: ./images/swagger.png
8 :width: 40px
9
10.. |yaml-icon| image:: ./images/yaml_logo.png
11 :width: 40px
12
elinuxhenrik0d271842020-10-19 10:17:28 +020013
elinuxhenrik0c442862020-01-31 11:27:50 +010014========
maximessone6b4d272019-10-31 13:26:13 +010015API-Docs
16========
17
18This is the API-docs of Non-RT RIC.
19
elinuxhenrik5ada5152020-10-19 10:39:59 +020020The Non-RT RIC consists of three parts, described in the sections below:
elinuxhenrik0c442862020-01-31 11:27:50 +010021 * The Policy Agent
elinuxhenrik6208ce82020-11-18 15:15:07 +010022 * The Enrichment Coordinator Service
elinuxhenrik5ada5152020-10-19 10:39:59 +020023 * The rAPP Catalogue
elinuxhenrik0c442862020-01-31 11:27:50 +010024
elinuxhenrik0c442862020-01-31 11:27:50 +010025
26Policy Agent
27============
elinuxhenrikc7a0d732020-02-04 14:49:59 +010028
elinuxhenrik6208ce82020-11-18 15:15:07 +010029For information about the The Policy Agent that is implemented in ONAP, see `readthedocs`_ and `wiki`_.
elinuxhenrik0c442862020-01-31 11:27:50 +010030
elinuxhenrik6208ce82020-11-18 15:15:07 +010031.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
32.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984
elinuxhenrike0fab9a2020-03-31 17:59:49 +020033
elinuxhenrik6208ce82020-11-18 15:15:07 +010034Enrichment Coordinator Service
35==============================
elinuxhenrik0c442862020-01-31 11:27:50 +010036
elinuxhenrik6208ce82020-11-18 15:15:07 +010037See `ECS API <./ecs-api.html>`_ for how to use the API.
elinuxhenrik0c442862020-01-31 11:27:50 +010038
elinuxhenrik6208ce82020-11-18 15:15:07 +010039.. csv-table::
40 :header: "API name", "|swagger-icon|"
41 :widths: 10,5
elinuxhenrikc7a0d732020-02-04 14:49:59 +010042
elinuxhenrik6208ce82020-11-18 15:15:07 +010043 "ECS API", ":download:`link <./offeredapis/swagger/ecs-api.json>`"
elinuxhenrik0c442862020-01-31 11:27:50 +010044
elinuxhenrik0c442862020-01-31 11:27:50 +010045
elinuxhenrik5ada5152020-10-19 10:39:59 +020046rAPP Catalogue
47==============
48
49The Non RT-RIC Service Catalogue provides a way for services to register themselves for other services to discover.
50
51See `RAC API <./rac-api.html>`_ for how to use the API.
52
elinuxhenrik5ada5152020-10-19 10:39:59 +020053
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
maximessoneaaee912020-03-26 16:43:27 +010060Complementary tools
61===================
62
maximessonf217fff2020-04-09 15:16:04 +020063There are two additional tools that can be used together with the Non-RT RIC, namely the Control Panel and the Near-RT RIC simulator.
maximessoneaaee912020-03-26 16:43:27 +010064
maximessonf217fff2020-04-09 15:16:04 +020065The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
elinuxhenrik0a4c38b2020-04-14 10:59:36 +020066Documentation for the Control Panel can be found here:
67:doc:`Non-RT RIC Control Panel <nonrtric-controlpanel:index>`.
68It can be downloaded from here: ::
maximessoneaaee912020-03-26 16:43:27 +010069
elinuxhenrik0a4c38b2020-04-14 10:59:36 +020070 git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
71
72The Near-RT RIC simulator simulates an A1 protocol termination endpoint. Documentation for the simulator can be found
73here: :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"