summaryrefslogtreecommitdiffstats
path: root/docs/consumedapis/consumedapis.rst
diff options
context:
space:
mode:
authorJohnKeeney <john.keeney@est.tech>2021-03-15 18:33:15 +0000
committerMuhammad Rehan Raza <muhammad.rehan.raza@est.tech>2021-03-22 16:08:07 +0000
commit70157a900303e75e8bcacc6404f0bdb5b4505c9c (patch)
treebe8ed376c3f0ea3f1f534fbd6ee24e4ec021ad7d /docs/consumedapis/consumedapis.rst
parent687d8d9ce92ee076ae64feef129cf4afbc64d987 (diff)
Updated documentation for Honolulu Branch
Change-Id: I7c1726af1f72493352f324756d91ea950ddb9a95 Signed-off-by: JohnKeeney <john.keeney@est.tech> Issue-ID: CCSDK-3201
Diffstat (limited to 'docs/consumedapis/consumedapis.rst')
-rwxr-xr-xdocs/consumedapis/consumedapis.rst26
1 files changed, 11 insertions, 15 deletions
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst
index 8357e43d..06b47dd1 100755
--- a/docs/consumedapis/consumedapis.rst
+++ b/docs/consumedapis/consumedapis.rst
@@ -1,5 +1,5 @@
.. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright 2020 Nordix Foundation
+.. Copyright 2021 Nordix Foundation
Consumed APIs
=============
@@ -11,26 +11,22 @@ Policy Management Service application is interacting with two ONAP APIs and the
CBS API
*******
-The CBS API is used to get the dynamic configuration of the service, such as available Near-RT RICs.
-
-::
-
- CBS_GET_ALL
+If *Consul* is used for configuring the A1 Policy Management Service the `ONAP DCAE Config Binding Service <https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/apis/configbinding.html>`_ is used.
*********
DMAAP API
*********
-The DMaaP API is used to provide the possibility to interact with the Policy Management Service through DMaaP Message
-Router.
+The A1 Policy Management Service API can also be accessed using *ONAP DMaaP*. To support this the `DMaaP Message Router API <https://docs.onap.org/projects/onap-dmaap-messagerouter-messageservice/en/honolulu/offeredapis/api.html>`_ is used.
-::
+*****************************************
+O-RAN A1 interface for A1 Policies (A1-P)
+*****************************************
- DMAAP_GET_EVENTS
+Southbound, the ONAP A1 Policy functions communicate with *near-RT-RIC* RAN functions using the **A1** interface, as defined by the `O-RAN Alliance <https://www.o-ran.org>`_
+The *A1 Interface - Application Protocol Specification (A1-AP)* describe this interface. The specification can be viewed from the `O-RAN Alliance <https://www.o-ran.org>`_ website.
-********
-A1-P API
-********
+The **Honolulu** ONAP A1 Policy functions implement the *A1 Policy* parts (*A1-P*) of A1-AP versions *v1.1* and *v2.0*
+
+An opensource implementation of a `near-RT-RIC <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=1179659>`_ is available from `O-RAN Software Community <https://o-ran-sc.org>`_. It supports a pre-spec version of the A1-AP. The ONAP A1 Policy functions described here also supports this A1 version (A1-OSC).
-The A1-P API is used to communicate with the Near-RT RICs (north bound). All endpoints of the OSC A1 REST API and the
-standard A1 REST API version 1.1 are used.