From ec9d0196f66dbcba749da69990e33379ddca9396 Mon Sep 17 00:00:00 2001
From: p1-ra <18233250+p1-ra@users.noreply.github.com>
Date: Thu, 12 Mar 2020 11:11:29 +0100
Subject: [PATCH] Update README.md

Add hidden gem section "Conditional Relationships subset"
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index df86d288..27a97d08 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,7 @@ Fast JSON API serialized 250 records in 3.01 ms
   * [Params](#params)
   * [Conditional Attributes](#conditional-attributes)
   * [Conditional Relationships](#conditional-relationships)
+  * [Conditional Relationships Subset](#conditional-relationships-subset)
   * [Sparse Fieldsets](#sparse-fieldsets)
   * [Using helper methods](#using-helper-methods)
 * [Contributing](#contributing)
@@ -435,6 +436,25 @@ serializer = MovieSerializer.new(movie, { params: { admin: current_user.admin? }
 serializer.serializable_hash
 ```
 
+### Conditional Relationships Subset
+
+Conditional relationships subset can be defined by passing a new `block` to implement a custom behaviour to get the related objects. The record and any params passed to the serializer are available inside the `block` as the first and second parameters, respectively.
+
+```ruby
+class MovieSerializer
+  include FastJsonapi::ObjectSerializer
+
+  # Only specified actors will be serialized if the :actors_id key of params is true
+  has_many(:actors, options: {if: Proc.new { |record| params && params[:actors_id] }}) {|record, params|
+    Actor.join(:movies).where(actor_id: params[:actors_id], movie_id: record.id)
+  }
+end
+
+# ...
+serializer = MovieSerializer.new(movie, { params: { actors_id: [42,1337] }})
+serializer.serializable_h
+```
+
 ### Sparse Fieldsets
 
 Attributes and relationships can be selectively returned per record type by using the `fields` option.