summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture/NBI_Developer_Guide.rst2
-rw-r--r--docs/installation/installation.rst4
-rw-r--r--docs/offeredapis/offeredapis.rst12
-rwxr-xr-xdocs/releasenotes/releasenotes.rst2
4 files changed, 10 insertions, 10 deletions
diff --git a/docs/architecture/NBI_Developer_Guide.rst b/docs/architecture/NBI_Developer_Guide.rst
index 6a38891..82a7f34 100644
--- a/docs/architecture/NBI_Developer_Guide.rst
+++ b/docs/architecture/NBI_Developer_Guide.rst
@@ -83,7 +83,7 @@ You can view the log output of the application with the following command:
**Testing**
When the application is running, you can access the API at
-:samp:`http://yourhostname:8080/nbi/api/v3` and fill the URL with the name
+:samp:`http://yourhostname:8080/nbi/api/v4` and fill the URL with the name
of the resources you asking for (/serviceSpecification, /service,
/serviceOrder or /status)
You can run a test by using `VisualStudio RestClient plugin <https://github.com/Huachao/vscode-restclient>`_
diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst
index ebf8c7a..fd52e84 100644
--- a/docs/installation/installation.rst
+++ b/docs/installation/installation.rst
@@ -78,14 +78,14 @@ Test
**Healthcheck**
-http://localhost:8080/nbi/api/v3/status
+http://localhost:8080/nbi/api/v4/status
You should get::
{
"name": "nbi",
"status": "ok",
- "version": "v3"
+ "version": "v4"
}
**Play with RESTclient**
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
diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst
index cdf3090..4943011 100755
--- a/docs/releasenotes/releasenotes.rst
+++ b/docs/releasenotes/releasenotes.rst
@@ -4,7 +4,7 @@
Release Notes
=============
-Version: 3.0.1
+Version: 4.0.0
--------------
:Release Date: 2018-11-30