Documentation update for TMF 633 API - POST /serviceSpecification

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

diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index 342b09a..c55d5a9 100644 (file)
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -26,6 +26,18 @@ integration with other ONAP components and API resource/operation provided.
 .. image:: ../images/onap_nbi_dublin.jpg
    :width: 800px
 
+************
+API Endpoint
+************
+
+Since Frankfurt, in an OOM ONAP deployment context:
+
+https://nbi.api.simpledemo.onap.org:30274/nbi/api/v4
+
+Locally, for dev and testing purpose:
+
+http://localhost:8080/nbi/api/v4
+
 ***********
 API Version
 ***********
@@ -94,6 +106,17 @@ API Table
    "serviceOrder", ":download:`link <api_serviceOrder/swagger.json>`", ":download:`link <api_serviceOrder/swagger.yaml>`", ":download:`link <api_serviceOrder/api.plantuml>`", ":download:`link <api_serviceOrder/model.xsd>`"
    "status", ":download:`link <api_status/swagger.json>`", ":download:`link <api_status/swagger.yaml>`", ":download:`link <api_status/api.plantuml>`", ":download:`link <api_status/model.xsd>`"
 
+***********************
+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>`
+
+
 ***************
 API Description
 ***************
@@ -107,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
@@ -138,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)**
 
@@ -146,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