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

Merge pull request #1417 from koryteg/custom_root_docs

Browse Source 
[DOCS] added documentation for adding custom root
This commit is contained in:
Benjamin Fleischer 2016-01-15 00:52:56 -06:00
commit 92e8a0a246
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/general/rendering.md
View File

@ -113,7 +113,23 @@ PR please :)
#### root
PR please :)
The resource root is derived from the class name of the resource being serialized.
e.g. `UserPostSerializer.new(UserPost.new)` will be serialized with the root `user_post` or `user_posts` according the adapter collection pluralization rules.
Specify the root by passing it as an argument to `render`. For example:
```ruby
render json: @user_post, root: "admin_post", adapter: :json
```
This will produce serialize as:
```json
{"admin_post": {
"title": "how to do open source"
}
}
```
`Note: the Attributes adapter (default) does not include a resource root.`
#### serializer