mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
add docs for returned headers on s3 get/head object
This commit is contained in:
parent
43b23e9147
commit
1024b837e2
2 changed files with 16 additions and 2 deletions
|
@ -3,6 +3,7 @@ module Fog
|
|||
class S3
|
||||
|
||||
# Get an object from S3
|
||||
#
|
||||
# ==== Parameters
|
||||
# * bucket_name<~String> - Name of bucket to read from
|
||||
# * object_name<~String> - Name of object to read
|
||||
|
@ -10,7 +11,12 @@ module Fog
|
|||
# ==== Returns
|
||||
# * response<~Fog::AWS::Response>:
|
||||
# * body<~String> - Contents of object
|
||||
# FIXME: headers
|
||||
# * 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
|
||||
# FIXME: optional params
|
||||
def get_object(bucket_name, object_name)
|
||||
request({
|
||||
:expects => 200,
|
||||
|
|
|
@ -3,7 +3,15 @@ module Fog
|
|||
class S3
|
||||
|
||||
# Get headers for an object from S3
|
||||
# FIXME: docs
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Fog::AWS::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
|
||||
def head_object(bucket_name, object_name)
|
||||
request({
|
||||
:expects => 200,
|
||||
|
|
Loading…
Reference in a new issue