Skip to content

Commit 35d1524

Browse files
authored
Merge pull request #393 from handrews/req-rel
Make "rel" required.
2 parents eb9682f + 980592e commit 35d1524

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

jsonschema-hyperschema.xml

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<!ENTITY rfc2046 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2046.xml">
44
<!ENTITY rfc2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
55
<!ENTITY rfc3986 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3986.xml">
6+
<!ENTITY rfc4151 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4151.xml">
67
<!--<!ENTITY rfc4287 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4287.xml">-->
78
<!--<!ENTITY rfc5226 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5226.xml">-->
89
<!ENTITY rfc5789 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.5789.xml">
@@ -766,6 +767,7 @@
766767
resource. The value MUST be a registered link relation from the
767768
<xref target="RFC5988">IANA Link Relation Type Registry established in RFC 5988</xref>,
768769
or a normalized URI following the <xref target="RFC3986">URI production of RFC 3986</xref>.
770+
This property is required.
769771
</t>
770772

771773
<t>
@@ -790,13 +792,24 @@
790792

791793
<t>
792794
Relationship definitions are not normally media type
793-
dependent, and users are encouraged to utilize existing
794-
accepted relation definitions.
795+
dependent, and users are encouraged to utilize the most
796+
suitable existing accepted relation definitions.
795797
</t>
796798

799+
<t>
800+
When no registered relation (aside from "related") applies, users are
801+
encouraged to mint their own extension relation types, as described in
802+
<xref target="RFC5988">section 4.2 of RFC 5988</xref>. The simplest
803+
approaches for choosing link relation type URIs are to either use
804+
a URI scheme that is already in use to identify the system's primary
805+
resources, or to use a human-readable, non-dereferenceable URI scheme
806+
such as <xref target="RFC4151">"tag", defined by RFC 4151</xref>.
807+
Extension relation type URIs need not be dereferenceable, even when
808+
using a scheme that allows it.
809+
</t>
797810
<figure>
798811
<preamble>
799-
For example, if a hyper-schema is defined:
812+
As an example of registered relation types, if a hyper-schema is defined:
800813
</preamble>
801814
<artwork>
802815
<![CDATA[{
@@ -1543,6 +1556,7 @@ GET /foo/
15431556
<references title="Informative References">
15441557
&rfc2046;
15451558
<!--&rfc5226;-->
1559+
&rfc4151;
15461560
&rfc5789;
15471561
&rfc5988;
15481562
&rfc7231;

0 commit comments

Comments
 (0)