Merge URL and ID styles #185
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
Removes ambiguity around the `links` key in documents, which clears path to merge the URL and ID styles of the spec. This is discussed in detail in json-api#183.
|
People can submit PRs to your fork, and it works the same way. |
| * `id` | ||
| * `href` | ||
| * `links` | ||
| No other keys should be present at the top level of the JSON response. |
There was a problem hiding this comment.
This is a should, should it be a SHOULD?
There was a problem hiding this comment.
Good question. Perhaps it would be better to turn the phrasing around to emphasize the negative: "There SHOULD NOT be any other keys present at the top level of the JSON response."
|
Looks good to me. @wycats ? |
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.
@lgebhardt and I based this PR on our proposal from #183. By removing ambiguity around the
linkskey in documents, we were able to merge the URL and ID styles of the spec. In the process of merging these styles, we also tried to clear up any inconsistencies in terminology (e.g. "document" vs. "resource") and layout. I hope we didn't mangle anything.This is obviously a pretty substantial PR. If it would help, I could create a "convergence" branch on the main repo so we can all work on this together and accept additional PRs before merging to master (er, gh-pages).