openactive / data-model-validator

The OpenActive data model validator library
MIT License
1 stars 1 forks source link

Data quality rule to check Discussion link in dataset site #417

Closed nickevansuk closed 8 months ago

nickevansuk commented 1 year ago

Validator should check that the discussion link in the dataset site resolves to a valid GitHub issues board (rather than just the repo, or some other location)

lukehesluke commented 9 months ago

@nickevansuk The Dataset API Discovery spec states, for discussionUrl:

Typically, although not necessarily, this will be a link to a GitHub repository

I suppose, in theory, it seems like non-GitHub repos should be supported (e.g. let's say a GitLab issues board or something else).

It would be useful to know what the impact of not doing this is?

If it seems like a useful thing to do, we could do something like:

(Although I understand this is quite a weak set of rules)

nickevansuk commented 9 months ago

Great point, and agreed we can't fail on anything that isn't in the spec.

Your suggestion makes sense to me: