json-schema-org / json-hyperschema-spec

A *future* location for the JSON Hyper-Schema I-D sources.
14 stars 4 forks source link

JSON Hyper-Schema - incorrect reference to JSON Schema core #2

Open hrennau opened 4 years ago

hrennau commented 4 years ago

Document: https://json-schema.org/draft/2019-09/json-schema-hypermedia.html

Issue: In several places, e.g. https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.6.1 (section 6.1, first paragraph)

an erroneous reference to the JSON Schema core specification is made: "Section 3.1 of the JSON Schema core specification)"

The referenced document: https://tools.ietf.org/html/draft-handrews-json-schema-02

has a section 3, but no section 3.1. This is quite relevant, because the reference is really needed in order to elucidate facts hinted at, but not really explained (e.g. "the link's context resource is, by default, the sub-instance to which it is attached (as defined by ...). This is often not the entire instance document." Interestingly, the term "sub-instance" is not used at all in the core specification, therefore it is not clear what "the sub-instance to which it is attached" means.

handrews commented 4 years ago

Blah. By the time we finally got core and validation in shape I was way too burnt out to catch these sort of things in Hyper-Schema. Thanks!