ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-22 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation about wildcard includes

Browse Source 
Resolves #1200
This commit is contained in:
Liam Bowen 2015-09-25 17:38:23 +00:00
parent 1f08865a10
commit a32ad4331f
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -213,6 +213,26 @@ resources in the `"included"` member when the resource names are included in the
render @posts, include: 'author,comments,comments.author'
```
In addition, two types of wildcards may be used. `*` includes one level of associations, and `**` includes all recursively. These can be combined with other paths.
```ruby
render @posts, include: '**' # or '*' for a single layer
```
The following would render posts and include the author, the author's comments, and every resource referenced by the author's comments (recursively). It could be combined, like above, with other paths in any combination desired.
```ruby
render @posts, include: 'author.comments.**'
```
The JSON API [specifies](http://jsonapi.org/format/#fetching-includes) that the user may supply a parameter specifying which related resources are to be included:
```ruby
render @posts, include: params[:include]
```
This raises some security concerns since the user could pass in `include=**`, so filter the values for `include` appropriately if you decide to support this JSON API feature.
## Installation
Add this line to your application's Gemfile: