From 4559774d6040ed48f2bc1161e03961e209cbe0bb Mon Sep 17 00:00:00 2001 From: Abhay Nikam Date: Thu, 21 Jun 2018 08:49:33 +0530 Subject: [PATCH] Updated the defination for the class_name in documentation --- docs/general/serializers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/serializers.md b/docs/general/serializers.md index 28417898..e951c08f 100644 --- a/docs/general/serializers.md +++ b/docs/general/serializers.md @@ -65,7 +65,7 @@ Where: - `virtual_value:` - `polymorphic:` defines if polymorphic relation type should be nested in serialized association. - `type:` the resource type as used by JSON:API, especially on a `belongs_to` relationship. - - `class_name:` used to determine `type` when `type` is not given. `class_name` option to supply the model name as string. + - `class_name:` the (String) model name used to determine `type`, when `type` is not given. e.g. `class_name: "Comment"` would imply the type `comments` - `foreign_key:` used by JSON:API on a `belongs_to` relationship to avoid unnecessarily loading the association object. - `namespace:` used when looking up the serializer and `serializer` is not given. Falls back to the parent serializer's `:namespace` instance options, which, when present, comes from the render options. See [Rendering#namespace](rendering.md#namespace] for more details. - optional: `&block` is a context that returns the association's attributes.