diff --git a/lib/fog/aws/requests/storage/get_bucket_location.rb b/lib/fog/aws/requests/storage/get_bucket_location.rb index d58924318..44cf8e2d0 100644 --- a/lib/fog/aws/requests/storage/get_bucket_location.rb +++ b/lib/fog/aws/requests/storage/get_bucket_location.rb @@ -7,14 +7,13 @@ module Fog # Get location constraint for an S3 bucket # - # @param bucket_name [String] - name of bucket to get location constraint for + # @param bucket_name [String] name of bucket to get location constraint for # - # @return response [Excon::Response]: - # * body<~Hash>: - # * 'LocationConstraint'<~String> - Location constraint of the bucket + # @return [Excon::Response] response: + # * body [Hash]: + # * LocationConstraint [String] - Location constraint of the bucket # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html def get_bucket_location(bucket_name) request({ diff --git a/lib/fog/aws/requests/storage/get_bucket_logging.rb b/lib/fog/aws/requests/storage/get_bucket_logging.rb index 9a3809139..a2f14d904 100644 --- a/lib/fog/aws/requests/storage/get_bucket_logging.rb +++ b/lib/fog/aws/requests/storage/get_bucket_logging.rb @@ -7,27 +7,24 @@ module Fog # Get logging status for an S3 bucket # - # ==== Parameters - # * bucket_name<~String> - name of bucket to get logging status for + # @param bucket_name [String] name of bucket to get logging status for # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'BucketLoggingStatus'<~Hash>: (will be empty if logging is disabled) - # * 'LoggingEnabled'<~Hash>: - # * 'TargetBucket'<~String> - bucket where logs are stored - # * 'TargetPrefix'<~String> - prefix logs are stored with - # * 'TargetGrants'<~Array>: - # * 'Grant'<~Hash>: - # * 'Grantee'<~Hash>: - # * 'DisplayName'<~String> - Display name of grantee - # * 'ID'<~String> - Id of grantee + # @return [Excon::Response] response: + # * body [Hash]: + # * BucketLoggingStatus (will be empty if logging is disabled) [Hash]: + # * LoggingEnabled [Hash]: + # * TargetBucket [String] - bucket where logs are stored + # * TargetPrefix [String] - prefix logs are stored with + # * TargetGrants [Array]: + # * Grant [Hash]: + # * Grantee [Hash]: + # * DisplayName [String] - Display name of grantee + # * ID [String] - Id of grantee # or - # * 'URI'<~String> - URI of group to grant access for - # * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] + # * URI [String] - URI of group to grant access for + # * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html def get_bucket_logging(bucket_name) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_bucket_object_versions.rb b/lib/fog/aws/requests/storage/get_bucket_object_versions.rb index f9968e701..6533fb974 100644 --- a/lib/fog/aws/requests/storage/get_bucket_object_versions.rb +++ b/lib/fog/aws/requests/storage/get_bucket_object_versions.rb @@ -7,52 +7,46 @@ module Fog # List information about object versions in an S3 bucket # - # ==== Parameters - # * bucket_name<~String> - name of bucket to list object keys from - # * options<~Hash> - config arguments for list. Defaults to {}. - # * 'delimiter'<~String> - causes keys with the same string between the prefix - # value and the first occurence of delimiter to be rolled up - # * 'key-marker'<~String> - limits object keys to only those that appear - # lexicographically after its value. - # * 'max-keys'<~Integer> - limits number of object keys returned - # * 'prefix'<~String> - limits object keys to those beginning with its value. - # * 'version-id-marker'<~String> - limits object versions to only those that - # appear lexicographically after its value + # @param bucket_name [String] name of bucket to list object keys from + # @param options [Hash] config arguments for list + # @option options delimiter [String] causes keys with the same string between the prefix value and the first occurence of delimiter to be rolled up + # @option options key-marker [String] limits object keys to only those that appear lexicographically after its value. + # @option options max-keys [Integer] limits number of object keys returned + # @option options prefix [String] limits object keys to those beginning with its value. + # @option options version-id-marker [String] limits object versions to only those that appear lexicographically after its value # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'Delimeter'<~String> - Delimiter specified for query - # * 'KeyMarker'<~String> - Key marker specified for query - # * 'MaxKeys'<~Integer> - Maximum number of keys specified for query - # * 'Name'<~String> - Name of the bucket - # * 'Prefix'<~String> - Prefix specified for query - # * 'VersionIdMarker'<~String> - Version id marker specified for query - # * 'IsTruncated'<~Boolean> - Whether or not this is the totality of the bucket - # * 'Versions'<~Array>: - # * 'DeleteMarker'<~Hash>: - # * 'IsLatest'<~Boolean> - Whether or not this is the latest version - # * 'Key'<~String> - Name of object - # * 'LastModified'<~String>: Timestamp of last modification of object - # * 'Owner'<~Hash>: - # * 'DisplayName'<~String> - Display name of object owner - # * 'ID'<~String> - Id of object owner - # * 'VersionId'<~String> - The id of this version + # @return [Excon::Response] response: + # * body [Hash]: + # * Delimeter [String] - Delimiter specified for query + # * KeyMarker [String] - Key marker specified for query + # * MaxKeys [Integer] - Maximum number of keys specified for query + # * Name [String] - Name of the bucket + # * Prefix [String] - Prefix specified for query + # * VersionIdMarker [String] - Version id marker specified for query + # * IsTruncated [Boolean] - Whether or not this is the totality of the bucket + # * Versions [Array]: + # * DeleteMarker [Hash]: + # * IsLatest [Boolean] - Whether or not this is the latest version + # * Key [String] - Name of object + # * LastModified [String]: Timestamp of last modification of object + # * Owner [Hash]: + # * DisplayName [String] - Display name of object owner + # * ID [String] - Id of object owner + # * VersionId [String] - The id of this version # or - # * 'Version'<~Hash>: - # * 'ETag'<~String>: Etag of object - # * 'IsLatest'<~Boolean> - Whether or not this is the latest version - # * 'Key'<~String> - Name of object - # * 'LastModified'<~String>: Timestamp of last modification of object - # * 'Owner'<~Hash>: - # * 'DisplayName'<~String> - Display name of object owner - # * 'ID'<~String> - Id of object owner - # * 'Size'<~Integer> - Size of object - # * 'StorageClass'<~String> - Storage class of object - # * 'VersionId'<~String> - The id of this version + # * Version [Hash]: + # * ETag [String]: Etag of object + # * IsLatest [Boolean] - Whether or not this is the latest version + # * Key [String] - Name of object + # * LastModified [String]: Timestamp of last modification of object + # * Owner [Hash]: + # * DisplayName [String] - Display name of object owner + # * ID [String] - Id of object owner + # * Size [Integer] - Size of object + # * StorageClass [String] - Storage class of object + # * VersionId [String] - The id of this version # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html def get_bucket_object_versions(bucket_name, options = {}) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_bucket_policy.rb b/lib/fog/aws/requests/storage/get_bucket_policy.rb index 74c0b814f..dbddd1186 100644 --- a/lib/fog/aws/requests/storage/get_bucket_policy.rb +++ b/lib/fog/aws/requests/storage/get_bucket_policy.rb @@ -5,15 +5,12 @@ module Fog # Get bucket policy for an S3 bucket # - # ==== Parameters - # * bucket_name<~String> - name of bucket to get policy for + # @param bucket_name [String] name of bucket to get policy for # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash> - policy document + # @return [Excon::Response] response: + # * body [Hash] - policy document # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html def get_bucket_policy(bucket_name) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_bucket_versioning.rb b/lib/fog/aws/requests/storage/get_bucket_versioning.rb index b38e32730..83967d657 100644 --- a/lib/fog/aws/requests/storage/get_bucket_versioning.rb +++ b/lib/fog/aws/requests/storage/get_bucket_versioning.rb @@ -7,17 +7,14 @@ module Fog # Get versioning status for an S3 bucket # - # ==== Parameters - # * bucket_name<~String> - name of bucket to get versioning status for + # @param bucket_name [String] name of bucket to get versioning status for # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'VersioningConfiguration'<~Hash> - # * Status<~String>: Versioning status in ['Enabled', 'Suspended', nil] + # @return [Excon::Response] response: + # * body [Hash]: + # * VersioningConfiguration [Hash]: + # * Status [String] - Versioning status in ['Enabled', 'Suspended', nil] # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html def get_bucket_versioning(bucket_name) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_bucket_website.rb b/lib/fog/aws/requests/storage/get_bucket_website.rb index aa9aa511a..d6375ade5 100644 --- a/lib/fog/aws/requests/storage/get_bucket_website.rb +++ b/lib/fog/aws/requests/storage/get_bucket_website.rb @@ -7,19 +7,17 @@ module Fog # Get website configuration for an S3 bucket # - # ==== Parameters - # * bucket_name<~String> - name of bucket to get website configuration for + # + # @param bucket_name [String] name of bucket to get website configuration for # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * IndexDocument<~Hash> - # * Suffix<~String> - Suffix appended when directory is requested - # * ErrorDocument<~Hash> - # * Key<~String> - Object key to return for 4XX class errors + # @return [Excon::Response] response: + # * body [Hash]: + # * IndexDocument [Hash]: + # * Suffix [String] - Suffix appended when directory is requested + # * ErrorDocument [Hash]: + # * Key [String] - Object key to return for 4XX class errors # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html def get_bucket_website(bucket_name) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_object.rb b/lib/fog/aws/requests/storage/get_object.rb index 0978e0902..7843d8a00 100644 --- a/lib/fog/aws/requests/storage/get_object.rb +++ b/lib/fog/aws/requests/storage/get_object.rb @@ -5,28 +5,25 @@ module Fog # Get an object from S3 # - # ==== Parameters - # * bucket_name<~String> - Name of bucket to read from - # * object_name<~String> - Name of object to read - # * options<~Hash>: - # * 'If-Match'<~String> - Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed). - # * 'If-Modified-Since'<~Time> - Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified). - # * 'If-None-Match'<~String> - Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified) - # * '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 - # * 'versionId'<~String> - specify a particular version to retrieve + # @param bucket_name [String] Name of bucket to read from + # @param object_name [String] Name of object to read + # @param options [Hash] + # @option options If-Match [String] Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed). + # @option options If-Modified-Since [Time] Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified). + # @option options If-None-Match [String] Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified) + # @option options If-Unmodified-Since [Time] Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed). + # @option options Range [String] Range of object to download + # @option options versionId [String] specify a particular version to retrieve # - # ==== Returns - # * response<~Excon::Response>: - # * body<~String> - Contents of object - # * headers<~Hash>: - # * 'Content-Length'<~String> - Size of object contents - # * 'Content-Type'<~String> - MIME type of object - # * 'ETag'<~String> - Etag of object - # * 'Last-Modified'<~String> - Last modified timestamp for object + # @return [Excon::Response] response: + # * body [String]- Contents of object + # * headers [Hash]: + # * Content-Length [String] - Size of object contents + # * Content-Type [String] - MIME type of object + # * ETag [String] - Etag of object + # * Last-Modified [String] - Last modified timestamp for object # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html def get_object(bucket_name, object_name, options = {}, &block) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_object_acl.rb b/lib/fog/aws/requests/storage/get_object_acl.rb index b6ae5aef5..fd2e0ed17 100644 --- a/lib/fog/aws/requests/storage/get_object_acl.rb +++ b/lib/fog/aws/requests/storage/get_object_acl.rb @@ -7,30 +7,27 @@ module Fog # Get access control list for an S3 object # - # ==== Parameters - # * bucket_name<~String> - name of bucket containing object - # * object_name<~String> - name of object to get access control list for - # * options<~Hash>: - # * 'versionId'<~String> - specify a particular version to retrieve + # @param bucket_name [String] name of bucket containing object + # @param object_name [String] name of object to get access control list for + # @param options [Hash] + # @option options versionId [String] specify a particular version to retrieve # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'AccessControlPolicy'<~Hash> - # * 'Owner'<~Hash>: - # * 'DisplayName'<~String> - Display name of object owner - # * 'ID'<~String> - Id of object owner - # * 'AccessControlList'<~Array>: - # * 'Grant'<~Hash>: - # * 'Grantee'<~Hash>: - # * 'DisplayName'<~String> - Display name of grantee - # * 'ID'<~String> - Id of grantee + # @return [Excon::Response] response: + # * body [Hash]: + # * [AccessControlPolicy [Hash]: + # * Owner [Hash]: + # * DisplayName [String] - Display name of object owner + # * ID [String] - Id of object owner + # * AccessControlList [Array]: + # * Grant [Hash]: + # * Grantee [Hash]: + # * DisplayName [String] - Display name of grantee + # * ID [String] - Id of grantee # or - # * 'URI'<~String> - URI of group to grant access for - # * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] + # * URI [String] - URI of group to grant access for + # * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html def get_object_acl(bucket_name, object_name, options = {}) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_object_http_url.rb b/lib/fog/aws/requests/storage/get_object_http_url.rb index 8aafb39a7..65c2852e5 100644 --- a/lib/fog/aws/requests/storage/get_object_http_url.rb +++ b/lib/fog/aws/requests/storage/get_object_http_url.rb @@ -32,17 +32,14 @@ module Fog # Get an expiring object http url from S3 # - # ==== Parameters - # * bucket_name<~String> - Name of bucket containing object - # * object_name<~String> - Name of object to get expiring url for - # * expires<~Time> - An expiry time for this url + # @param bucket_name [String] Name of bucket containing object + # @param object_name [String] Name of object to get expiring url for + # @param expires [Time] An expiry time for this url # - # ==== Returns - # * response<~Excon::Response>: - # * body<~String> - url for object + # @return [Excon::Response] response: + # * body [String] - url for object # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html include GetObjectHttpUrl diff --git a/lib/fog/aws/requests/storage/get_object_https_url.rb b/lib/fog/aws/requests/storage/get_object_https_url.rb index ada1d170f..f8588cd52 100644 --- a/lib/fog/aws/requests/storage/get_object_https_url.rb +++ b/lib/fog/aws/requests/storage/get_object_https_url.rb @@ -14,17 +14,14 @@ module Fog # Get an expiring object https url from S3 # - # ==== Parameters - # * bucket_name<~String> - Name of bucket containing object - # * object_name<~String> - Name of object to get expiring url for - # * expires<~Time> - An expiry time for this url + # @param bucket_name [String] Name of bucket containing object + # @param object_name [String] Name of object to get expiring url for + # @param expires [Time] An expiry time for this url # - # ==== Returns - # * response<~Excon::Response>: - # * body<~String> - url for object + # @return [Excon::Response] response: + # * body [String] - url for object # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html include GetObjectHttpsUrl diff --git a/lib/fog/aws/requests/storage/get_object_torrent.rb b/lib/fog/aws/requests/storage/get_object_torrent.rb index 3305b3385..b8fe1f121 100644 --- a/lib/fog/aws/requests/storage/get_object_torrent.rb +++ b/lib/fog/aws/requests/storage/get_object_torrent.rb @@ -5,26 +5,23 @@ module Fog # Get torrent for an S3 object # - # ==== Parameters - # * bucket_name<~String> - name of bucket containing object - # * object_name<~String> - name of object to get torrent for + # @param bucket_name [String] name of bucket containing object + # @param object_name [String] name of object to get torrent for # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'AccessControlPolicy'<~Hash> - # * 'Owner'<~Hash>: - # * 'DisplayName'<~String> - Display name of object owner - # * 'ID'<~String> - Id of object owner - # * 'AccessControlList'<~Array>: - # * 'Grant'<~Hash>: - # * 'Grantee'<~Hash>: - # * 'DisplayName'<~String> - Display name of grantee - # * 'ID'<~String> - Id of grantee - # * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] + # @return [Excon::Response] response: + # * body [Hash]: + # * AccessControlPolicy [Hash: + # * Owner [Hash]: + # * DisplayName [String] - Display name of object owner + # * ID [String] - Id of object owner + # * AccessControlList [Array]: + # * Grant [Hash]: + # * Grantee [Hash]: + # * DisplayName [String] - Display name of grantee + # * ID [String] - Id of grantee + # * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP] # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html def get_object_torrent(bucket_name, object_name) unless bucket_name diff --git a/lib/fog/aws/requests/storage/get_object_url.rb b/lib/fog/aws/requests/storage/get_object_url.rb index 5e885ff6f..9b4fb90bd 100644 --- a/lib/fog/aws/requests/storage/get_object_url.rb +++ b/lib/fog/aws/requests/storage/get_object_url.rb @@ -32,17 +32,14 @@ module Fog # Get an expiring object url from S3 # - # ==== Parameters - # * bucket_name<~String> - Name of bucket containing object - # * object_name<~String> - Name of object to get expiring url for - # * expires<~Time> - An expiry time for this url + # @param bucket_name [String] Name of bucket containing object + # @param object_name [String] Name of object to get expiring url for + # @param expires [Time] An expiry time for this url # - # ==== Returns - # * response<~Excon::Response>: - # * body<~String> - url for object + # @return [Excon::Response] response: + # * body [String] - url for object # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html include GetObjectUrl diff --git a/lib/fog/aws/requests/storage/get_request_payment.rb b/lib/fog/aws/requests/storage/get_request_payment.rb index fd42256b7..bcdcc6e3a 100644 --- a/lib/fog/aws/requests/storage/get_request_payment.rb +++ b/lib/fog/aws/requests/storage/get_request_payment.rb @@ -7,16 +7,13 @@ module Fog # Get configured payer for an S3 bucket # - # ==== Parameters - # * bucket_name<~String> - name of bucket to get payer for + # @param bucket_name [String] name of bucket to get payer for # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'Payer'<~String> - Specifies who pays for download and requests + # @return [Excon::Response] response: + # * body [Hash]: + # * Payer [String] - Specifies who pays for download and requests # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html def get_request_payment(bucket_name) request({ diff --git a/lib/fog/aws/requests/storage/get_service.rb b/lib/fog/aws/requests/storage/get_service.rb index 7c83e76e5..ea6fb12a9 100644 --- a/lib/fog/aws/requests/storage/get_service.rb +++ b/lib/fog/aws/requests/storage/get_service.rb @@ -7,18 +7,16 @@ module Fog # List information about S3 buckets for authorized user # - # ==== Returns - # * response<~Excon::Response>: - # * body<~Hash>: - # * 'Buckets'<~Hash>: - # * 'Name'<~String> - Name of bucket - # * 'CreationTime'<~Time> - Timestamp of bucket creation - # * 'Owner'<~Hash>: - # * 'DisplayName'<~String> - Display name of bucket owner - # * 'ID'<~String> - Id of bucket owner + # @return [Excon::Response] response: + # * body [Hash]: + # * Buckets [Hash]: + # * Name [String] - Name of bucket + # * CreationTime [Time] - Timestamp of bucket creation + # * Owner [Hash]: + # * DisplayName [String] - Display name of bucket owner + # * ID [String] - Id of bucket owner # - # ==== See Also - # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html + # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html # def get_service request({