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

Add documentation for root (#1959)

Browse Source
This commit is contained in:
大野峻典
2016-11-02 03:25:52 +09:00
committed by Yohan Robert
parent cb20b957ed
commit ce8dd36633
2 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/general/serializers.md
View File

@@ -217,7 +217,17 @@ The object being serialized.
#### #root
PR please :)
Resource root which is included in `JSON` adapter. As you can see at [Adapters Document](adapters.md), `Attribute` adapter (default) and `JSON API` adapter does not include root at top level.
By default, the resource root comes from the `model_name` of the serialized object's class.
There are several ways to specify root:
* [Overriding the root key](rendering.md#overriding-the-root-key)
* [Setting `type`](serializers.md#type)
* Specifying the `root` option, e.g. `root: 'specific_name'`, during the serializer's initialization:
```ruby
ActiveModelSerializers::SerializableResource.new(foo, root: 'bar')
```
#### #scope