Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / nonrtric / 01ea4be5a7b6db523676a766fc4eef72385cb01a / . / docs / api-docs.rst
blob: ef234a5661f603c785a6530598865c737fea4b4c [file] [log] [blame]
maximessone6b4d272019-10-31 13:26:13 +0100[diff] [blame]1.. 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 +0200[diff] [blame]3.. Copyright (C) 2020 Nordix
maximessone6b4d272019-10-31 13:26:13 +0100[diff] [blame]4
elinuxhenrik0d271842020-10-19 10:17:28 +0200[diff] [blame]5.. _api_docs:
6
elinuxhenrik6208ce82020-11-18 15:15:07 +0100[diff] [blame]7.. |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 +0200[diff] [blame]13
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]14========
maximessone6b4d272019-10-31 13:26:13 +0100[diff] [blame]15API-Docs
16========
17
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]18Here we describe the APIs to access the Non-RT RIC functions.
maximessone6b4d272019-10-31 13:26:13 +0100[diff] [blame]19
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]20The core Non-RT RIC consists of several parts, with available APIs described in the sections below:
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]21
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]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>**
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]26
elinuxhenrikff5f78e2020-12-08 12:59:19 +0100[diff] [blame]27A1 Policy Management Service
28============================
elinuxhenrikc7a0d732020-02-04 14:49:59 +0100[diff] [blame]29
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]30For 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>`_.
elinuxhenrike0fab9a2020-03-31 17:59:49 +0200[diff] [blame]31
elinuxhenrik6208ce82020-11-18 15:15:07 +0100[diff] [blame]32Enrichment Coordinator Service
33==============================
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]34
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]35See `A1 Enrichment Information Coordination Service API <./ecs-api.html>`_ for full details of the API.
36
37The API is also described in Swagger-JSON and YAML:
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]38
elinuxhenrik6208ce82020-11-18 15:15:07 +0100[diff] [blame]39.. csv-table::
elinuxhenrik7a09fbb2020-12-04 16:51:19 +0100[diff] [blame]40 :header: "API name", "|swagger-icon|", "|yaml-icon|"
41 :widths: 10,5,5
elinuxhenrikc7a0d732020-02-04 14:49:59 +0100[diff] [blame]42
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]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>`"
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]44
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]45Non-RT-RIC App Catalogue (Initial)
46==================================
elinuxhenrik0c442862020-01-31 11:27:50 +0100[diff] [blame]47
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]48The Service Catalogue provides a way for services to register themselves for other services to discover.
elinuxhenrik5ada5152020-10-19 10:39:59 +0200[diff] [blame]49
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]50See `Service Catalogue API <./rac-api.html>`_ for full details of the API.
elinuxhenrik5ada5152020-10-19 10:39:59 +0200[diff] [blame]51
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]52The API is also described in Swagger-JSON and YAML:
elinuxhenrik5ada5152020-10-19 10:39:59 +0200[diff] [blame]53
elinuxhenrik5ada5152020-10-19 10:39:59 +0200[diff] [blame]54
55.. csv-table::
56 :header: "API name", "|swagger-icon|", "|yaml-icon|"
57 :widths: 10,5, 5
58
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]59 "Service Catalogue API", ":download:`link <../r-app-catalogue/api/rac-api.json>`", ":download:`link <../r-app-catalogue/api/rac-api.yaml>`"
elinuxhenrik5ada5152020-10-19 10:39:59 +0200[diff] [blame]60
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]61K8S Helm Chart LCM Manager (Initial)
62====================================
maximessoneaaee912020-03-26 16:43:27 +0100[diff] [blame]63
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]64**<ToDo>**
65
66See Also: Non-RT RIC Control Panel
67==================================
maximessoneaaee912020-03-26 16:43:27 +0100[diff] [blame]68
maximessonf217fff2020-04-09 15:16:04 +0200[diff] [blame]69The Non-RT RIC Control Panel provides a user interface that allows the user to interact with the Non-RT RIC.
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]70
71Documentation 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
elinuxhenrik0a4c38b2020-04-14 10:59:36 +0200[diff] [blame]73It can be downloaded from here: ::
maximessoneaaee912020-03-26 16:43:27 +0100[diff] [blame]74
elinuxhenrik0a4c38b2020-04-14 10:59:36 +0200[diff] [blame]75 git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel".
76
JohnKeeney01ea4be2021-05-26 19:32:47 +0100[diff] [blame^]77See Also: A1 / Near-RT RIC simulator
78====================================
79
80The Near-RT RIC simulator simulates an A1 protocol termination endpoint.
81
82Documentation 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
84It can be downloaded from here: ::
elinuxhenrik0a4c38b2020-04-14 10:59:36 +0200[diff] [blame]85
86 git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"