Merge pull request #52 from oracle/release_2018-04-05

Releasing version 1.3.18

CHANGELOG.rst

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
+====================
+1.3.18 - 2018-04-05
+====================
+
+Added
+-----
+* Added Python 3.6 as a supported Python version
+
+Fixed
+------
+* Python API reference documentation improvements
+
+
 ====================
 1.3.17 - 2018-03-26
 ====================

README-development.rst

@@ -21,12 +21,12 @@ __ https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm
 
 Running Tests
 =============
-The SDK uses `pytest` as its test framework. You can run tests against Python 2.7 Python 3.5 using the `tox` command. Note that this requires that you have those versions of Python installed, 
+The SDK uses `pytest` as its test framework. You can run tests against Python 2.7, Python 3.5 and Python 3.6 using the `tox` command. Note that this requires that you have those versions of Python installed, 
 otherwise you must pass `-e` or run tests directly:
 
 .. code-block:: sh
 
-    # This will run tests against all configured Pythons in tox.ini (currently 2.7 and 3.5). You need to have those versions installed
+    # This will run tests against all configured Pythons in tox.ini (currently 2.7, 3.5 and 3.6). You need to have those versions installed
     tox
 
     # This will run tests against a specific Python versions

docs/_templates/autosummary/model_class.rst

@@ -0,0 +1,10 @@
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}
+    :show-inheritance:
+    :special-members: __init__
+    :members:
+    :undoc-members:
+    :inherited-members:

docs/_templates/autosummary/service_client.rst

@@ -0,0 +1,34 @@
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: operations
+      :nosignatures:
+      :template: autosummary/service_operation.rst
+   {% for item in methods %}
+      {% if item != "__init__" %}
+      ~{{ name }}.{{ item }}
+      {% endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/_templates/autosummary/service_operation.rst

@@ -0,0 +1,5 @@
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}

docs/api/audit.rst

@@ -0,0 +1,22 @@
+Audit 
+=====
+
+.. autosummary::
+    :toctree: audit/client
+    :nosignatures:
+    :template: autosummary/service_client.rst
+
+    oci.audit.AuditClient
+
+--------
+ Models
+--------
+
+.. autosummary::
+    :toctree: audit/models
+    :nosignatures:
+    :template: autosummary/model_class.rst
+
+    oci.audit.models.AuditEvent
+    oci.audit.models.Configuration
+    oci.audit.models.UpdateConfigurationDetails

docs/api/config.rst

@@ -0,0 +1,15 @@
+========
+ Config
+========
+
+.. module:: oci.config
+
+.. autofunction:: from_file
+
+.. autofunction:: validate_config
+
+.. module:: oci.regions
+
+.. autofunction:: is_region
+
+.. autofunction:: endpoint_for

docs/api/core.rst

@@ -0,0 +1,154 @@
+Core Services 
+=============
+
+.. autosummary::
+    :toctree: core/client
+    :nosignatures:
+    :template: autosummary/service_client.rst
+
+    oci.core.BlockstorageClient
+    oci.core.ComputeClient
+    oci.core.VirtualNetworkClient
+
+--------
+ Models
+--------
+
+.. autosummary::
+    :toctree: core/models
+    :nosignatures:
+    :template: autosummary/model_class.rst
+
+    oci.core.models.AttachBootVolumeDetails
+    oci.core.models.AttachIScsiVolumeDetails
+    oci.core.models.AttachParavirtualizedVolumeDetails
+    oci.core.models.AttachVnicDetails
+    oci.core.models.AttachVolumeDetails
+    oci.core.models.BootVolume
+    oci.core.models.BootVolumeAttachment
+    oci.core.models.BulkAddVirtualCircuitPublicPrefixesDetails
+    oci.core.models.BulkDeleteVirtualCircuitPublicPrefixesDetails
+    oci.core.models.CaptureConsoleHistoryDetails
+    oci.core.models.ConnectLocalPeeringGatewaysDetails
+    oci.core.models.ConnectRemotePeeringConnectionsDetails
+    oci.core.models.ConsoleHistory
+    oci.core.models.Cpe
+    oci.core.models.CreateCpeDetails
+    oci.core.models.CreateCrossConnectDetails
+    oci.core.models.CreateCrossConnectGroupDetails
+    oci.core.models.CreateDhcpDetails
+    oci.core.models.CreateDrgAttachmentDetails
+    oci.core.models.CreateDrgDetails
+    oci.core.models.CreateIPSecConnectionDetails
+    oci.core.models.CreateImageDetails
+    oci.core.models.CreateInstanceConsoleConnectionDetails
+    oci.core.models.CreateInternetGatewayDetails
+    oci.core.models.CreateLocalPeeringGatewayDetails
+    oci.core.models.CreatePrivateIpDetails
+    oci.core.models.CreatePublicIpDetails
+    oci.core.models.CreateRemotePeeringConnectionDetails
+    oci.core.models.CreateRouteTableDetails
+    oci.core.models.CreateSecurityListDetails
+    oci.core.models.CreateSubnetDetails
+    oci.core.models.CreateVcnDetails
+    oci.core.models.CreateVirtualCircuitDetails
+    oci.core.models.CreateVirtualCircuitPublicPrefixDetails
+    oci.core.models.CreateVnicDetails
+    oci.core.models.CreateVolumeBackupDetails
+    oci.core.models.CreateVolumeBackupPolicyAssignmentDetails
+    oci.core.models.CreateVolumeDetails
+    oci.core.models.CrossConnect
+    oci.core.models.CrossConnectGroup
+    oci.core.models.CrossConnectLocation
+    oci.core.models.CrossConnectMapping
+    oci.core.models.CrossConnectPortSpeedShape
+    oci.core.models.CrossConnectStatus
+    oci.core.models.DeleteVirtualCircuitPublicPrefixDetails
+    oci.core.models.DhcpDnsOption
+    oci.core.models.DhcpOption
+    oci.core.models.DhcpOptions
+    oci.core.models.DhcpSearchDomainOption
+    oci.core.models.Drg
+    oci.core.models.DrgAttachment
+    oci.core.models.EgressSecurityRule
+    oci.core.models.ExportImageDetails
+    oci.core.models.ExportImageViaObjectStorageTupleDetails
+    oci.core.models.ExportImageViaObjectStorageUriDetails
+    oci.core.models.FastConnectProviderService
+    oci.core.models.GetPublicIpByIpAddressDetails
+    oci.core.models.GetPublicIpByPrivateIpIdDetails
+    oci.core.models.IPSecConnection
+    oci.core.models.IPSecConnectionDeviceConfig
+    oci.core.models.IPSecConnectionDeviceStatus
+    oci.core.models.IScsiVolumeAttachment
+    oci.core.models.IcmpOptions
+    oci.core.models.Image
+    oci.core.models.ImageSourceDetails
+    oci.core.models.ImageSourceViaObjectStorageTupleDetails
+    oci.core.models.ImageSourceViaObjectStorageUriDetails
+    oci.core.models.IngressSecurityRule
+    oci.core.models.Instance
+    oci.core.models.InstanceConsoleConnection
+    oci.core.models.InstanceCredentials
+    oci.core.models.InstanceSourceDetails
+    oci.core.models.InstanceSourceViaBootVolumeDetails
+    oci.core.models.InstanceSourceViaImageDetails
+    oci.core.models.InternetGateway
+    oci.core.models.LaunchInstanceDetails
+    oci.core.models.LaunchOptions
+    oci.core.models.LetterOfAuthority
+    oci.core.models.LocalPeeringGateway
+    oci.core.models.ParavirtualizedVolumeAttachment
+    oci.core.models.PeerRegionForRemotePeering
+    oci.core.models.PortRange
+    oci.core.models.PrivateIp
+    oci.core.models.PublicIp
+    oci.core.models.RemotePeeringConnection
+    oci.core.models.RouteRule
+    oci.core.models.RouteTable
+    oci.core.models.SecurityList
+    oci.core.models.Shape
+    oci.core.models.Subnet
+    oci.core.models.TcpOptions
+    oci.core.models.TunnelConfig
+    oci.core.models.TunnelStatus
+    oci.core.models.UdpOptions
+    oci.core.models.UpdateBootVolumeDetails
+    oci.core.models.UpdateConsoleHistoryDetails
+    oci.core.models.UpdateCpeDetails
+    oci.core.models.UpdateCrossConnectDetails
+    oci.core.models.UpdateCrossConnectGroupDetails
+    oci.core.models.UpdateDhcpDetails
+    oci.core.models.UpdateDrgAttachmentDetails
+    oci.core.models.UpdateDrgDetails
+    oci.core.models.UpdateIPSecConnectionDetails
+    oci.core.models.UpdateImageDetails
+    oci.core.models.UpdateInstanceDetails
+    oci.core.models.UpdateInternetGatewayDetails
+    oci.core.models.UpdateLocalPeeringGatewayDetails
+    oci.core.models.UpdatePrivateIpDetails
+    oci.core.models.UpdatePublicIpDetails
+    oci.core.models.UpdateRemotePeeringConnectionDetails
+    oci.core.models.UpdateRouteTableDetails
+    oci.core.models.UpdateSecurityListDetails
+    oci.core.models.UpdateSubnetDetails
+    oci.core.models.UpdateVcnDetails
+    oci.core.models.UpdateVirtualCircuitDetails
+    oci.core.models.UpdateVnicDetails
+    oci.core.models.UpdateVolumeBackupDetails
+    oci.core.models.UpdateVolumeDetails
+    oci.core.models.Vcn
+    oci.core.models.VirtualCircuit
+    oci.core.models.VirtualCircuitBandwidthShape
+    oci.core.models.VirtualCircuitPublicPrefix
+    oci.core.models.Vnic
+    oci.core.models.VnicAttachment
+    oci.core.models.Volume
+    oci.core.models.VolumeAttachment
+    oci.core.models.VolumeBackup
+    oci.core.models.VolumeBackupPolicy
+    oci.core.models.VolumeBackupPolicyAssignment
+    oci.core.models.VolumeBackupSchedule
+    oci.core.models.VolumeSourceDetails
+    oci.core.models.VolumeSourceFromVolumeBackupDetails
+    oci.core.models.VolumeSourceFromVolumeDetails

docs/api/database.rst

@@ -0,0 +1,56 @@
+Database 
+========
+
+.. autosummary::
+    :toctree: database/client
+    :nosignatures:
+    :template: autosummary/service_client.rst
+
+    oci.database.DatabaseClient
+
+--------
+ Models
+--------
+
+.. autosummary::
+    :toctree: database/models
+    :nosignatures:
+    :template: autosummary/model_class.rst
+
+    oci.database.models.Backup
+    oci.database.models.BackupSummary
+    oci.database.models.CreateBackupDetails
+    oci.database.models.CreateDataGuardAssociationDetails
+    oci.database.models.CreateDataGuardAssociationToExistingDbSystemDetails
+    oci.database.models.CreateDatabaseDetails
+    oci.database.models.CreateDatabaseFromBackupDetails
+    oci.database.models.CreateDbHomeDetails
+    oci.database.models.CreateDbHomeWithDbSystemIdBase
+    oci.database.models.CreateDbHomeWithDbSystemIdDetails
+    oci.database.models.CreateDbHomeWithDbSystemIdFromBackupDetails
+    oci.database.models.DataGuardAssociation
+    oci.database.models.DataGuardAssociationSummary
+    oci.database.models.Database
+    oci.database.models.DatabaseSummary
+    oci.database.models.DbBackupConfig
+    oci.database.models.DbHome
+    oci.database.models.DbHomeSummary
+    oci.database.models.DbNode
+    oci.database.models.DbNodeSummary
+    oci.database.models.DbSystem
+    oci.database.models.DbSystemShapeSummary
+    oci.database.models.DbSystemSummary
+    oci.database.models.DbVersionSummary
+    oci.database.models.FailoverDataGuardAssociationDetails
+    oci.database.models.LaunchDbSystemDetails
+    oci.database.models.Patch
+    oci.database.models.PatchDetails
+    oci.database.models.PatchHistoryEntry
+    oci.database.models.PatchHistoryEntrySummary
+    oci.database.models.PatchSummary
+    oci.database.models.ReinstateDataGuardAssociationDetails
+    oci.database.models.RestoreDatabaseDetails
+    oci.database.models.SwitchoverDataGuardAssociationDetails
+    oci.database.models.UpdateDatabaseDetails
+    oci.database.models.UpdateDbHomeDetails
+    oci.database.models.UpdateDbSystemDetails

docs/api/dns.rst

@@ -0,0 +1,36 @@
+DNS 
+===
+
+.. autosummary::
+    :toctree: dns/client
+    :nosignatures:
+    :template: autosummary/service_client.rst
+
+    oci.dns.DnsClient
+
+--------
+ Models
+--------
+
+.. autosummary::
+    :toctree: dns/models
+    :nosignatures:
+    :template: autosummary/model_class.rst
+
+    oci.dns.models.CreateZoneDetails
+    oci.dns.models.ExternalMaster
+    oci.dns.models.PatchDomainRecordsDetails
+    oci.dns.models.PatchRRSetDetails
+    oci.dns.models.PatchZoneRecordsDetails
+    oci.dns.models.RRSet
+    oci.dns.models.Record
+    oci.dns.models.RecordCollection
+    oci.dns.models.RecordDetails
+    oci.dns.models.RecordOperation
+    oci.dns.models.TSIG
+    oci.dns.models.UpdateDomainRecordsDetails
+    oci.dns.models.UpdateRRSetDetails
+    oci.dns.models.UpdateZoneDetails
+    oci.dns.models.UpdateZoneRecordsDetails
+    oci.dns.models.Zone
+    oci.dns.models.ZoneSummary