Skip to content

Add model docs and links to model docs, Add return types, Fixup format #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 22, 2017
Merged

Add model docs and links to model docs, Add return types, Fixup format #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
699d750
Add model docs and links to model docs, Add return types, Fixup forma…
garthy Feb 14, 2017
198ca20
Merge branch 'master' into add_model_ref_and_fixup
briangustafson Mar 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ Virtual Network

.. autofunction:: to_dict

.. autoclass:: Sentinel
.. autoclass:: Sentinel
10 changes: 10 additions & 0 deletions oraclebmc/core/blockstorage_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ def create_volume(self, create_volume_details, **kwargs):
may be rejected).

:return: A Response object with data of type Volume
:rtype: Volume
"""
resource_path = "/volumes"
method = "POST"
Expand Down Expand Up @@ -110,6 +111,7 @@ def create_volume_backup(self, create_volume_backup_details, **kwargs):
may be rejected).

:return: A Response object with data of type VolumeBackup
:rtype: VolumeBackup
"""
resource_path = "/volumeBackups"
method = "POST"
Expand Down Expand Up @@ -157,6 +159,7 @@ def delete_volume(self, volume_id, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type None
:rtype: None
"""
resource_path = "/volumes/{volumeId}"
method = "DELETE"
Expand Down Expand Up @@ -203,6 +206,7 @@ def delete_volume_backup(self, volume_backup_id, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type None
:rtype: None
"""
resource_path = "/volumeBackups/{volumeBackupId}"
method = "DELETE"
Expand Down Expand Up @@ -244,6 +248,7 @@ def get_volume(self, volume_id, **kwargs):
The OCID of the volume.

:return: A Response object with data of type Volume
:rtype: Volume
"""
resource_path = "/volumes/{volumeId}"
method = "GET"
Expand Down Expand Up @@ -279,6 +284,7 @@ def get_volume_backup(self, volume_backup_id, **kwargs):
The OCID of the volume backup.

:return: A Response object with data of type VolumeBackup
:rtype: VolumeBackup
"""
resource_path = "/volumeBackups/{volumeBackupId}"
method = "GET"
Expand Down Expand Up @@ -325,6 +331,7 @@ def list_volume_backups(self, compartment_id, **kwargs):
The value of the `opc-next-page` response header from the previous \"List\" call.

:return: A Response object with data of type list[VolumeBackup]
:rtype: list[VolumeBackup]
"""
resource_path = "/volumeBackups"
method = "GET"
Expand Down Expand Up @@ -383,6 +390,7 @@ def list_volumes(self, compartment_id, **kwargs):
The value of the `opc-next-page` response header from the previous \"List\" call.

:return: A Response object with data of type list[Volume]
:rtype: list[Volume]
"""
resource_path = "/volumes"
method = "GET"
Expand Down Expand Up @@ -436,6 +444,7 @@ def update_volume(self, volume_id, update_volume_details, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type Volume
:rtype: Volume
"""
resource_path = "/volumes/{volumeId}"
method = "PUT"
Expand Down Expand Up @@ -487,6 +496,7 @@ def update_volume_backup(self, volume_backup_id, update_volume_backup_details, *
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type VolumeBackup
:rtype: VolumeBackup
"""
resource_path = "/volumeBackups/{volumeBackupId}"
method = "PUT"
Expand Down
22 changes: 22 additions & 0 deletions oraclebmc/core/compute_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ def attach_volume(self, attach_volume_details, **kwargs):
may be rejected).

:return: A Response object with data of type VolumeAttachment
:rtype: VolumeAttachment
"""
resource_path = "/volumeAttachments/"
method = "POST"
Expand Down Expand Up @@ -103,6 +104,7 @@ def capture_console_history(self, capture_console_history_details, **kwargs):
may be rejected).

:return: A Response object with data of type ConsoleHistory
:rtype: ConsoleHistory
"""
resource_path = "/instanceConsoleHistories/"
method = "POST"
Expand Down Expand Up @@ -156,6 +158,7 @@ def create_image(self, create_image_details, **kwargs):
may be rejected).

:return: A Response object with data of type Image
:rtype: Image
"""
resource_path = "/images/"
method = "POST"
Expand Down Expand Up @@ -198,6 +201,7 @@ def delete_console_history(self, instance_console_history_id, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type None
:rtype: None
"""
resource_path = "/instanceConsoleHistories/{instanceConsoleHistoryId}"
method = "DELETE"
Expand Down Expand Up @@ -244,6 +248,7 @@ def delete_image(self, image_id, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type None
:rtype: None
"""
resource_path = "/images/{imageId}"
method = "DELETE"
Expand Down Expand Up @@ -293,6 +298,7 @@ def detach_volume(self, volume_attachment_id, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type None
:rtype: None
"""
resource_path = "/volumeAttachments/{volumeAttachmentId}"
method = "DELETE"
Expand Down Expand Up @@ -336,6 +342,7 @@ def get_console_history(self, instance_console_history_id, **kwargs):
The OCID of the console history.

:return: A Response object with data of type ConsoleHistory
:rtype: ConsoleHistory
"""
resource_path = "/instanceConsoleHistories/{instanceConsoleHistoryId}"
method = "GET"
Expand Down Expand Up @@ -379,6 +386,7 @@ def get_console_history_content(self, instance_console_history_id, **kwargs):
Length of the snapshot data to retrieve.

:return: A Response object with data of type bytes
:rtype: bytes
"""
resource_path = "/instanceConsoleHistories/{instanceConsoleHistoryId}/data"
method = "GET"
Expand Down Expand Up @@ -427,6 +435,7 @@ def get_image(self, image_id, **kwargs):
The OCID of the image.

:return: A Response object with data of type Image
:rtype: Image
"""
resource_path = "/images/{imageId}"
method = "GET"
Expand Down Expand Up @@ -462,6 +471,7 @@ def get_instance(self, instance_id, **kwargs):
The OCID of the instance.

:return: A Response object with data of type Instance
:rtype: Instance
"""
resource_path = "/instances/{instanceId}"
method = "GET"
Expand Down Expand Up @@ -497,6 +507,7 @@ def get_volume_attachment(self, volume_attachment_id, **kwargs):
The OCID of the volume attachment.

:return: A Response object with data of type VolumeAttachment
:rtype: VolumeAttachment
"""
resource_path = "/volumeAttachments/{volumeAttachmentId}"
method = "GET"
Expand Down Expand Up @@ -562,6 +573,7 @@ def instance_action(self, instance_id, action, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type Instance
:rtype: Instance
"""
resource_path = "/instances/{instanceId}"
method = "POST"
Expand Down Expand Up @@ -645,6 +657,7 @@ def launch_instance(self, launch_instance_details, **kwargs):
may be rejected).

:return: A Response object with data of type Instance
:rtype: Instance
"""
resource_path = "/instances/"
method = "POST"
Expand Down Expand Up @@ -698,6 +711,7 @@ def list_console_histories(self, compartment_id, **kwargs):
The OCID of the instance.

:return: A Response object with data of type list[ConsoleHistory]
:rtype: list[ConsoleHistory]
"""
resource_path = "/instanceConsoleHistories/"
method = "GET"
Expand Down Expand Up @@ -772,6 +786,7 @@ def list_images(self, compartment_id, **kwargs):
The value of the `opc-next-page` response header from the previous \"List\" call.

:return: A Response object with data of type list[Image]
:rtype: list[Image]
"""
resource_path = "/images/"
method = "GET"
Expand Down Expand Up @@ -841,6 +856,7 @@ def list_instances(self, compartment_id, **kwargs):
The value of the `opc-next-page` response header from the previous \"List\" call.

:return: A Response object with data of type list[Instance]
:rtype: list[Instance]
"""
resource_path = "/instances/"
method = "GET"
Expand Down Expand Up @@ -905,6 +921,7 @@ def list_shapes(self, compartment_id, **kwargs):
The OCID of an image.

:return: A Response object with data of type list[Shape]
:rtype: list[Shape]
"""
resource_path = "/shapes"
method = "GET"
Expand Down Expand Up @@ -972,6 +989,7 @@ def list_vnic_attachments(self, compartment_id, **kwargs):
The OCID of the VNIC.

:return: A Response object with data of type list[VnicAttachment]
:rtype: list[VnicAttachment]
"""
resource_path = "/vnicAttachments/"
method = "GET"
Expand Down Expand Up @@ -1043,6 +1061,7 @@ def list_volume_attachments(self, compartment_id, **kwargs):
The OCID of the volume.

:return: A Response object with data of type list[VolumeAttachment]
:rtype: list[VolumeAttachment]
"""
resource_path = "/volumeAttachments/"
method = "GET"
Expand Down Expand Up @@ -1101,6 +1120,7 @@ def terminate_instance(self, instance_id, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type None
:rtype: None
"""
resource_path = "/instances/{instanceId}"
method = "DELETE"
Expand Down Expand Up @@ -1157,6 +1177,7 @@ def update_image(self, image_id, update_image_details, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type Image
:rtype: Image
"""
resource_path = "/images/{imageId}"
method = "PUT"
Expand Down Expand Up @@ -1218,6 +1239,7 @@ def update_instance(self, instance_id, update_instance_details, **kwargs):
will be updated or deleted only if the etag you provide matches the resource's current etag value.

:return: A Response object with data of type Instance
:rtype: Instance
"""
resource_path = "/instances/{instanceId}"
method = "PUT"
Expand Down
Loading