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 #1095 from beauby/config-docs

Browse Source 
Add documentation about configuration options.
This commit is contained in:
João Moura 2015-09-07 02:13:11 -03:00
commit c03427dc5c
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@ -8,6 +8,7 @@ This is the documentation of AMS, it's focused on the **0.10.x version.**
- [Getting Started](general/getting_started.md)
- [Adapters](general/adapters.md)
- [Configuration Options](general/configuration_options.md)
## How to

11
docs/general/configuration_options.md Normal file
View File

@ -0,0 +1,11 @@
# Configuration Options
The following configuration options can be set on `ActiveModel::Serializer.config` inside an initializer.
## General
- `adapter`: The [adapter](adapters.md) to use. Possible values: `:flatten_json, :json, :json_api`. Default: `:flatten_json`.
## JSON API
- `jsonapi_resource_type`: Whether the `type` attributes of resources should be singular or plural. Possible values: `:singular, :plural`. Default: `:plural`.