summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/offeredapis.rst
diff options
context:
space:
mode:
authorelinuxhenrik <henrik.b.andersson@est.tech>2020-10-13 16:39:13 +0200
committerelinuxhenrik <henrik.b.andersson@est.tech>2020-10-16 13:41:53 +0200
commitea2fcc88ac18dc3da0de191645688ab7829db0c4 (patch)
tree7d104da2c5f7d4aca4f1b2c37d4e0066f55c8b28 /docs/offeredapis/offeredapis.rst
parentdf373ec4c902a2596dd2dfe957425af1e3113b17 (diff)
Add A1 Adapter API documentation
Change-Id: Id19e858c67681b781871169ef79da5edf48c5cb2 Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Diffstat (limited to 'docs/offeredapis/offeredapis.rst')
-rw-r--r--docs/offeredapis/offeredapis.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index c3a7c95f..08126c0d 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -12,7 +12,7 @@ Offered APIs
Introduction
************
-The north bound ...
+The north bound REST API of the Policy Management Service provides convenient methods to handle policies.
Global ORAN architecture
@@ -25,17 +25,11 @@ integration with other ONAP components and API resource/operation provided.
:width: 500pt
-API Endpoint
-************
-
-TBD
-
-
API Version
***********
APIs are described with a state version with "v" following the API Name,
-e.g.: ``TBD``.
+e.g.: ``v2/policy``.
The schema associated with a REST API must have its version number aligned
with that of the REST API.
@@ -77,6 +71,7 @@ API Table
:widths: 10,5, 5
"PMS API", ":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:
@@ -85,3 +80,9 @@ PMS API
.......
`PMS API <./pms-api.html>`_
+.. _a1_adapter_api:
+
+A1 ADAPTER API
+..............
+`A1 ADAPTER API (Internal) <./a1-adapter-api.html>`_
+