aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/SO_R1_Interface.rst36
1 files changed, 34 insertions, 2 deletions
diff --git a/docs/SO_R1_Interface.rst b/docs/SO_R1_Interface.rst
index 78f354d367..8346e2b98c 100644
--- a/docs/SO_R1_Interface.rst
+++ b/docs/SO_R1_Interface.rst
@@ -1971,6 +1971,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:
@@ -2556,7 +2560,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 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
@@ -2640,6 +2644,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. |
@@ -2808,6 +2814,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:
@@ -2822,10 +2832,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. |
@@ -2856,10 +2872,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
+++++++++++++++
@@ -2881,7 +2901,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
@@ -2940,6 +2960,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:
@@ -3070,6 +3092,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. |
@@ -3118,6 +3142,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. |
@@ -3130,6 +3156,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. |
@@ -3206,6 +3234,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. |