summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis
diff options
context:
space:
mode:
authorromaingimbert <romain.gimbert@orange.com>2019-04-02 13:50:17 +0200
committerromaingimbert <romain.gimbert@orange.com>2019-04-02 13:50:17 +0200
commit0cb3b571ae8cb5cfa4905357c22e223d1b4a8d24 (patch)
treec326ba6972ba59a071927335e0be07fe9d839cfb /docs/offeredapis
parenta5e02123aea6f24850470a3f54865cfed6540740 (diff)
Update NBI version to 4
-change nbi version to 4.0.0 -change path to v4 Change-Id: Idc35e25fa13625b0916909d5030fcb458561a3fa Issue-ID: EXTAPI-220 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
Diffstat (limited to 'docs/offeredapis')
-rw-r--r--docs/offeredapis/offeredapis.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index f575b01..ac9b486 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -30,7 +30,7 @@ API Version
***********
APIs are described with a state version with ā€œvā€ following the API Name,
-e.g.: ``nbi/api/v3/productOrder``.
+e.g.: ``nbi/api/v4/productOrder``.
The schema associated with a REST API must have its version number aligned
with that of the REST API.
@@ -121,7 +121,7 @@ Only *basic* service characteristics will be managed in this release. By
**GET serviceSpecification(list)**
-Example: ``GET /nbi/api/v3/serviceSpecification/
+Example: ``GET /nbi/api/v4/serviceSpecification/
?category=NetworkService&distributionStatus=DISTRIBUTED``
It is possible to retrieve a list of ``serviceSpecification`` (get by list).
@@ -134,14 +134,14 @@ If no ``serviceSpecification`` matches, an empty list is send back.
**GET service Specification (id)**
-Example: ``GET /nbi/api/v3/serviceSpecification/{uuid}``
+Example: ``GET /nbi/api/v4/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``
+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)
@@ -159,7 +159,7 @@ and ``type``
**GET Service Inventory (list)**
-Example: ``GET /nbi/api/v3/service/?relatedParty.id=Pontus``
+Example: ``GET /nbi/api/v4/service/?relatedParty.id=Pontus``
GET (by list) allows to request with following criteria (all optional) :
@@ -184,7 +184,7 @@ if no service matches, an empty list is send back.
**GET Service Inventory (id)**
-Example: ``GET /nbi/api/v3/service/{id}`` When querying for a specific service
+Example: ``GET /nbi/api/v4/service/{id}`` When querying for a specific service
instance id, no additional filters are required.
The Service Inventory API will retrieve the service instance data from A&AI using