Better multiple related resources request example #1227
Merged
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
> GET /articles/1?include=author,comments.author is confusing since `author` and `comments.author` both reference the `author` resource', but with different meaning. It looks a lot like GET /users/1?include=articles,articles.comments which is identical to GET /users/1?include=articles.comments since full linkage requires intermediate resources to be returned So, I've changed the the related resources to be more obviously different
bf4
commented
Oct 14, 2017
jelhan
requested changes
Feb 13, 2022
There was a problem hiding this comment.
Thanks a lot for this proposal. I agree that having author twice could be confusing. Additionally I would switch the order. Than it would directly add to the examples given before. In order they would be the following:
GET /articles/1?include=comments HTTP/1.1
GET /articles/1?include=comments.author HTTP/1.1
GET /articles/1?include=comments.author,ratings HTTP/1.1Co-authored-by: Jeldrik Hanschke <jelhan@users.noreply.github.com>
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.
is confusing since
authorandcomments.authorboth reference theauthorresource',but with different meaning.
It looks a lot like how
is identical to
since full linkage requires intermediate resources to be returned
So, I've changed the the related resources to be more obviously different