summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis
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/offeredapis
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/offeredapis')
-rw-r--r--docs/offeredapis/offeredapis.rst50
1 files changed, 17 insertions, 33 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index a43c0460..99f59e9b 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -1,7 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0
International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2020 Nordix Foundation
+.. Copyright 2021 Nordix Foundation
.. _offered_apis:
@@ -10,42 +10,22 @@ 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
:width: 500pt
-
-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 +38,23 @@ 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>`_