include related resources on GET requests by default, add option to omit related resources about fortune HOT 11 CLOSED

For clarity, is this for requests like: GET /api/v1/author/123?include=books ?
This would be as per http://jsonapi.org/format/ "Inclusion of Related Documents" ?

from fortune.

@benbarclay may be interested in this...

from fortune.

Yeah. I opened this issue before that syntax became part of the spec, so I think that it would make sense to omit related resources unless it is requested.

from fortune.

Interesting. I hadn't noticed the addition of Compound Documents to the
spec.

I agree that it would be really useful to include.

I know I have one or two examples where I do lookups three levels deep,
based on parent -> child relationships.

Not sure how the spec handles data being nested several levels deep. It
would being a useful thing to at least think through.

I agree with omitting related resources unless requested. As a default, it
saves bandwidth and it also maintains backward compatability.

On Monday, 9 December 2013, Dali Zheng wrote:

Yeah. I opened this issue before that syntax became part of the spec, so I
think that it would make sense to omit related resources unless it is
requested.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/7#issuecomment-30102501
.

from fortune.

@benbarclay the issue of links to nested compound documents was recently brought up over there: json-api/json-api#170

from fortune.

Should fortune automatically output the "links" metadata describing which linked fields point to which resource types (as per the examples in json-api/json-api#170 ) ?

from fortune.

Yep. It currently already does that, just not for compound documents yet: https://github.com/daliwali/fortune/blob/master/lib/route.js#L503

from fortune.

Is is possible to include the related resource using GET method. I tried it with a simple example but it only includes id's not complete resources. Also if we can use ?include=resource then using fortunejs will make alot of sense for most rest api.

from fortune.

Any updates on this? :)

from fortune.

It's in the rewrite, I'm planning on supporting every optional part of the spec (MAYs and SHOULDs). The way it works is just as described in the spec, using the ?include= query.

from fortune.

Awesome. Being able to get full resources by ?include=resource like @creativeaura said would be useful.

from fortune.