Improve VF-C documnent

Issue-ID: VFC-828
Change-Id: Ibddfb5bf709567e8060c8c3363c1cb8d76920d98
Signed-off-by: yangyan <yangyanyj@chinamobile.com>

diff --git a/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst
index 7188dc7..6ed6196 100644 (file)
--- a/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst
+++ b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst
@@ -1,1086 +1,651 @@
 \r
 \r
 Network services lifecycle management northbound APIs\r
-==========\r
-\r
- {\r
-   "swagger": "2.0",\r
-\r
-   "info": {\r
-\r
-     "version": "1.0.0",\r
-\r
-     "title": "ONAP VFC Network Service Lifecycle Management API",\r
-\r
-     "description": "VFC Network Service Lifecycle Management Rest API.",\r
-\r
-     "contact": {\r
-\r
-       "name": "ONAP VFC team",\r
-\r
-       "email": "onap-discuss@lists.onap.org",\r
-\r
-       "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"\r
-\r
-     }\r
-\r
-   },\r
-\r
-   "basePath": "/api/nslcm/v1",\r
-\r
-   "schemes": [\r
-\r
-     "http",\r
-     "https"\r
-\r
-   ],\r
-\r
-   "consumes": [\r
-\r
-     "application/json"\r
-\r
-   ],\r
-   "produces": [\r
-\r
-     "application/json"\r
-\r
-   ],\r
-   "paths": {\r
-\r
-     "/ns": {\r
-\r
-       "post": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-         "summary": "ns create",\r
-\r
-         "description": "ns create",\r
-\r
-         "operationId": "ns_create",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-\r
-             "in": "body",\r
-\r
-             "name": "NSCreateRequest",\r
-\r
-             "description": "NS Instance Create Request",\r
-\r
-             "required": true,\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsCreateRequest"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "200": {\r
-\r
-             "description": "successful operation",\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsCreateResponse"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         }\r
-\r
-       },\r
-\r
-       "get": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-\r
-         "summary": "ns get",\r
-\r
-         "description": "ns get",\r
-\r
-         "operationId": "ns_get",\r
-\r
-         "parameters": [],\r
-\r
-         "responses": {\r
-\r
-           "200": {\r
-\r
-             "description": "successful operation",\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsInfo"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "/ns/{nsInstanceId}/Instantiate": {\r
-\r
-       "post": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-\r
-         "summary": "ns Instantiate",\r
-\r
-         "description": "ns Instantiate",\r
-\r
-         "operationId": "ns_Instantiate",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-             "required": true,\r
-\r
-             "type": "string",\r
-\r
-             "description": "",\r
-\r
-             "name": "nsInstanceId",\r
-\r
-             "in": "path"\r
-\r
-           },\r
-           {\r
-\r
-             "in": "body",\r
-\r
-             "name": "NSInstantiateRequest",\r
-\r
-             "description": "NS Instantiate Request Body",\r
-\r
-             "required": true,\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsInstantiateRequest"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "200": {\r
-\r
-             "description": "",\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/JobInfo"\r
-\r
-             }\r
-\r
-           },\r
-\r
-           "201": {\r
-\r
-             "description": "Invalid Request"\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "/ns/{nsInstanceId}/scale": {\r
-\r
-       "post": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-\r
-         "summary": "ns scale",\r
-\r
-         "description": "ns scale",\r
-\r
-         "operationId": "ns_scale",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-\r
-             "required": true,\r
-\r
-             "type": "string",\r
-\r
-             "description": "",\r
-\r
-             "name": "nsInstanceId",\r
-\r
-             "in": "path"\r
-\r
-           },\r
-\r
-           {\r
-\r
-             "in": "body",\r
-\r
-             "name": "ScaleNSRequest",\r
-\r
-             "description": "Scale NS Request Body",\r
-\r
-             "required": true,\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsScaleRequest"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "200": {\r
-\r
-             "description": "",\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/JobInfo"\r
-\r
-             }\r
-\r
-           },\r
-\r
-           "201": {\r
-\r
-             "description": "Invalid Request"\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "/ns/{ns_instance_id}/heal": {\r
-\r
-       "post": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-\r
-         "summary": "ns heal",\r
-\r
-         "description": "ns heal",\r
-\r
-         "operationId": "ns_heal",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-             "required": true,\r
-\r
-             "type": "string",\r
-\r
-             "description": "Identifier of the NS instance.",\r
-\r
-             "name": "ns_instance_id",\r
-\r
-             "in": "path"\r
-\r
-           },\r
-\r
-           {\r
-\r
-             "in": "body",\r
-\r
-             "name": "healVnfData",\r
-\r
-             "description": "healVnfData",\r
-\r
-             "required": true,\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsHealRequest"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "202": {\r
-\r
-             "description": "",\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/JobInfo"\r
-\r
-             }\r
-\r
-           },\r
-\r
-           "500": {\r
-\r
-             "description": "the url is invalid"\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "/ns/{ns_instance_id}/terminate": {\r
-\r
-       "post": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-\r
-         "summary": "ns terminate",\r
-\r
-         "description": "ns terminate",\r
-\r
-         "operationId": "ns_terminate",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-\r
-             "required": true,\r
-\r
-             "type": "string",\r
-\r
-             "description": "Identifier of the NS instance.",\r
-\r
-             "name": "ns_instance_id",\r
-\r
-             "in": "path"\r
-\r
-           },\r
-\r
-           {\r
-             "in": "body",\r
-\r
-             "name": "NsTerminateRequest",\r
-\r
-             "description": "NsTerminateRequest",\r
-\r
-             "required": true,\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/NsTerminateRequest"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "202": {\r
-\r
-             "description": "",\r
-\r
-             "schema": {\r
-\r
-               "$ref": "#/definitions/JobInfo"\r
-\r
-             }\r
-\r
-           },\r
-\r
-           "500": {\r
-\r
-             "description": "the url is invalid"\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-     "/ns/{ns_instance_id}": {\r
-\r
-       "delete": {\r
-\r
-         "tags": [\r
-\r
-           "ns"\r
-\r
-         ],\r
-\r
-         "summary": "ns delete",\r
-\r
-         "description": "ns delete",\r
-\r
-         "operationId": "ns_delete",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-             "required": true,\r
-\r
-             "type": "string",\r
-\r
-             "description": "Identifier of the NS instance.",\r
-\r
-             "name": "ns_instance_id",\r
-\r
-             "in": "path"\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "204": {\r
-\r
-             "description": "The NS instance resource and the associated NS identifier were deleted successfully."\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "/jobs/{jobId}": {\r
-\r
-       "post": {\r
-\r
-         "tags": [\r
-\r
-           "job"\r
-\r
-         ],\r
-\r
-         "summary": "jobstatus",\r
-\r
-         "description": "",\r
-\r
-         "operationId": "jobstatus",\r
-\r
-         "parameters": [\r
-\r
-           {\r
-             "required": true,\r
-\r
-             "type": "string",\r
-\r
-             "description": "",\r
-\r
-             "name": "jobId",\r
-\r
-             "in": "path"\r
-\r
-           },\r
-\r
-           {\r
-\r
-             "in": "body",\r
-\r
-             "name": "body",\r
-\r
-             "description": "request param",\r
-\r
-             "required": true,\r
-\r
+=====================================================\r
+\r
+{\r
+  "swagger": "2.0",\r
+  "info": {\r
+    "version": "1.0.0",\r
+    "title": "ONAP VFC Network Service Lifecycle Management API",\r
+    "description": "VFC Network Service Lifecycle Management Rest API.",\r
+    "contact": {\r
+      "name": "ONAP VFC team",\r
+      "email": "onap-discuss@lists.onap.org",\r
+      "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"\r
+    }\r
+  },\r
+  "basePath": "/api/nslcm/v1",\r
+  "schemes": [\r
+    "http",\r
+    "https"\r
+  ],\r
+  "consumes": [\r
+    "application/json"\r
+  ],\r
+  "produces": [\r
+    "application/json"\r
+  ],\r
+  "paths": {\r
+    "/ns": {\r
+      "post": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns create",\r
+        "description": "ns create",\r
+        "operationId": "ns_create",\r
+        "parameters": [\r
+          {\r
+            "in": "body",\r
+            "name": "NSCreateRequest",\r
+            "description": "NS Instance Create Request",\r
+            "required": true,\r
+            "schema": {\r
+              "$ref": "#/definitions/NsCreateRequest"\r
+            }\r
+          }\r
+        ],\r
+        "responses": {\r
+          "200": {\r
+            "description": "successful operation",\r
+            "schema": {\r
+              "$ref": "#/definitions/NsCreateResponse"\r
+            }\r
+          },\r
+          "404": {\r
+            "description": "URL not found"\r
+          }\r
+        }\r
+      },\r
+      "get": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns get",\r
+        "description": "ns get",\r
+        "operationId": "ns_instantces_get",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "job response message id",\r
+            "name": "csarId",\r
+            "in": "query"\r
+          }\r
+        ],\r
+        "responses": {\r
+          "200": {\r
+            "description": "successful operation",\r
+            "schema": {\r
+              "$ref": "#/definitions/NsInstancesInfo"\r
+            }\r
+          },\r
+          "404": {\r
+            "description": "URL not found"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/ns/{nsInstanceId}/Instantiate": {\r
+      "post": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns Instantiate",\r
+        "description": "ns Instantiate",\r
+        "operationId": "ns_Instantiate",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "",\r
+            "name": "nsInstanceId",\r
+            "in": "path"\r
+          },\r
+          {\r
+            "in": "body",\r
+            "name": "NSInstantiateRequest",\r
+            "description": "NS Instantiate Request Body",\r
+            "required": true,\r
+            "schema": {\r
+              "$ref": "#/definitions/NsInstantiateRequest"\r
+            }\r
+          }\r
+        ],\r
+        "responses": {\r
+          "200": {\r
+            "description": "",\r
+            "schema": {\r
+              "$ref": "#/definitions/JobInfo"\r
+            }\r
+          },\r
+          "201": {\r
+            "description": "Invalid Request"\r
+          },\r
+          "404": {\r
+            "description": "URL not found"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/ns/{nsInstanceId}/scale": {\r
+      "post": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns scale",\r
+        "description": "ns scale",\r
+        "operationId": "ns_scale",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "",\r
+            "name": "nsInstanceId",\r
+            "in": "path"\r
+          },\r
+          {\r
+            "in": "body",\r
+            "name": "ScaleNSRequest",\r
+            "description": "Scale NS Request Body",\r
+            "required": true,\r
+            "schema": {\r
+              "$ref": "#/definitions/NsScaleRequest"\r
+            }\r
+          }\r
+        ],\r
+        "responses": {\r
+          "200": {\r
+            "description": "",\r
+            "schema": {\r
+              "$ref": "#/definitions/JobInfo"\r
+            }\r
+          },\r
+          "201": {\r
+            "description": "Invalid Request"\r
+          },\r
+          "404": {\r
+            "description": "URL not found"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/ns/{nsInstanceId}/heal": {\r
+      "post": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns heal",\r
+        "description": "ns heal",\r
+        "operationId": "ns_heal",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "Identifier of the NS instance.",\r
+            "name": "nsInstanceId",\r
+            "in": "path"\r
+          },\r
+          {\r
+            "in": "body",\r
+            "name": "healVnfData",\r
+            "description": "healVnfData",\r
+            "required": true,\r
+            "schema": {\r
+              "$ref": "#/definitions/NsHealRequest"\r
+            }\r
+          }\r
+        ],\r
+        "responses": {\r
+          "202": {\r
+            "description": "",\r
+            "schema": {\r
+              "$ref": "#/definitions/JobInfo"\r
+            }\r
+          },\r
+          "404": {\r
+            "description": "URL not found"\r
+          },\r
+          "500": {\r
+            "description": "the url is invalid"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/ns/{nsInstanceId}/terminate": {\r
+      "post": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns terminate",\r
+        "description": "ns terminate",\r
+        "operationId": "ns_terminate",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "Identifier of the NS instance.",\r
+            "name": "nsInstanceId",\r
+            "in": "path"\r
+          },\r
+          {\r
+            "in": "body",\r
+            "name": "NsTerminateRequest",\r
+            "description": "NsTerminateRequest",\r
+            "required": true,\r
+            "schema": {\r
+              "$ref": "#/definitions/NsTerminateRequest"\r
+            }\r
+          }\r
+        ],\r
+        "responses": {\r
+          "202": {\r
+            "description": "",\r
+            "schema": {\r
+              "$ref": "#/definitions/JobInfo"\r
+            }\r
+          },\r
+          "500": {\r
+            "description": "the url is invalid"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/ns/{nsInstanceId}": {\r
+      "get": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns get",\r
+        "description": "ns get",\r
+        "operationId": "ns_instance_get",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "Identifier of the NS instance.",\r
+            "name": "nsInstanceId",\r
+            "in": "path"\r
+          }\r
+        ],\r
+        "responses": {\r
+          "200": {\r
+            "description": "successful operation",\r
+            "schema": {\r
+              "$ref": "#/definitions/NsInstanceInfo"\r
+            }\r
+          }\r
+        }\r
+      },\r
+      "delete": {\r
+        "tags": [\r
+          "ns"\r
+        ],\r
+        "summary": "ns delete",\r
+        "description": "ns delete",\r
+        "operationId": "ns_delete",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "Identifier of the NS instance.",\r
+            "name": "nsInstanceId",\r
+            "in": "path"\r
+          }\r
+        ],\r
+        "responses": {\r
+          "204": {\r
+            "description": "The NS instance resource and the associated NS identifier were deleted successfully."\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "/jobs/{jobId}": {\r
+      "get": {\r
+        "tags": [\r
+          "job"\r
+        ],\r
+        "summary": "jobstatus",\r
+        "description": "",\r
+        "operationId": "get_jobstatus",\r
+        "parameters": [\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "job Id",\r
+            "name": "jobId",\r
+            "in": "path"\r
+          },\r
+          {\r
+            "required": true,\r
+            "type": "string",\r
+            "description": "job response message id",\r
+            "name": "responseId",\r
+            "in": "query"\r
+          }\r
+        ],\r
+        "responses": {\r
+          "202": {\r
+            "description": "",\r
              "schema": {\r
-\r
-               "$ref": "#/definitions/JobProgressRequest"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         ],\r
-\r
-         "responses": {\r
-\r
-           "202": {\r
-\r
-             "description": ""\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     }\r
-\r
-   },\r
-\r
-   "definitions": {\r
-\r
-     "NsCreateRequest": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "context":{\r
-\r
-            "type": "object",\r
-\r
-            "properties": {\r
-\r
+              "$ref": "#/definitions/JobDetailInfo"\r
+            }\r
+          }\r
+        }\r
+      }\r
+    }\r
+  },\r
+  "definitions": {\r
+    "NsCreateRequest": {\r
+      "type": "object",\r
+      "properties": {\r
+        "context":{\r
+          "type": "object",\r
+           "properties": {\r
               "globalCustomerId":{\r
-\r
                  "type": "string",\r
                  "description": "the global customer id"\r
-\r
               },\r
-\r
               "serviceType":{\r
                  "type": "string",\r
-\r
                  "description": "service type"\r
-\r
               }\r
-\r
             }\r
-\r
-         },\r
-\r
-         "csarId": {\r
-\r
-           "type": "string",\r
-\r
-           "description": "the NS package ID"\r
-\r
-         },\r
-\r
-         "nsName": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "description": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "NsCreateResponse": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "nsInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-     "NsInstantiateRequest": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "LocationConstraints": {\r
-\r
-           "type": "array",\r
-\r
-           "items": {\r
-\r
-             "$ref": "#/definitions/LocationConstraint"\r
-\r
-           }\r
-\r
-         },\r
-\r
-         "additionalParamForNs": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "LocationConstraint": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "vnfProfileId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-         "locationConstraints": {\r
-\r
-           "type": "object",\r
-\r
-           "properties": {\r
-\r
-             "vimid": {\r
-\r
-               "type": "string"\r
-\r
-             }\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "NsScaleRequest": {\r
-\r
+        },\r
+        "csarId": {\r
+          "type": "string",\r
+          "description": "the NS package ID"\r
+        },\r
+        "nsName": {\r
+          "type": "string"\r
+        },\r
+        "description": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "NsCreateResponse": {\r
+      "type": "object",\r
+      "properties": {\r
+        "nsInstanceId": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "NsInstantiateRequest": {\r
+      "type": "object",\r
+      "properties": {\r
+        "LocationConstraints": {\r
+          "type": "array",\r
+          "items": {\r
+            "$ref": "#/definitions/LocationConstraint"\r
+          }\r
+        },\r
+        "additionalParamForNs": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "LocationConstraint": {\r
+      "type": "object",\r
+      "properties": {\r
+        "vnfProfileId": {\r
+          "type": "string"\r
+        },\r
+        "locationConstraints": {\r
+          "type": "object",\r
+          "properties": {\r
+            "vimid": {\r
+              "type": "string"\r
+            }\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "NsScaleRequest": {\r
+      "type": "object",\r
+      "properties": {\r
+        "scaleType": {\r
+          "type": "string"\r
+        },\r
+        "scaleNsByStepsData": {\r
+          "$ref": "#/definitions/NsScaleByStepsData"\r
+        }\r
+      }\r
+    },\r
+    "NsScaleByStepsData": {\r
+      "type": "object",\r
+      "properties": {\r
+        "scalingDirection": {\r
+          "type": "string"\r
+        },\r
+        "aspectId": {\r
+          "type": "string"\r
+        },\r
+        "numberOfSteps": {\r
+          "type": "integer"\r
+        }\r
+      }\r
+    },\r
+    "NsHealRequest": {\r
+      "type": "object",\r
+      "properties": {\r
+        "vnfInstanceId": {\r
+          "type": "string"\r
+        },\r
+        "cause": {\r
+          "type": "string"\r
+        },\r
+        "additionalParams": {\r
+          "type": "object",\r
+          "properties": {\r
+            "action": {\r
+              "type": "string"\r
+            },\r
+            "actionvminfo": {\r
+              "type": "object",\r
+              "properties": {\r
+                "vmid": {\r
+                  "type": "string"\r
+                },\r
+                "vmname": {\r
+                  "type": "string"\r
+                }\r
+              }\r
+            }\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "NsTerminateRequest": {\r
+      "type": "object",\r
+      "properties": {\r
+        "terminationType": {\r
+          "type": "string"\r
+        },\r
+        "gracefulTerminationTimeout": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "JobInfo": {\r
+      "type": "object",\r
+      "properties": {\r
+        "jobId": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "NsInstancesInfo":{\r
+      "type": "array",\r
+      "items": {\r
+            "$ref": "#/definitions/NsInstanceInfo"\r
+      }\r
+    },\r
+    "NsInstanceInfo": {\r
+      "type": "object",\r
+      "properties": {\r
+        "nsInstanceId": {\r
+          "type": "string"\r
+        },\r
+        "nsName": {\r
+          "type": "string"\r
+        },\r
+        "description": {\r
+          "type": "string"\r
+        },\r
+        "nsdId": {\r
+          "type": "string"\r
+        },\r
+        "vnfInfo": {\r
+          "type": "array",\r
+          "items": {\r
+            "$ref": "#/definitions/vnfInfo"\r
+          }\r
+        },\r
+        "vlInfo": {\r
+          "type": "array",\r
+          "items": {\r
+            "$ref": "#/definitions/vlInfo"\r
+          }\r
+        },\r
+        "vnffgInfo": {\r
+          "type": "array",\r
+          "items": {\r
+            "$ref": "#/definitions/vnffgInfo"\r
+          }\r
+        },\r
+        "nsState": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "vnfInfo": {\r
+      "type": "object",\r
+      "properties": {\r
+        "vnfInstanceId": {\r
+          "type": "string"\r
+        },\r
+        "vnfInstanceName": {\r
+          "type": "string"\r
+        },\r
+        "vnfdId": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "vlInfo": {\r
+      "type": "object",\r
+      "properties": {\r
+        "vlInstanceId": {\r
+          "type": "string"\r
+        },\r
+        "vlInstanceName": {\r
+          "type": "string"\r
+        },\r
+        "vldId": {\r
+          "type": "string"\r
+        },\r
+        "relatedCpInstanceId": {\r
+          "type": "array",\r
+          "items": {\r
+            "$ref": "#/definitions/cpInfo"\r
+          }\r
+        }\r
+      }\r
+    },\r
+    "cpInfo": {\r
+      "type": "object",\r
+      "properties": {\r
+        "cpInstanceId": {\r
+          "type": "string"\r
+        },\r
+        "cpInstanceName": {\r
+          "type": "string"\r
+        },\r
+        "cpdId": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "vnffgInfo": {\r
+      "type": "object",\r
+      "properties": {\r
+        "vnffgInstanceId": {\r
+          "type": "string"\r
+        },\r
+        "vnfId": {\r
+          "type": "string"\r
+        },\r
+        "pnfId": {\r
+          "type": "string"\r
+        },\r
+        "virtualLinkId": {\r
+          "type": "string"\r
+        },\r
+        "cpId": {\r
+          "type": "string"\r
+        },\r
+        "nfp": {\r
+          "type": "string"\r
+        }\r
+      }\r
+    },\r
+    "jobResponseInfo": {\r
        "type": "object",\r
-\r
        "properties": {\r
-\r
-         "scaleType": {\r
-\r
-           "type": "string"\r
-\r
+          "status": {\r
+            "type": "string"\r
+          },\r
+         "progress":{\r
+            "type": "string"\r
          },\r
-\r
-         "scaleNsByStepsData": {\r
-\r
-           "$ref": "#/definitions/NsScaleByStepsData"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "NsScaleByStepsData": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "scalingDirection": {\r
-\r
-           "type": "string"\r
-\r
+         "statusDescription": {\r
+            "type": "string"\r
          },\r
-\r
-         "aspectId": {\r
-\r
-           "type": "string"\r
-\r
+         "errorCode": {\r
+            "type": "string"\r
          },\r
-\r
-         "numberOfSteps": {\r
-\r
-           "type": "integer"\r
-\r
-         }\r
-\r
+         "responseId": {\r
+            "type": "string"\r
+        }\r
        }\r
-\r
-     },\r
-\r
-     "NsHealRequest": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "vnfInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "cause": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "additionalParams": {\r
-\r
-           "type": "object",\r
-\r
-           "properties": {\r
-\r
-             "action": {\r
-\r
+    },\r
+    "JobDetailInfo":{\r
+      "type": "object",\r
+      "properties": {\r
+            "jobId": {\r
                "type": "string"\r
-\r
              },\r
-\r
-             "actionvminfo": {\r
-\r
-               "type": "object",\r
-\r
-               "properties": {\r
-\r
-                 "vmid": {\r
-\r
-                   "type": "string"\r
-\r
-                 },\r
-\r
-                 "vmname": {\r
-\r
-                   "type": "string"\r
-\r
-                 }\r
-\r
-               }\r
-\r
-             }\r
-\r
-           }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "NsTerminateRequest": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "terminationType": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "gracefulTerminationTimeout": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "JobInfo": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "jobId": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "JobProgressRequest": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "progress": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "desc": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "errcode": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "NsInfo": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "nsInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "nsName": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "description": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "nsdId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "vnfInfo": {\r
-\r
-           "type": "array",\r
-\r
-           "items": {\r
-\r
-             "$ref": "#/definitions/vnfInfo"\r
-\r
-           }\r
-\r
-         },\r
-\r
-         "vlInfo": {\r
-\r
-           "type": "array",\r
-\r
-           "items": {\r
-\r
-             "$ref": "#/definitions/vlInfo"\r
-\r
-           }\r
-\r
-         },\r
-\r
-         "vnffgInfo": {\r
-\r
-           "type": "array",\r
-\r
-           "items": {\r
-\r
-             "$ref": "#/definitions/vnffgInfo"\r
-\r
-           }\r
-\r
-         },\r
-\r
-         "nsState": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "vnfInfo": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "vnfInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "vnfInstanceName": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "vnfdId": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "vlInfo": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "vlInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "vlInstanceName": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "vldId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "relatedCpInstanceId": {\r
-\r
-           "type": "array",\r
-\r
-           "items": {\r
-\r
-             "$ref": "#/definitions/cpInfo"\r
-\r
+            "responseDescriptor":\r
+            {\r
+                "type":"object",\r
+                "properties": {\r
+                    "status": {\r
+                       "type": "string"\r
+                    },\r
+                    "progress":{\r
+                       "type": "string"\r
+                    },\r
+                    "statusDescription": {\r
+                       "type": "string"\r
+                    },\r
+                    "errorCode": {\r
+                       "type": "string"\r
+                    },\r
+                    "responseId": {\r
+                       "type": "string"\r
+                    },\r
+                    "responseHistoryList": {\r
+                        "type": "array",\r
+                        "items": {\r
+                           "$ref": "#/definitions/jobResponseInfo"\r
+                        }\r
+                    }\r
+                }\r
            }\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-\r
-     "cpInfo": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "cpInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "cpInstanceName": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "cpdId": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     },\r
-     "vnffgInfo": {\r
-\r
-       "type": "object",\r
-\r
-       "properties": {\r
-\r
-         "vnffgInstanceId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "vnfId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-         "pnfId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "virtualLinkId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "cpId": {\r
-\r
-           "type": "string"\r
-\r
-         },\r
-\r
-         "nfp": {\r
-\r
-           "type": "string"\r
-\r
-         }\r
-\r
-       }\r
-\r
-     }\r
-\r
-   }\r
-\r
- }
\ No newline at end of file
+      }\r
+    }\r
+  }\r
+}
\ No newline at end of file

diff --git a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
index 8d9cff6..c5c63c8 100644 (file)
--- a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
+++ b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst
@@ -8,8 +8,9 @@
 **1 Scope**\r
 =============\r
 \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
+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.\r
+Some content has been updated, about the API Swagger definition, you can find here 'GVNFM_LCM_APIs<https://gerrit.onap.org/r/gitweb?p=vfc/gvnfm/vnflcm.git;a=blob;f=lcm/lcm/swagger/swagger.json;h=f098d282927d3535f5e9e6950f26b9171e04d30c;hb=HEAD>'.\r
+\r
 \r
 **2 Terms, Definitions and Abbreviations**\r
 ===========================================\r
@@ -1681,4 +1682,4 @@ Table 2-1 abbreviations
 \r
 .. |image0| image:: VNFM_API.png\r
    :width: 5.07047in\r
-   :height: 5.6320
\ No newline at end of file
+   :height: 5.6320in
\ No newline at end of file

diff --git a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
index c289626..a88e29e 100644 (file)
--- a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
+++ b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst
@@ -8,6 +8,8 @@
 **1.  Scope**\r
 ==============\r
 The scope of the present document is to describe the VNFM driver integrated related API specification.\r
+Some content has been updated, about the API Swagger definition, you can find here 'VNFM driver development related API<https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob;f=lcm/swagger/vfc.vnfdriver.swagger.json;h=fc35adbdc75df1307ca2c43a11bfb472da2a27c6;hb=HEAD>'\r
+\r
 \r
 **2.  Terms, Definitions and Abbreviations**\r
 =============================================\r

diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst
index c6f561b..816bad2 100644 (file)
--- a/docs/platform/APIs/index.rst
+++ b/docs/platform/APIs/index.rst
@@ -3,12 +3,12 @@
 
 
 VF-C Offered APIs
-=================
+==================
 List VF-C APIs offered.
 
 
 VFC Northbound API
-----------
+------------------
 
 Network services lifecycle management APIs
 
@@ -20,7 +20,7 @@ Network services lifecycle management APIs
 
 
 VNFM Integration APIs 
----------------
+---------------------
 
 VNFM Driver Integration Related APIs
 
@@ -32,7 +32,7 @@ VNFM Driver Integration Related APIs
 
 
 GVNFM Northbound & Southbound APIs
------------
+----------------------------------
 
 GVNFM Northbound & Southbound APIs for VNF Integration
 

diff --git a/docs/platform/Auto-healing.png b/docs/platform/Auto-healing.png
new file mode 100644 (file)
index 0000000..6ebb891
Binary files /dev/null and b/docs/platform/Auto-healing.png differ

diff --git a/docs/platform/Instantiation.png b/docs/platform/Instantiation.png
new file mode 100644 (file)
index 0000000..b26347c
Binary files /dev/null and b/docs/platform/Instantiation.png differ

diff --git a/docs/platform/Termination.png b/docs/platform/Termination.png
new file mode 100644 (file)
index 0000000..311d78a
Binary files /dev/null and b/docs/platform/Termination.png differ

diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst
index 2aef466..0843955 100644 (file)
--- a/docs/platform/consumedapis.rst
+++ b/docs/platform/consumedapis.rst
@@ -10,6 +10,7 @@ References to APIs offered by other components
  - DCAE: Use DCAE Ves collector API to report FCAPS data to DCAE
  - MSB:  Use MSB to register and find microservice
  - Modeling: Use nfvparser API to parse tosca template
+ - Multicloud: Use Multicloud API to CRUD virtual resource
 
 
 

diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst
index 13d1e0f..5f71714 100644 (file)
--- a/docs/platform/delivery.rst
+++ b/docs/platform/delivery.rst
@@ -6,23 +6,21 @@ VF-C includes the following components in R1.
 
 .. |image0| image:: components.png
    :width: 5.97047in
-   :height: 5.63208in
+   :height: 4.63208in
 
 VF-C includes several components in ONAP R1.
 
-Catalog is used to store the package distributed by SDC, it is a runtime catalog.
-
-Workflow include two micro service, one is workflow manage service and the other is workflow-activiti engine service, this two service will onboard workflow to workflow engine and parse workflow.
+* Catalog is used to store the package distributed by SDC, it is a runtime catalog.
 
+* Workflow include two micro service, one is workflow manage service and the other is workflow-activiti engine service, this two service will onboard workflow to workflow engine and parse workflow.
 
-For NS lifecycle manager,it mainly completes the NS lifecycle management,such as NS Instantiation/termination and auto-healing.
+* For NS lifecycle manager,it mainly completes the NS lifecycle management,such as NS Instantiation/termination and auto-healing.
 
-For Resource manager, it will communicate with NS lifecycle manager to update instance data to A&AI.
+* For Resource manager, it will communicate with NS lifecycle manager to update instance data to A&AI.
 
-In VF-C southbound, it includes Gvnfmdriver and SVNFM driver which will interact with GVNFM and Vendor VNFM respectively to execute VNF lifecycle management,
-VF-C provides vnfm driver northbound api,then Vendor can implement this APIs to integrate with VF-C.
+* In VF-C southbound, it includes Gvnfmdriver and SVNFM driver which will interact with GVNFM and Vendor VNFM respectively to execute VNF lifecycle management,VF-C provides vnfm driver northbound api,then Vendor can implement this APIs to integrate with VF-C.
 
-For the EMS driver,it can collect VNF lay’s Fcaps data from Vendor EMS, and then translate and put these data to DCAE Vescollector
+* For the EMS driver,it can collect VNF lay’s Fcaps data from Vendor EMS, and then translate and put these data to DCAE Vescollector
 
 
 For the Amsterdam release, VF-C includes the following components:
@@ -44,4 +42,30 @@ GVNFM
  - vfc-gvnfm-vnfres
 Workflow
  - workflow-engine-mgr-service
- - activiti-extension
\ No newline at end of file
+ - activiti-extension
+ 
+VF-C support VolTE use case in R1 and R2, following are the vVoLTE releated Workflow in VF-C.
+
+* VoLTE Use Case Instantiation In VF-C
+
+|image1|
+
+.. |image1| image:: Instantiation.png
+   :width: 5.97047in
+   :height: 5.63208in
+
+* VoLTE Use Case Termination in VF-C
+
+|image2|
+
+.. |image2| image:: Termination.png
+   :width: 5.97047in
+   :height: 5.63208in
+   
+* VoLTE Use Case Auto-healing in VF-C
+
+|image3|
+
+.. |image3| image:: Auto-healing.png
+   :width: 5.97047in
+   :height: 5.63208in
\ No newline at end of file

diff --git a/docs/release-notes.rst.bak b/docs/release-notes.rst.bak
deleted file mode 100644 (file)
index 79cf95d..0000000
--- a/docs/release-notes.rst.bak
+++ /dev/null
@@ -1,77 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-
-VF-C Release Notes
-==================
-
-.. note::
-       * This Release Notes must be updated each time the team decides to Release new artifacts.
-       * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-       * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-       * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-       * This note must be removed after content has been added.
-
-VF-C includes two main component:NFV-O and GVNFM, can implement life cycle management and FCAPS of VNF and NS. VF-C takes part in end2end service orchestration and close loop automatiion by working with SO,DCAE and Policy. 
-VF-C also provides standard south bound interface to VNFMs and can integration with multi vendor VNFMs via drivers.
-
-
-
-Version: 1.0.0
---------------
-
-
-:Release Date: 2017-11-16
-
-
-
-**New Features**
-
- - NS lifecycle management, including NS instance creation,termination and healing
- - VNF lifecycle management, including VNF nstance creation,termination and healing
- - VNF FCAPS, collecting FCAPS data from vendor EMS
- - VNFM Integration, integration with specific VNFMs of vendors to deploy commercial VNFs
- - VNF Integration, integration with VNF via GVNFM
- 
-released components:
-
-NFVO
- - vfc-nfvo-lcm
- - vfc-nfvo-catalog
- - vfc-nfvo-resmgr
- - vfc-nfvo-driver-emsdriver
- - vfc-nfvo-driver-gvnfm-gvnfmadapter
- - vfc-nfvo-driver-gvnfm-jujudriver
- - vfc-nfvo-driver-svnfm-ztedriver
- - vfc-nfvo-driver-svnfm-huaweidriver
- - vfc-nfvo-driver-svnfm-nokiadriver
- - vfc-nfvo-driver-sfc-ztesfcdriver
-GVNFM
- - vfc-gvnfm-vnflcm
- - vfc-gvnfm-vnfmgr
- - vfc-gvnfm-vnfres
-Workflow
- - workflow-engine-mgr-service
- - activiti-extension
-
-**Bug Fixes**
-
-This is the initial release
-**Known Issues**
-
-None
-
-**Security Issues**
-
-None
-**Upgrade Notes**
-
-This is the initial release
-**Deprecation Notes**
-
-This is the initial release
-**Other**
-
-===========
-
-End of Release Notes