Skip to content

Commit adc530b

Browse files
bf4dgebjelhan
authored
Better multiple related resources request example (json-api#1227)
* Better multiple related resources request example > 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 * Update _format/1.0/index.md Co-authored-by: Jeldrik Hanschke <jelhan@users.noreply.github.com> Co-authored-by: Dan Gebhardt <dan@cerebris.com> Co-authored-by: Jeldrik Hanschke <jelhan@users.noreply.github.com>
1 parent e4b1919 commit adc530b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

_format/1.0/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ resources.
973973
Multiple related resources can be requested in a comma-separated list:
974974

975975
```http
976-
GET /articles/1?include=author,comments.author HTTP/1.1
976+
GET /articles/1?include=comments.author,ratings HTTP/1.1
977977
Accept: application/vnd.api+json
978978
```
979979

0 commit comments

Comments
 (0)