Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #1433 from westonplatter/aws_docs

[docs::aws::storage] fixed some syntax and formatted a request
  • Loading branch information...
commit 4a5da3a4fb784e035ba25471e7edec242965734f 2 parents 62e1c09 + bfd4563
@geemus geemus authored
View
2  lib/fog/aws/models/storage/file.rb
@@ -101,7 +101,7 @@ def copy(target_directory_key, target_file_key, options = {})
# required attributes: directory, key
#
# @param options [Hash]
- # @options versionId []
+ # @option options versionId []
# @return [Boolean] true if successful
#
def destroy(options = {})
View
4 lib/fog/aws/requests/storage/complete_multipart_upload.rb
@@ -12,7 +12,7 @@ class Real
# @param [String] upload_id Id of upload to add part to
# @param [Array<String>] parts Array of etags as Strings for parts
#
- # @return Excon::Response
+ # @return [Excon::Response]
# * headers (Hash)
# * Bucket (String) -- bucket of new object
# * ETag (String) -- etag of new object (will be needed to complete upload)
@@ -45,4 +45,4 @@ def complete_multipart_upload(bucket_name, object_name, upload_id, parts)
end # Real
end # Storage
end # AWS
-end # Fog
+end # Fog
View
39 lib/fog/aws/requests/storage/copy_object.rb
@@ -7,28 +7,27 @@ class Real
# Copy an object from one S3 bucket to another
#
- # ==== Parameters
- # * source_bucket_name<~String> - Name of source bucket
- # * source_object_name<~String> - Name of source object
- # * target_bucket_name<~String> - Name of bucket to create copy in
- # * target_object_name<~String> - Name for new copy of object
- # * options<~Hash>:
- # * 'x-amz-metadata-directive'<~String> - Specifies whether to copy metadata from source or replace with data in request. Must be in ['COPY', 'REPLACE']
- # * 'x-amz-copy_source-if-match'<~String> - Copies object if its etag matches this value
- # * 'x-amz-copy_source-if-modified_since'<~Time> - Copies object it it has been modified since this time
- # * 'x-amz-copy_source-if-none-match'<~String> - Copies object if its etag does not match this value
- # * 'x-amz-copy_source-if-unmodified-since'<~Time> - Copies object it it has not been modified since this time
- # * 'x-amz-storage-class'<~String> - Default is 'STANDARD', set to 'REDUCED_REDUNDANCY' for non-critical, reproducable data
+ # @param source_bucket_name [String] Name of source bucket
+ # @param source_object_name [String] Name of source object
+ # @param target_bucket_name [String] Name of bucket to create copy in
+ # @param target_object_name [String] Name for new copy of object
+ #
+ # @param options [Hash]:
+ # @option options [String] x-amz-metadata-directive Specifies whether to copy metadata from source or replace with data in request. Must be in ['COPY', 'REPLACE']
+ # @option options [String] x-amz-copy_source-if-match Copies object if its etag matches this value
+ # @option options [Time] x-amz-copy_source-if-modified_since Copies object it it has been modified since this time
+ # @option options [String] x-amz-copy_source-if-none-match Copies object if its etag does not match this value
+ # @option options [Time] x-amz-copy_source-if-unmodified-since Copies object it it has not been modified since this time
+ # @option options [String] x-amz-storage-class Default is 'STANDARD', set to 'REDUCED_REDUNDANCY' for non-critical, reproducable data
#
- # ==== Returns
- # * response<~Excon::Response>:
- # * body<~Hash>:
- # * 'ETag'<~String> - etag of new object
- # * 'LastModified'<~Time> - date object was last modified
+ #
+ # @return [Excon::Response]
+ # * body [Hash]:
+ # * ETag [String] - etag of new object
+ # * LastModified [Time] - date object was last modified
#
- # ==== See Also
- # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html
-
+ # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html
+ #
def copy_object(source_bucket_name, source_object_name, target_bucket_name, target_object_name, options = {})
headers = { 'x-amz-copy-source' => "/#{source_bucket_name}/#{CGI.escape(source_object_name)}" }.merge!(options)
request({
Please sign in to comment.
Something went wrong with that request. Please try again.