Add documentation for API Status Kind #5350
Conversation
|
Thanks! |
|
Let's just leave #2974 open to handle that. |
| * `409 StatusConflict` | ||
| * Indicates that an item with the given identifier already exists and can't be created or can't be updated. | ||
| * Suggested client recovery behavior | ||
| * Do not retry. Fix the request: if creating a new item, change the identifier. If updating an item, ensure the `ResourceVersion` is up to date. |
There was a problem hiding this comment.
This case may require more explanation. You may also want to add a forward reference to the more detailed status response, below.
Unlike the cases above, an automatic response to 409 should typically be feasible.
For example, when updating, usually the client would GET the object, check the client's preconditions, re-merge changes if still valid according to preconditions, and retry with the updated request (including resourceVersion).
When creating, the client would GET and compare that the fields they tried to set matched the created object. Name uniqueness ensures idempotence in the presence of failure to receive a response, including due to failure of the client. A pre-existing object should be considered ok, provided it matched what the client wanted.
|
This is awesome! Just a couple comments. |
|
Thanks Brian! Addressed comments. |
| * Suggested client recovery behavior | ||
| * Do not retry. Fix the request. | ||
| * `429 StatusTooManyRequests` | ||
| * Indicates that the either the client rate limit has been exceeded or the server has recieved more requests then it can process. |
|
LGTM, other than the typo, which can be fixed in another PR. Thanks! |
Add documentation for API Status Kind
CC @bgrant0607