Correcting status code 409 related error information.#569
Correcting status code 409 related error information.#569rartych merged 7 commits intocamaraproject:mainfrom
Conversation
tlohmar
requested review from
PedroDiez,
jlurien,
patrice-conil,
rartych and
shilpa-padgaonkar
as code owners
Removal of double quotes.
PedroDiez
left a comment
PedroDiez
left a comment
There was a problem hiding this comment.
Some editorial suggestions for alignment.
Look good Co-authored-by: Rafal Artych <[email protected]> Co-authored-by: Pedro Díez García <[email protected]>
artifacts/CAMARA_common.yaml
Outdated
| status: 409 | ||
| code: ABORTED | ||
| message: Concurrency conflict. | ||
| message: Resource is being modified by another operation. Please retry. |
There was a problem hiding this comment.
Is 'Please retry' always appropriate? The other operation that is modifying the resource may result in a resource state that means the intended operation is no longer required, or is outdated, or could cause conflict if retried. Maybe better to say 'Please wait, and read the new resource state before retrying (if appropriate)'
There was a problem hiding this comment.
We need to remember that in Commonalities we give only example of the message that should be modified in API definition as needed.
Suggestions are welcome if this example can be improved.
There was a problem hiding this comment.
Yes, this is just an example. The value of the message parameter is not defined by CAMARA. I assume that this comment is resolved by @rartych feedback.
Co-authored-by: Kevin Smith <[email protected]>
Co-authored-by: Rafal Artych <[email protected]>
Updating the scope/description of the ABORTED Error Code in both, common.yaml and Design Guide.
5 participants
What type of PR is this?
What this PR does / why we need it:
The PR addresses the recommendations proposed in Issue #562, including the deprecation of the error code
CONFLICT.The PR also improves the description, how these aligned error codes are related to the
ErrorInfoObject in the response body.Which issue(s) this PR fixes:
Fixes #562
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.