eiffel-community / eiffel-remrem

eiffel-remrem
Apache License 2.0
3 stars 12 forks source link

Validate purls in ArtC events #13

Open e-backmark-ericsson opened 1 year ago

e-backmark-ericsson commented 1 year ago

Description

The ArtC.identity field is a string representing a p ackage URL (purl). The Eiffel event json schemas cannot easily provide a format specification that would validate this field in a desired way, so a recommendation is instead that the event producers would validate this field explicitly.

Motivation

This kind of validation is better done in the event producer than in the json schemas. See also https://github.com/eiffel-community/eiffel/issues/324

Exemplification

There are package URL parsers that could be used to parse the data for the ArtC.identity field before creating/sending the event. See https://github.com/package-url/purl-spec#known-implementations

Benefits

Less risk of sending invalid ArtC events on the message bus

Possible Drawbacks

This would be a non-backwards compatible change since it would potentially reject to send events that are accepted today.