Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some notifications include update and canonical link in links array #82

Open
antje-s opened this issue Jan 23, 2024 · 7 comments
Open

Comments

@antje-s
Copy link
Contributor

antje-s commented Jan 23, 2024

Should we add to Requirement 11:
"H": The links array property SHALL provide only one link with a link relation of http://def.wmo.int/def/rel/wnm/-/deletion, http://def.wmo.int/def/rel/wnm/-/update or IANA link relation of canonical"
to be more precise, whether it is new data, an update or a deletion.

@amilan17
Copy link
Member

for reference, the other requirements in Req. 11:

  • E | For new data and metadata notifications, the links array property SHALL provide at least one link with an IANA link relation of canonical to clearly identify the preferred access link.
  • F | For data or metadata update notifications, the links array property SHALL provide at least one link with a link relation of http://def.wmo.int/def/rel/wnm/-/update to clearly identify the preferred access link.
  • G | For data or metadata deletions, the links array property SHALL provide at least one link with a link relation of http://def.wmo.int/def/rel/wnm/-/deletion to clearly identify data which has been deleted or removed.

@amilan17
Copy link
Member

Note, this is different than what we are doing with WCMP2 which has these distinct properties instead:

  • created | optional | The date that the link was created
  • updated | optional | The date that the link was updated

@amilan17
Copy link
Member

@wmo-im/tt-wismd

@josusky
Copy link
Contributor

josusky commented Jan 24, 2024

@antje-s are you objecting the formulation "at least one" and would prefer to have there "exactly one"?
I mean, it would make sense. Until now, we implicitly expected that one notification talks about one data (or metadata) item/record, not about multiple. We have array of links, to be able to provide additional information (in the form of links). I do not think anyone really expects a notification with multiple links marked as "canonical" or as "http://def.wmo.int/def/rel/wnm/-/deletion".
@tomkralidis any comments from your side?

@antje-s
Copy link
Contributor Author

antje-s commented Jan 24, 2024

The messages should not contain links for canonical and update (or deletion) at the same time. The notification is either for new data OR an update for already published data. Change to "exactly one" would be good, but then someone could still include "exactly one" canonical link AND "exactly one" update link.

@josusky
Copy link
Contributor

josusky commented Nov 17, 2024

I have also stumbled upon notifications with both "canonical" and "update" links. We should definitely clarify this. The current formulation allows multiple canonical links too. I suggest to change /req/core/links (Requirement 11) as follows:

E. For new data and metadata notifications, the links array property SHALL provide exactly one link with an IANA link relation value canonical to clearly identify the preferred access link.
F. For data or metadata update notifications, the links array property SHALL provide exactly one link with a link relation value update to clearly identify the preferred access link.
G. For data or metadata deletions, the links array property SHALL provide exactly one link with a link relation value deletion to clearly identify data which has been deleted or removed.

and add one more requirement:

I. The links array property SHALL contain only one link with relation value canonical, update, or deletion. These relations cannot be combined within one WNM.

Of course, suggestions for better formulations are welcomed, but the current formulations with "at least one" are obviously causing confusion.

@tomkralidis
Copy link
Collaborator

TT-WISMD 2024-11-27

  • option to update WNM per:
    • update Requirements 11E and 11F to update "at least one" to "exactly one"
    • add 11I per @josusky 's comment The links array property SHALL contain **only one** link with relation value canonical, update, or deletion. These relations SHALL NOT be combined within one WNM.

ACTION: @amilan17 to investigate update workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants