ga4gh-beacon / beacon-v2

Unified repository for the GA4GH Beacon v2 API standard
Creative Commons Zero v1.0 Universal
27 stars 22 forks source link

for templates the format must be "uri-template". #110

Closed redmitry closed 1 month ago

redmitry commented 1 year ago

in the beaconMapSchema.json some URLs are templates and must have the uri-template" format (#103).

jrambla commented 10 months ago

IMU not all the uri you have modified are uri-templates (e.g. filteringterms). I'm fine with changing all (?) to uri-templates, if a non-template uri could be expressed as uri-template, is that true?

costero-e commented 10 months ago

I would say uri-template is more like a type of uri, not the other way round. If we say something is a uri-template we are excluding uri that don't include braces {} with a parameter. What do you think @redmitry ?

redmitry commented 10 months ago

https://datatracker.ietf.org/doc/html/rfc6570

uri-template is an URI "with variables" - it is as in the name - a template to produce the URI. Technically any URI should be a valid template with no variables... My point is that for the endpoints that includes {xxx} variables are not valid URIs, but are "uri-template"s.

Another thing is that Json Schemas 2019-2020 by default should just ignore "format". My validator validates it and reports an error. Current Beacon Network uses "fixed" schema (not from github) for the /map: see the difference: beaconMapResponse.json vs beaconEntryTypesResponse.json

So could we use "uri-template" in all places? Yes. But I see no point.

Best,

Dmitry

costero-e commented 10 months ago

Thank you @redmitry . So, are we still willing to accept this PR? Or can we close it?

redmitry commented 10 months ago

Thank you @redmitry . So, are we still willing to accept this PR? Or can we close it?

IMO this should be in the main branch.

costero-e commented 10 months ago

Still, one review pending, @mbaudis or @jrambla. Thank you.