Skip to content

Minor readability / clarity fixes #372

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 5 commits into from
Aug 31, 2017
Merged

Minor readability / clarity fixes #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
444748e
Explain applying hyper-schema based on validation
handrews Aug 25, 2017
a7c50d6
Phrase as a requirement.
handrews Aug 25, 2017
d9304de
Define operations before discussing them.
handrews Aug 29, 2017
ccebf95
Further clarify $id base URI determination.
handrews Aug 30, 2017
ec5c9cd
Clarify fragment-only vs all URIs
handrews Aug 30, 2017
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
12 changes: 7 additions & 5 deletions jsonschema-core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,10 +431,12 @@

<section title='The "$id" keyword' anchor="id-keyword">
<t>
The "$id" keyword defines a URI for the schema,
and the base URI that other URI references within the schema are resolved against.
The "$id" keyword itself is resolved against the base URI that the object as a
whole appears in.
The "$id" keyword defines a URI for the schema, and the base URI that
other URI references within the schema are resolved against.
A subschema's "$id" is resolved against the base URI of its parent schema.
If no parent sets an explicit base with "$id", the base URI is that of the
entire document, as determined per
<xref target="RFC3986">RFC 3986 section 5</xref>.
</t>
<t>
If present, the value for this keyword MUST be a string, and MUST represent a
Expand Down Expand Up @@ -468,7 +470,7 @@
Pointer references are updated.
</t>
<t>
The effect of defining a URI fragment "$id" that neither
The effect of defining a fragment-only "$id" URI reference that neither
matches the above requirements nor is a valid JSON pointer
is not defined.
</t>
Expand Down
12 changes: 10 additions & 2 deletions jsonschema-hyperschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,10 @@
</figure>

<section title="Interaction with validation">
<t>
Hyper-schema keywords can be applied when the instance is valid against
the schema that includes those keywords.
</t>
<t>
Hyper-schemas MUST NOT be applied to an instance if the instance fails to
validate against the validation keywords within or containing the hyper-schema.
Expand Down Expand Up @@ -464,6 +468,10 @@
hint may be added in a future draft (see issue #73 in the GitHub repository).
</cref>
</t>
<t>
An operation is a specific use of a link described by an LDO, after any
template variables have been resolved.
</t>
<t>
There are several ways that a client can use data with a link:
<list>
Expand All @@ -474,8 +482,8 @@
inherent relation to the target resource's representation</t>
</list>
The three ways to use client-supplied data are each addressed by a separate
schema keyword within the link description object. Link operations
ignore schemas that are not relevant to their semantics.
schema keyword within the link description object. When performing operations,
clients SHOULD ignore schemas that are not relevant to their semantics.
</t>
<t>
Link Description Objects do not directly indicate what operations, such
Expand Down