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

[skip ci] Fix root key documentation (#1761)

Browse Source 
The current documentation stated that it was not possible to override
the root key for the JSON adapter. This was removed from the
documentation and it now links the useful documentation pages.
This commit is contained in:
Yohan Robert 2016-05-31 21:30:47 +02:00 committed by Ben Mills
parent 6e609c1218
commit b8af2892f7
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/general/adapters.md
View File

@ -67,9 +67,11 @@ Doesn't follow any specific convention.
### JSON ### JSON
The response document always with a root key. The json response is always rendered with a root key.
The root key **can't be overridden**, and will be derived from the resource being serialized. The root key can be overridden by:
* passing the `root` option in the render call. See details in the [Rendering Guides](rendering.md#overriding-the-root-key).
* setting the `type` of the serializer. See details in the [Serializers Guide](serializers.md#type).
Doesn't follow any specific convention. Doesn't follow any specific convention.