Skip to content

Decorate schema with specification version information #448

@jonnew

Description

@jonnew

I suggest that the JSON schema would be more useful if it was:

  1. Annotated with the spec version it validates
  2. Potentially versioned alongside spec releases (e.g., schema/0.2.21/probe.json.schema)

For versioning, one easy option is to add a comment:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$comment": "Validates the probeinterface specification version 0.3.2. See https://probeinterface.readthedocs.io",
....

This could be automated during the creation of a release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions