[DOC] Correct ReDoc API documentation

[externalapi/nbi.git] / docs / offeredapis / offeredapis.rst

diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index 0d1bb04..66f657e 100644 (file)
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -16,9 +16,9 @@ NBI stands for NorthBound Interface. It brings to ONAP a set of API that can
 be used by external systems as BSS for example. These API are based on
 **TMF API**.
 
-*******************************************
-Global NBI architecture for El Alto release
-*******************************************
+********************************************
+Global NBI architecture for Honolulu release
+********************************************
 
 Following illustration provides a global view about **NBI** architecture,
 integration with other ONAP components and API resource/operation provided.
@@ -110,11 +110,11 @@ API Table
 API ReDoc Documentation
 ***********************
 
-* :doc:`API hub <redoc/api_hub>`
-* :doc:`Service Catalog <redoc/api_serviceCatalog>`
-* :doc:`Service Inventory <redoc/api_serviceInventory>`
-* :doc:`Service Order <redoc/api_serviceOrder>`
-* :doc:`Status <redoc/api_status>`
+- `hub <./hub.html>`_
+- `serviceCatalog <./service_catalog.html>`_
+- `serviceInventory <./service_inventory.html>`_
+- `serviceOrder <./service_order.html>`_
+- `status <./status.html>`_
 
 
 ***************
@@ -130,7 +130,6 @@ is provided - Swagger is documented.
 
 Only ``serviceSpecification`` resource is provided.
 Information are retrieved in **SDC** (and in TOSCA file)
-- Only GET operation is provided - this API does not update **SDC**.
 
 Only characteristics at service level will be retrieved in ONAP TOSCA file.
 For example if an ONAP service is composed of VNF and the VF module, the
@@ -161,7 +160,7 @@ If no ``serviceSpecification`` matches, an empty list is send back.
 Example: ``GET /nbi/api/v4/serviceSpecification/{uuid}``
 
 It is use to retrieve one ``serviceSpecification`` - all available information
-are retieved (see Swagger for description)
+are retrieved (see Swagger for description)
 
 **GET service Specification Schema (id)**
 
@@ -169,7 +168,19 @@ Example:
 ``GET /nbi/api/v4/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)
+- all available information are retrieved (see Swagger for description)
+
+**POST service Specification**
+
+Example:
+
+``POST /nbi/api/v4/serviceSpecification``
+
+This operation creates a ``serviceSpecification`` in catalog (see Swagger for description)
+It is used to provide a consistent way of on-boarding third party services to SDC via External API
+
+Only *primitive type* service characteristics are supported as part of this release. Further enhancements
+need to be made on other modules of ONAP for ensuring e2e automation of third party services. 
 
 ----------------
 serviceInventory