TEST_CODEOWNERS/rails
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Remove listings from the serialization guide that won't make 3.2.

Browse Source
This commit is contained in:
José Valim 2011-11-23 23:22:46 +00:00
parent 8896b4fdc8
commit 6da52c617e
1 changed files with 0 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
railties/guides/source/serializers.textile
View File

@ -459,25 +459,6 @@ In other words, if a +PostSerializer+ is trying to serialize comments, it will f
look for +PostSerializer::CommentSerializer+ before falling back to +CommentSerializer+
and finally +comment.as_json+.
h3. Optional Associations
In some cases, you will want to allow a front-end to decide whether to include associated
content or not. You can achieve this easily by making an association *optional*.
<ruby>
class PostSerializer < ActiveModel::Serializer
attributes :title. :body
has_many :comments, :optional => true
# ...
end
</ruby>
If an association is optional, it will not be included unless the request asks for it
with an +including+ parameter. The +including+ parameter is a comma-separated list of
optional associations to include. If the +including+ parameter includes an association
you did not specify in your serializer, it will receive a +401 Forbidden+ response.
h3. Overriding the Defaults
h4. Authorization Scope
@ -500,24 +481,6 @@ which allows you to define a dynamic authorization scope based on the current re
WARNING: If you use different objects as authorization scopes, make sure that they all implement whatever interface you use in your serializers to control what the outputted JSON looks like.
h4. Parameter to Specify Included Optional Associations
In most cases, you should be able to use the default +including+ parameter to specify
which optional associations to include. If you are already using that parameter name or
want to reserve it for some reason, you can specify a different name by using the
+serialization_includes_param+ class method.
<ruby>
class PostsController < ApplicationController
serialization_includes_param :associations_to_include
end
</ruby>
You can also implement a +serialization_includes+ instance method, which should return an
Array of optional includes.
WARNING: If you implement +serialization_includes+ and return an invalid association, your user will receive a +401 Forbidden+ exception.
h3. Using Serializers Outside of a Request
The serialization API encapsulates the concern of generating a JSON representation of