Normalization of error status and code allowed values#316
Conversation
Co-authored-by: Eric Murray <eric.murray@vodafone.com>
Co-authored-by: Eric Murray <eric.murray@vodafone.com>
…o normalize_error_status_code_enums_in_error_responses
|
PR ready for review (@patrice-conil, @eric-murray, @rartych, @shilpa-padgaonkar) |
patrice-conil
left a comment
There was a problem hiding this comment.
Just a remark about difference between 410/412 errors (see comment)
@rartych I'm not sure if this statement is 100% correct. I would agree that the introduction of ENUM isn't a break for API consumers (mainly effort for the changes of the API definitions), but the replacement of "422 UNSUPPORTED_DEVICE_IDENTIFIERS" could be a breaking change for API consumers who have checked on this code. |
Agree @hdamker it is breaking change. Already documented/changed in PR description |
What type of PR is this?
What this PR does / why we need it:
This PR aims to define a normalization of error
statusandcodeallowed values for CAMARA APIs, by means of the use of a common chema model that can be applied for every excepction scenario.Taking advantage of this PR also a correction is managed:
422 UNSUPPORTED_DEVICE_IDENTIFIERSexception renamed to422 UNSUPPORTED_IDENTIFIERindicated in API Design guidelines is also included inCAMARA_common.yamlAlso making exceptions alignment as per this comment in
CAMARA_common.yaml. Updates in API Design guidelines Section 6.2 will be managed by Update error codes and info.description template for device / phone number identifiers #324 and Enhancements and Alignments in Errors #329Which issue(s) this PR fixes:
Fixes #196
Does this PR introduce a breaking change?
Special notes for reviewers:
Documentation impacted:
Once this PR is agreed (i.e. the baseline), other artifacts would have to be updated:
We can talk this point in the next commonalities meeting (14/10) and aligned this with @bigludo7
Changelog input
Additional documentation
N/A