Skip to content

Gregsdennis/locatable iri adjustments #1435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 20, 2023
Merged

Gregsdennis/locatable iri adjustments #1435

Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d078e30
add guidance for schema authors about locatable IRIs
gregsdennis Sep 3, 2023
3627d12
invert recommendation against online access to for offline access
gregsdennis Sep 4, 2023
1ba7a15
provide explicit permission to download schemas
gregsdennis Sep 5, 2023
1c7a336
remove guidance that authors need to consider locatability of URIs
gregsdennis Sep 13, 2023
82041cd
update downloading requirement from MUST to SHOULD
gregsdennis Sep 13, 2023
76bffb6
restore requirement to MUST
gregsdennis Sep 13, 2023
ef5ea07
correct URI usage to IRI
gregsdennis Sep 14, 2023
38b515a
update back to SHOULD after 'implementation' discussion
gregsdennis Sep 19, 2023
9920bd8
update other MUST to SHOULD
gregsdennis Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions jsonschema-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1143,9 +1143,8 @@ provides the ability to validate recursive structures through self-reference.

The resolved IRI produced by these keywords is not necessarily a network
locator, only an identifier. A schema need not be downloadable from the address
if it is a network-addressable URL, and implementations SHOULD NOT assume they
should perform a network operation when they encounter a network-addressable
IRI.
if it is a network-addressable URL. Implementations which can access the network
MUST default to operating offline.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be a "SHOULD" to not contradict the "SHOULD" on 1285.


##### Direct References with `$ref` {#ref}

Expand Down Expand Up @@ -1275,17 +1274,19 @@ The use of IRIs to identify remote schemas does not necessarily mean anything is
downloaded, but instead JSON Schema implementations SHOULD understand ahead of
time which schemas they will be using, and the IRIs that identify them.

When schemas are downloaded, for example by a generic user-agent that does not
know until runtime which schemas to download, see [Usage for
Hypermedia](#hypermedia).

Implementations SHOULD be able to associate arbitrary IRIs with an arbitrary
schema and/or automatically associate a schema's `$id`-given IRI, depending on
the trust that the validator has in the schema. Such IRIs and schemas can be
supplied to an implementation prior to processing instances, or may be noted
within a schema document as it is processed, producing associations as shown in
{{idexamples}}.

Implementations MAY provide functionality to automatically fetch schemas based
on location semantics expressed by the IRI, however such functionality SHOULD be
disabled by default to prefer offline operation. When schemas are downloaded,
for example by a generic user-agent that does not know until runtime which
schemas to download, see {{hypermedia}}.

#### Detecting a Meta-Schema

Implementations MUST recognize a schema as a meta-schema if it is being examined
Expand Down