Skip to content

Commit 4bb06bf

Browse files
committed
added idempotency
1 parent 2e9de99 commit 4bb06bf

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

  • software-development-practices

software-development-practices/api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ This document outlines minimum expectations for API specification across ROOST p
2727
| API versioning strategy | How are API versions communicated? (URL path, header, etc.) | P1 |
2828
| Deprecation notices | Deprecated endpoints are marked in the spec before removal | P1 |
2929

30+
## Idempotency
31+
| Item | Description/Notes | Priority |
32+
| ------- | --------- | -------- |
33+
| Idempotency for mutating operations | Document which `POST`, `PUT`, and `PATCH` endpoints are idempotent. Non-idempotent `POST` endpoints should support an idempotency key to allow safe client retries | P1 |
34+
3035
## Non-HTTP APIs
3136
| Item | Description/Notes | Priority |
3237
| ------- | --------- | -------- |

0 commit comments

Comments
 (0)