mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
[rackspace|block_storage] updated yard docs for requests
This commit is contained in:
Kyle Rames
parent
fb788279e1
commit
dd2cc108ae
8 changed files with 80 additions and 80 deletions
|
|
@ -11,15 +11,15 @@ module Fog
|
|||
# @option options [String] :display_description display description for snapshot
|
||||
# @option options [Boolean] :force Set to true to force service to create snapshot
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'snapshot'<~Hash>:
|
||||
# * 'volume_id'<~String>: - the volume_id of the snapshot
|
||||
# * 'display_description'<~String>: - display description of snapshot
|
||||
# * 'status'<~String>: - status of snapshot
|
||||
# * 'id'<~String>: - id of snapshot
|
||||
# * 'size'<~Fixnum>: - size of the snapshot in GB
|
||||
# * 'display_name'<~String>: - display name of snapshot
|
||||
# * 'created_at'<~String>: - creation time of snapshot
|
||||
# * body [Hash]:
|
||||
# * 'snapshot' [Hash]:
|
||||
# * 'volume_id' [String]: - the volume_id of the snapshot
|
||||
# * 'display_description' [String]: - display description of snapshot
|
||||
# * 'status' [String]: - status of snapshot
|
||||
# * 'id' [String]: - id of snapshot
|
||||
# * 'size' [Fixnum]: - size of the snapshot in GB
|
||||
# * 'display_name' [String]: - display name of snapshot
|
||||
# * 'created_at' [String]: - creation time of snapshot
|
||||
# @note All writes to the volume should be flushed before creating the snapshot, either by un-mounting any file systems on the volume or by detaching the volume.
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/POST_createSnapshot__v1__tenant_id__snapshots.html
|
||||
def create_snapshot(volume_id, options = {})
|
||||
|
|
|
|||
|
|
@ -12,19 +12,19 @@ module Fog
|
|||
# @option options [String] :volume_type type of volume
|
||||
# @option options [String] :snapshot_id The optional snapshot from which to create a volume.
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'volume'<~Hash>:
|
||||
# * 'volume_type'<~String>: - type of volume
|
||||
# * 'display_description'<~String>: - volume description
|
||||
# * 'metadata'<~Hash>: - volume metadata
|
||||
# * 'availability_zone'<~String>: - region of the volume
|
||||
# * 'status'<~String>: - status of volume
|
||||
# * 'id'<~String>: - id of volume
|
||||
# * 'attachments'<~Array<Hash>: - array of hashes containing attachment information
|
||||
# * 'size'<~Fixnum>: - size of volume in GB (100 GB minimum)
|
||||
# * 'snapshot_id'<~String>: - The optional snapshot from which to create a volume.
|
||||
# * 'display_name'<~String>: - display name of volume
|
||||
# * 'created_at'<~String>: - the volume creation time
|
||||
# * body [Hash]:
|
||||
# * 'volume' [Hash]:
|
||||
# * 'volume_type' [String]: - type of volume
|
||||
# * 'display_description' [String]: - volume description
|
||||
# * 'metadata' [Hash]: - volume metadata
|
||||
# * 'availability_zone'[String]: - region of the volume
|
||||
# * 'status' [String]: - status of volume
|
||||
# * 'id' [String]: - id of volume
|
||||
# * 'attachments' [Array<Hash]: - array of hashes containing attachment information
|
||||
# * 'size' [Fixnum]: - size of volume in GB (100 GB minimum)
|
||||
# * 'snapshot_id' [String]: - The optional snapshot from which to create a volume.
|
||||
# * 'display_name' [String]: - display name of volume
|
||||
# * 'created_at' [String]: - the volume creation time
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/POST_createVolume__v1__tenant_id__volumes.html
|
||||
def create_volume(size, options = {})
|
||||
data = {
|
||||
|
|
|
|||
|
|
@ -6,17 +6,17 @@ module Fog
|
|||
# Retrieves snapshot detail
|
||||
# @param [String] snapshot_id
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'snapshot'<~Hash>:
|
||||
# * 'volume_id'<~String>: - volume_id of the snapshot
|
||||
# * 'display_description'<~String>: - snapshot display description
|
||||
# * 'status'<~String>: - snapshot status
|
||||
# * 'os-extended-snapshot-attributes:project_id'<~String>: -
|
||||
# * 'id'<~String>: - snapshot id
|
||||
# * 'size'<~Fixnum>: - size of the snapshot in GB
|
||||
# * 'os-extended-snapshot-attributes:progress'<~String>: -
|
||||
# * 'display_name'<~String>: - display name of snapshot
|
||||
# * 'created_at'<~String>: - creation time of snapshot
|
||||
# * body [Hash]:
|
||||
# * 'snapshot' [Hash]:
|
||||
# * 'volume_id' [String]: - volume_id of the snapshot
|
||||
# * 'display_description' [String]: - snapshot display description
|
||||
# * 'status' [String]: - snapshot status
|
||||
# * 'os-extended-snapshot-attributes:project_id' [String]: -
|
||||
# * 'id' [String]: - snapshot id
|
||||
# * 'size' [Fixnum]: - size of the snapshot in GB
|
||||
# * 'os-extended-snapshot-attributes:progress' [String]: -
|
||||
# * 'display_name' [String]: - display name of snapshot
|
||||
# * 'created_at' [String]: - creation time of snapshot
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getSnapshot__v1__tenant_id__snapshots.html
|
||||
def get_snapshot(snapshot_id)
|
||||
request(
|
||||
|
|
|
|||
|
|
@ -6,21 +6,21 @@ module Fog
|
|||
# Retrieves volume detail
|
||||
# @param [String] volume_id
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'volume'<~Hash>:
|
||||
# * 'volume_type'<~String>: - volume type
|
||||
# * 'display_description'<~String>: - volume display description
|
||||
# * 'metadata'<~Hash>: - volume metadata
|
||||
# * 'availability_zone'<~String>: - region of volume
|
||||
# * 'status'<~String>: - status of volume
|
||||
# * 'id'<~String>: - id of volume
|
||||
# * 'attachments'<~Array<Hash>: - array of hashes containing attachment information
|
||||
# * 'size'<~Fixnum>: - size of volume in GB (100 GB minimum)
|
||||
# * 'snapshot_id'<~String>: - The optional snapshot from which to create a volume.
|
||||
# * 'os-vol-host-attr:host'<~String>: -
|
||||
# * 'display_name'<~String>: - display name of volume
|
||||
# * 'created_at'<~String>: - the volume creation time
|
||||
# * 'os-vol-tenant-attr:tenant_id'<~String>: -
|
||||
# * body [Hash]:
|
||||
# * 'volume' [Hash]:
|
||||
# * 'volume_type' [String]: - volume type
|
||||
# * 'display_description' [String]: - volume display description
|
||||
# * 'metadata' [Hash]: - volume metadata
|
||||
# * 'availability_zone' [String]: - region of volume
|
||||
# * 'status' [String]: - status of volume
|
||||
# * 'id' [String]: - id of volume
|
||||
# * 'attachments' [Array<Hash]: - array of hashes containing attachment information
|
||||
# * 'size' [Fixnum]: - size of volume in GB (100 GB minimum)
|
||||
# * 'snapshot_id' [String]: - The optional snapshot from which to create a volume.
|
||||
# * 'os-vol-host-attr:host' [String]: -
|
||||
# * 'display_name' [String]: - display name of volume
|
||||
# * 'created_at' [String]: - the volume creation time
|
||||
# * 'os-vol-tenant-attr:tenant_id' [String]: -
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolume__v1__tenant_id__volumes.html
|
||||
def get_volume(volume_id)
|
||||
request(
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ module Fog
|
|||
# Retrieves volume type detail
|
||||
# @param [String] volume_type_id
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'volume_type'<~Hash>: -
|
||||
# * 'name'<~String>: - name of volume type
|
||||
# * 'extra_specs'<~Hash>: -
|
||||
# * 'id'<~String>: - id of volume type
|
||||
# * body [Hash]:
|
||||
# * 'volume_type' [Hash]: -
|
||||
# * 'name' [String]: - name of volume type
|
||||
# * 'extra_specs' [Hash]: -
|
||||
# * 'id' [String]: - id of volume type
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolumeType__v1__tenant_id__types.html
|
||||
def get_volume_type(volume_type_id)
|
||||
request(
|
||||
|
|
|
|||
|
|
@ -5,15 +5,15 @@ module Fog
|
|||
|
||||
# Retrieves list of snapshots
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'snapshots'<~Array>: -
|
||||
# * 'volume_id'<~String>: - volume_id of the snapshot
|
||||
# * 'display_description'<~String>: - display description of snapshot
|
||||
# * 'status'<~String>: - status of snapshot
|
||||
# * 'id'<~String>: - id of snapshot
|
||||
# * 'size'<~Fixnum>: - size of the snapshot in GB
|
||||
# * 'display_name'<~String>: - display name of snapshot
|
||||
# * 'created_at'<~String>: - creation time of snapshot
|
||||
# * body [Hash]:
|
||||
# * 'snapshots' [Array]: -
|
||||
# * 'volume_id' [String]: - volume_id of the snapshot
|
||||
# * 'display_description' [String]: - display description of snapshot
|
||||
# * 'status' [String]: - status of snapshot
|
||||
# * 'id' [String]: - id of snapshot
|
||||
# * 'size' [Fixnum]: - size of the snapshot in GB
|
||||
# * 'display_name' [String]: - display name of snapshot
|
||||
# * 'created_at' [String]: - creation time of snapshot
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getSnapshotsSimple__v1__tenant_id__snapshots.html
|
||||
def list_snapshots
|
||||
request(
|
||||
|
|
|
|||
|
|
@ -5,11 +5,11 @@ module Fog
|
|||
|
||||
# Retrieves list of volume types
|
||||
# @return [Excon::Response] response
|
||||
# * body<~Hash>:
|
||||
# * 'volume_types'<~Array>: -
|
||||
# * 'name'<~String>: - name of volume type
|
||||
# * 'extra_specs'<~Hash>: -
|
||||
# * 'id'<~Fixnum>: - id of volume type
|
||||
# * body [Hash]:
|
||||
# * 'volume_types' [Array]: -
|
||||
# * 'name' [String]: - name of volume type
|
||||
# * 'extra_specs' [Hash]: -
|
||||
# * 'id' [Fixnum]: - id of volume type
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolumeTypes__v1__tenant_id__types.html
|
||||
def list_volume_types
|
||||
request(
|
||||
|
|
|
|||
|
|
@ -5,19 +5,19 @@ module Fog
|
|||
|
||||
# Retrieves list of volumes
|
||||
# @return [Excon::Response] response:
|
||||
# * body<~Hash>:
|
||||
# * 'volumes'<~Array>: -
|
||||
# * 'volume_type'<~String>: - volume type
|
||||
# * 'display_description'<~String>: - display desciption for volume
|
||||
# * 'metadata'<~Hash>: - metadata for volume
|
||||
# * 'availability_zone'<~String>: - region for volume
|
||||
# * 'status'<~String>: - status of volume
|
||||
# * 'id'<~String>: - id of volume
|
||||
# * 'attachments'<~Array>: - array of hashes containing attachment information
|
||||
# * 'size'<~Fixnum>: - size of volume in GB (100 GB minimum)
|
||||
# * 'snapshot_id'<~String>: - optional snapshot from which to create a volume.
|
||||
# * 'display_name'<~String>: - display name of bolume
|
||||
# * 'created_at'<~String>: - volume creation time
|
||||
# * body [Hash]:
|
||||
# * 'volumes' [Array]: -
|
||||
# * 'volume_type' [String]: - volume type
|
||||
# * 'display_description' [String]: - display desciption for volume
|
||||
# * 'metadata' [Hash]: - metadata for volume
|
||||
# * 'availability_zone' [String]: - region for volume
|
||||
# * 'status' [String]: - status of volume
|
||||
# * 'id' [String]: - id of volume
|
||||
# * 'attachments' [Array]: - array of hashes containing attachment information
|
||||
# * 'size' [Fixnum]: - size of volume in GB (100 GB minimum)
|
||||
# * 'snapshot_id' [String]: - optional snapshot from which to create a volume.
|
||||
# * 'display_name' [String]: - display name of bolume
|
||||
# * 'created_at' [String]: - volume creation time
|
||||
# @see http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/GET_getVolumesSimple__v1__tenant_id__volumes.html
|
||||
def list_volumes
|
||||
request(
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue