Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update rendering.md #1557

Closed
wants to merge 3 commits into from
Closed

Update rendering.md #1557

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
171f40c
Update rendering.md
Jwan622 Mar 5, 2016
8d87536
Update rendering.md
Mar 15, 2016
d4e9384
Update rendering.md
Mar 15, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/general/rendering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,14 @@ This feature is specific to JsonApi, so you have to use the use the [JsonApi Ada

PR please :)

#### root
#### Overriding the root key

The resource root is derived from the class name of the resource being serialized.
Overriding the resource root only applies when using the JSON adapter.

Normally, the resource root is derived from the class name of the resource being serialized.
e.g. `UserPostSerializer.new(UserPost.new)` will be serialized with the root `user_post` or `user_posts` according the adapter collection pluralization rules.

Specify the root by passing it as an argument to `render`. For example:
When using the JSON adapter in your initializer (ActiveModelSerializers.config.adapter = :json), or passing in the adapter in your render call, you can specify the root by passing it as an argument to `render`. For example:

```ruby
render json: @user_post, root: "admin_post", adapter: :json
Expand All @@ -169,7 +171,7 @@ This will be rendered as:
}
}
```
Note: the `Attributes` adapter (default) does not include a resource root.
Note: the `Attributes` adapter (default) does not include a resource root. You also will not be able to create a single top-level root if you are using the :json_api adapter.

#### serializer

Expand Down