Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalization of error status and code allowed values #316

Conversation

PedroDiez
Copy link
Contributor

@PedroDiez PedroDiez commented Oct 11, 2024

What type of PR is this?

  • correction
  • enhancement

What this PR does / why we need it:

This PR aims to define a normalization of error status and code allowed 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:

Which issue(s) this PR fixes:

Fixes #196

Does this PR introduce a breaking change?

  • Yes
  • No

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

Normalization of error `status` and `code` allowed values for CAMARA APIs.

Additional documentation

N/A

PedroDiez and others added 5 commits November 5, 2024 19:26
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
@PedroDiez
Copy link
Contributor Author

PR ready for review (@patrice-conil, @eric-murray, @rartych, @shilpa-padgaonkar)

Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a remark about difference between 410/412 errors (see comment)

Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@rartych rartych left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rartych rartych merged commit c187d24 into camaraproject:main Nov 27, 2024
1 check passed
@hdamker
Copy link
Collaborator

hdamker commented Dec 6, 2024

Does this PR introduce a breaking change?

  • Yes
  • No

@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.

@PedroDiez
Copy link
Contributor Author

Does this PR introduce a breaking change?

  • Yes
  • No

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Specify allowed values for error status and code in the error schema
5 participants