search

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
9 stars 24 forks source link

guideline_for_specversion_cloudevent_concept_as_enum #187

Closed PedroDiez closed 2 months ago

PedroDiez commented 2 months ago

What type of PR is this?

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

shilpa-padgaonkar commented 2 months ago

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