ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 14:29:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
d02cd30fe5
active_model_serializers/docs/general/configuration_options.md
Benjamin Fleischer 9d7da8afc4 Add support for top level jsonapi member.
2015-10-01 21:22:49 -05:00

871 B
Raw Blame History

Configuration Options

The following configuration options can be set on ActiveModel::Serializer.config inside an initializer.

General

  • adapter: The adapter to use. Possible values: :attributes, :json, :json_api. Default: :attributes.

JSON API

  • jsonapi_resource_type: Whether the type attributes of resources should be singular or plural. Possible values: :singular, :plural. Default: :plural.
  • jsonapi_include_toplevel_object: Whether to include a top level JSON API member in the response document. Default: false.
  • Used when jsonapi_include_toplevel_object is true:
    • jsonapi_version: The latest version of the spec the API conforms to. Default: '1.0'.
    • jsonapi_toplevel_meta: Optional metadata. Not included if empty. Default: {}.