spec icon indicating copy to clipboard operation
spec copied to clipboard

Versioning field in the context part is confusing, maybe rename to specversion

Open m-linner-ericsson opened this issue 3 years ago • 7 comments

The version field https://github.com/cdevents/spec/blob/main/spec.md#version specifies that it defines the version of the specification. Also the https://github.com/cdevents/spec/blob/main/spec.md#type-context specifies that is should contain the version of the event. When looking at a event this is super confusing.

Proposal is to rename the version filed to something more descriptive that describes that it specifies the specification version. Maybe rename it to spec_version.

m-linner-ericsson avatar Feb 16 '23 08:02 m-linner-ericsson

We are missing the version part in some of our event examples. For example https://github.com/cdevents/spec/blob/main/spec.md#type-context and https://github.com/cdevents/spec/blob/main/spec.md#context-example

We could rename the top version with "specversion", but we might need to do it by deprecating the old parameter for some time first.

e-backmark-ericsson avatar Jun 05 '23 15:06 e-backmark-ericsson

@xibz proposed to make some user study to see how people perceive version fields in CDEvents and what impact this change would have - we should change it only if it actually solves the issue.

afrittoli avatar Jul 22 '24 15:07 afrittoli

@e-backmark-ericsson to check through Slack on how people understand the term 'version' in these cases.

Update Post written: https://cdeliveryfdn.slack.com/archives/C030SKZ0F4K/p1724755953895869

e-backmark-ericsson avatar Aug 26 '24 15:08 e-backmark-ericsson

As discussed in the WG on 09.09.2024 - we shall rename the version field to specversion in v0.5.

afrittoli avatar Sep 09 '24 15:09 afrittoli

My vote is change version to specversion

xbcsmith avatar Sep 09 '24 15:09 xbcsmith

we talked about this in both SIG regions, and decided to go with specversion

xibz avatar Sep 09 '25 14:09 xibz

Related PR (not blocking): https://github.com/cdevents/cdevents.dev/pull/54

afrittoli avatar Nov 06 '25 10:11 afrittoli