Merge pull request #1095 from beauby/config-docs

Add documentation about configuration options.
rails-api · Sep 7, 2015 · c03427d · c03427d
2 parents 8e08437 + bac812f
commit c03427d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -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
 

diff --git a/docs/general/configuration_options.md b/docs/general/configuration_options.md
@@ -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`.