Fix API documentation for UUI req 11/50311/1
authorsubhash kumar singh <subhash.kumar.singh@huawei.com>
Tue, 5 Jun 2018 09:13:55 +0000 (17:13 +0800)
committersubhash kumar singh <subhash.kumar.singh@huawei.com>
Tue, 5 Jun 2018 09:13:55 +0000 (17:13 +0800)
Fix API documentation for UUI req

Change-Id: Iac29eb404f5d3513f12c921018c15099a1aa3d40
Issue-ID: SO-660
Signed-off-by: subhash kumar singh <subhash.kumar.singh@huawei.com>
docs/SO_R1_Interface.rst

index bd65408..561a087 100644 (file)
@@ -1771,33 +1771,65 @@ Service Object
 +------------------------------+-----------------+------------------------------------+
 |Attribute                     |Content          |Description                         |
 +==============================+=================+====================================+
-|modelName                     |String           |Service instance name.              |
+|name                          |String           |Service instance name.              |
 +------------------------------+-----------------+------------------------------------+
 |description                   |String           |Service instance description        |
 +------------------------------+-----------------+------------------------------------+
-|modelUUID                     |String           |Model UUID                          |
+|serviceUuid                   |String           |Model UUID                          |
 +------------------------------+-----------------+------------------------------------+
-|modelInvariantUUID            |String           |Model Invariant UUID                |
+|serviceInvariantUuid          |String           |Model Invariant UUID                |
 +------------------------------+-----------------+------------------------------------+
-|created                       |Timestamp        |Cretaed Timestamp                   |
+|gloabalSubscriberId           |String           |Customer Id                         |
 +------------------------------+-----------------+------------------------------------+
-|toscaCsarArtifactUUID         |String           |tosca Csar Artifact UUID            |
+|serviceType                   |String           |service Type                        |
 +------------------------------+-----------------+------------------------------------+
-|modelVersion                  |String           |Model Version                       |
+|parameters                    |Object           |Parameter Object                    |
 +------------------------------+-----------------+------------------------------------+
-|category                      |String           |category                            |
+
+Parameter Object
+
 +------------------------------+-----------------+------------------------------------+
-|serviceType                   |String           |service Type                        |
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|locationConstraints           |List of object   |location infor for each vnf         |
++------------------------------+-----------------+------------------------------------+
+|resource                      |List of Resource |resource of service/resource        |
++------------------------------+-----------------+------------------------------------+
+|requestInputs                 |key-value map    |input of service/resource
++------------------------------+-----------------+------------------------------------+
+
+LocationConstraint Object
+
++------------------------------+-----------------+------------------------------------+
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|vnfProfileId                  |String           |Customization id for VNF            |
++------------------------------+-----------------+------------------------------------+
+|locationConstraints           |Object           |DC location info of VNF             |
 +------------------------------+-----------------+------------------------------------+
-|serviceRole                   |String           |service Role                        |
+
+VnfLocationConstraint Object
+
++------------------------------+-----------------+------------------------------------+
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|vimId                         |String           |VIM id from ESR definition          |
++------------------------------+-----------------+------------------------------------+
+
+Resource Object
+
++------------------------------+-----------------+------------------------------------+
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|resourceName                  |String           |The resource name                   |
 +------------------------------+-----------------+------------------------------------+
-|environmentContext            |String           |environment Context                 |
+|resourceInvariantUuid         |String           |The resource invariant UUID.        |
 +------------------------------+-----------------+------------------------------------+
-|workloadContext               |String           |workload Context                    |
+|resourceUuid                  |String           |The resource UUID.                  |
 +------------------------------+-----------------+------------------------------------+
-|recipes                       |Object           |recipes                             |
+|resourceCustomizationUuid     |String           |The resource customization UUID.    |
 +------------------------------+-----------------+------------------------------------+
-|serviceResourceCustomizations |Object           |serviceResourceCustomizations       |
+|parameters                    |Object           |Parameter of resource               |
 +------------------------------+-----------------+------------------------------------+
 
 Response: