Skip to content

Commit

Permalink
Address Yusuke's comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
rofrankel committed Nov 29, 2023
1 parent 59db6d1 commit 79cdf96
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
9 changes: 6 additions & 3 deletions aep/general/0155/aep.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@

It is sometimes useful for an API to have a unique, customer-provided
identifier for particular requests. This can be useful for several purposes,
such as de-duplicating requests from parallel processes, ensuring the safety of
retries, or auditing.
such as:

- De-duplicating requests from parallel processes
- Ensuring the safety of retries
- Auditing

The purpose of idempotency keys is to provide idempotency guarantees: allowing
the same request to be issued more than once without subsequent calls having
Expand Down Expand Up @@ -41,7 +44,7 @@ message CreateBookRequest {
- If a duplicate request is detected, the server **should** return the
response for the previously successful request, because the client most
likely did not receive the previous response.
- APIs **may** choose any reasonable timeframe for honoring idempotency keys.
- APIs **should** honor idempotency keys for at least an hour.
- The `idempotency_key` field **must** be provided on the request message to
which it applies (and it **must not** be a field on resources themselves).
- Idempotency keys **should** be optional.
Expand Down
3 changes: 1 addition & 2 deletions aep/general/0155/aep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@ state: approved
slug: idempotency
created: 2019-05-06
placement:
category: design-patterns
category: requests
order: 60
redirect_from: '/idempotency'

0 comments on commit 79cdf96

Please sign in to comment.