search

RSNA / ACR-RSNA-CDEs

JSON schema and other materials related to the joint ACR-RSNA project to create common data elements.
https://radelement.org/
14 stars 5 forks source link

Schema version #37

Closed shadowdoc closed 5 months ago

shadowdoc commented 5 months ago

Renamed version -> [set_version, element_version] and added schema_version to both set and element levels.

Updated SampleDES.cde.json accordingly.

Closes #36

shadowdoc commented 5 months ago

From @talkasab:

Would it be better to require the $schema element and have it point to a specific version of the schema rather than having to say, “Such and such version”, and then have to go look that up? The URL could effectively be the version.

My response: Very interesting concept and probably a good idea. I think that $schema is required for JSON Schema compliance and we probably shouldn't overload or remove that. It looks like others suggest using $id. I found the third answer here particularly useful. https://stackoverflow.com/questions/61077293/is-there-a-standard-for-specifying-a-version-for-json-schema

talkasab commented 5 months ago

Could I propose that we use the $id field of the schema file itself to show a URL for the schema which is locked to a specific Github tag/release. The URL will include the tag/version information within it so it will be clear what version it is. Then, each CDE Set JSON file can have the $schema property pointing to that fixed version of the schema. Does this make sense?

shadowdoc commented 5 months ago

Following committee discussion we decided:

shadowdoc commented 5 months ago

@talkasab and @SuP3RM - can you review again? I believe we're ready.