Skip to content

Core: Improve language for schema references section #551

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 6 commits into from
Mar 1, 2018
Merged

Core: Improve language for schema references section #551

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9e69ef6
Core: Improve language for schema references section
awwright Feb 28, 2018
6b541c0
Move the schema references preamble back up to the top of the section
awwright Feb 28, 2018
f51f8cb
Clarify/strenghten some security considerations
awwright Feb 28, 2018
adf96df
Core: Cite definition at first usage of URI in the section
awwright Feb 28, 2018
ad91243
s/name/plain name/
awwright Mar 1, 2018
d9abd15
Core: Link to Hypermedia section instead
awwright Mar 1, 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
20 changes: 14 additions & 6 deletions jsonschema-core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,11 @@
</section>

<section title="Base URI and Dereferencing">
<t>
To differentiate between schemas in a vast ecosystem, schemas are
identified by URI, and can embed references to other schemas by specifying their URI.
</t>

<section title="Initial Base URI">
<t>
<xref target="RFC3986">RFC3986 Section 5.1</xref> defines how to determine the
Expand Down Expand Up @@ -709,11 +714,14 @@
</t>
<section title="Loading a referenced schema">
<t>
To differentiate between schemas in a vast ecosystem, schemas are
identified by URI. As specified above, this 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 URIs that
identify them.
The use of URIs 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 URIs that identify them.
</t>
<t>
When schemas are downloaded,
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't follow this paragraph. Taking the dependent clause out I read "When schemas are downloaded... see Usage over HTTP" which is a bit unclear.

Could this be rephrased as something like:

"For use cases when it is desirable to download schemas, such as a hypermedia system where schemas are discovered at runtime, see Usage for Hypermedia"

Note I'm proposing linking to section 11 as a whole rather than 11.3, because the actual linking of a downloadable schema is covered in 11.1, and I think that is needed to fully understand the issue (along with 11.3).

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, I totally missed that. Yes, I was looking for that section.

for example by a generic user-agent that doesn't know until runtime which schemas to download,
see <xref target="http-usage">Usage over HTTP</xref>.
</t>
<t>
Implementations SHOULD be able to associate arbitrary URIs with an arbitrary
Expand Down Expand Up @@ -928,7 +936,7 @@ Link: </alice>;rel="schema", </bob>;rel="schema"

</section>

<section title="Usage Over HTTP">
<section title="Usage Over HTTP" anchor="http-usage">
<t>
When used for hypermedia systems over a network,
<xref target="RFC7231">HTTP</xref> is frequently the protocol of choice for
Expand Down