Skip to content

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

Merged
rartych merged 1 commit intocamaraproject:mainfrom
PedroDiez:Error_responses_enum_alignment_notifications_and_subscriptions
Jan 8, 2025
Merged

Subscriptions and Notifications artifacts errors aligment -enum values-#361
rartych merged 1 commit intocamaraproject:mainfrom
PedroDiez:Error_responses_enum_alignment_notifications_and_subscriptions

Conversation

@PedroDiez
Copy link
Contributor

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

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

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

Development

Successfully merging this pull request may close these issues.

Error responses in event-subscription-template.yaml does not use enumeration of error status and code allowed values

4 participants