Skip to content

Rename latest schema documents (#237) — moved from PR #462

@lubianat

Description

@lubianat

The PR #237 was opened by @d-v-b and stated:

changes the suffix of the schema documents in the latest version of the spec from .schema to .schema.json, to enable JSON syntax highlighting in text editors.
Because this will be a breaking change for anyone linking to the published schemas under the old names, this PR should not be merged until we reach a solution to this problem (e.g., a redirect).
addresses #236

The Pull Request currently needs to be ported to #ome/ngff-spec

Issue #236 stated:

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 .schema.json.

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

This issue supersedes #236, with an update.

On today's PR review (German-BioImaging/incubator#54) we discussed this as one of the first things after the 0.6 release (i.e. for 1.0.dev), if that is okay.

@jo-mueller may make the PR when the time comes, though others are welcome to do so too

Metadata

Metadata

Assignees

No one assigned

    Labels

    infraConcern: basic infrastructure

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions