lib/fog/aws/requests/storage/get_object_acl.rb in fog-maestrodev-1.7.0.20121114190951 vs lib/fog/aws/requests/storage/get_object_acl.rb in fog-maestrodev-1.8.0.20130109172219
- old
+ new
@@ -5,33 +5,30 @@
require 'fog/aws/parsers/storage/access_control_list'
# 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
raise ArgumentError.new('bucket_name is required')
end