diff options
| author |   sanchitap <sanchita@techmahindra.com> | 2018-05-07 16:46:09 +0530 |
|---|---|---|
| committer |   Seshu Kumar M <seshu.kumar.m@huawei.com> | 2018-05-08 06:29:20 +0000 |
| commit | beba3e2184d727ab54c08341bbee3b14f97d92db (patch) | |
| tree | 9bdc73657a2fa253bb9bc5f0815168c52244d8ed /docs/SO_R1_Interface.rst | |
| parent | f2d0a4f94fb3d4ea44d2019271c28db6cdacfb79 (diff) | |
SO API doc update
UUI APIs, SDC APIs updated
Change-Id: I77a245217197b95b1735e75c8ff0bb09c2772d70
Issue-ID: SO-413
Signed-off-by: sanchitap <sanchita@techmahindra.com>
Diffstat (limited to 'docs/SO_R1_Interface.rst')
| -rw-r--r-- | docs/SO_R1_Interface.rst | 76 |
1 files changed, 32 insertions, 44 deletions
diff --git a/docs/SO_R1_Interface.rst b/docs/SO_R1_Interface.rst index 3c0d01917b..78f354d367 100644 --- a/docs/SO_R1_Interface.rst +++ b/docs/SO_R1_Interface.rst @@ -197,6 +197,7 @@ Platform Object +-------------------------+------------------+-------------------------------------------------+ LineOfBusiness Object + +-------------------------+------------------+-------------------------------------------------+ |Attribute |Content |Description | +=========================+==================+=================================================+ @@ -1767,50 +1768,37 @@ Request Body: Service Object -+----------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+================+==================+=================================================+ -|name |String |Service instance name. | -+----------------+------------------+-------------------------------------------------+ -|description |String |Service instance description | -+----------------+------------------+-------------------------------------------------+ -|serviceDef ID |String |The service invariantUUID. It is defined in SDC. | -+----------------+------------------+-------------------------------------------------+ -|templateId |String |The service Template UUID. It is defined in SDC. | -+----------------+------------------+-------------------------------------------------+ -|parameters |Parameter Object |Parameter Object | -+----------------+------------------+-------------------------------------------------+ - -Parameter Object - -+----------------------+------------------+-----------------------------------------------------+ -|Attribute |Content |Description | -+======================+==================+=====================================================+ -|globalSubscriberId |String |The subscriber id. It is defined in AAI | -+----------------------+------------------+-----------------------------------------------------+ -|subscriberName |String |The subscriber name. It is defined in AAI | -+----------------------+------------------+-----------------------------------------------------+ -|serviceType |String |The service type. It is defined in AAI | -+----------------------+------------------+-----------------------------------------------------+ -|templateName |String |The service Template name | -+----------------------+------------------+-----------------------------------------------------+ -|resources |Object |This field manages parameters of resources | -+----------------------+------------------+-----------------------------------------------------+ -|resourceName |String |The resource name | -+----------------------+------------------+-----------------------------------------------------+ -|resouceDefId |String |The resource invariantUUID. It is defined in SDC. | -+----------------------+------------------+-----------------------------------------------------+ -|resourceId |String |The resource UUID. It is defined in SDC. | -+----------------------+------------------+-----------------------------------------------------+ -|nsParameters |String |Parameters for current resource object. | -+----------------------+------------------+-----------------------------------------------------+ -|locationConstraints |String |The DC location info for each VNF of current service | -+----------------------+------------------+-----------------------------------------------------+ -|vnfProfileId |String |VNFD id | -+----------------------+------------------+-----------------------------------------------------+ -|additionalParamForNs |String |The parameter for current resource | -+----------------------+------------------+-----------------------------------------------------+ - ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|modelName |String |Service instance name. | ++------------------------------+-----------------+------------------------------------+ +|description |String |Service instance description | ++------------------------------+-----------------+------------------------------------+ +|modelUUID |String |Model UUID | ++------------------------------+-----------------+------------------------------------+ +|modelInvariantUUID |String |Model Invariant UUID | ++------------------------------+-----------------+------------------------------------+ +|created |Timestamp |Cretaed Timestamp | ++------------------------------+-----------------+------------------------------------+ +|toscaCsarArtifactUUID |String |tosca Csar Artifact UUID | ++------------------------------+-----------------+------------------------------------+ +|modelVersion |String |Model Version | ++------------------------------+-----------------+------------------------------------+ +|category |String |category | ++------------------------------+-----------------+------------------------------------+ +|serviceType |String |service Type | ++------------------------------+-----------------+------------------------------------+ +|serviceRole |String |service Role | ++------------------------------+-----------------+------------------------------------+ +|environmentContext |String |environment Context | ++------------------------------+-----------------+------------------------------------+ +|workloadContext |String |workload Context | ++------------------------------+-----------------+------------------------------------+ +|recipes |Object |recipes | ++------------------------------+-----------------+------------------------------------+ +|serviceResourceCustomizations |Object |serviceResourceCustomizations | ++------------------------------+-----------------+------------------------------------+ Response: |