Releasing version 2.0.3

Author: Art Hall

CHANGELOG.rst

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
+====================
+2.0.3 -2018-09-06
+====================
+
+Added
+-----
+* Added support for updating metadata fields on an instance in the Compute service
+
+Fixed
+-------
+* Fixed example wait_for_resource_in_state.py to use existing response objects.  The updated example can be found on `GitHub <https://github.com/oracle/oci-python-sdk/blob/master/examples/wait_for_resource_in_state.py>`__.
+
 ====================
 2.0.2 - 2018-08-23
 ====================

requirements.txt

@@ -7,6 +7,7 @@ mock==2.0.0
 pyOpenSSL==17.4.0
 pytest==3.2.3
 pytest-catchlog==1.2.2
+pytest-cov==2.5.1
 python-dateutil>=2.5.3,<=2.7.3
 pytz>=2016.10
 sphinx-rtd-theme==0.2.5b2

setup.py

@@ -30,7 +30,7 @@ def open_relative(*path):
 
 requires = [
     "certifi",
-    "configparser==3.5.0",
+    "configparser>=3.5.0b1",
     "cryptography>=2.1.3",
     "pyOpenSSL<=17.4.0",
     "python-dateutil>=2.5.3,<=2.7.3",

src/oci/core/blockstorage_client.py

@@ -236,11 +236,11 @@ def create_volume(self, create_volume_details, **kwargs):
         For general information about block volumes, see
         `Overview of Block Volume Service`__.
 
-        A volume and instance can be in separate compartments but must be in the same Availability Domain.
+        A volume and instance can be in separate compartments but must be in the same availability domain.
         For information about access control and compartments, see
         `Overview of the IAM Service`__. For information about
-        Availability Domains, see `Regions and Availability Domains`__.
-        To get a list of Availability Domains, use the `ListAvailabilityDomains` operation
+        availability domains, see `Regions and Availability Domains`__.
+        To get a list of availability domains, use the `ListAvailabilityDomains` operation
         in the Identity and Access Management Service API.
 
         You may optionally specify a *display name* for the volume, which is simply a friendly name or
@@ -1742,9 +1742,9 @@ def list_boot_volume_backups(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -1850,11 +1850,11 @@ def list_boot_volume_backups(self, compartment_id, **kwargs):
     def list_boot_volumes(self, availability_domain, compartment_id, **kwargs):
         """
         ListBootVolumes
-        Lists the boot volumes in the specified compartment and Availability Domain.
+        Lists the boot volumes in the specified compartment and availability domain.
 
 
         :param str availability_domain: (required)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2031,9 +2031,9 @@ def list_volume_backups(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -2168,9 +2168,9 @@ def list_volume_group_backups(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -2272,7 +2272,7 @@ def list_volume_groups(self, compartment_id, **kwargs):
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2293,9 +2293,9 @@ def list_volume_groups(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -2401,14 +2401,14 @@ def list_volume_groups(self, compartment_id, **kwargs):
     def list_volumes(self, compartment_id, **kwargs):
         """
         ListVolumes
-        Lists the volumes in the specified compartment and Availability Domain.
+        Lists the volumes in the specified compartment and availability domain.
 
 
         :param str compartment_id: (required)
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2429,9 +2429,9 @@ def list_volumes(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 

src/oci/core/compute_client.py

@@ -1820,16 +1820,16 @@ def instance_action(self, instance_id, action, **kwargs):
     def launch_instance(self, launch_instance_details, **kwargs):
         """
         LaunchInstance
-        Creates a new instance in the specified compartment and the specified Availability Domain.
+        Creates a new instance in the specified compartment and the specified availability domain.
         For general information about instances, see
         `Overview of the Compute Service`__.
 
         For information about access control and compartments, see
         `Overview of the IAM Service`__.
 
-        For information about Availability Domains, see
+        For information about availability domains, see
         `Regions and Availability Domains`__.
-        To get a list of Availability Domains, use the `ListAvailabilityDomains` operation
+        To get a list of availability domains, use the `ListAvailabilityDomains` operation
         in the Identity and Access Management Service API.
 
         All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned,
@@ -1929,7 +1929,7 @@ def list_boot_volume_attachments(self, availability_domain, compartment_id, **kw
 
 
         :param str availability_domain: (required)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2022,7 +2022,7 @@ def list_console_histories(self, compartment_id, **kwargs):
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2043,9 +2043,9 @@ def list_console_histories(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -2196,9 +2196,9 @@ def list_images(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -2391,7 +2391,7 @@ def list_instance_console_connections(self, compartment_id, **kwargs):
     def list_instances(self, compartment_id, **kwargs):
         """
         ListInstances
-        Lists the instances in the specified compartment and the specified Availability Domain.
+        Lists the instances in the specified compartment and the specified availability domain.
         You can filter the results by specifying an instance name (the list will include all the identically-named
         instances in the compartment).
 
@@ -2400,7 +2400,7 @@ def list_instances(self, compartment_id, **kwargs):
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2421,9 +2421,9 @@ def list_instances(self, compartment_id, **kwargs):
             sort order is case sensitive.
 
             **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
-            optionally filter by Availability Domain if the scope of the resource type is within a
-            single Availability Domain. If you call one of these \"List\" operations without specifying
-            an Availability Domain, the resources are grouped by Availability Domain, then sorted.
+            optionally filter by availability domain if the scope of the resource type is within a
+            single availability domain. If you call one of these \"List\" operations without specifying
+            an availability domain, the resources are grouped by availability domain, then sorted.
 
             Allowed values are: "TIMECREATED", "DISPLAYNAME"
 
@@ -2537,7 +2537,7 @@ def list_shapes(self, compartment_id, **kwargs):
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2618,14 +2618,14 @@ def list_vnic_attachments(self, compartment_id, **kwargs):
         ListVnicAttachments
         Lists the VNIC attachments in the specified compartment. A VNIC attachment
         resides in the same compartment as the attached instance. The list can be
-        filtered by instance, VNIC, or Availability Domain.
+        filtered by instance, VNIC, or availability domain.
 
 
         :param str compartment_id: (required)
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -2720,7 +2720,7 @@ def list_volume_attachments(self, compartment_id, **kwargs):
             The OCID of the compartment.
 
         :param str availability_domain: (optional)
-            The name of the Availability Domain.
+            The name of the availability domain.
 
             Example: `Uocm:PHX-AD-1`
 
@@ -3067,7 +3067,12 @@ def update_image(self, image_id, update_image_details, **kwargs):
     def update_instance(self, instance_id, update_instance_details, **kwargs):
         """
         UpdateInstance
-        Updates the display name of the specified instance. Avoid entering confidential information.
+        Updates certain fields on the specified instance. Fields that are not provided in the
+        request will not be updated. Avoid entering confidential information.
+
+        Changes to metadata fields will be reflected in the instance metadata service (this may take
+        up to a minute).
+
         The OCID of the instance remains the same.
 
 

src/oci/core/models/boot_volume.py

@@ -16,6 +16,9 @@ class BootVolume(object):
     talk to an administrator. If you're an administrator who needs to write policies to give users access, see
     `Getting Started with Policies`__.
 
+    **Warning:** Oracle recommends that you avoid using any confidential information when you
+    supply string values using the API.
+
     __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm
     __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm
     """
@@ -161,7 +164,7 @@ def __init__(self, **kwargs):
     def availability_domain(self):
         """
         **[Required]** Gets the availability_domain of this BootVolume.
-        The Availability Domain of the boot volume.
+        The availability domain of the boot volume.
 
         Example: `Uocm:PHX-AD-1`
 
@@ -175,7 +178,7 @@ def availability_domain(self):
     def availability_domain(self, availability_domain):
         """
         Sets the availability_domain of this BootVolume.
-        The Availability Domain of the boot volume.
+        The availability domain of the boot volume.
 
         Example: `Uocm:PHX-AD-1`
 
@@ -461,7 +464,7 @@ def size_in_mbs(self, size_in_mbs):
     def source_details(self):
         """
         Gets the source_details of this BootVolume.
-        The boot volume source, either an existing boot volume in the same Availability Domain or a boot volume backup.
+        The boot volume source, either an existing boot volume in the same availability domain or a boot volume backup.
         If null, this means that the boot volume was created from an image.
 
 
@@ -474,7 +477,7 @@ def source_details(self):
     def source_details(self, source_details):
         """
         Sets the source_details of this BootVolume.
-        The boot volume source, either an existing boot volume in the same Availability Domain or a boot volume backup.
+        The boot volume source, either an existing boot volume in the same availability domain or a boot volume backup.
         If null, this means that the boot volume was created from an image.
 
 

src/oci/core/models/boot_volume_attachment.py

@@ -10,6 +10,9 @@
 class BootVolumeAttachment(object):
     """
     Represents an attachment between a boot volume and an instance.
+
+    **Warning:** Oracle recommends that you avoid using any confidential information when you
+    supply string values using the API.
     """
 
     #: A constant which can be used with the lifecycle_state property of a BootVolumeAttachment.
@@ -103,7 +106,7 @@ def __init__(self, **kwargs):
     def availability_domain(self):
         """
         **[Required]** Gets the availability_domain of this BootVolumeAttachment.
-        The Availability Domain of an instance.
+        The availability domain of an instance.
 
         Example: `Uocm:PHX-AD-1`
 
@@ -117,7 +120,7 @@ def availability_domain(self):
     def availability_domain(self, availability_domain):
         """
         Sets the availability_domain of this BootVolumeAttachment.
-        The Availability Domain of an instance.
+        The availability domain of an instance.
 
         Example: `Uocm:PHX-AD-1`
 

src/oci/core/models/boot_volume_backup.py

@@ -17,6 +17,9 @@ class BootVolumeBackup(object):
     who needs to write policies to give users access, see `Getting Started with
     Policies`__.
 
+    **Warning:** Oracle recommends that you avoid using any confidential information when you
+    supply string values using the API.
+
     __ https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumebackups.htm
     __ https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm
     """