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

[docs::aws::storage] standardized return format

Browse source 
for key with values,
    # @return variable [data_type]:
  for values,
    # * variable [data_type] - description of value
This commit is contained in:
Weston Platter 2013-01-02 19:42:54 -06:00
parent a5650fd17e
commit 47df9f1b69
7 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/fog/aws/requests/storage/complete_multipart_upload.rb
View file

@ -13,11 +13,11 @@ module Fog
# @param [Array<String>] parts Array of etags as Strings for parts
#
# @return [Excon::Response]
# * headers (Hash)
# * Bucket (String) -- bucket of new object
# * ETag (String) -- etag of new object (will be needed to complete upload)
# * Key (String) -- key of new object
# * Location (String) -- location of new object
# * headers [Hash]:
# * Bucket [String] - bucket of new object
# * ETag [String] - etag of new object (will be needed to complete upload)
# * Key [String] - key of new object
# * Location [String] - location of new object
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html
#

2
lib/fog/aws/requests/storage/delete_bucket_cors.rb
View file

@ -8,7 +8,7 @@ module Fog
# @param bucket_name [String] name of bucket to delete cors rules from
#
# @return [Excon::Response] response:
# * status [Integer] 204
# * status [Integer] - 204
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html

2
lib/fog/aws/requests/storage/delete_bucket_lifecycle.rb
View file

@ -8,7 +8,7 @@ module Fog
# @param bucket_name [String] name of bucket to delete lifecycle configuration from
#
# @return [Excon::Response] response:
# * status [Integer] 204
# * status [Integer] - 204
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html

2
lib/fog/aws/requests/storage/delete_bucket_policy.rb
View file

@ -8,7 +8,7 @@ module Fog
# @param bucket_name [String] name of bucket to delete policy from
#
# @return [Excon::Response] response:
# * status [Integer] 204
# * status [Integer] - 204
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html

2
lib/fog/aws/requests/storage/delete_bucket_website.rb
View file

@ -8,7 +8,7 @@ module Fog
# @param bucket_name [String] name of bucket to delete website configuration from
#
# @return [Excon::Response] response:
# * status [Integer] 204
# * status [Integer] - 204
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html

16
lib/fog/aws/requests/storage/delete_multiple_objects.rb
View file

@ -19,15 +19,15 @@ module Fog
# * body [Hash]:
# * DeleteResult [Array]:
# * Deleted [Hash]:
# * Key [String] Name of the object that was deleted
# * VersionId [String] ID for the versioned onject in case of a versioned delete
# * DeleteMarker [Boolean] Indicates if the request accessed a delete marker
# * DeleteMarkerVersionId [String] Version ID of the delete marker accessed
# * Key [String] - Name of the object that was deleted
# * VersionId [String] - ID for the versioned onject in case of a versioned delete
# * DeleteMarker [Boolean] - Indicates if the request accessed a delete marker
# * DeleteMarkerVersionId [String] - Version ID of the delete marker accessed
# * Error [Hash]:
# * Key [String] Name of the object that failed to be deleted
# * VersionId [String] ID of the versioned object that was attempted to be deleted
# * Code [String] Status code for the result of the failed delete
# * Message [String] Error description
# * Key [String] - Name of the object that failed to be deleted
# * VersionId [String] - ID of the versioned object that was attempted to be deleted
# * Code [String] - Status code for the result of the failed delete
# * Message [String] - Error description
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html

2
lib/fog/aws/requests/storage/delete_object.rb
View file

@ -9,7 +9,7 @@ module Fog
# @param object_name [String] Name of object to delete
#
# @return [Excon::Response] response:
# * status [Integer] 204
# * status [Integer] - 204
#
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html