refactor get set tagging apis for bucket and object (#1246)

minio · Feb 1, 2024 · 953dfa9 · 953dfa9
1 parent ff816e7
commit 953dfa9
Show file tree

Hide file tree

Showing 11 changed files with 228 additions and 202 deletions.
diff --git a/README.md b/README.md
@@ -198,9 +198,12 @@ The complete API Reference is available here:
 - [list-incomplete-uploads.js](https://github.com/minio/minio-js/blob/master/examples/list-incomplete-uploads.js)
 - [get-bucket-versioning.mjs](https://github.com/minio/minio-js/blob/master/examples/get-bucket-versioning.js)
 - [set-bucket-versioning.mjs](https://github.com/minio/minio-js/blob/master/examples/set-bucket-versioning.js)
-- [set-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-tagging.js)
+- [set-bucket-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/set-bucket-tagging.js)
+- [get-bucket-versioning.mjs](https://github.com/minio/minio-js/blob/master/examples/get-bucket-versioning.js)
+- [set-bucket-versioning.mjs](https://github.com/minio/minio-js/blob/master/examples/set-bucket-versioning.js)
+- [set-bucket-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/set-bucket-tagging.js)
 - [get-bucket-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/get-bucket-tagging.mjs)
-- [remove-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-tagging.js)
+- [remove-bucket-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-tagging.js)
 - [set-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-lifecycle.js)
 - [get-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-lifecycle.js)
 - [remove-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-lifecycle.js)
@@ -226,9 +229,9 @@ The complete API Reference is available here:
 - [stat-object.mjs](https://github.com/minio/minio-js/blob/master/examples/stat-object.mjs)
 - [get-object-retention.js](https://github.com/minio/minio-js/blob/master/examples/get-object-retention.js)
 - [put-object-retention.js](https://github.com/minio/minio-js/blob/master/examples/put-object-retention.js)
-- [put-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/put-object-tagging.js)
+- [put-object-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/put-object-tagging.js)
 - [get-object-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/get-object-tagging.mjs)
-- [remove-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/remove-object-tagging.js)
+- [remove-object-tagging.mjs](https://github.com/minio/minio-js/blob/master/examples/remove-object-tagging.js)
 - [set-object-legal-hold.js](https://github.com/minio/minio-js/blob/master/examples/set-object-legalhold.mjs)
 - [get-object-legal-hold.js](https://github.com/minio/minio-js/blob/master/examples/get-object-legal-hold.mjs)
 - [compose-object.js](https://github.com/minio/minio-js/blob/master/examples/compose-object.js)

diff --git a/docs/API.md b/docs/API.md
@@ -578,27 +578,21 @@ await minioClient.removeBucketReplication('source-bucket')
 
 <a name="setBucketTagging"></a>
 
-### setBucketTagging(bucketName, tags, callback)
+### setBucketTagging(bucketName, tags)
 
 Set Tags on a Bucket
 
 **Parameters**
 
-| Param           | Type       | Description                                               |
-| --------------- | ---------- | --------------------------------------------------------- |
-| `bucketName`    | _string_   | Name of the bucket.                                       |
-| `tags`          | _object_   | Tags map Configuration e.g: `{<tag-key-1>:<tag-value-1>}` |
-| `callback(err)` | _function_ | Callback is called with `err` in case of error.           |
+| Param        | Type     | Description                                               |
+| ------------ | -------- | --------------------------------------------------------- |
+| `bucketName` | _string_ | Name of the bucket.                                       |
+| `tags`       | _object_ | Tags map Configuration e.g: `{<tag-key-1>:<tag-value-1>}` |
 
 **Example**
 
 ```js
-minioClient.setBucketTagging('bucketname', tags, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await minioClient.setBucketTagging('bucketname', tags)
 ```
 
 <a name="removeBucketTagging"></a>
@@ -609,44 +603,33 @@ Remove Tags on a Bucket
 
 **Parameters**
 
-| Param           | Type       | Description                                     |
-| --------------- | ---------- | ----------------------------------------------- |
-| `bucketName`    | _string_   | Name of the bucket.                             |
-| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
+| Param        | Type     | Description         |
+| ------------ | -------- | ------------------- |
+| `bucketName` | _string_ | Name of the bucket. |
 
 **Example**
 
 ```js
-minioClient.removeBucketTagging('bucketname', function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await minioClient.removeBucketTagging('bucketname')
 ```
 
 <a name="getBucketTagging"></a>
 
-### getBucketTagging(bucketName, callback)
+### getBucketTagging(bucketName)
 
-Remove Tags on a Bucket
+Gets Tags on a Bucket
 
 **Parameters**
 
-| Param                     | Type       | Description                                     |
-| ------------------------- | ---------- | ----------------------------------------------- |
-| `bucketName`              | _string_   | Name of the bucket.                             |
-| `callback(err, tagsList)` | _function_ | Callback is called with `err` in case of error. |
+| Param        | Type     | Description         |
+| ------------ | -------- | ------------------- |
+| `bucketName` | _string_ | Name of the bucket. |
 
 **Example**
 
 ```js
-minioClient.getBucketTagging('bucketname', function (err, tagsList) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success', tagsList)
-})
+const tagList = await minioClient.getBucketTagging('bucketname')
+console.log(tagList)
 ```
 
 <a name="setBucketLifecycle"></a>
@@ -1417,79 +1400,57 @@ minioClient.getObjectRetention('bucketname', 'bucketname', { versionId: 'my-vers
 
 <a name="setObjectTagging"></a>
 
-### setObjectTagging(bucketName, objectName, tags[, putOpts, callback])
+### setObjectTagging(bucketName, objectName, tags[, putOpts])
 
 Put Tags on an Object
 
 **Parameters**
 
-| Param           | Type       | Description                                                  |
-| --------------- | ---------- | ------------------------------------------------------------ |
-| `bucketName`    | _string_   | Name of the bucket.                                          |
-| `objectName`    | _string_   | Name of the object.                                          |
-| `tags`          | _object_   | Tags map Configuration e.g: `{<tag-key-1>:<tag-value-1>}`    |
-| `putOpts`       | _object_   | Default is {}. e.g `{versionId:"my-version-id"}`. (Optional) |
-| `callback(err)` | _function_ | Callback is called with `err` in case of error.              |
+| Param        | Type     | Description                                                  |
+| ------------ | -------- | ------------------------------------------------------------ |
+| `bucketName` | _string_ | Name of the bucket.                                          |
+| `objectName` | _string_ | Name of the object.                                          |
+| `tags`       | _object_ | Tags map Configuration e.g: `{<tag-key-1>:<tag-value-1>}`    |
+| `putOpts`    | _object_ | Default is {}. e.g `{versionId:"my-version-id"}`. (Optional) |
 
 **Example**
 
 ```js
-minioClient.setObjectTagging('bucketname', 'object-name', tags, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await minioClient.setObjectTagging('bucketname', 'object-name', tags)
 ```
 
 **Example 1**
 Put tags on a version of an object.
 
 ```js
-minioClient.setObjectTagging('bucketname', 'object-name', tags, { versionId: 'my-version-id' }, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await minioClient.setObjectTagging('bucketname', 'object-name', tags, { versionId: 'my-version-id' })
 ```
 
 <a name="removeObjectTagging"></a>
 
-### removeObjectTagging(bucketName, objectName[, removeOpts, callback])
+### removeObjectTagging(bucketName, objectName[, removeOpts])
 
 Remove Tags on an Object
 
 **Parameters**
 
-| Param           | Type       | Description                                                   |
-| --------------- | ---------- | ------------------------------------------------------------- |
-| `bucketName`    | _string_   | Name of the bucket.                                           |
-| `objectName`    | _string_   | Name of the object.                                           |
-| `removeOpts`    | _object_   | Defaults to {}. e.g `{versionId:"my-version-id"}`. (Optional) |
-| `callback(err)` | _function_ | Callback is called with `err` in case of error.               |
+| Param        | Type     | Description                                                   |
+| ------------ | -------- | ------------------------------------------------------------- |
+| `bucketName` | _string_ | Name of the bucket.                                           |
+| `objectName` | _string_ | Name of the object.                                           |
+| `removeOpts` | _object_ | Defaults to {}. e.g `{versionId:"my-version-id"}`. (Optional) |
 
 **Example**
 
 ```js
-minioClient.removeObjectTagging('bucketname', 'object-name', function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await minioClient.removeObjectTagging('bucketname', 'object-name')
 ```
 
 **Example1**
 Remove tags on a version of an object.
 
 ```js
-minioClient.removeObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' }, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await minioClient.removeObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' })
 ```
 
 <a name="getObjectTagging"></a>
@@ -1509,15 +1470,14 @@ Get Tags of an Object
 **Example**
 
 ```js
-const tagsList = await minioClient.getObjectTagging('bucketname', 'object-name')
-console.log('Success', tagsList)
+console.log(await minioClient.getObjectTagging('bucketname', 'object-name'))
 ```
 
 **Example1**
 Get tags on a version of an object.
 
 ```js
-const tagsList = await minioClient.getObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' })
+console.log(await minioClient.getObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' }))
 ```
 
 <a name="getObjectLegalHold"></a>

diff --git a/examples/remove-bucket-tagging.js → examples/remove-bucket-tagging.mjs b/examples/remove-bucket-tagging.js → examples/remove-bucket-tagging.mjs
@@ -25,9 +25,4 @@ const s3Client = new Minio.Client({
   secretKey: 'YOUR-SECRETACCESSKEY',
 })
 
-s3Client.removeBucketTagging('bucketname', function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await s3Client.removeBucketTagging('bucketname')
diff --git a/examples/remove-object-tagging.js → examples/remove-object-tagging.mjs b/examples/remove-object-tagging.js → examples/remove-object-tagging.mjs
@@ -25,17 +25,7 @@ const s3Client = new Minio.Client({
   secretKey: 'YOUR-SECRETACCESSKEY',
 })
 
-s3Client.removeObjectTagging('bucketname', 'object-name', function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await s3Client.removeObjectTagging('bucketname', 'object-name')
 
 //remove tags on a version of an object
-s3Client.removeObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' }, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await s3Client.removeObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' })
diff --git a/examples/set-bucket-tagging.js → examples/set-bucket-tagging.mjs b/examples/set-bucket-tagging.js → examples/set-bucket-tagging.mjs
@@ -25,11 +25,5 @@ const s3Client = new Minio.Client({
   secretKey: 'YOUR-SECRETACCESSKEY',
 })
 
-const tagsMap = { tagkey: 'tagvalue' }
-
-s3Client.setBucketTagging('bucketname', tagsMap, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+const tagsMap = { tagkey: 'my-bucket-tag' }
+await s3Client.setBucketTagging('test-bucket', tagsMap)
diff --git a/examples/set-object-tagging.js → examples/set-object-tagging.mjs b/examples/set-object-tagging.js → examples/set-object-tagging.mjs
@@ -27,17 +27,7 @@ const s3Client = new Minio.Client({
 
 const tagsMap = { tagkey: 'tagvalue' }
 
-s3Client.setObjectTagging('bucketname', 'object-name', tagsMap, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await s3Client.setObjectTagging('bucketname', 'object-name', tagsMap)
 
 //Put tags on a version of an object
-s3Client.setObjectTagging('bucketname', 'object-name', tagsMap, { versionId: 'my-version-id' }, function (err) {
-  if (err) {
-    return console.log(err)
-  }
-  console.log('Success')
-})
+await s3Client.setObjectTagging('bucketname', 'object-name', tagsMap, { versionId: 'my-version-id' })