summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis
diff options
context:
space:
mode:
authorJohnKeeney <john.keeney@est.tech>2021-03-09 18:32:45 +0000
committerKAPIL SINGAL <ks220y@att.com>2021-03-09 19:55:20 +0000
commitde4ac0d74436887c13b07b8abf2dbbf3db6a4c8e (patch)
treee4ac01891933f47f0f2e55e6a548ae62f3dedebf /docs/offeredapis
parentfba2c668e8036187b4dcaf3422c1143d1b2abc7e (diff)
Updating documentation for Honolulu
Change-Id: I2d049db7acb49e50e21963096d00b2bee6076d09 Signed-off-by: JohnKeeney <john.keeney@est.tech> Issue-ID: CCSDK-3201
Diffstat (limited to 'docs/offeredapis')
-rw-r--r--docs/offeredapis/offeredapis.rst40
1 files changed, 16 insertions, 24 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index a43c0460..1ef7dd0c 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -10,15 +10,15 @@ Offered APIs
============
Introduction
-************
+------------
-The north bound REST API of the Policy Management Service provides convenient methods to handle policies.
+The north bound REST API of the A1 Policy Management Service provides convenient methods to handle policies.
-Overview
-************************
+Overall architecture for O-RAN A1 Policy functions
+--------------------------------------------------
-Following illustration provides a global view about **ORAN** architecture,
+This picture provides a overview of ONAP's A1 Controller architecture,
integration with other ONAP components and API resource/operation provided.
.. image:: ../media/ONAP-A1ControllerArchitecture.png
@@ -26,26 +26,15 @@ integration with other ONAP components and API resource/operation provided.
API Version
-***********
+-----------
APIs are described with a state version with "v" following the API Name,
e.g.: ``v2/policy``.
The schema associated with a REST API must have its version number aligned
with that of the REST API.
-The version number has major, minor and revision numbers. E.g. v1.0.0
-The version number (without the revision number) is held in the URI.
-
-The major version number is incremented for an incompatible change.
-The minor version number is incremented for a compatible change.
-For minor modifications of the API, version numbering must not be updated,
-
-For major modifications of the API, not backward compatible and forcing client
-implementations to be changed, the major version number must be updated.
-
-
API Table
-*********
+---------
.. |swagger-icon| image:: ../media/swagger.png
:width: 40px
@@ -58,19 +47,22 @@ API Table
:header: "API name", "|swagger-icon|", "|yaml-icon|"
:widths: 10,5, 5
- "PMS API", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`"
+ "A1 Policy Management Service API (NBI)", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`"
"A1 ADAPTER API (Internal)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`"
-
.. _pms_api:
-PMS API
-.......
-`PMS API <./pms-api.html>`_
+A1 Policy Management Service API
+................................
+
+The A1 Policy Management Service API is described in more detail in `A1 Policy Management Service API (html) <./pms-api.html>`_
+
.. _a1_adapter_api:
A1 ADAPTER API
..............
-`A1 ADAPTER API (Internal) <./a1-adapter-api.html>`_
+The O-RAN A1 Adapter provides an **internal** RESTCONF API that is used by the A1 Policy Management System when accessing the A1 Interface. This API is useful for test and verification but should not be used otherwise.
+
+The A1 Adapter API is described in more detail in `A1 ADAPTER API (html) <./a1-adapter-api.html>`_