Skip to content

Commit 8ae6570

Browse files
committed
docs(idempotency): cleanup default behavior section
Signed-off-by: heitorlessa <[email protected]>
1 parent 285e7ff commit 8ae6570

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/utilities/idempotency.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -728,15 +728,15 @@ graph TD;
728728

729729
### Customizing the default behavior
730730

731-
Idempotent decorator can be further configured with **`IdempotencyConfig`** as seen in the previous example. These are the available options for further configuration
731+
You can override and further extend idempotency behavior via **`IdempotencyConfig`** with the following options:
732732

733733
| Parameter | Default | Description |
734734
| ------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
735735
| **event_key_jmespath** | `""` | JMESPath expression to extract the idempotency key from the event record using [built-in functions](./jmespath_functions.md#built-in-jmespath-functions){target="_blank"} |
736-
| **payload_validation_jmespath** | `""` | JMESPath expression to validate whether certain parameters have changed in the event while the event payload |
736+
| **payload_validation_jmespath** | `""` | JMESPath expression to validate whether certain parameters have changed in the event while the event payload _e.g., payload tampering._ |
737737
| **raise_on_no_idempotency_key** | `False` | Raise exception if no idempotency key was found in the request |
738-
| **expires_after_seconds** | 3600 | The number of seconds to wait before a record is expired |
739-
| **use_local_cache** | `False` | Whether to locally cache idempotency results |
738+
| **expires_after_seconds** | 3600 | The number of seconds to wait before a record is expired, allowing a new transaction with the same idempotency key |
739+
| **use_local_cache** | `False` | Whether to cache idempotency results in-memory to save on persistence storage latency and costs |
740740
| **local_cache_max_items** | 256 | Max number of items to store in local cache |
741741
| **hash_function** | `md5` | Function to use for calculating hashes, as provided by [hashlib](https://docs.python.org/3/library/hashlib.html){target="_blank" rel="nofollow"} in the standard library. |
742742
| **response_hook** | `None` | 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) |

0 commit comments

Comments
 (0)