xref for "self" rel type, improve the wording for usage guidance, security concerns #497
Conversation
This file contains hidden or 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
Nov 17, 2017
For some reason the reference to the Atom RFC, where "self" was originally defined, was commented out. Restore the reference and cite it. The text for "self" was confusing in that it was unclear which parts applied in general and which parts applied to only "self" links for the entire instance document. Rearrange some sentences to make that more clear.
It seems likely to be related to embedded collection item representations and whether they can be considered authoritative without following the link. Also note the GitHub issue where this is being discussed.
While improving text around the self link, noticed that the ids were wrong on one of the example self link output structures, as well as the corresponding item link.
|
The force-push is just a rebase to resolve conflicts with the merged change that re-arranged the normative vs informative reference lists. |
The last paragraph actualy went with the line that was moved up to the end of the new first paragraph. So move the former last paragraph to be second.
|
And also updated with a better paragraph order. |
dlax
approved these changes
Nov 18, 2017
gregsdennis
added
clarification
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.
For some reason the reference to the Atom RFC, where "self" was
originally defined, was commented out. Restore the reference
and cite it.
The text for "self" was confusing in that it was unclear which
parts applied in general and which parts applied to only "self"
links for the entire instance document. Rearrange some sentences
to make that more clear.
Also partially addresses issue #485 by improving CREF text about
the "self" security concerns.