Added docs for edge case in Sigv4Signer (#622)

* Added docs for edge case in Sigv4Signer Signed-off-by: nikolai biriukov <[email protected]> * Added PR to changelog Signed-off-by: nikolai biriukov <[email protected]> --------- Signed-off-by: nikolai biriukov <[email protected]>
opensearch-project · Oct 3, 2023 · cfcaea3 · cfcaea3
1 parent 394a844
commit cfcaea3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 ### Added
 - Added Security API
+- Documentation for edge-case in Sigv4Signer ([#622](https://github.com/opensearch-project/opensearch-js/pull/622))
 ### Dependencies
 - Bumps `rimraf` from 5.0.0 to 5.0.5
 - Bumps `eslint` from 8.41.0 to 8.50.0

diff --git a/USER_GUIDE.md b/USER_GUIDE.md
@@ -65,6 +65,7 @@ const client = new Client({
     getCredentials: () =>
       new Promise((resolve, reject) => {
         // Any other method to acquire a new Credentials object can be used.
+        // If you use profiles, make sure to pass role assumer, or use default provider fromNodeProviderChain
         AWS.config.getCredentials((err, credentials) => {
           if (err) {
             reject(err);