1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00

fix docs to show that Excon::Response is returned

This commit is contained in:
Wesley Beary 2009-11-02 18:48:49 -08:00
parent 41ace1cd2f
commit d6e857e52d
65 changed files with 65 additions and 65 deletions

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# Acquire an elastic IP address.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'publicIp'<~String> - The acquired address
# * 'requestId'<~String> - Id of the request

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# * public_ip<~String> - Public ip to assign to instance
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -12,7 +12,7 @@ unless Fog.mocking?
# * device<~String> - Specifies how the device is exposed to the instance (e.g. "/dev/sdh")
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'attachTime'<~Time> - Time of attachment was initiated at
# * 'device'<~String> - Device as it is exposed to the instance

View file

@ -19,7 +19,7 @@ unless Fog.mocking?
# * 'ToPort' - End of port range (or -1 for ICMP wildcard)
#
# === Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * key_name<~String> - Unique name for key pair.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'keyFingerprint'<~String> - SHA-1 digest of DER encoded private key
# * 'keyMaterial'<~String> - Unencrypted encoded PEM private key

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# * group_description<~String> - Description of group.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * volume_id<~String> - Id of EBS volume to snapshot
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'progress'<~String> - The percentage progress of the snapshot
# * 'requestId'<~String> - id of request

View file

@ -12,7 +12,7 @@ unless Fog.mocking?
# * snapshot_id<~String> - Optional, snapshot to create volume from
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'availabilityZone'<~String> - Availability zone for volume
# * 'createTime'<~Time> - Timestamp for creation

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * key_name<~String> - Name of the key pair.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * group_name<~String> - Name of the security group.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * snapshot_id<~String> - ID of snapshot to delete
# ==== Returns
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * volume_id<~String> - Id of volume to delete.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * public_ip<~Array> - List of ips to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'addressesSet'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * zone_name<~String> - List of availability zones to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'availabilityZoneInfo'<~Array>:

View file

@ -14,7 +14,7 @@ unless Fog.mocking?
# * 'Owner'<~String> - Only return images belonging to owner.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'imagesSet'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * instance_id<~Array> - List of instance ids to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'reservationSet'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * key_name<~Array>:: List of key names to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'keySet'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * region_name<~String> - List of regions to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'regionInfo'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * group_name<~Array> - List of groups to describe, defaults to all
#
# === Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'securityGroupInfo'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * snapshot_id<~Array> - List of snapshots to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'snapshotSet'<~Array>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * volume_id<~Array> - List of volumes to describe, defaults to all
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'volumeSet'<~Array>:
# * 'availabilityZone'<~String> - Availability zone for volume

View file

@ -14,7 +14,7 @@ unless Fog.mocking?
# * 'InstanceId'<~String> - Id of instance to associate volume with
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'attachTime'<~Time> - Time of attachment was initiated at
# * 'device'<~String> - Device as it is exposed to the instance

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * public_ip<~String> - Public ip to assign to instance
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * instance_id<~String> - Id of instance to get console output from
#
# ==== Returns
# # * response<~Fog::AWS::Response>:
# # * response<~Excon::Response>:
# * body<~Hash>:
# * 'instanceId'<~String> - Id of instance
# * 'output'<~String> - Console output

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * instance_id<~Array> - Ids of instances to reboot
#
# ==== Returns
# # * response<~Fog::AWS::Response>:
# # * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# Release an elastic IP address.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -19,7 +19,7 @@ unless Fog.mocking?
# * 'ToPort' - End of port range (or -1 for ICMP wildcard)
#
# === Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'return'<~Boolean> - success?

View file

@ -35,7 +35,7 @@ unless Fog.mocking?
# * 'VirtualName'<~String> - ?
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'groupSet'<~Array>: groups the instances are members in
# * 'groupName'<~String> - Name of group

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * instance_id<~Array> - Ids of instances to terminates
#
# ==== Returns
# # * response<~Fog::AWS::Response>:
# # * response<~Excon::Response>:
# * body<~Hash>:
# * 'requestId'<~String> - Id of request
# * 'instancesSet'<~Array>:

View file

@ -19,7 +19,7 @@ unless Fog.mocking?
# * 'x-amz-copy_source-if-unmodified-since'<~Time> - Copies object it it has not been modified since this time
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'ETag'<~String> - etag of new object
# * 'LastModified'<~Time> - date object was last modified

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * bucket_name<~String> - name of bucket to delete
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * status<~Integer> - 204
def delete_bucket(bucket_name)
request({

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# * object_name<~String> - Name of object to delete
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * status<~Integer> - 204
def delete_object(bucket_name, object_name)
request({

View file

@ -17,7 +17,7 @@ unless Fog.mocking?
# value and the first occurence of delimiter to be rolled up
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'Delimeter'<~String> - Delimiter specified for query
# * 'Marker'<~String> - Marker specified for query

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * bucket_name<~String> - name of bucket to get location constraint for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'LocationConstraint'<~String> - Location constraint of the bucket
def get_bucket_location(bucket_name)

View file

@ -16,7 +16,7 @@ unless Fog.mocking?
# * 'If-Unmodified-Since'<~Time> - Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
# * 'Range'<~String> - Range of object to download
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~String> - Contents of object
# * headers<~Hash>:
# * 'Content-Length'<~String> - Size of object contents

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * bucket_name<~String> - name of bucket to get payer for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'Payer'<~String> - Specifies who pays for download and requests
def get_request_payment(bucket_name)

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List information about S3 buckets for authorized user
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'Buckets'<~Hash>:
# * 'Name'<~String> - Name of bucket

View file

@ -17,7 +17,7 @@ unless Fog.mocking?
# * 'Range'<~String> - Range of object to download
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~String> - Contents of object
# * headers<~Hash>:
# * 'Content-Length'<~String> - Size of object contents

View file

@ -12,7 +12,7 @@ unless Fog.mocking?
# * :location_constraint<~Symbol> - sets the location for the bucket
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * status<~Integer> - 200
def put_bucket(bucket_name, options = {})
if options['LocationConstraint']

View file

@ -21,7 +21,7 @@ unless Fog.mocking?
# * "x-amz-meta-#{name}" - Headers to be returned with object, note total size of request without body must be less than 8 KB.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * headers<~Hash>:
# * 'ETag'<~String> - etag of new object
def put_object(bucket_name, object_name, data, options = {})

View file

@ -17,7 +17,7 @@ unless Fog.mocking?
# not valid. Each name and value can be up to 1024 bytes long.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'
# * 'RequestId'

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# following characters: a-z, A-Z, 0-9, '_', '-' and '.'.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'
# * 'RequestId'

View file

@ -19,7 +19,7 @@ unless Fog.mocking?
# bytes long.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'
# * 'RequestId'

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# following characters: a-z, A-Z, 0-9, '_', '-' and '.'.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'
# * 'RequestId'

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# following characters: a-z, A-Z, 0-9, '_', '-' and '.'.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'AttributeNameCount' - number of unique attribute names in domain
# * 'AttributeNamesSizeBytes' - total size of unique attribute names, in bytes

View file

@ -19,7 +19,7 @@ unless Fog.mocking?
# bytes long.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'Attributes' - list of attribute name/values for the item
# * 'BoxUsage'

View file

@ -13,7 +13,7 @@ unless Fog.mocking?
# * 'NextToken'<~String> - Offset token to start listing, defaults to nil
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'
# * 'Domains' - array of domain names.

View file

@ -18,7 +18,7 @@ unless Fog.mocking?
# be up to 1024 bytes long.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'
# * 'RequestId'

View file

@ -9,7 +9,7 @@ module Fog
# * next_token<~String> - Offset token to start list, defaults to nil.
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'BoxUsage'<~Float>
# * 'RequestId'<~String>

View file

@ -15,7 +15,7 @@ unless Fog.mocking?
# * 'path'<~String> - Return objects nested in the pseudo path
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * headers<~Hash>:
# * 'X-Account-Container-Count'<~String> - Count of containers
# * 'X-Account-Bytes-Used'<~String> - Bytes used

View file

@ -12,7 +12,7 @@ unless Fog.mocking?
# * 'marker'<~String> - Only return objects with name greater than this value
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Array>:
# * container<~Hash>:
# * 'bytes'<~Integer>: - Number of bytes used by container

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * container<~String> - Name of container to retrieve info for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * headers<~Hash>:
# * 'X-Container-Object-Count'<~String> - Count of containers
# * 'X-Container-Bytes-Used'<~String> - Bytes used

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List number of containers and total bytes stored
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * headers<~Hash>:
# * 'X-Account-Container-Count'<~String> - Count of containers
# * 'X-Account-Bytes-Used'<~String> - Bytes used

View file

@ -11,7 +11,7 @@ unless Fog.mocking?
# * options<~Hash> - Name
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * 'image'<~Hash>:
# * 'created'<~Time> - Creation time
# * 'id'<~Integer> - Id of image

View file

@ -19,7 +19,7 @@ unless Fog.mocking?
# * 'path'<~String> - Path to file (255 bytes total of path strings)
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'server'<~Hash>:
# * 'addresses'<~Hash>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * server_id<~Integer> - Id of server to get details for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'server'<~Hash>:
# * 'addresses'<~Hash>:

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * server_id<~Integer> - Id of server to list addresses for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'addresses'<~Array>:
# * 'public'<~Array> - Public ip addresses

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List all images (IDs and names only)
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'id'<~Integer> - Id of the flavor
# * 'name'<~String> - Name of the flavor

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List all images (IDs and names only)
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'id'<~Integer> - Id of the flavor
# * 'name'<~String> - Name of the flavor

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List all images (IDs and names only)
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'id'<~Integer> - Id of the image
# * 'name'<~String> - Name of the image

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List all images
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'id'<~Integer> - Id of the image
# * 'name'<~String> - Name of the image

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * server_id<~Integer> - Id of server to list addresses for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'private'<~Array> - Public ip addresses
def list_private_addresses

View file

@ -10,7 +10,7 @@ unless Fog.mocking?
# * server_id<~Integer> - Id of server to list addresses for
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'public'<~Array> - Public ip addresses
def list_public_addresses

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List all servers (IDs and names only)
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'servers'<~Array>:
# * 'id'<~Integer> - Id of server

View file

@ -7,7 +7,7 @@ unless Fog.mocking?
# List all servers details
#
# ==== Returns
# * response<~Fog::AWS::Response>:
# * response<~Excon::Response>:
# * body<~Hash>:
# * 'servers'<~Array>:
# * 'id'<~Integer> - Id of server