Enhancements and Alignments in Errors #329
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PedroDiez
requested review from
shilpa-padgaonkar,
rartych,
patrice-conil and
RubenBG7
as code owners
2 tasks
…o Enhancements_and_Alignments_in_Errors
PedroDiez
changed the title
2 tasks
rartych
reviewed
Nov 25, 2024
Comment on lines
+785
to
+788
| **Mandatory Errors** to be **documented in CAMARA API Spec YAML** are the following: | ||
|
|
||
| - For event notifications flow, the ones defined in [notification-as-cloud-event.yaml](/artifacts/notification-as-cloud-event.yaml) | ||
| - For event subscriptions APIs, the ones defined in [event-subscription-template.yaml](/artifacts/camara-cloudevents/event-subscription-template.yaml) |
There was a problem hiding this comment.
I would prefer to include all normative requirements in the guidelines and use artifacts as illustrative files or templates.
It looks that we have respective requirements in chapter 12:
Suggested change
| **Mandatory Errors** to be **documented in CAMARA API Spec YAML** are the following: | |
| - For event notifications flow, the ones defined in [notification-as-cloud-event.yaml](/artifacts/notification-as-cloud-event.yaml) | |
| - For event subscriptions APIs, the ones defined in [event-subscription-template.yaml](/artifacts/camara-cloudevents/event-subscription-template.yaml) | |
| **Mandatory Errors** to be **documented in CAMARA API Spec YAML** are the following: | |
| - For event subscriptions APIs, the ones defined in [12.1 Subscription](#error-definition-for-resource-based-explicit-subscription) | |
| - For event notifications flow, the ones defined in [12.2 Event notification](#error-definition-for-event-notification) |
Currently these points in Design Guidelines are not changed in PR #313,
I propose to introduce these changes within this PR #329 after merging PR #313
WDYT @bigludo7 @PedroDiez ?
There was a problem hiding this comment.
It is fine, to be adressed after PR#313
rartych
reviewed
Nov 25, 2024
| - Error status 403 | ||
| - Error status 429 TOO_MANY_REQUESTS (For rate limit control) | ||
|
|
||
| NOTE: The rest of Error status defined in section 6.1. will be documented depending on specific considerations within a given WG. |
There was a problem hiding this comment.
Rephrasing and avoiding "WG" (it is rather Sub project or sandbox project working on API definition)
Suggested change
| NOTE: The rest of Error status defined in section 6.1. will be documented depending on specific considerations within a given WG. | |
| NOTE: The remaining Error statuses defined in section 6.1 will be documented based on specific considerations for the given API. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
This PR is to address agreements within #321
statusto be documented in API Spec YAMLWhich issue(s) this PR fixes:
Fixes #321
Does this PR introduce a breaking change?
Changes in error codes to be used in API defintions
Special notes for reviewers:
Ready for review
Changelog input
Additional documentation
N/A