Draft docs

Issue-Id: DCAEGEN2-109
Change-Id: I85513ed5b34c0f60b8b0924b2016bbb3224beb9c
Signed-off-by: Lusheng Ji <lji@research.att.com>

1 files changed, 768 insertions, 0 deletions

diff --git a/docs/sections/apiexample/vfcexample.rst b/docs/sections/apiexample/vfcexample.rst
new file mode 100644
index 00000000..71d3b781
--- /dev/null
+++ b/docs/sections/apiexample/vfcexample.rst
@@ -0,0 +1,768 @@
+=================================================
+ONAP VFC Network Service Lifecycle Management API
+=================================================
+
+:Date:   2017-10-09
+
+.. contents::
+   :depth: 3
+..
+
+Overview
+========
+
+VFC Network Service Lifecycle Management Rest API.
+
+Version information
+-------------------
+
+*Version* : 1.0.0
+
+Contact information
+-------------------
+
+| *Contact* : ONAP VFC team
+| *Contact Email* : onap-discuss@lists.onap.org
+
+URI scheme
+----------
+
+| *BasePath* : /api/nslcm/v1
+| *Schemes* : HTTP, HTTPS
+
+Consumes
+--------
+
+-  ``application/json``
+
+Produces
+--------
+
+-  ``application/json``
+
+Paths
+=====
+
+jobstatus
+---------
+
+::
+
+    GET /jobs/{jobId}
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Path* | | **jobId** | job Id                               | string           |
+| *       | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+| **Query | | **respons | job response message id              | string           |
+| **      | eId**       |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++-------------------------+--------------------------------------------------+
+| HTTP Code               | Schema                                           |
++=========================+==================================================+
+| **202**                 | `JobDetailInfo <#_jobdetailinfo>`__              |
++-------------------------+--------------------------------------------------+
+
+Tags
+~~~~
+
+-  job
+
+ns create
+---------
+
+::
+
+    POST /ns
+
+Description
+~~~~~~~~~~~
+
+ns create
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Body* | | **NSCreat | NS Instance Create Request           | `NsCreateRequest |
+| *       | eRequest**  |                                      |  <#_nscreaterequ |
+|         | | *required |                                      | est>`__          |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **200** | successful operation                               | `NsCreateRespo |
+|         |                                                    | nse <#_nscreat |
+|         |                                                    | eresponse>`__  |
++---------+----------------------------------------------------+----------------+
+| **404** | URL not found                                      | No Content     |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns get
+------
+
+::
+
+    GET /ns
+
+Description
+~~~~~~~~~~~
+
+ns get
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Query | | **csarId* | job response message id              | string           |
+| **      | *           |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **200** | successful operation                               | `NsInstancesIn |
+|         |                                                    | fo <#_nsinstan |
+|         |                                                    | cesinfo>`__    |
++---------+----------------------------------------------------+----------------+
+| **404** | URL not found                                      | No Content     |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns Instantiate
+--------------
+
+::
+
+    POST /ns/{nsInstanceId}/Instantiate
+
+Description
+~~~~~~~~~~~
+
+ns Instantiate
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Path* | | **nsInsta |                                      | string           |
+| *       | nceId**     |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+| **Body* | | **NSInsta | NS Instantiate Request Body          | `NsInstantiateRe |
+| *       | ntiateReque |                                      | quest <#_nsinsta |
+|         | st**        |                                      | ntiaterequest>`_ |
+|         | | *required |                                      | _                |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **200** |                                                    | `JobInfo <#_jo |
+|         |                                                    | binfo>`__      |
++---------+----------------------------------------------------+----------------+
+| **201** | Invalid Request                                    | No Content     |
++---------+----------------------------------------------------+----------------+
+| **404** | URL not found                                      | No Content     |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns scale
+--------
+
+::
+
+    POST /ns/{nsInstanceId}/scale
+
+Description
+~~~~~~~~~~~
+
+ns scale
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Path* | | **nsInsta |                                      | string           |
+| *       | nceId**     |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+| **Body* | | **ScaleNS | Scale NS Request Body                | `NsScaleRequest  |
+| *       | Request**   |                                      | <#_nsscalereques |
+|         | | *required |                                      | t>`__            |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **200** |                                                    | `JobInfo <#_jo |
+|         |                                                    | binfo>`__      |
++---------+----------------------------------------------------+----------------+
+| **201** | Invalid Request                                    | No Content     |
++---------+----------------------------------------------------+----------------+
+| **404** | URL not found                                      | No Content     |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns get
+------
+
+::
+
+    GET /ns/{ns_instance_id}
+
+Description
+~~~~~~~~~~~
+
+ns get
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **200** | successful operation                               | `NsInstanceInf |
+|         |                                                    | o <#_nsinstanc |
+|         |                                                    | einfo>`__      |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns delete
+---------
+
+::
+
+    DELETE /ns/{ns_instance_id}
+
+Description
+~~~~~~~~~~~
+
+ns delete
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
+| *       | tance\_id** |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **204** | The NS instance resource and the associated NS     | No Content     |
+|         | identifier were deleted successfully.              |                |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns heal
+-------
+
+::
+
+    POST /ns/{ns_instance_id}/heal
+
+Description
+~~~~~~~~~~~
+
+ns heal
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
+| *       | tance\_id** |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+| **Body* | | **healVnf | healVnfData                          | `NsHealRequest < |
+| *       | Data**      |                                      | #_nshealrequest> |
+|         | | *required |                                      | `__              |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **202** |                                                    | `JobInfo <#_jo |
+|         |                                                    | binfo>`__      |
++---------+----------------------------------------------------+----------------+
+| **404** | URL not found                                      | No Content     |
++---------+----------------------------------------------------+----------------+
+| **500** | the url is invalid                                 | No Content     |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+ns terminate
+------------
+
+::
+
+    POST /ns/{ns_instance_id}/terminate
+
+Description
+~~~~~~~~~~~
+
+ns terminate
+
+Parameters
+~~~~~~~~~~
+
++---------+-------------+--------------------------------------+------------------+
+| Type    | Name        | Description                          | Schema           |
++=========+=============+======================================+==================+
+| **Path* | | **ns\_ins | Identifier of the NS instance.       | string           |
+| *       | tance\_id** |                                      |                  |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+| **Body* | | **NsTermi | NsTerminateRequest                   | `NsTerminateRequ |
+| *       | nateRequest |                                      | est <#_nstermina |
+|         | **          |                                      | terequest>`__    |
+|         | | *required |                                      |                  |
+|         | *           |                                      |                  |
++---------+-------------+--------------------------------------+------------------+
+
+Responses
+~~~~~~~~~
+
++---------+----------------------------------------------------+----------------+
+| HTTP    | Description                                        | Schema         |
+| Code    |                                                    |                |
++=========+====================================================+================+
+| **202** |                                                    | `JobInfo <#_jo |
+|         |                                                    | binfo>`__      |
++---------+----------------------------------------------------+----------------+
+| **500** | the url is invalid                                 | No Content     |
++---------+----------------------------------------------------+----------------+
+
+Tags
+~~~~
+
+-  ns
+
+Definitions
+===========
+
+JobDetailInfo
+-------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **jobId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **responseDescriptor**       | `responseDescriptor <#_jobdetailinfo_resp |
+| | *optional*                   | onsedescriptor>`__                        |
++--------------------------------+-------------------------------------------+
+
+**responseDescriptor**
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **errorCode**                | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **progress**                 | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **responseHistoryList**      | < `jobResponseInfo <#_jobresponseinfo>`__ |
+| | *optional*                   | > array                                   |
++--------------------------------+-------------------------------------------+
+| | **responseId**               | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **status**                   | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **statusDescription**        | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+JobInfo
+-------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **jobId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+LocationConstraint
+------------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **locationConstraints**      | `locationConstraints <#_locationconstrain |
+| | *optional*                   | t_locationconstraints>`__                 |
++--------------------------------+-------------------------------------------+
+| | **vnfProfileId**             | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+**locationConstraints**
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **vimid**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsCreateRequest
+---------------
+
++-------------+---------------------------------------------+------------------+
+| Name        | Description                                 | Schema           |
++=============+=============================================+==================+
+| | **csarId* | the NS package ID                           | string           |
+| *           |                                             |                  |
+| | *optional |                                             |                  |
+| *           |                                             |                  |
++-------------+---------------------------------------------+------------------+
+| | **descrip |                                             | string           |
+| tion**      |                                             |                  |
+| | *optional |                                             |                  |
+| *           |                                             |                  |
++-------------+---------------------------------------------+------------------+
+| | **nsName* |                                             | string           |
+| *           |                                             |                  |
+| | *optional |                                             |                  |
+| *           |                                             |                  |
++-------------+---------------------------------------------+------------------+
+
+NsCreateResponse
+----------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **nsInstanceId**             | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsHealRequest
+-------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **additionalParams**         | `additionalParams <#_nshealrequest_additi |
+| | *optional*                   | onalparams>`__                            |
++--------------------------------+-------------------------------------------+
+| | **cause**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnfInstanceId**            | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+**additionalParams**
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **action**                   | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **actionvminfo**             | `actionvminfo <#_nshealrequest_actionvmin |
+| | *optional*                   | fo>`__                                    |
++--------------------------------+-------------------------------------------+
+
+**actionvminfo**
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **vmid**                     | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vmname**                   | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsInstanceInfo
+--------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **description**              | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **nsInstanceId**             | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **nsName**                   | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **nsState**                  | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **nsdId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vlInfo**                   | < `vlInfo <#_vlinfo>`__ > array           |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnfInfo**                  | < `vnfInfo <#_vnfinfo>`__ > array         |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnffgInfo**                | < `vnffgInfo <#_vnffginfo>`__ > array     |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsInstancesInfo
+---------------
+
+*Type* : < `NsInstanceInfo <#_nsinstanceinfo>`__ > array
+
+NsInstantiateRequest
+--------------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **LocationConstraints**      | <                                         |
+| | *optional*                   | `LocationConstraint <#_locationconstraint |
+|                                | >`__                                      |
+|                                | > array                                   |
++--------------------------------+-------------------------------------------+
+| | **additionalParamForNs**     | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsScaleByStepsData
+------------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **aspectId**                 | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **numberOfSteps**            | integer                                   |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **scalingDirection**         | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsScaleRequest
+--------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **scaleNsByStepsData**       | `NsScaleByStepsData <#_nsscalebystepsdata |
+| | *optional*                   | >`__                                      |
++--------------------------------+-------------------------------------------+
+| | **scaleType**                | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+NsTerminateRequest
+------------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **gracefulTerminationTimeout | string                                    |
+| **                             |                                           |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **terminationType**          | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+cpInfo
+------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **cpInstanceId**             | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **cpInstanceName**           | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **cpdId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+jobResponseInfo
+---------------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **errorCode**                | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **progress**                 | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **responseId**               | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **status**                   | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **statusDescription**        | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+vlInfo
+------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **relatedCpInstanceId**      | < `cpInfo <#_cpinfo>`__ > array           |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vlInstanceId**             | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vlInstanceName**           | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vldId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+vnfInfo
+-------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **vnfInstanceId**            | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnfInstanceName**          | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnfdId**                   | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+
+vnffgInfo
+---------
+
++--------------------------------+-------------------------------------------+
+| Name                           | Schema                                    |
++================================+===========================================+
+| | **cpId**                     | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **nfp**                      | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **pnfId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **virtualLinkId**            | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnfId**                    | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+
+| | **vnffgInstanceId**          | string                                    |
+| | *optional*                   |                                           |
++--------------------------------+-------------------------------------------+