-
-
Notifications
You must be signed in to change notification settings - Fork 213
Clarify the specification links are to the latest version of the schema #51
Comments
Perhaps we should just remove the version identifier and use a date, for the documents. And with this method, v4, and later v5, can identify the meta-schemas. |
@awwright that seems like a good idea. Also, I feel like we should give ourselves the option of releasing updates to the three different documents independently, and the v4, v5... notation doesn't hold up well to that. But if we have some nice core and validation fixes to get feedback on while we're bogged down on some big hyper-schema thing, it would be nice to be able to put those out. |
I feel that releasing updates to document seperatly is OK, but I also feel a bit uneasy. It may be intended to make this possible by splitting the spec to several documents, but it causes a problem if we proceed down that road. Allowing updates to the documents seperatly is fine, IF at least one of the following is true:
Otherwise, we could run into fractions of the specification, as I've outlined above. |
I'm happy to change the wording for the text relating to this issue to just say 'latest', however we should then also make clear that the metaschemas may not be the latest, and that someone looking at them should check to which draft they pertain. |
@Relequestual I don't feel any need to rush in to independently releasing things. I'm hoping that we can stabilize core soon and not need to update it further most of the time. Also, there's no separate meta-schema for core. While we only list the meta-schemas as informative, for most people it is the |
After some discussion with @awwright on irc, my take away was the following.
As an aside
|
I hope this is supposed to be "draft-6 is being worked on", as publishing a draft-6 of the specification and draft-5 of the meta-schema and leaving the meta-schema number one behind would be very confusing. |
@handrews the meta-schema for draft 5 is being worked on. I expect that to be completed before the spec draft-6 documents. Perosnally, I'd like to suggest that future specs are released with meta-schemas so we don't have this lag. Did you say you believe creating a correct meta-schema for draft-5 is not possible? If that's the case, then we need to say that in stead, somehow. |
@Relequestual I submitted a meta-schema for draft 5 a while back and @awwright rejected it because draft 5 is already published and can't be changed, and he insisted that it does not need its own meta-schema. I later added the meta-schema changes for draft 5 to what's now the draft 6 work, and that commit could easily be spliced out for a branch or something if we want to release a draft 5 meta-schema. I expressed a great deal of frustration over the lack of meta-schema for draft 5 and was repeatedly told that I was wrong and should drop it, so I'm puzzled now. I thought a lack of meta-schema was a major flaw with draft 5 but my attempts to fix that were decisively rejected. |
I don't even know what this means. The fix is already in master. |
well... =[
If the meta-schemas are already for draft 5, and you mean on master for THIS repo, then great! As for your previous comment... that's just bonkers and I missed that discussion. If you still have / can get at the draft 5 meta-schema, onto the website it will go! No questions... Although we shall see what @awwright says to all this tomorrow... I will make sure he sees this on irc... |
I'll make a PR for draft 5 on this repo later today. I can easily strip out the draft 6 changes that are on master (and actually I think adding "$ref" to the meta-schema is still caught up in a PR awaiting approval for > 3 weeks now, so I can add that in for the PR on this repo). |
RIGHTO! |
For reference #57 |
I'd really like to figure out a different way of referring to I-D publications other than by a number we give it, because such a scheme is going to get really confusing now that the IETF has restarted numbering, and it'll get even more confusing as we publish more documents. |
@awwright We've discussed this. There is no other satisfactory method. Sorry. |
@Relequestual And this doesn't have anything to do with the meta-schema or implementation requirements; I'm merely suggesting our references to the Internet-Draft should try to use the official IETF designation where possible - if others have to use the serial number for the collection, they can, even if it's a bit confusing. For example, the tag is named this way: https://github.com/json-schema-org/json-schema-spec/releases |
Yeah... I'm wondering if others would are happy about that... I'd have much rather it was tagged with draft-5 with a reference to the full IETF designation. Simple is best. Going back to draft 0, 1, 2, etc would be WAY more confusing. I wouldn't be supprised if others would have mentioned it if you'd asked before making the tag. |
I mean, this issue exists because it's confusing and we need to be clear. If we say draft 5 = these documents on the website, I see no problem. #56 is enough for me. |
Blocked because of discussion at json-schema-org/json-schema-spec#168 |
I decided to merge #56 as there was no further comments or discussion. |
Looks great 🎉. Close away. |
Currently it's implied the links are to Draft 4, but they're not.
The text was updated successfully, but these errors were encountered: