modify the document API 79/22779/2
authormaopengzhang <zhang.maopeng1@zte.com.cn>
Wed, 8 Nov 2017 12:46:18 +0000 (20:46 +0800)
committermaopengzhang <zhang.maopeng1@zte.com.cn>
Wed, 8 Nov 2017 13:31:58 +0000 (21:31 +0800)
Modify the document API

Change-Id: Id4ca172a95309ccffeb7c792f1b8033fede4c688
Issue-ID: VFC-54
Signed-off-by: maopengzhang <zhang.maopeng1@zte.com.cn>
docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
docs/platform/APIs/index.rst
lcm/swagger/vfc.vnfdriver.swagger.json

index c6db432..8d9cff6 100644 (file)
@@ -2,14 +2,14 @@
    :depth: 3\r
 ..\r
 \r
-   **VNFM API**\r
+   **GVNFM Northbound & Southbound APIs**\r
    **V0.1**\r
 \r
 **1 Scope**\r
 =============\r
 \r
-    The scope of the present document is to describe the VNFM exposed\r
-    API specification over Or-Vnfm Reference Point.\r
+    The scope of the present document is to describe the GVNFM exposed\r
+    API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.\r
 \r
 **2 Terms, Definitions and Abbreviations**\r
 ===========================================\r
@@ -29,7 +29,7 @@
 \r
 Table 2-1 abbreviations\r
 \r
-**3. Interfaces provided by VNFM**  (Or-Vnfm/Ve-Vnfm-vnf\r
+**3. Interfaces provided by GVNFM**  (Or-Vnfm\r
 ==========================================================\r
 \r
    Interfaces use RESTful API and the format is as follows:\r
index 4aa6f52..c289626 100644 (file)
@@ -7,7 +7,7 @@
 \r
 **1.  Scope**\r
 ==============\r
-The scope of the present document is to describe the VNFM Driver exposed API specification.\r
+The scope of the present document is to describe the VNFM driver integrated related API specification.\r
 \r
 **2.  Terms, Definitions and Abbreviations**\r
 =============================================\r
@@ -34,7 +34,7 @@ Interfaces use RESTful API and the format is as follows:
 http(s)://[hostname][:port]/api/{vnfmtype}/v1/{vnfm_id}/[……]\r
 R1 vnfmtype:\r
 zte-vnfm\r
-fw-vnfm\r
+hw-vnfm\r
 juju\r
 \r
 **3.1  Instantiate VNF**\r
@@ -643,7 +643,7 @@ VNF filter: vnfInstanceId via url [R1]
 +---------------+------------------------------------------------------------------+\r
 | IF Definition |  Description                                                     |\r
 +===============+==================================================================+\r
-| URI           | http(s)://[hostname][:port]/api//nslcm/v1/ns/grantvnf            |\r
+| URI           | http(s)://[hostname][:port]/api/nslcm/v1/ns/grantvnf             |\r
 +---------------+------------------------------------------------------------------+\r
 | Operation     |  POST                                                            |\r
 +---------------+------------------------------------------------------------------+\r
@@ -701,7 +701,7 @@ VNF filter: vnfInstanceId via url [R1]
 +---------------+------------------------------------------------------------------+\r
 | IF Definition |  Description                                                     |\r
 +===============+==================================================================+\r
-| URI           | http(s)://[hostname][:port]/api/nslcm/v1/vnfs/                   |\r
+| URI           | http(s)://[hostname][:port]/api/nslcm/v1/ns/{vnfmid}/vnfs/       |\r
 |               | {vnfInstanceId}/Notify                                           |\r
 +---------------+------------------------------------------------------------------+\r
 | Operation     |  POST                                                            |\r
index b05bede..c6f561b 100644 (file)
@@ -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
index e16d9cc..d1db684 100644 (file)
         }
       }
     },
-    "/nslcm/v1/{vnfmid}/vnfs/{vnfInstanceId}/Notify": {
+    "/nslcm/v1/ns/{vnfmid}/vnfs/{vnfInstanceId}/Notify": {
       "post": {
         "tags": [
           "NSLCM"