Consolidating interfaces at one place

Issue-ID: SO-300

Change-Id: I94fec6472e17882f2564a4fe44292dffd8d6d07e
Signed-off-by: seshukm <seshu.kumar.m@huawei.com>

diff --git a/docs/SO_R1_Interface.rst b/docs/SO_R1_Interface.rst
index 6ed8ebe..ddac76b 100644 (file)
--- a/docs/SO_R1_Interface.rst
+++ b/docs/SO_R1_Interface.rst
@@ -18,4 +18,350 @@ See :download:`UUI-SO_API_Specification_v0.1.docx`
 \r
 The interface between Multi VIM and SO:\r
 \r
-See :download:`SO_MultiCloud.xlsx`
\ No newline at end of file
+See :download:`SO_MultiCloud.xlsx`\r
+\r
+SO APIs\r
+============\r
+\r
+UUI API\r
+----------------\r
+Create E2E service instance\r
+++++++++++++++++++++++++++++\r
+\r
++--------------------+-------------------------------------+\r
+|Interface Definition|Description                          |\r
++====================+=====================================+\r
+|URI                 |{serverRoot}/e2eServiceInstances/v3  |\r
++--------------------+-------------------------------------+\r
+|Operation Type      |POST                                 |\r
++--------------------+-------------------------------------+\r
+|Content-Type        |multipart/form-data                  |\r
++--------------------+-------------------------------------+\r
+\r
+Request Body:\r
+\r
++---------+---------+-----------+--------------------------+-----------------------------+\r
+|Attribute|Qualifier|Cardinality|Content                   |Description                  |\r
++=========+=========+===========+==========================+=============================+\r
+|service  |M        |1          |Service Object            |Content of service object.   |\r
++---------+---------+-----------+--------------------------+-----------------------------+\r
+\r
+Service Object \r
+\r
++----------------+------------------+-------------------------------------------------+\r
+|Attribute       |Content           |Description                                      |\r
++================+==================+=================================================+\r
+|name            |String            |Service instance name.                           |\r
++----------------+------------------+-------------------------------------------------+\r
+|description     |String            |Service instance description                     |\r
++----------------+------------------+-------------------------------------------------+\r
+|serviceDef ID   |String            |The service invariantUUID. It is defined in SDC. |\r
++----------------+------------------+-------------------------------------------------+\r
+|templateId      |String            |The service Template UUID. It is defined in SDC. |\r
++----------------+------------------+-------------------------------------------------+\r
+|parameters      |Parameter Object  |Parameter Object                                 |\r
++----------------+------------------+-------------------------------------------------+\r
+\r
+Parameter Object\r
+\r
++----------------------+------------------+-----------------------------------------------------+\r
+|Attribute             |Content           |Description                                          |\r
++======================+==================+=====================================================+\r
+|globalSubscriberId    |String            |The subscriber id. It is defined in AAI              |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|subscriberName        |String            |The subscriber name. It is defined in AAI            |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|serviceType           |String            |The service type. It is defined in AAI               |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|templateName          |String            |The service Template name                            |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|resources             |Parameter Object  |This field manages parameters of resources           |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|resourceName          |String            |The resource name                                    |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|resouceDefId          |String            |The resource invariantUUID. It is defined in SDC.    |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|resourceId            |String            |The resource UUID. It is defined in SDC.             |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|nsParameters          |String            |Parameters for current resource object.              |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|locationConstraints   |String            |The DC location info for each VNF of current service |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|vnfProfileId          |String            |VNFD id                                              |\r
++----------------------+------------------+-----------------------------------------------------+\r
+|additionalParamForNs  |String            |The parameter for current resource                   |\r
++----------------------+------------------+-----------------------------------------------------+\r
+\r
+\r
+Response:\r
+\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|Attribute    |Qualifier|Cardinality|Content|Description                                                             |\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|serviceId    |M        |1          |String |Service instance ID.                                                    |\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operationId  |M        |1          |String |Service Operation ID.                                                   |\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+\r
+Delete E2E service instance\r
+++++++++++++++++++++++++++++\r
+\r
++--------------------+-----------------------------------------------+\r
+|Interface Definition|Description                                    |\r
++====================+===============================================+\r
+|URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}|\r
++--------------------+-----------------------------------------------+\r
+|Operation Type      |DELETE                                         |\r
++--------------------+-----------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+----------------------------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description                             |\r
++===================+=========+===========+=======+========================================+\r
+|globalSubscriberId |M        |1          |String |The subscriber id. It is defined in AAI |\r
++-------------------+---------+-----------+-------+----------------------------------------+\r
+|serviceType        |M        |1          |String |The service type. It is defined in AAI  |\r
++-------------------+---------+-----------+-------+----------------------------------------+\r
+\r
+Response:\r
+\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|Attribute    |Qualifier|Cardinality|Content|Description                                                             |\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operationId  |M        |1          |String |The operation id.                                                       |\r
++-------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+\r
+Query E2E service operation result\r
+++++++++++++++++++++++++++\r
+\r
++--------------------+------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                             |\r
++====================+========================================================================+\r
+|URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|\r
++--------------------+------------------------------------------------------------------------+\r
+|Operation Type      |GET                                                                     |\r
++--------------------+------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++--------------+---------+-----------+-------+--------------+\r
+|Attribute     |Qualifier|Cardinality|Content|Description   |\r
++==============+=========+===========+=======+==============+\r
+|serviceId     |M        |1          |Service instance ID.  |\r
++--------------+---------+-----------+-------+--------------+\r
+|operationId   |M        |1          |Service Operation ID. |\r
++--------------+---------+-----------+-------+--------------+\r
+\r
+Response:\r
+\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|Attribute         |Qualifier|Cardinality|Content|Description                                                             |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operation         |M        |1          |String |Operation object identify.                                              |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operationId       |M        |1          |String |Operation ID.                                                           |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operation         |M        |1          |String |Operation type, create|delete.                                          |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|result            |M        |1          |String |Operation result: finished, error, processing.                          |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|reason            |M        |1          |String |If failing, need to write fail reason.                                  |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|userId            |M        |1          |String |Operation user ID.                                                      |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operationContent  |M        |1          |String |The status detail of current operation which is being executing.        |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|progress          |M        |1          |String |Current operation progress.                                             |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|operateAt         |M        |1          |String |Time that it starts to execute operation.                               |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+|finishedAt        |M        |1          |String |Time that it finished executing operation.                              |\r
++------------------+---------+-----------+-------+------------------------------------------------------------------------+\r
+\r
+AAI API\r
+----------------\r
+\r
+create or update an existing service-instance\r
++++++++++++++++++++++++++++++++++++++++++++++\r
+\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                                                                                                                         |\r
++====================+====================================================================================================================================================================+\r
+|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Operation Type      |PUT                                                                                                                                                                 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description            |\r
++===================+=========+===========+=======+=======================+\r
+|global-customer-id |M        |1          |String |Global Customer ID     |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-type       |M        |1          |String |Service Type           |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-instance-id|M        |1          |String |Service Instance ID    |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+\r
+Response:\r
+\r
++---------+---------+-----------+-------+-------------------+\r
+|Attribute|Qualifier|Cardinality|Content|Description        |\r
++---------+---------+-----------+-------+-------------------+\r
+|HTTP code|M        |1          |Integer|HTTP response code |\r
++---------+---------+-----------+-------+-------------------+\r
+\r
+delete an existing service-instance\r
++++++++++++++++++++++++++++++++++++\r
+\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                                                                                                                         |\r
++====================+====================================================================================================================================================================+\r
+|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Operation Type      |DELETE                                                                                                                                                              |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description            |\r
++===================+=========+===========+=======+=======================+\r
+|global-customer-id |M        |1          |String |Global Customer ID     |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-type       |M        |1          |String |Service Type           |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-instance-id|M        |1          |String |Service Instance ID    |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+\r
+Response:\r
+\r
++---------+---------+-----------+-------+-------------------+\r
+|Attribute|Qualifier|Cardinality|Content|Description        |\r
++---------+---------+-----------+-------+-------------------+\r
+|HTTP code|M        |1          |Integer|HTTP response code |\r
++---------+---------+-----------+-------+-------------------+\r
+\r
+get service-instances\r
++++++++++++++++++++++\r
+\r
++--------------------+-----------------------------------------------------------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                                                                                  |\r
++====================+=============================================================================================================================+\r
+|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|\r
++--------------------+-----------------------------------------------------------------------------------------------------------------------------+\r
+|Operation Type      |GET                                                                                                                          |\r
++--------------------+-----------------------------------------------------------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description            |\r
++===================+=========+===========+=======+=======================+\r
+|global-customer-id |M        |1          |String |Global Customer ID     |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-type       |M        |1          |String |Service Type           |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+\r
+Response:\r
+\r
++-----------------+---------+-----------+----------------+-------------------+\r
+|Attribute        |Qualifier|Cardinality|Content         |Description        |\r
++-----------------+---------+-----------+----------------+-------------------+\r
+|service-instances|M        |1          |ServiceInstances|Service Instances  |\r
++-----------------+---------+-----------+----------------+-------------------+\r
+\r
+get service-instance\r
+++++++++++++++++++++\r
+\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                                                                                                                         |\r
++====================+====================================================================================================================================================================+\r
+|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Operation Type      |GET                                                                                                                                                                 |\r
++--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description            |\r
++===================+=========+===========+=======+=======================+\r
+|global-customer-id |M        |1          |String |Global Customer ID     |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-type       |M        |1          |String |Service Type           |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-instance-id|M        |1          |String |Service instance ID    |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+\r
+Response:\r
+\r
++-----------------+---------+-----------+----------------+-------------------+\r
+|Attribute        |Qualifier|Cardinality|Content         |Description        |\r
++-----------------+---------+-----------+----------------+-------------------+\r
+|service-instance |M        |1          |ServiceInstance |Service Instance   |\r
++-----------------+---------+-----------+----------------+-------------------+\r
+\r
+see node definition for valid relationships\r
++++++++++++++++++++++++++++++++++++++++++++\r
+\r
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                                                                                                                                                        |\r
++====================+===================================================================================================================================================================================================+\r
+|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|\r
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Operation Type      |PUT                                                                                                                                                                                                |\r
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description            |\r
++===================+=========+===========+=======+=======================+\r
+|global-customer-id |M        |1          |String |Global Customer ID     |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-type       |M        |1          |String |Service Type           |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-instance-id|M        |1          |String |Service instance ID    |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+\r
+Response:\r
+\r
++---------+---------+-----------+-------+-------------------+\r
+|Attribute|Qualifier|Cardinality|Content|Description        |\r
++---------+---------+-----------+-------+-------------------+\r
+|HTTP code|M        |1          |Integer|HTTP response code |\r
++---------+---------+-----------+-------+-------------------+\r
+\r
+delete an existing relationship\r
++++++++++++++++++++++++++++++++\r
+\r
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Interface Definition|Description                                                                                                                                                                                        |\r
++====================+===================================================================================================================================================================================================+\r
+|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|\r
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+|Operation Type      |DELETE                                                                                                                                                                                             |\r
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+\r
+\r
+Request Parameters:\r
+\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|Attribute          |Qualifier|Cardinality|Content|Description            |\r
++===================+=========+===========+=======+=======================+\r
+|global-customer-id |M        |1          |String |Global Customer ID     |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-type       |M        |1          |String |Service Type           |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+|service-instance-id|M        |1          |String |Service instance ID    |\r
++-------------------+---------+-----------+-------+-----------------------+\r
+\r
+Response:\r
+\r
++---------+---------+-----------+-------+-------------------+\r
+|Attribute|Qualifier|Cardinality|Content|Description        |\r
++---------+---------+-----------+-------+-------------------+\r
+|HTTP code|M        |1          |Integer|HTTP response code |\r
++---------+---------+-----------+-------+-------------------+
\ No newline at end of file