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

revised docs to reflect the feedback

Browse Source
This commit is contained in:
Kory Tegman 2016-01-06 22:21:19 -08:00
parent d153dfe2cd
commit aeefb6a080
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/general/rendering.md
View File

@ -113,25 +113,24 @@ PR please :)
#### root
By default the Json Adapter `root` will follow snake case format, like so:
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.
| resource | single root | collection root |
|----------|-------------|-----------------|
| UserPost | user_posts | user_post |
If you would like to change the `root` of your json, specify it in the render call:
Specify the root by passing it as an argument to `render`. For example:
```ruby
render json: @user_post, root: "admin_post"
render json: @user_post, root: "admin_post", adapter: :json
```
This will produce json like:
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
PR please :)