Skip to content

Replace RFC 5988[bis] with RFC 8288 #454

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 1 commit into from
Oct 26, 2017
Merged

Replace RFC 5988[bis] with RFC 8288 #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions jsonschema-core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC3986 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3986.xml">
<!ENTITY RFC5988 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5988.xml">
<!ENTITY RFC6839 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6839.xml">
<!ENTITY RFC6901 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6901.xml">
<!ENTITY RFC7049 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7049.xml">
<!ENTITY RFC7159 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7159.xml">
<!ENTITY RFC7231 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7231.xml">
<!ENTITY RFC8288 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.8288.xml">
<!ENTITY ldp SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml4/reference.W3C.REC-ldp-20150226.xml">
<!ENTITY fragid-best-practices SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml4/reference.W3C.WD-fragid-best-practices-20121025.xml">
]>
Expand Down Expand Up @@ -673,7 +673,7 @@
JSON has been adopted widely by HTTP servers for automated APIs and robots. This
section describes how to enhance processing of JSON documents in a more RESTful
manner when used with protocols that support media types and
<xref target="RFC5988">Web linking</xref>.
<xref target="RFC8288">Web linking</xref>.
</t>

<section title='Linking to a schema'>
Expand All @@ -685,7 +685,7 @@

<t>
In HTTP, such links can be attached to any response using the
<xref target="RFC5988">Link header</xref>. An example of such a header would be:
<xref target="RFC8288">Link header</xref>. An example of such a header would be:
</t>

<figure>
Expand Down Expand Up @@ -924,9 +924,9 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
</references>

<references title="Informative References">
&RFC5988;
&RFC7049;
&RFC7231;
&RFC8288;
&fragid-best-practices;
<reference anchor="json-schema-validation">
<front>
Expand Down
28 changes: 9 additions & 19 deletions jsonschema-hyperschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,14 @@
<!--<!ENTITY rfc4287 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4287.xml">-->
<!--<!ENTITY rfc5226 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5226.xml">-->
<!ENTITY rfc5789 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5789.xml">
<!ENTITY rfc5988 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5988.xml">
<!ENTITY rfc6068 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6068.xml">
<!ENTITY rfc6570 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6570.xml">
<!ENTITY rfc6573 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6573.xml">
<!ENTITY rfc6901 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.6901.xml">
<!ENTITY rfc7230 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7230.xml">
<!ENTITY rfc7231 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7231.xml">
<!ENTITY rfc7807 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.7807.xml">
<!ENTITY I-D.nottingham-rfc5988bis SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.draft-nottingham-rfc5988bis-08.xml">
<!ENTITY rfc8288 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.8288.xml">
<!ENTITY I-D.luff-relative-json-pointer SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.draft-luff-relative-json-pointer-00.xml">
<!ENTITY I-D.reschke-http-jfv SYSTEM "https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.draft-reschke-http-jfv-06.xml">
]>
Expand Down Expand Up @@ -95,11 +94,7 @@
<t>
The primary mechanism introduced for specifying links is the Link Description
Object (LDO), which is a serialization of the abstract link model
defined in <xref target="I-D.nottingham-rfc5988bis">RFC 5988bis, section 2</xref>.
<cref>
This section references the work-in-progress RFC5988bis, with the expectation
that it will reach RFC before this specification does.
</cref>
defined in <xref target="RFC8288">RFC 8288, section 2</xref>.
</t>
<t>
This specification will use the concepts, syntax, and terminology defined by the
Expand Down Expand Up @@ -163,7 +158,7 @@
<t>
The terms "link", "link context" (or "context"), "link target" (or "target"),
and "target attributes" are to be interpreted as defined in
<xref target="I-D.nottingham-rfc5988bis">Section 2 of RFC 5988bis</xref>.
<xref target="RFC8288">Section 2 of RFC 8288</xref>.
</t>
<t>
The term "user agent" is to be interpreted as defined in
Expand Down Expand Up @@ -224,7 +219,7 @@
A JSON Hyper-Schema implementation is able to take a hyper-schema, an
instance, and in some cases client input, and produce a set of fully
resolved valid links. As defined by
<xref target="I-D.nottingham-rfc5988bis">RFC 5988bis, section 2</xref>,
<xref target="RFC8288">RFC 8288, section 2</xref>,
a link consists of a context, a typed relation, a target, and optionally
additional target attributes.
</t>
Expand Down Expand Up @@ -327,12 +322,8 @@

<section title="Link Description Object" anchor="ldo">
<t>
<cref>
This section references the work-in-progress RFC5988bis, with the expectation
that it will reach RFC before this specification does.
</cref>
A Link Description Object (LDO) is a serialization of the abstract link model
defined in <xref target="I-D.nottingham-rfc5988bis">RFC 5988bis, section 2</xref>.
defined in <xref target="RFC8288">RFC 8288, section 2</xref>.
As described in that document, a link consists of a context, a relation type,
a target, and optionally target attributes. JSON Hyper-Schema's LDO provides
all of these, along with additional features using JSON Schema to describe input
Expand Down Expand Up @@ -439,7 +430,7 @@
<section title="rel" anchor="rel">
<t>
The value of this property MUST be a string, and MUST be a single
Link Relation Type as defined in RFC 5988bis, Section 2.1.
Link Relation Type as defined in RFC 8288, Section 2.1.
</t>
<t>
This property is required.
Expand Down Expand Up @@ -492,7 +483,7 @@
<t>
When no registered relation (aside from "related") applies, users are
encouraged to mint their own extension relation types, as described in
<xref target="RFC5988">section 4.2 of RFC 5988</xref>. The simplest
<xref target="RFC8288">section 2.1.2 of RFC 8288</xref>. The simplest
approaches for choosing link relation type URIs are to either use
a URI scheme that is already in use to identify the system's primary
resources, or to use a human-readable, non-dereferenceable URI scheme
Expand Down Expand Up @@ -2238,13 +2229,12 @@ Link: <https://schema.example.com/entry> rel=describedBy
<!--&rfc5226;-->
&rfc4151;
&rfc5789;
&rfc5988;
&rfc6068;
&rfc6573;
&rfc7230;
&rfc7231;
&rfc7807;
&I-D.nottingham-rfc5988bis;
&rfc8288;
</references>
<section title="Using JSON Hyper-Schema in APIs" anchor="apis">
<t>
Expand Down Expand Up @@ -2331,7 +2321,7 @@ Link: <https://schema.example.com/entry> rel=describedBy
<t hangText="draft-handrews-json-schema-hyperschema-00">
<list style="symbols">
<t>Top to bottom reorganization and rewrite</t>
<t>Group keywords per RFC 5988bis context/relation/target/target attributes</t>
<t>Group keywords per RFC 8288 context/relation/target/target attributes</t>
<t>Additional keyword groups for template resolution and describing input</t>
<t>Added section on general implementation requirements</t>
<t>Expanded overview to provide context</t>
Expand Down