phenopackets / phenopacket-format

26 stars 10 forks source link

Remove redundancy in JSON-schema #55

Open cmungall opened 8 years ago

cmungall commented 8 years ago

The json-schema has many repetitive sections. This is not in itself wrong, but it can be confusing and/or intimidating to people trying to introspect the format directly from the jsons (in fact they should use model documentation, which we need to provide - https://github.com/phenopackets/phenopacket-reference-implementation/issues/17 )

If we use $ref tags we can simplify it - however, some tools may not respect these (cc @kshefchek )

kshefchek commented 8 years ago

$ref tags will work for the python validators if they refer to an internal path, see http://spacetelescope.github.io/understanding-json-schema/structuring.html

If they refer to a URI (urn:something:...) then it will attempt to resolve it as an URI and fail.