Add Event versioning section to Guide document#475
Add Event versioning section to Guide document#475rartych merged 14 commits intocamaraproject:mainfrom
Conversation
Update CAMARA-API-Event-Subscription-and-Notification-Guide.md Change type attribute definition from api-version to event-version
Update with decisions and comments from the RM call on 2025-05-06.
add text on breaking and non-breaking changes
Updates following the review on 2025-06-04.
documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md
Outdated
Show resolved
Hide resolved
…uide.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>
|
Good catch Rafal :-) |
|
@tanjadegroot In line 145 replace: with: |
another goo d catch. I though that had already been changed. Should the note on an array value be kept ? |
update of the table - types parameter.
Yes - it will be changed with PR #477 - I hope without conflict. |
documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md
Outdated
Show resolved
Hide resolved
…uide.md add section link Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>
|
Also align some information in https://github.com/camaraproject/Commonalities/blob/main/artifacts/camara-cloudevents/event-subscription-template.yaml#L8. Replace:
By
|
PedroDiez
left a comment
There was a problem hiding this comment.
Fine to me, commented a minor point
corrected api-version to event-version
Fixed - I checked for all occurrences of "api-version" and they are covered now (where applicable) |
|
@rartych @hdamker I know we discussed this, but at second thought I think this is the last (good) opportunity to change the place of the version field to put it behind the event-name: api-name.event-name.event-version Advantage: Putting the event-version after the event-name may help in reducing any confusion wrt to the API version. I checked, and currently we have around 8 subscription APIs (6 in Spring25) and all are still initial APIs so it should not be a big deal if we change now. We can leave the API updates to be done for M4. |
As far as I have seen unique stable API impacted would be "quality-on-demand". Rest of impacted APIs are initial versions so far |
As codeowner in QualityOnDemand I would like to keep the v1.0.0 API and v1 "event family" stable, and change to a new event versioning approach only later (or not at all as long there are no other changes to the event data structure). We don't have the alternative to offer both event types in parallel unfortunately. |
OK, actually, I think one could introduce the change by adding a new event type (with the same version in a different place) and a copy of the same event structure in a backward compatible way in a next release, and and deprecating the old one 2 releases later (as per the standard defined procedure). OK, fine to take time for more discussion on this. /LGTM as is then. |
That's unfortunately does not work with implicit subscriptions like in quality-on-demand.
Sorry ... I guess we have called it an "event set" in the discussion. |
|
Am I assuming correctly that this merge will be done by the commonalities team or should I do it ? |
What type of PR is this?
What this PR does / why we need it:
Add the section on event versioning to the Guide document.
Which issue(s) this PR fixes:
Fixes #474
Does this PR introduce a breaking change?
Special notes for reviewers:
I have moved some of the text out of and under the table as markdown does not support linebreaks in table cells :-(
Additional documentation
Same text on wiki (same text): https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14557919/API+versioning#Event-versioning