chore: add tokenId optional parameter for generateDisposableToken docs

momentohq · Dec 18, 2024 · b8bf4ad · b8bf4ad
1 parent 25510ee
commit b8bf4ad
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/cache/develop/api-reference/auth.md b/docs/cache/develop/api-reference/auth.md
@@ -109,6 +109,10 @@ The auth APIs create and manage API keys and tokens for Momento services. These
         - **scope** - [*DisposableTokenScope*](#disposabletokenscope-objects): The permissions to grant to the new disposable token. Pre-built DisposableTokenScope objects are provided by the SDKs.
         - **expiresIn** - *Number* \| *ExpiresIn object*: The number of seconds until the token expires or an ExpiresIn object representing a duration by calling the ExpiresIn.minutes() or ExpiresIn.hours(1) methods. Disposable tokens must expire within 1 hour.
 
+        #### Optional Parameters
+        ----------------
+        - **tokenId** - *string*: user-provided string that can help identify which messages were published with which disposable token.
+
         #### Returns
         ----------------
         One of the following:

diff --git a/docs/leaderboards/api-reference/auth.md b/docs/leaderboards/api-reference/auth.md
@@ -110,6 +110,10 @@ The auth APIs create and manage API keys and tokens for Momento services. These
         - **scope** - [*DisposableTokenScope*](#disposabletokenscope-objects): The permissions to grant to the new disposable token. Pre-built DisposableTokenScope objects are provided by the SDKs.
         - **expiresIn** - *Number* \| *ExpiresIn object*: The number of seconds until the token expires or an ExpiresIn object representing a duration by calling the ExpiresIn.minutes() or ExpiresIn.hours(1) methods. Disposable tokens must expire within 1 hour.
 
+        #### Optional Parameters
+        ----------------
+        - **tokenId** - *string*: user-provided string that can help identify which messages were published with which disposable token.
+
         #### Returns
         ----------------
         One of the following:

diff --git a/docs/topics/api-reference/auth.md b/docs/topics/api-reference/auth.md
@@ -109,6 +109,10 @@ The auth APIs create and manage API keys and tokens for Momento services. These
         - **scope** - [*DisposableTokenScope*](#disposabletokenscope-objects): The permissions to grant to the new disposable token. Pre-built DisposableTokenScope objects are provided by the SDKs.
         - **expiresIn** - *Number* \| *ExpiresIn object*: The number of seconds until the token expires or an ExpiresIn object representing a duration by calling the ExpiresIn.minutes() or ExpiresIn.hours(1) methods. Disposable tokens must expire within 1 hour.
 
+        #### Optional Parameters
+        ----------------
+        - **tokenId** - *string*: user-provided string that can help identify which messages were published with which disposable token.
+
         #### Returns
         ----------------
         One of the following: