Skip to content

Commit c03427d

Browse files
committed
Merge pull request #1095 from beauby/config-docs
Add documentation about configuration options.
2 parents 8e08437 + bac812f commit c03427d

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This is the documentation of AMS, it's focused on the **0.10.x version.**
88

99
- [Getting Started](general/getting_started.md)
1010
- [Adapters](general/adapters.md)
11+
- [Configuration Options](general/configuration_options.md)
1112

1213
## How to
1314

docs/general/configuration_options.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Configuration Options
2+
3+
The following configuration options can be set on `ActiveModel::Serializer.config` inside an initializer.
4+
5+
## General
6+
7+
- `adapter`: The [adapter](adapters.md) to use. Possible values: `:flatten_json, :json, :json_api`. Default: `:flatten_json`.
8+
9+
## JSON API
10+
11+
- `jsonapi_resource_type`: Whether the `type` attributes of resources should be singular or plural. Possible values: `:singular, :plural`. Default: `:plural`.

0 commit comments

Comments
 (0)