wmo-im / wis2-topic-hierarchy

WIS2 Topic Hierarchy
https://wmo-im.github.io/wis2-topic-hierarchy
Apache License 2.0
6 stars 4 forks source link

Q from pub department about versioning #181

Closed amilan17 closed 1 month ago

amilan17 commented 1 month ago

Question regarding the meaning of F in the versioning: A renaming or removal in the WMO Notification Message encoding SHALL result in a major version update.

"Just clarifying meaning here: should “in” be “of”? i.e. is it the WMO Notification Message encoding itself that is renamed or removed? The way it is currently written suggests that something contained inside the message encoding is renamed/removed."

1.4 Versioning
The topic hierarchy version helps data providers and data consumers with change management and transition in relation to updates.
Requirement 4   /req/core/versioning
A   A minor version SHALL NOT result in any changes to the version level.
B   A major version SHALL result in a change to the version level (for example, a becomes b).
C   Removal of a topic at any level SHALL result in a major version update.
D   Renaming of a topic at any level SHALL result in a major version update.
E   A change in the structure of the topic hierarchy SHALL result in a major version update.
F   A renaming or removal in  the WMO Notification Message encoding SHALL result in a major version update.
amilan17 commented 1 month ago

@antje-s -- do you have a minute to comment on this?

antje-s commented 1 month ago

The WNM format itself changed (deleted or updated fieldnames, added fields are unproblematic)

amilan17 commented 1 month ago

@antje-s Thank you.

tomkralidis commented 1 month ago

Thanks @antje-s. Yes "in" is intended.