From ea2fcc88ac18dc3da0de191645688ab7829db0c4 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Tue, 13 Oct 2020 16:39:13 +0200 Subject: Add A1 Adapter API documentation Change-Id: Id19e858c67681b781871169ef79da5edf48c5cb2 Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik --- docs/offeredapis/offeredapis.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'docs/offeredapis/offeredapis.rst') 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>`_ + -- cgit 1.2.3-korg