complete_multipart_upload.rb in gapinc-fog-1.14.0

- old
+ new

@@ -11,15 +11,19 @@
         # @param [String] object_name Name of object to complete multipart upload for
         # @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]
-        #   * headers [Hash]:
+        #   * body [Hash]: (success)
         #     * Bucket [String] - bucket of new object
-        #     * ETag [String] - etag of new object (will be needed to complete upload)
+        #     * ETag [String] - etag of new object
         #     * Key [String] - key of new object
         #     * Location [String] - location of new object
+        #   * body [Hash]: (failure)
+        #     * Code [String] - Error status code
+        #     * Message [String] - Error description
         #
+        # @note This request could fail and still return +200 OK+, so it's important that you check the response.
         # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html
         #
         def complete_multipart_upload(bucket_name, object_name, upload_id, parts)
           data = "<CompleteMultipartUpload>"
           parts.each_with_index do |part, index|