summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authormaopengzhang <zhang.maopeng1@zte.com.cn>2017-11-08 20:46:18 +0800
committermaopengzhang <zhang.maopeng1@zte.com.cn>2017-11-08 21:31:58 +0800
commitcce7dad05f7ac0850043edb362bbab996e4d009b (patch)
tree3f3c0450a252744c3660c754faa462f286298a35 /docs
parentaa4a35ce020716569a8b7320f2886e4ad85474b6 (diff)
modify the document API
Modify the document API Change-Id: Id4ca172a95309ccffeb7c792f1b8033fede4c688 Issue-ID: VFC-54 Signed-off-by: maopengzhang <zhang.maopeng1@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst8
-rw-r--r--docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst8
-rw-r--r--docs/platform/APIs/index.rst10
3 files changed, 13 insertions, 13 deletions
diff --git a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
index c6db4326..8d9cff6a 100644
--- a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
+++ b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
@@ -2,14 +2,14 @@
:depth: 3
..
- **VNFM API**
+ **GVNFM Northbound & Southbound APIs**
**V0.1**
**1 Scope**
=============
- The scope of the present document is to describe the VNFM exposed
- API specification over Or-Vnfm Reference Point.
+ The scope of the present document is to describe the GVNFM exposed
+ API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
**2 Terms, Definitions and Abbreviations**
===========================================
@@ -29,7 +29,7 @@
Table 2-1 abbreviations
-**3. Interfaces provided by VNFM** (Or-Vnfm/Ve-Vnfm-vnf)
+**3. Interfaces provided by GVNFM** (Or-Vnfm)
==========================================================
Interfaces use RESTful API and the format is as follows:
diff --git a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
index 4aa6f52c..c289626d 100644
--- a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
+++ b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
@@ -7,7 +7,7 @@
**1. Scope**
==============
-The scope of the present document is to describe the VNFM Driver exposed API specification.
+The scope of the present document is to describe the VNFM driver integrated related API specification.
**2. Terms, Definitions and Abbreviations**
=============================================
@@ -34,7 +34,7 @@ Interfaces use RESTful API and the format is as follows:
http(s)://[hostname][:port]/api/{vnfmtype}/v1/{vnfm_id}/[……]
R1 vnfmtype:
zte-vnfm
-fw-vnfm
+hw-vnfm
juju
**3.1 Instantiate VNF**
@@ -643,7 +643,7 @@ VNF filter: vnfInstanceId via url [R1]
+---------------+------------------------------------------------------------------+
| IF Definition | Description |
+===============+==================================================================+
-| URI | http(s)://[hostname][:port]/api//nslcm/v1/ns/grantvnf |
+| URI | http(s)://[hostname][:port]/api/nslcm/v1/ns/grantvnf |
+---------------+------------------------------------------------------------------+
| Operation | POST |
+---------------+------------------------------------------------------------------+
@@ -701,7 +701,7 @@ VNF filter: vnfInstanceId via url [R1]
+---------------+------------------------------------------------------------------+
| IF Definition | Description |
+===============+==================================================================+
-| URI | http(s)://[hostname][:port]/api/nslcm/v1/vnfs/ |
+| URI | http(s)://[hostname][:port]/api/nslcm/v1/ns/{vnfmid}/vnfs/ |
| | {vnfInstanceId}/Notify |
+---------------+------------------------------------------------------------------+
| Operation | POST |
diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst
index b05bede2..c6f561be 100644
--- a/docs/platform/APIs/index.rst
+++ b/docs/platform/APIs/index.rst
@@ -7,7 +7,7 @@ VF-C Offered APIs
List VF-C APIs offered.
-NS LCM API
+VFC Northbound API
----------
Network services lifecycle management APIs
@@ -19,10 +19,10 @@ Network services lifecycle management APIs
NSLCM_API/index
-VNFM Driver API
+VNFM Integration APIs
---------------
-VNFM Driver component northbound APIs
+VNFM Driver Integration Related APIs
.. toctree::
:maxdepth: 1
@@ -31,10 +31,10 @@ VNFM Driver component northbound APIs
-VNF LCM API
+GVNFM Northbound & Southbound APIs
-----------
-VNF lifecycle management APIs
+GVNFM Northbound & Southbound APIs for VNF Integration
.. toctree::
:maxdepth: 1