Issue #648: overly specific reason for not using relative URLs#651
Open
evanp wants to merge 1 commit into
Open
Issue #648: overly specific reason for not using relative URLs#651evanp wants to merge 1 commit into
evanp wants to merge 1 commit into
Conversation
Issue #648 points out that the reason listed in Section 2.2 for not using relative URLs is incomplete and inexact. This erratum replaces the term "JSON parser implementations" with the more general and accurate "consumers", which is used elsewhere in the document.
| ## Activity Streams | ||
|
|
||
| - None yet reported. | ||
| - Section 2.2 "IRIs and URLs" says that publishers SHOULD NOT generate AS2 documents with relative IRI and URL references because JSON parser implementations may not conserve the base context to resolve relative references. This is overly specific; there are other types of implementations that may also fail to conserve the base context. One correction is to simply remove the reference to JSON parsers and replace it with "consumers": "Relative IRI (and URL) references SHOULD NOT be used within an Activity Streams 2.0 document due to the fact that many consumers are not capable of reliably preserving the base context necessary to properly resolve relative references." |
Contributor
There was a problem hiding this comment.
Maybe replace "base context" with "base URI" ? As to avoid confusion with @context? So:
Suggested change
| - Section 2.2 "IRIs and URLs" says that publishers SHOULD NOT generate AS2 documents with relative IRI and URL references because JSON parser implementations may not conserve the base context to resolve relative references. This is overly specific; there are other types of implementations that may also fail to conserve the base context. One correction is to simply remove the reference to JSON parsers and replace it with "consumers": "Relative IRI (and URL) references SHOULD NOT be used within an Activity Streams 2.0 document due to the fact that many consumers are not capable of reliably preserving the base context necessary to properly resolve relative references." | |
| - Section 2.2 "IRIs and URLs" says that publishers SHOULD NOT generate AS2 documents with relative IRI and URL references because JSON parser implementations may not conserve the base context to resolve relative references. This is overly specific; there are other types of implementations that may also fail to conserve the base context. One correction is to simply remove the reference to JSON parsers and replace it with "consumers": "Relative IRI (and URL) references SHOULD NOT be used within an Activity Streams 2.0 document due to the fact that many consumers are not capable of reliably preserving the base URI necessary to properly resolve relative references." |
We could also add a note that determining the base URI may have significant uncertainty between the implementations and different object structures you might receive. e.g., if an object has an @id but a relative IRI or URL with in, does that mean it's relative to that @id even if the parent object has a @base?
Contributor
There was a problem hiding this comment.
The language of "base URI" comes from RFC 3986, Section 5.2.1
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
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.
Issue #648 points out that the reason listed in Section 2.2 for not using relative URLs is incomplete and inexact. This erratum replaces the term "JSON parser implementations" with the more general and accurate "consumers", which is used elsewhere in the document.