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 warnings about global adapter config to docs (#2176)

Browse Source
This commit is contained in:
Nate Pinsky
2017-10-24 15:30:57 -07:00
committed by Benjamin Fleischer
parent 4d7c2457d7
commit 88367da970
3 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/howto/add_root_key.md
View File

@@ -18,6 +18,13 @@ In order to add the root key you need to use the ```JSON``` Adapter, you can cha
ActiveModelSerializers.config.adapter = :json
```
Note that adapter configuration has no effect on a serializer that is called
directly, e.g. in a serializer unit test. Instead, something like
`UserSerializer.new(user).as_json` will *always* behave as if the adapter were
the 'Attributes' adapter. See [Outside Controller
Usage](../howto/outside_controller_use.md) for more details on recommended
usage.
You can also specify a class as adapter, as long as it complies with the ActiveModelSerializers adapters interface.
It will add the root key to all your serialized endpoints.