Skip to content
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

Ref is delegation - try 3 #628

Merged
merged 3 commits into from
Jun 30, 2018
Merged

Ref is delegation - try 3 #628

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7435bcb
$ref no longer effects other properties in the same object.
Relequestual Jun 28, 2018
e1b1768
Fixed white space issues... xml2rfc is really picky!
Relequestual Jun 28, 2018
a3d8df3
Fix typo and change word
Relequestual Jun 29, 2018
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
14 changes: 9 additions & 5 deletions jsonschema-core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -955,14 +955,18 @@

<section title='Schema References With "$ref"' anchor="ref">
<t>
The "$ref" keyword is used to reference a schema, and provides the ability to
validate recursive structures through self-reference.
The "$ref" keyword can be used to reference a schema which is to be applied to the
current instance location. "$ref" is an applicator key word, applying the referred
schema to the instance.
</t>
<t>
An object schema with a "$ref" property MUST be interpreted as a "$ref" reference.
The value of the "$ref" property MUST be a URI Reference.
The value of the "$ref" property MUST be a string which is a URI Reference.
Resolved against the current URI base, it identifies the URI of a schema to use.
All other properties in a "$ref" object MUST be ignored.
</t>
<t>
As the value of "$ref" is a URI Reference, this allows the posibility to externalise or
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: "possibility"

shard a schema across multiple files, and provides the ability to validate recursive structures
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm vaguely familiar with "shard" as a database term, but it feels a bit awkward here. I actually thought it was a typo for "share" and almost submitted the review with that comment. How about "or divide a schema across multiple files"?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah that sounds better. I actually originally used a different word, but for this PR changed to shard because of familiarity as a database term. I'll change this.

through self-reference.
</t>
<t>
The URI is not a network locator, only an identifier. A schema need not be
Expand Down