Skip to content

Commit f8df545

Browse files
authored
Merge pull request #13 from ietf-wg-httpapi/jayadeba-patch-1
update my email id and incorporate some of the outstanding issues.
2 parents 1bc0427 + b17853d commit f8df545

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

draft-ietf-httpapi-idempotency-key-header.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ author:
2020
ins: J. Jena
2121
name: Jayadeba Jena
2222
organization: PayPal, Inc.
23-
email: jjena@paypal.com
23+
email: jayadebaj@gmail.com
2424

2525
-
2626
ins: S. Dalal
@@ -147,25 +147,25 @@ For each request, server SHOULD
147147

148148
## Error Scenarios
149149

150-
If the `Idempotency-Key` request header is missing for a documented idempotent operation requiring this header, the resource server MUST reply with an HTTP `400` status code with body containing a link pointing to relevant documentation. Alternately, using the HTTP header `Link`, the client can be informed about the error as shown below.
150+
If the `Idempotency-Key` request header is missing for a documented idempotent operation requiring this header, the resource server SHOULD reply with an HTTP `400` status code with body containing a link pointing to relevant documentation. Alternately, using the HTTP header `Link`, the client can be informed about the error as shown below.
151151

152152
HTTP/1.1 400 Bad Request
153153
Link: <https://developer.example.com/idempotency>;
154154
rel="describedby"; type="text/html"
155155

156-
If there is an attempt to reuse an idempotency key with a different request payload, the resource server MUST reply with a HTTP `422` status code with body containing a link pointing to relevant documentation. The status code `422` is defined in Section 11.2 of {{!RFC4918}}. The server can also inform the client by using the HTTP header `Link` as shown below.
156+
If there is an attempt to reuse an idempotency key with a different request payload, the resource server SHOULD reply with a HTTP `422` status code with body containing a link pointing to relevant documentation. The status code `422` is defined in Section 11.2 of {{!RFC4918}}. The server can also inform the client by using the HTTP header `Link` as shown below.
157157

158158
HTTP/1.1 422 Unprocessable Entity
159159
Link: <https://developer.example.com/idempotency>;
160160
rel="describedby"; type="text/html"
161161

162-
If the request is retried, while the original request is still being processed, the resource server MUST reply with an HTTP `409` status code with body containing a link or the HTTP header `Link` pointing to the relevant documentation.
162+
If the request is retried, while the original request is still being processed, the resource server SHOULD reply with an HTTP `409` status code with body containing a link or the HTTP header `Link` pointing to the relevant documentation.
163163

164164
HTTP/1.1 409 Conflict
165165
Link: <https://developer.example.com/idempotency>;
166166
rel="describedby"; type="text/html"
167167

168-
Error scenarios above describe the status of failed idempotent requests, after the resource server prcocesses them. Clients MUST correct the requests before performing a retry operation, or the the resource server MUST fail the request and return one of the above errors.
168+
Error scenarios above describe the status of failed idempotent requests after the resource server prcocesses them. Clients MUST correct the requests (with the execption of 409 where no correction is required) before performing a retry operation, or the the resource server MUST fail the request and return one of the above errors.
169169

170170
For other 4xx/5xx errors, such as 401, 403, 500, 502, 503, 504, 429, or any other HTTP error code that is not listed here, the client SHOULD act appropriately by following the resource server's documentation.
171171

0 commit comments

Comments
 (0)