id everywhere plus deref explanation #1648
Merged
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
jpstroop
suggested changes
Sep 17, 2018
source/api/presentation/3.0/index.md
Outdated
| Clients _MAY_ render `id` on an Annotation Page. | ||
| * An Annotation _MUST_ have the `id` property.<br/> | ||
| Clients _MAY_ render `id` on an Annotation. | ||
| The existence of an HTTP(S) URI in the `id` property does not mean that the URI _MUST_ be dereferencable. The [definitions of the Resources][prezi30-resource-structure] give guidance as to this, as does the [table in Appendix A][prezi30-appendixa]. |
There was a problem hiding this comment.
... does not mean that the URI MUST ...
Slightly weird use of an RFC MUST. I think a regular "must" would be less confusing, or replace with something simpler, like "The HTTP(S) URI given in the id property does not have to be dereferencable" or "...is not required to be dereferencable."
(or RFC 6919 OUGHT TO) 😉
jpstroop
approved these changes
Sep 17, 2018
mikeapp
approved these changes
Sep 17, 2018
zimeon
approved these changes
Sep 18, 2018
tomcrane
approved these changes
Sep 18, 2018
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.
Closes #1607