From ec7b5859f77882892325840eae0716fcaab6c14f Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Mon, 1 May 2017 10:23:13 -0500 Subject: [PATCH] Document namespace --- docs/general/serializers.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/general/serializers.md b/docs/general/serializers.md index 0606c51d0..5b23ba0f4 100644 --- a/docs/general/serializers.md +++ b/docs/general/serializers.md @@ -67,6 +67,7 @@ Where: - `type:` the resource type as used by JSON:API, especially on a `belongs_to` relationship. - `class_name:` used to determine `type` when `type` not given - `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. - prevents `association_name` method from being called. - return value of block is used as the association value.