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

Subscriptions and Notifications artifacts errors aligment -enum values- #361

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

PedroDiez
Copy link
Collaborator

What type of PR is this?

  • correction
  • enhancement

What this PR does / why we need it:

This PR is needed in order to align both:

With the Error Model agreed for Metarelease Spring 25, in which for both status and code enum values are mormative.

Which issue(s) this PR fixes:

Fixes #354

Does this PR introduce a breaking change?

  • Yes
  • No

Breaking Changes:

  • In event-subscription-template.yaml new 422 errors are documented (think that makes sense) and also some of them are changed:

DEVICE_IDENTIFIERS_MISMATCH -> IDENTIFIER_MISMATCH
DEVICE_NOT_APPLICABLE -> SERVICE_NOT_APPLICABLE

NOTE: The indication of enum values for status and code might be understood as a breaking change if a former implementation did not consider in advance and other value was being used.

Special notes for reviewers:

notification-as-cloud-event.yaml - Besides Error alignment it is also removed 5xx error references (500 and 503), to be aligned to not document not mandatory errors.

Changelog input

 Subscriptions and Notifications artifacts errors aligment -enum values-

Additional documentation

N/A

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks Pedro

Copy link
Collaborator

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation enhancement New feature or request Spring25
Projects
None yet
3 participants