Release 1.4.1

IBM · Dec 13, 2018 · 2aed781 · 2aed781
1 parent 446ab74
commit 2aed781
Show file tree

Hide file tree

Showing 11 changed files with 466 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,15 @@
 # CHANGELOG
 
 
+# 1.4.1
+## Content
+### Features
+* GET Bucket (List Objects) Version 2
+### Defect Fixes
+* COSSDK-47892: https://github.com/IBM/ibm-cos-sdk-js/issues/34
+* COSSDK-48042: https://github.com/IBM/ibm-cos-sdk-js/pull/36
+
+
 # 1.4.0
 ## Content
 ### Features

diff --git a/README.md b/README.md
@@ -101,7 +101,7 @@ doCreateBucket()
     });
 ```
 
-## Immutable Object Storage (New)
+## Immutable Object Storage
 Users can configure buckets with an Immutable Object Storage policy to prevent objects from being modified or deleted for a defined period of time.  The retention period can be specified on a per-object basis, or objects can inherit a default retention period set on the bucket.  It is also possible to set open-ended and permanent retention periods.  Immutable Object Storage meets the rules set forth by the SEC governing record retention, and IBM Cloud administrators are unable to bypass these restrictions.  For more detail [see the documentation](https://console.bluemix.net/docs/services/cloud-object-storage/basics/immutable.html).
 
 ## Archive Tier Support

diff --git a/apis/s3-2006-03-01.min.json b/apis/s3-2006-03-01.min.json
@@ -1645,25 +1645,7 @@
           "Marker": {},
           "NextMarker": {},
           "Contents": {
-            "type": "list",
-            "member": {
-              "type": "structure",
-              "members": {
-                "Key": {},
-                "LastModified": {
-                  "type": "timestamp"
-                },
-                "ETag": {},
-                "Size": {
-                  "type": "integer"
-                },
-                "StorageClass": {},
-                "Owner": {
-                  "shape": "S2n"
-                }
-              }
-            },
-            "flattened": true
+            "shape": "S5u"
           },
           "Name": {},
           "Prefix": {},
@@ -1679,6 +1661,81 @@
       },
       "alias": "GetBucket"
     },
+    "ListObjectsV2": {
+      "http": {
+        "method": "GET",
+        "requestUri": "/{Bucket}?list-type=2"
+      },
+      "input": {
+        "type": "structure",
+        "required": [
+          "Bucket"
+        ],
+        "members": {
+          "Bucket": {
+            "location": "uri",
+            "locationName": "Bucket"
+          },
+          "Delimiter": {
+            "location": "querystring",
+            "locationName": "delimiter"
+          },
+          "EncodingType": {
+            "location": "querystring",
+            "locationName": "encoding-type"
+          },
+          "MaxKeys": {
+            "location": "querystring",
+            "locationName": "max-keys",
+            "type": "integer"
+          },
+          "Prefix": {
+            "location": "querystring",
+            "locationName": "prefix"
+          },
+          "ContinuationToken": {
+            "location": "querystring",
+            "locationName": "continuation-token"
+          },
+          "FetchOwner": {
+            "location": "querystring",
+            "locationName": "fetch-owner",
+            "type": "boolean"
+          },
+          "StartAfter": {
+            "location": "querystring",
+            "locationName": "start-after"
+          }
+        }
+      },
+      "output": {
+        "type": "structure",
+        "members": {
+          "IsTruncated": {
+            "type": "boolean"
+          },
+          "Contents": {
+            "shape": "S5u"
+          },
+          "Name": {},
+          "Prefix": {},
+          "Delimiter": {},
+          "MaxKeys": {
+            "type": "integer"
+          },
+          "CommonPrefixes": {
+            "shape": "S5n"
+          },
+          "EncodingType": {},
+          "KeyCount": {
+            "type": "integer"
+          },
+          "ContinuationToken": {},
+          "NextContinuationToken": {},
+          "StartAfter": {}
+        }
+      }
+    },
     "ListParts": {
       "http": {
         "method": "GET",
@@ -1789,7 +1846,7 @@
             "locationName": "x-amz-acl"
           },
           "AccessControlPolicy": {
-            "shape": "S66",
+            "shape": "S6d",
             "locationName": "AccessControlPolicy",
             "xmlNamespace": {
               "uri": "http://s3.amazonaws.com/doc/2006-03-01/"
@@ -2125,7 +2182,7 @@
             "locationName": "x-amz-acl"
           },
           "AccessControlPolicy": {
-            "shape": "S66",
+            "shape": "S6d",
             "locationName": "AccessControlPolicy",
             "xmlNamespace": {
               "uri": "http://s3.amazonaws.com/doc/2006-03-01/"
@@ -2743,7 +2800,28 @@
       },
       "flattened": true
     },
-    "S66": {
+    "S5u": {
+      "type": "list",
+      "member": {
+        "type": "structure",
+        "members": {
+          "Key": {},
+          "LastModified": {
+            "type": "timestamp"
+          },
+          "ETag": {},
+          "Size": {
+            "type": "integer"
+          },
+          "StorageClass": {},
+          "Owner": {
+            "shape": "S2n"
+          }
+        }
+      },
+      "flattened": true
+    },
+    "S6d": {
       "type": "structure",
       "members": {
         "Grants": {

diff --git a/apis/s3-2006-03-01.normal.json b/apis/s3-2006-03-01.normal.json
@@ -423,6 +423,25 @@
       "documentation": "Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.",
       "alias": "GetBucket"
     },
+    "ListObjectsV2": {
+      "name": "ListObjectsV2",
+      "http": {
+        "method": "GET",
+        "requestUri": "/{Bucket}?list-type=2"
+      },
+      "input": {
+        "shape": "ListObjectsV2Request"
+      },
+      "output": {
+        "shape": "ListObjectsV2Output"
+      },
+      "errors": [
+        {
+          "shape": "NoSuchBucket"
+        }
+      ],
+      "documentation": "<p>Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.</p>"
+    },
     "ListParts": {
       "name": "ListParts",
       "http": {
@@ -3326,6 +3345,115 @@
         }
       }
     },
+    "ListObjectsV2Output": {
+      "type": "structure",
+      "members": {
+        "IsTruncated": {
+          "shape": "IsTruncated",
+          "documentation": "<p>A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.</p>"
+        },
+        "Contents": {
+          "shape": "ObjectList",
+          "documentation": "<p>Metadata about each object returned.</p>"
+        },
+        "Name": {
+          "shape": "BucketName",
+          "documentation": "<p>Name of the bucket to list.</p>"
+        },
+        "Prefix": {
+          "shape": "Prefix",
+          "documentation": "<p>Limits the response to keys that begin with the specified prefix.</p>"
+        },
+        "Delimiter": {
+          "shape": "Delimiter",
+          "documentation": "<p>A delimiter is a character you use to group keys.</p>"
+        },
+        "MaxKeys": {
+          "shape": "MaxKeys",
+          "documentation": "<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>"
+        },
+        "CommonPrefixes": {
+          "shape": "CommonPrefixList",
+          "documentation": "<p>CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter</p>"
+        },
+        "EncodingType": {
+          "shape": "EncodingType",
+          "documentation": "<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>"
+        },
+        "KeyCount": {
+          "shape": "KeyCount",
+          "documentation": "<p>KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys </p>"
+        },
+        "ContinuationToken": {
+          "shape": "Token",
+          "documentation": "<p>ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key</p>"
+        },
+        "NextContinuationToken": {
+          "shape": "NextToken",
+          "documentation": "<p>NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key</p>"
+        },
+        "StartAfter": {
+          "shape": "StartAfter",
+          "documentation": "<p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket</p>"
+        }
+      }
+    },
+    "ListObjectsV2Request": {
+      "type": "structure",
+      "required": [
+        "Bucket"
+      ],
+      "members": {
+        "Bucket": {
+          "shape": "BucketName",
+          "documentation": "<p>Name of the bucket to list.</p>",
+          "location": "uri",
+          "locationName": "Bucket"
+        },
+        "Delimiter": {
+          "shape": "Delimiter",
+          "documentation": "<p>A delimiter is a character you use to group keys.</p>",
+          "location": "querystring",
+          "locationName": "delimiter"
+        },
+        "EncodingType": {
+          "shape": "EncodingType",
+          "documentation": "<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>",
+          "location": "querystring",
+          "locationName": "encoding-type"
+        },
+        "MaxKeys": {
+          "shape": "MaxKeys",
+          "documentation": "<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>",
+          "location": "querystring",
+          "locationName": "max-keys"
+        },
+        "Prefix": {
+          "shape": "Prefix",
+          "documentation": "<p>Limits the response to keys that begin with the specified prefix.</p>",
+          "location": "querystring",
+          "locationName": "prefix"
+        },
+        "ContinuationToken": {
+          "shape": "Token",
+          "documentation": "<p>ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key</p>",
+          "location": "querystring",
+          "locationName": "continuation-token"
+        },
+        "FetchOwner": {
+          "shape": "FetchOwner",
+          "documentation": "<p>The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true</p>",
+          "location": "querystring",
+          "locationName": "fetch-owner"
+        },
+        "StartAfter": {
+          "shape": "StartAfter",
+          "documentation": "<p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket</p>",
+          "location": "querystring",
+          "locationName": "start-after"
+        }
+      }
+    },
     "ListPartsOutput": {
       "type": "structure",
       "members": {