OpenAPI-Specification
OpenAPI-Specification copied to clipboard
draft-bhutton-json-schema-00 is deprecated , Should the specification point to the 01 ?
in many places of the 3.2 it is using the Link https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-4.2.1
However the status of the document is set as Document type | Expired Internet-Draft (individual)
with a newer version
https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-01
should it be used instead ? if yes should it be backported to older 3.1.X and / or 3.0.X
I'd really like to deal with this, #2951, and #3800 iin a unified way, and document it under #3785.
I created an issue at json-schema github repo. Please see https://github.com/json-schema-org/json-schema-spec/issues/1539#issuecomment-2405827605
Maybe OAI can reference https://json-schema.org/draft/2020-12 instead of the IETF drafts?
We are ultimately using Specref for the normative references in the OpenAPI specification documents, and for v3.1.x these are
Both entries currently point to the corresponding IETF drafts -00.
These Specref entries are owned by the JSON Schema team, and if they decide to update them, our spec build process will pick that up the next time it runs.
Whether these entries will then point to the -01 IETF drafts or to the JSON Schema site is totally up to the JSON Schema team.
I propose closing this issue as we don't have to do anything.
@ralfhandl there is no functional difference between the -00 and -01 drafts. The -01 draft is like a patch release. That is why it is also "2020-12" even though it was released in 2021. There is no way to tell any implementation to distinguish between these.
However, it would be better to point readers to the -01 draft for the same reason that it is better to point our readers to 3.1.1 than to 3.1.0.
Ok, created
- https://github.com/tobie/specref/pull/856
to update the Specref entries. @Relequestual should cross-check whether this is ok.
Side note: if the Specref entries are changed, the next rebuild of the OAS specs will make 3.1.0 and 3.1.1 also reference the "-01" drafts.
@ralfhandl
Side note: if the Specref entries are changed, the next rebuild of the OAS specs will make 3.1.0 and 3.1.1 also reference the "-01" drafts.
That does not seem desirable, any more than having 3.1.0 and 3.1.1 suddenly point to RFC9110 instead of RFC7231.
@ralfhandl actually I guess that analogy is not entirely perfect as the RFCs have changes to some degree... it does feel strange though.
The Specref entries for the JSON Schema 2020-12 drafts have now been updated, which means on the next respec rebuild the 3.1.0 and 3.1.1 specs will list the newer drafts in the "Normative References" section.
Direct links to sections of these drafts remain unchanged in the 3.1.0 and 3.1.1 specs, which is a bit odd, but nothing we can reasonably do about. (The unreasonable solution would be to add even more hyperlink fiddling to the md2html.js script 😎)
For 3.2.0 the direct links are updated in
- #4467
These Specref entries are owned by the JSON Schema team, and if they decide to update them, our spec build process will pick that up the next time it runs.
I've talked to the rest of the JSON Schema team and none of us have heard of Specref or knew anything about these entries.
@karenetheridge I just assumed that whoever originally created the Specref entries for JSON Schema was affiliated with the JSON Schema team at the time 🤷♂
@Relequestual is an editor of these IETF drafts and commented positively on
- https://github.com/tobie/specref/pull/856
This apparently was good enough for the Specref maintainers to merge my pull request.