Make "rel" required. #393
Merged
Make "rel" required. #393
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dlax
approved these changes
Sep 3, 2017
dlax
reviewed
Sep 9, 2017
jsonschema-hyperschema.xml
Outdated
| @@ -792,8 +792,8 @@ | |||
| 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 the system is already using to identify its primary | |||
| resources, or to use a human-readable, no-dereferenceable URI scheme | |||
| a URI scheme that is already in use identify the system's primary | |||
RFC 5988bis lists the link relation type as one of the three required aspects of a link. Since we do not need to support the deprecated "rev" mechanisms for specifying relation types, we can make "rel" required. This will encourage hyper-schema authors to think more about choosing relation types.
Using URIs for custom relation types is often a little intimidating, and frequently ignored. Provide some guidance on some simple approaches to make it easier for hyper-schema authors to use this now-required field correctly.
|
Last call! Barring objections, this will get merged in the next day or two. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #297
There are two commits here: the first simply makes "rel" required, while
the second attempts to address concerns over having to create new URIs
for custom link relations by pointing out two simple approaches.
The
"rel"section is getting large, but I will address that when I address#377 in which I have suggested a new outline to more clearly organize
the spec.
RFC 5988bis lists the link relation type as one of the three
required aspects of a link.
Since we do not need to support the deprecated "rev" mechanisms
for specifying relation types, we can make "rel" required.
This will encourage hyper-schema authors to think more about
choosing relation types.