summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis
diff options
context:
space:
mode:
authorromaingimbert <romain.gimbert@orange.com>2019-03-21 10:04:30 +0100
committerromaingimbert <romain.gimbert@orange.com>2019-03-22 14:23:25 +0100
commit5973e241424950c8f6fcf1b9d5a107b19b5a9816 (patch)
tree4d7036853565712d2474555a8a735a23ec82da28 /docs/offeredapis
parent726031bf80339a3c23cc52f89a403e86afa301f4 (diff)
Documentation improvement
-add documentation from dublin -change pdf Change-Id: I18c1356a862eac851f46ff12348ec268fd615127 Issue-ID: EXTAPI-169 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
Diffstat (limited to 'docs/offeredapis')
-rw-r--r--docs/offeredapis/images/ONAP_External_ID_Beijing.jpgbin103409 -> 0 bytes
-rw-r--r--docs/offeredapis/images/ONAP_External_ID_Casablanca.jpgbin126974 -> 0 bytes
-rw-r--r--docs/offeredapis/offeredapis.rst21
-rw-r--r--docs/offeredapis/pdf/nbicallflow.pdfbin142247 -> 963461 bytes
4 files changed, 18 insertions, 3 deletions
diff --git a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg b/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg
deleted file mode 100644
index 8fbd4ab..0000000
--- a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg
deleted file mode 100644
index 721d9f2..0000000
--- a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index 9845165..f575b01 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -16,13 +16,13 @@ be used by external systems as BSS for example. These API are based on
**TMF API**.
**********************************************
-Global NBI architecture for Casablanca release
+Global NBI architecture for Dublin release
**********************************************
Following illustration provides a global view about **NBI** architecture,
integration with other ONAP components and API resource/operation provided.
-.. image:: images/ONAP_External_ID_Casablanca.jpg
+.. image:: ../images/onap_nbi_dublin.jpg
:width: 800px
***********
@@ -139,6 +139,13 @@ Example: ``GET /nbi/api/v3/serviceSpecification/{uuid}``
It is use to retrieve one ``serviceSpecification`` - all available information
are retieved (see Swagger for description)
+**GET service Specification Schema (id)**
+
+Example: ``GET /nbi/api/v3/serviceSpecification/{uuid}/specificationInputSchema``
+
+It is use to retrieve one input schema from the tosca file stored in **NBI** - all available
+information are retieved (see Swagger for description)
+
----------------
serviceInventory
----------------
@@ -270,7 +277,15 @@ notifications. 3 events are managed:
• A service order state changes
• A service order item state changes
-These 3 events have distinct notification allowing any system to subscribe to
+It is also possible to subscribe to **AAI** and **SDC** notifications via **NBI**.
+4 events are managed:
+
+• A new service is created in **AAI***
+• A service attribute value is changed in **AAI**
+• A service is removed in **AAI**
+• A service specification is distributed in **SDC**
+
+These 7 events have distinct notification allowing any system to subscribe to
one, two or all notification types.
The implementation will be split in 2 components:
diff --git a/docs/offeredapis/pdf/nbicallflow.pdf b/docs/offeredapis/pdf/nbicallflow.pdf
index 8fc564b..b1e1fea 100644
--- a/docs/offeredapis/pdf/nbicallflow.pdf
+++ b/docs/offeredapis/pdf/nbicallflow.pdf
Binary files differ