Skip to content

Make "rel" required. #393

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 2 commits into from
Sep 15, 2017
Merged

Make "rel" required. #393

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c508b71
Make "rel" required.
handrews Sep 3, 2017
980592e
Add guidance on using and creating relation types
handrews Sep 3, 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
20 changes: 17 additions & 3 deletions jsonschema-hyperschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<!ENTITY rfc2046 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2046.xml">
<!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 rfc4151 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4151.xml">
<!--<!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">
Expand Down Expand Up @@ -645,6 +646,7 @@
resource. The value MUST be a registered link relation from the
<xref target="RFC5988">IANA Link Relation Type Registry established in RFC 5988</xref>,
or a normalized URI following the <xref target="RFC3986">URI production of RFC 3986</xref>.
This property is required.
</t>

<t>
Expand All @@ -668,13 +670,24 @@

<t>
Relationship definitions are not normally media type
dependent, and users are encouraged to utilize existing
accepted relation definitions.
dependent, and users are encouraged to utilize the most
suitable existing accepted relation definitions.
</t>

<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
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
such as <xref target="RFC4151">"tag", defined by RFC 4151</xref>.
Extension relation type URIs need not be dereferenceable, even when
using a scheme that allows it.
</t>
<figure>
<preamble>
For example, if a hyper-schema is defined:
As an example of registered relation types, if a hyper-schema is defined:
</preamble>
<artwork>
<![CDATA[{
Expand Down Expand Up @@ -1215,6 +1228,7 @@ GET /foo/
<references title="Informative References">
&rfc2046;
<!--&rfc5226;-->
&rfc4151;
&rfc5789;
&rfc5988;
&rfc7231;
Expand Down