Merge pull request #630 from sachse/readme-fix

README: Change :embed_key to :key
This commit is contained in:
Steve Klabnik 2014-09-25 19:41:50 -04:00
commit e41eedd4dd

View File

@ -524,15 +524,15 @@ Now, any associations will be supplied as an Array of IDs:
} }
``` ```
You may also choose to embed the IDs by the association's name underneath an You may also choose to embed the IDs by the association's name underneath a
`embed_key` for the resource. For example, say we want to change `comment_ids` `key` for the resource. For example, say we want to change `comment_ids`
to `comments` underneath a `links` key: to `comments` underneath a `links` key:
```ruby ```ruby
class PostSerializer < ActiveModel::Serializer class PostSerializer < ActiveModel::Serializer
attributes :id, :title, :body attributes :id, :title, :body
has_many :comments, embed: :ids, embed_namespace: :links has_many :comments, embed: :ids, key: :comments, embed_namespace: :links
end end
``` ```
@ -694,7 +694,7 @@ class PostSerializer < ActiveModel::Serializer
embed :ids, include: true embed :ids, include: true
attributes :id, :title, :body attributes :id, :title, :body
has_many :comments, embed_key: :external_id has_many :comments, key: :external_id
end end
``` ```