Skip to content

Explain meta-schema status and support #141

Open
@handrews

Description

@handrews

Every time we fix a bug in place someone complains, so explain somewhere that we do that, what it means, and that it's on purpose. Also say something about what sort of changes would not be fixed in place.

TL;DR: If the meta-schema contradicts the spec, and the fix will not cause problems with users who were complying with reasonable interpretations the spec, then we'll fix it in place. Examples:

  • Leaving out a keyword. Adding it in will only cause problems if someone was using the keyword for something else. Most users would prefer the meta-schema to detect improper use
  • Egregiously wrong defaults, like the string "true" instead of the boolean true. Defaults are not intended to be automatically written into instances, but if the default is the wrong type then anyone who attempts to use it will have problems.

I can't come up with something that we wouldn't fix in place, as the more dramatically breaking things would probably be caught as soon as people start using it. In which case it's better to fix even a dramatic thing in place. But let's say something about the possibility so people don't completely freak out thinking that we'll just arbitrarily mess with it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: On HoldSimilar to blocked, but is assigned to someone.📝 DocumentationIndicates improvements or additions to documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions