Fix compound relationships includes

[Exelord]

Hey,
I noticed that including compound relationships of the resource doesn't add correct linkage data.

Resources model

-- author
---- has_many posts
------ has_many comments

Current behavior

calling a url GET /author/4?include=posts.comments doesn't return linkage for posts relationship of author resource

Expected standard

According to JSONAPI spec: http://jsonapi.org/format/#fetching-includes

Because compound documents require full linkage (except when relationship linkage is excluded by sparse fieldsets), intermediate resources in a multi-part path must be returned along with the leaf nodes. For example, a response to a request for comments.author should include comments as well as the author of each of those comments.

Note: A server may choose to expose a deeply nested relationship such as comments.author as a direct relationship with an alias such as comment-authors. This would allow a client to request /articles/1?include=comment-authors instead of /articles/1?include=comments.author. By abstracting the nested relationship with an alias, the server can still provide full linkage in compound documents without including potentially unwanted intermediate resources.

Proposed behavior

calling a url GET /author/4?include=posts.comments does return linkage for posts relationship of author resource

[Azdaroth]

Hi @fotinakis, any chance of having it merged soon? This would be a super helpful addition for us. Thanks.

[fotinakis]

Hey @Exelord thanks for this, sorry for the delay reviewing.

Can you check out the one test comment here and see what the correct behavior for that should be? After that LGTM

[fotinakis]

This changes the behavior of the test, it's specifically testing the behavior of "overlapping include paths" but this no longer does that.

[fotinakis]

Nice!

[fotinakis]

@Exelord friendly ping here

[Exelord]

@fotinakis Done.

[fotinakis]

Published in jsonapi-serializers v1.0.1. Thanks for contributing!