Skip to content

guideline_for_specversion_cloudevent_concept_as_enum#187

Merged
rartych merged 1 commit intomainfrom
guideline_for_specversion_cloudevent_concept_as_enum
Apr 26, 2024
Merged

guideline_for_specversion_cloudevent_concept_as_enum#187
rartych merged 1 commit intomainfrom
guideline_for_specversion_cloudevent_concept_as_enum

Conversation

@PedroDiez
Copy link
Contributor

What type of PR is this?

  • enhancement
  • documentation

What this PR does / why we need it:

It as been identified in #176 a misaligment in the way the "specversion" field is indicated in API Specs in some Working Gruops.
An aligment is required for any WG to use the same guideline.

Setting this field as an "enum" is foreseen the better option to avoid any misunderstandings both for API design and App developers expectation for its handling. This PR deals with it.

Which issue(s) this PR fixes:

Fixes #176

Special notes for reviewers:

N/A

Changelog input

 release-note - Align design guideline for cloudevent "specversion" field

Additional documentation

N/A

@PedroDiez PedroDiez requested a review from bigludo7 April 18, 2024 14:20
@PedroDiez PedroDiez added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 18, 2024
Copy link
Contributor

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

/LGTM

@shilpa-padgaonkar
Copy link
Contributor

@rartych : If you do not see any issues as well, could you kindly approve & merge?

@rartych rartych merged commit 4dd2d42 into main Apr 26, 2024
@rartych rartych mentioned this pull request Jun 5, 2024
@rartych rartych deleted the guideline_for_specversion_cloudevent_concept_as_enum branch October 9, 2024 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Align Common Design Model for Cloud Event specversion field in APIs Design

4 participants