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

Errors Documented in notification-as-cloud-event.yaml #348

Closed
PedroDiez opened this issue Nov 29, 2024 · 3 comments · Fixed by #351
Closed

Errors Documented in notification-as-cloud-event.yaml #348

PedroDiez opened this issue Nov 29, 2024 · 3 comments · Fixed by #351
Assignees
Labels
correction correction in documentation Spring25

Comments

@PedroDiez
Copy link
Collaborator

PedroDiez commented Nov 29, 2024

Problem description
While reviewing PR #329 and based on this comment, think maybe we need some actions with regards to the errors documented in the event notification artifact.

  1. Should we remove 500, 503 errors from the artifact (i.e. we assume any server exception is implicitly managed by the API consumer, in the same fashion as we do for Telco Operator)? And therefore align it in API Design guidelines?

  2. As in artifact are documented 400, 401, 403, 410, 429, should we considered all of them as mandatory? And therefore align it in API Design guidelines?

Parent Issue: #273

Expected behavior
Based on the output discussion.

Initially the proposal would be:

  • Remove Errors 500, 503 from the artifact. Align in API Design Guidelines
  • Consider Errors 410 and 429 as mandatory for event notifications. Align in API Design Guidelines

Alternative solution
Not evaluated

Additional context
Alignment of Errors the CAMARA guidelines
Based on output I can generate a PR or take advantage of ongoing PR #329

@PedroDiez PedroDiez added the correction correction in documentation label Nov 29, 2024
@PedroDiez
Copy link
Collaborator Author

@PedroDiez PedroDiez self-assigned this Nov 29, 2024
@bigludo7
Copy link
Collaborator

bigludo7 commented Dec 1, 2024

Hello @PedroDiez
To be sure to be aligned you mean in this file: https://github.com/camaraproject/Commonalities/blob/main/artifacts/notification-as-cloud-event.yaml ?
If yes fully aligned. I can do the PR.

@PedroDiez
Copy link
Collaborator Author

Hello @PedroDiez To be sure to be aligned you mean in this file: https://github.com/camaraproject/Commonalities/blob/main/artifacts/notification-as-cloud-event.yaml ? If yes fully aligned. I can do the PR.

Hello @bigludo7, Yes i refer to that document

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

Successfully merging a pull request may close this issue.

2 participants