JSON Schema draft version not specified
imartinezortiz opened this issue · comments
Filing an issue about the xAPI Profiles specification? Please include the following
- Which part/parts of the specification are at issue?
xAPI profiles structure, xAPI profiles about
- What is your understanding of what the spec means in these parts?
Both documents mentioned the JSON Schema specification but do not specify precisely the draft version that should be used whenever a JSON schema string is provided.
- Related to your implementation, what's the use case you're trying to achieve? What are the user stories you're trying to support?
Seems that there are some (breaking) changes between versions, so any xapi profile processing library (or some of its dependencies) needs to guess the draft version or give up validating the associated value to the schema.
- How you would like the specification to be improved?
I would like a clarification regarding the JSON schema version, versions, or minimum version that the schema definitions (either inline or reference) can be used. Note that there is a variable support of json schema drafts in different implementations
Per the 5/3/2022 will need to update to the latest JSON schema version. The latest version needs to be pinned down and said that is the version that is used. Make sure that there are no issues between the version that was used when the spec was written and the new version.
Whenever you use JSON Schema, use the latest version (could potentially link to the latest, @FeLungs will take this on.
Version at time of writing the xAPI Profile spec was Draft 7. Since then, there have been two major releases:
- Draft 8 added some additional features and reworked how the format key worked.
- Draft 9 which expanded on those features and also updated Items and additional Items
The documents are written as Internet-Drafts and there are no plans for joining a standardization body
Internet-Drafts expire after six months, so our goal is to publish often enough to always have a set of unexpired drafts available. There may be brief gaps as we wrap up each draft and finalize the text
Given this, we should keep an eye on JSON Schema during our work bc the most recent release was published on 2021-02-01 and there will likely be another release soon.
Opened #261 to clarify JSONSchema version that is currently used in the spec. But I suggest to keep this opened for future reference and update the Draft version in the new version of the specification
Just doing some maintenance on pending issues. As expected, new versions of the core and validation specifications have been published with new changes and clarifications
Moreover there some discussion in the JSON Schema Community to create a Charter in the OpenJS Foundation to clarify and steer the project effort.
Finally, there implementations in most programming / languages that support the 2020-12 specs (also known as Draft 9).