Skip to content

Commit 8d3fee2

Browse files
Apply suggestions from code review
Co-authored-by: Leandro Damascena <[email protected]> Signed-off-by: Heitor Lessa <[email protected]>
1 parent aeece16 commit 8d3fee2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/utilities/idempotency.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Unless you're looking to use an [existing table or customize each attribute](#dy
101101
| Configuration | Value | Notes |
102102
| ------------------ | ------------ | ---------------------------------------------------------------------------------------- |
103103
| Partition key | `id` | Format: <br> `{lambda_fn_name}.{module_name}.{fn_qualified_name}#{idempotency_key_hash}` |
104-
| TTL attribute name | `expiration` | Using AWS Console? this is configurable after table creation |
104+
| TTL attribute name | `expiration` | Using AWS Console? This is configurable after table creation |
105105

106106
Note that `fn_qualified_name` means the [qualified name for classes and functions](https://peps.python.org/pep-3155/){target="_blank" rel="nofollow"} defined in PEP-3155.
107107

@@ -207,7 +207,7 @@ By default, `idempotent_function` serializes, stores, and returns your annotated
207207

208208
The output serializer supports any JSON serializable data, **Python Dataclasses** and **Pydantic Models**.
209209

210-
!!! info "When using the `output_serializer` parameter, the data will continue to be stored in DynamoDB as a JSON string."
210+
!!! info "When using the `output_serializer` parameter, the data will continue to be stored in your persistent storage as a JSON string."
211211

212212
=== "Pydantic"
213213

@@ -321,7 +321,7 @@ We want to use `user_id` and `product_id` fields as our idempotency key. **If we
321321

322322
### Adjusting expiration window
323323

324-
!!! note "We expire idempotency records after **an hour** (3600 seconds). After that, a transaction with the same payload [will not be considered idempotent](#expired-idempotency-records)."
324+
!!! note "By default, we expire idempotency records after **an hour** (3600 seconds). After that, a transaction with the same payload [will not be considered idempotent](#expired-idempotency-records)."
325325

326326
You can change this expiration window with the **`expires_after_seconds`** parameter. There is no limit on how long this expiration window can be set to.
327327

@@ -436,7 +436,7 @@ You can customize the attribute names during initialization:
436436

437437
!!! info "We recommend Redis version 7 or higher for optimal performance."
438438

439-
For simple setups, initialize `RedisCachePersistenceLayer` with your cluster endpoint and port to connect.
439+
For simple setups, initialize `RedisCachePersistenceLayer` with your Redis endpoint and port to connect.
440440

441441
For security, we enforce SSL connections by default; to disable it, set `ssl=False`.
442442

0 commit comments

Comments
 (0)