From 21cc2c63ba04dc1a00233e7ed6ae47e1a974c795 Mon Sep 17 00:00:00 2001
From: liuyuan <liuyuanyjy@chinamobile.com>
Date: Thu, 4 Apr 2019 15:27:03 +0800
Subject: add more docutment in lcm

Change-Id: Iba68f049d7e02f533593403980fe7fcbce1cd592
Issue-ID: VFC-1337
Signed-off-by: liuyuan <liuyuanyjy@chinamobile.com>
---
 docs/platform/APIs/index.rst | 51 ++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 47 insertions(+), 4 deletions(-)

(limited to 'docs/platform/APIs/index.rst')

diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst
index f0a88a4a..ad31664d 100644
--- a/docs/platform/APIs/index.rst
+++ b/docs/platform/APIs/index.rst
@@ -4,7 +4,13 @@
 
 VF-C Offered APIs
 ==================
-List VF-C APIs offered.
+
+.. contents::
+   :depth: 2
+
+Now VF-C provides the NS life cycle management APIs to UUI,SO,Policy and package management APIs to UUI.
+For VNFM vendor, VF-C also provides the VNFM integration APIs, they can reference these APIs to implmemet their VNFMDriver to integrate with VF-C and ONAP.
+
 
 
 VFC Northbound API
@@ -12,6 +18,36 @@ VFC Northbound API
 
 Network services lifecycle management APIs
 
+In Dublin release, VF-C provides SOL005 compliant APIs as follows
+
+::
+
+    api/nslcm/v1/ns_instances
+    api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)
+    api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/instantiate
+    api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/update
+    api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/scale
+    api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/heal
+    api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/terminate
+    api/nslcm/v1/ns_lcm_op_occs/(?P<lcmopoccid>[0-9a-zA-Z_-]+)
+    api/nslcm/v1/subscriptions
+    api/nslcm/v1/ns_lcm_op_occs
+
+But for the previous APIs, we still keep in Dublin, but the following APIs will be deprecated in the future release
+
+::
+
+	api/nslcm/v1/ns
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/instantiate
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/terminate
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/postdeal
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/scale
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/heal
+    api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/update
+	
+
+More APIs defination and reference can be found in the following page:
 
 .. toctree::
    :maxdepth: 1
@@ -22,7 +58,11 @@ Network services lifecycle management APIs
 VNFM Integration APIs 
 ---------------------
 
-VNFM Driver Integration Related APIs
+VNFM Driver Integration Related APIs, these APIs are mainly provided for Vendor, if you want to integrate with VF-C and ONAP, you can reference these APIs to implement your VNFMDriver
+These integration APIs includ two part:
+
+* The VNF life cycle management APIs for the VNFMDriver should be implemented
+* The NFVO APIs for the VNFMDri1 will be request, like grant APIs 
 
 .. toctree:: 
    :maxdepth: 1
@@ -34,6 +74,10 @@ VNFM Driver Integration Related APIs
 GVNFM Northbound & Southbound APIs
 ----------------------------------
 
+VF-C provides the Generic VFNM , it can be as the GVNFM reference implementaton.
+Now the Northbound APIs of GVNFM has been compli1t with SOL003 and it now can be integrate with VF-C NFVO.
+In tosca-based vCPE use case, the GVNFM founction have been verified in Casablanca release.
+
 GVNFM Northbound & Southbound APIs for VNF Integration
 
 .. toctree:: 
@@ -50,5 +94,4 @@ CATALOG APIs for VNF Integration
 .. toctree::
    :maxdepth: 1
 
-   CATALOG_API/index
-
+   CATALOG_API/index   
\ No newline at end of file
-- 
cgit 1.2.3-korg