Code Review / so.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Fix API documentation for UUI req
[so.git] / docs / SO_R1_Interface.rst
diff --git a/docs/SO_R1_Interface.rst b/docs/SO_R1_Interface.rst
index df68005..561a087 100644 (file)
--- a/docs/SO_R1_Interface.rst
+++ b/docs/SO_R1_Interface.rst
@@ -2,13 +2,13 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2017 Huawei Technologies Co., Ltd.
 
-SO Amsterdam Interfaces
-================
+SO Interfaces
+================================
 
 .. image:: images/SO_R1_1.png
 
 SO APIs
-============
+=================================
 
 North Bound APIs
 ----------------
@@ -197,6 +197,7 @@ Platform Object
 +-------------------------+------------------+-------------------------------------------------+
 
 LineOfBusiness Object
+
 +-------------------------+------------------+-------------------------------------------------+
 |Attribute                |Content           |Description                                      |
 +=========================+==================+=================================================+
@@ -1025,7 +1026,7 @@ Request Object
 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 +===================+=========+===========+==========================+===========================================+
-|requestId          |M        |1          |String                    |Request Id                                 |
+|requestId          |M        |1          |String                    |Request Id.                                |
 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 |startTime          |M        |1          |request Object            |Start time.                                |
 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -1767,50 +1768,69 @@ 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                                 |
-+----------------+------------------+-------------------------------------------------+
++------------------------------+-----------------+------------------------------------+
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|name                          |String           |Service instance name.              |
++------------------------------+-----------------+------------------------------------+
+|description                   |String           |Service instance description        |
++------------------------------+-----------------+------------------------------------+
+|serviceUuid                   |String           |Model UUID                          |
++------------------------------+-----------------+------------------------------------+
+|serviceInvariantUuid          |String           |Model Invariant UUID                |
++------------------------------+-----------------+------------------------------------+
+|gloabalSubscriberId           |String           |Customer Id                         |
++------------------------------+-----------------+------------------------------------+
+|serviceType                   |String           |service Type                        |
++------------------------------+-----------------+------------------------------------+
+|parameters                    |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                         |
++==============================+=================+====================================+
+|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             |
++------------------------------+-----------------+------------------------------------+
+
+VnfLocationConstraint Object
+
++------------------------------+-----------------+------------------------------------+
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|vimId                         |String           |VIM id from ESR definition          |
++------------------------------+-----------------+------------------------------------+
+
+Resource Object
+
++------------------------------+-----------------+------------------------------------+
+|Attribute                     |Content          |Description                         |
++==============================+=================+====================================+
+|resourceName                  |String           |The resource name                   |
++------------------------------+-----------------+------------------------------------+
+|resourceInvariantUuid         |String           |The resource invariant UUID.        |
++------------------------------+-----------------+------------------------------------+
+|resourceUuid                  |String           |The resource UUID.                  |
++------------------------------+-----------------+------------------------------------+
+|resourceCustomizationUuid     |String           |The resource customization UUID.    |
++------------------------------+-----------------+------------------------------------+
+|parameters                    |Object           |Parameter of resource               |
++------------------------------+-----------------+------------------------------------+
 
 Response:
 
@@ -1983,6 +2003,10 @@ Request Parameters:
 +-------------------+---------+-----------+-------+-----------------------+
 |service-type       |M        |1          |String |Service Type           |
 +-------------------+---------+-----------+-------+-----------------------+
+|subscriber-name    |O        |1          |String |Subscriber name        |
++-------------------+---------+-----------+-------+-----------------------+
+|subscriber-type    |O        |1          |String |Subscriber type        |
++-------------------+---------+-----------+-------+-----------------------+
 
 Response:
 
@@ -2568,7 +2592,7 @@ https://developer.openstack.org/api-ref/compute/#create-server
 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
 |Interface Definition|Description                                                                                                            |
 +====================+=======================================================================================================================+
-|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers                       |
+|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.37/{tenant_id}/servers                      |
 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
 |Operation Type      |POST                                                                                                                   |
 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
@@ -2652,6 +2676,8 @@ Response:
 +-------------------------+------------------+------------------------------------------------------------------------------+
 |Attribute                |Content           |Description                                                                   |
 +=========================+==================+==============================================================================+
+|Location                 |String            |The location URL of the server.                                               |
++-------------------------+------------------+------------------------------------------------------------------------------+
 |server                   |object            |A server object.                                                              |
 +-------------------------+------------------+------------------------------------------------------------------------------+
 |id                       |String            |The UUID of the server.                                                       |
@@ -2820,6 +2846,10 @@ Request Body:
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
+|is_default                  |O        |1          |boolean                   |The network is default or not.                                                                   |
++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
+|availability_zone_hints     |O        |1          |array                     |The availability zone candidate for the network.                                                 |
++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 
 Response:
 
@@ -2834,10 +2864,16 @@ Response:
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |availability_zones           |array             |The availability zone for the network.                                        |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|created_at                   |String            |Time at which the resource has been created (in UTC ISO8601 format).          |
++-----------------------------+------------------+------------------------------------------------------------------------------+
 |dns_domain                   |String            |A valid DNS domain.                                                           |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |id                           |String            |The ID of the network.                                                        |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|ipv4_address_scope           |String            |The ID of the IPv4 address scope that the network is associated with.         |
++-----------------------------+------------------+------------------------------------------------------------------------------+
+|ipv6_address_scope           |String            |The ID of the IPv6 address scope that the network is associated with.         |
++-----------------------------+------------------+------------------------------------------------------------------------------+
 |mtu                          |integer           |The maximum transmission unit (MTU) value to address fragmentation.           |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |name                         |String            |Human-readable name of the network.                                           |
@@ -2868,10 +2904,14 @@ Response:
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |tenant_id                    |String            |The ID of the project.                                                        |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|updated_at                   |String            |Time at which the resource has been updated (in UTC ISO8601 format).          |
++-----------------------------+------------------+------------------------------------------------------------------------------+
 |vlan_transparent             |boolean           |Indicates the VLAN transparency mode of the network.                          |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |description                  |String            |A human-readable description for the resource.                                |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|is_default                   |boolean           |The network is default pool or not.                                           |
++-----------------------------+------------------+------------------------------------------------------------------------------+
 
 Delete Network
 +++++++++++++++
@@ -2893,7 +2933,7 @@ Request Body:
 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
 +============================+=========+===========+==========================+==============================================================+
-|network_id                  |M        |1          |Object                    |The ID of the network.                                        |
+|network_id                  |M        |1          |String                    |The ID of the network.                                        |
 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
 
 Create Subnet
@@ -2952,6 +2992,8 @@ Request Body:
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 |use_default_subnetpool      |O        |1          |boolean                   |Whether to allocate this subnet from the default subnet pool.                                    |
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
+|service_types               |O        |1          |array                     |The service types associated with the subnet.                                                    |
++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 
 Response:
 
@@ -3082,6 +3124,8 @@ Request Body:
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
+|qos_policy_id               |O        |1          |string                    |QoS policy associated with the port.                                                             |
++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 |security_groups             |O        |1          |array                     |The IDs of security groups applied to the port.                                                  |
 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
@@ -3130,6 +3174,8 @@ Response:
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |id                           |string            |The ID of the resource.                                                       |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|ip_allocation                |string            |Indicates when ports use either deferred, immediate or no IP allocation (none)|
++-----------------------------+------------------+------------------------------------------------------------------------------+
 |mac_address                  |string            |The MAC address of the port.                                                  |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |name                         |string            |Human-readable name of the resource.                                          |
@@ -3142,6 +3188,8 @@ Response:
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |revision_number              |integer           |The revision number of the resource.                                          |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|qos_policy_id                |string            |The ID of the QoS policy associated with the port.                            |
++-----------------------------+------------------+------------------------------------------------------------------------------+
 |security_groups              |array             |The IDs of security groups applied to the port.                               |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |status                       |string            |The port status. Values are ACTIVE, DOWN, BUILD and ERROR.                    |
@@ -3218,6 +3266,10 @@ Response:
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |project_id                   |string            |The ID of the project.                                                        |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
+|created_at                   |string            |Time at which the resource has been created (in UTC ISO8601 format).          |
++-----------------------------+------------------+------------------------------------------------------------------------------+
+|updated_at                   |string            |Time at which the resource has been updated (in UTC ISO8601 format).          |
++-----------------------------+------------------+------------------------------------------------------------------------------+
 |revision_number              |integer           |The revision number of the resource.                                          |
 +-----------------------------+------------------+------------------------------------------------------------------------------+
 |name                         |string            |Human-readable name of the resource.                                          |
Service Orchestrator