JSON API filter included resources

json json-api jsonapi-resources
beniutek picture beniutek · Oct 23, 2016 · Viewed 8.1k times · Source

The question is about JSON API specification and how properly do a request (I'm using ruby on rails and the json api resources gem but that's a general question anyway, I know how to implement it, I just want to follow the rules of JSON API at: http://jsonapi.org/format/)

Situation 1:

  • I want to get all shelves
  • I want to include all books that are on those shelves
  • The get I'm supposed to use in this case is: www.library.com/shelves?include=books

Situation 2:

  • I want to get all books but only books that are marked as unread

  • The get I'm supposed to use is: www.library.com/books?filter[unread]=true

What would be correct way of designing request for all shelves with included unread books?

Can't figure this one out

www.library.com/shelves?include=books&filter[books.unread]=true ?

www.library.com/shelves?include=unread_books ? <- would have to specify another resource, books that are unread

www.library.com/shelves?filter[books.unread]=true ?

What's the most correct way of doing this?

EDIT

After speaking with my tech lead and a few other programmers, the first options is favoured the most in such cases

Answer

brian picture brian · Oct 23, 2016

I would bet on the first one:

www.library.com/shelves?include=books&filter[books.unread]=true

Related questions

Sending json api object using postman

I am using JSONAPI Specification http://jsonapi.org/format/#status And I have data like below, { "data": { "type": "tag", "id": "1", "attributes": { "name": "Test" } } } How do I make a post request to the end point using postman chrome extension ? I am …

Read More
Serialize an array of models using active_model_serializers

I am trying to send the serialized version of a model to a view as a param, using the gem active_model_serializers #app/serializers/admin_serializer.rb class AdminSerializer < ActiveModel::Serializer attributes :id, :email, :access_locked? end #app/…

Read More
How do I POST JSON data with cURL?

I use Ubuntu and installed cURL on it. I want to test my Spring REST application with cURL. I wrote my POST code at the Java side. However, I want to test it with cURL. I am trying to post …

Read More