ome / ngff

Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.
https://ngff.openmicroscopy.org
Other
110 stars 38 forks source link

file extension for schema documents #236

Open d-v-b opened 2 months ago

d-v-b commented 2 months ago

The schema documents are named with a .schema file extension. Because the schema documents are JSON schema, (which is JSON) .json is probably the right file extension to use instead. This change would make these documents much easier to read / edit, e.g. on github or in IDEs that provide json syntax highlighting. If it's important to designate these documents as JSON schema, we could do <name>.schema.json.

Is there a compelling reason for .schema as an extension, or can we move to schema.json?

d-v-b commented 2 months ago

important to consider here that downstream libraries may pull in the schema documents by name for testing.

So some redirection or duplication would be necessary to avoid breaking those workflows after name changes.