Skip to content

docs(idempotency): fix descriptions in Advanced table #3092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 25, 2024
Merged

docs(idempotency): fix descriptions in Advanced table #3092

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f6f8cfe
fix descriptions in advanced table
garysassano Sep 20, 2024
d52a4fc
update description
garysassano Sep 20, 2024
6af10c4
Merge branch 'main' into patch-1
garysassano Sep 20, 2024
51fd8c2
Merge branch 'main' into patch-1
garysassano Sep 24, 2024
eaff787
Merge branch 'main' into patch-1
dreamorosi Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/utilities/idempotency.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,16 +569,16 @@ When using DynamoDB as a persistence layer, you can alter the attribute names by

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

| Parameter | Default | Description |
| ----------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **eventKeyJmespath** | `''` | JMESPath expression to extract the idempotency key from the event |
| **payloadValidationJmespath** | `''` | JMESPath expression to validate whether certain parameters have changed in the event while the event payload |
| **throwOnNoIdempotencyKey** | `false` | Throw an error if no idempotency key was found in the request |
| **expiresAfterSeconds** | 3600 | The number of seconds to wait before a record is expired |
| **useLocalCache** | `false` | Whether to locally cache idempotency results |
| **localCacheMaxItems** | 256 | Max number of items to store in local cache |
| **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. |
| **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) |
| Parameter | Default | Description |
| ----------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **eventKeyJmespath** | `''` | JMESPath expression to extract the idempotency key from the event record using [built-in functions](./jmespath.md#built-in-jmespath-functions){target="_blank"} |
| **payloadValidationJmespath** | `''` | JMESPath expression to validate that the specified fields haven't changed across requests for the same idempotency key _e.g., payload tampering._ |
| **throwOnNoIdempotencyKey** | `false` | Throw an error if no idempotency key was found in the request |
| **expiresAfterSeconds** | 3600 | The number of seconds to wait before a record is expired, allowing a new transaction with the same idempotency key |
| **useLocalCache** | `false` | Whether to cache idempotency results in-memory to save on persistence storage latency and costs |
| **localCacheMaxItems** | 256 | Max number of items to store in local cache |
| **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. |
| **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) |

### Handling concurrent executions with the same payload

Expand Down