Skip to content

Commit 05c16e5

Browse files
docs(idempotency): fix descriptions in Advanced table (#3092)
Co-authored-by: Andrea Amorosi <[email protected]>
1 parent cc3b4d3 commit 05c16e5

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/utilities/idempotency.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -569,16 +569,16 @@ When using DynamoDB as a persistence layer, you can alter the attribute names by
569569

570570
Idempotent decorator can be further configured with **`IdempotencyConfig`** as seen in the previous examples. These are the available options for further configuration
571571

572-
| Parameter | Default | Description |
573-
| ----------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
574-
| **eventKeyJmespath** | `''` | JMESPath expression to extract the idempotency key from the event |
575-
| **payloadValidationJmespath** | `''` | JMESPath expression to validate whether certain parameters have changed in the event while the event payload |
576-
| **throwOnNoIdempotencyKey** | `false` | Throw an error if no idempotency key was found in the request |
577-
| **expiresAfterSeconds** | 3600 | The number of seconds to wait before a record is expired |
578-
| **useLocalCache** | `false` | Whether to locally cache idempotency results |
579-
| **localCacheMaxItems** | 256 | Max number of items to store in local cache |
580-
| **hashFunction** | `md5` | Function to use for calculating hashes, as provided by the [crypto](https://nodejs.org/api/crypto.html#cryptocreatehashalgorithm-options){target="_blank"} module in the standard library. |
581-
| **responseHook** | `undefined` | Function to use for processing the stored Idempotent response. This function hook is called when an existing idempotent response is found. See [Manipulating The Idempotent Response](idempotency.md#manipulating-the-idempotent-response) |
572+
| Parameter | Default | Description |
573+
| ----------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
574+
| **eventKeyJmespath** | `''` | JMESPath expression to extract the idempotency key from the event record using [built-in functions](./jmespath.md#built-in-jmespath-functions){target="_blank"} |
575+
| **payloadValidationJmespath** | `''` | JMESPath expression to validate that the specified fields haven't changed across requests for the same idempotency key _e.g., payload tampering._ |
576+
| **throwOnNoIdempotencyKey** | `false` | Throw an error if no idempotency key was found in the request |
577+
| **expiresAfterSeconds** | 3600 | The number of seconds to wait before a record is expired, allowing a new transaction with the same idempotency key |
578+
| **useLocalCache** | `false` | Whether to cache idempotency results in-memory to save on persistence storage latency and costs |
579+
| **localCacheMaxItems** | 256 | Max number of items to store in local cache |
580+
| **hashFunction** | `md5` | Function to use for calculating hashes, as provided by the [crypto](https://nodejs.org/api/crypto.html#cryptocreatehashalgorithm-options){target="_blank"} module in the standard library. |
581+
| **responseHook** | `undefined` | Function to use for processing the stored Idempotent response. This function hook is called when an existing idempotent response is found. See [Manipulating The Idempotent Response](idempotency.md#manipulating-the-idempotent-response) |
582582

583583
### Handling concurrent executions with the same payload
584584

0 commit comments

Comments
 (0)