Add documentation for root #1959
Conversation
|
@shunsuke227ono, thanks for your PR! By analyzing the history of the files in this pull request, we identified @bf4, @yogeshjain999 and @groyoh to be potential reviewers. |
| * [Setting `type`](https://github.com/rails-api/active_model_serializers/blob/master/docs/general/serializers.md#type) | ||
| * Passing an argument like `root: 'specific_name'` to the serializer's initialization. | ||
|
|
||
| You can also see examples of root at linked pages above. |
There was a problem hiding this comment.
What do you mean by that sentence exactly?
There was a problem hiding this comment.
This means you can find some examples how 'root' is used in the pages linked above. I added this line because I thought it might be easier for reader if they can find some examples of usage. But now I guess maybe this is not really needed. So I will remove this line!
| There are some ways to specify root like below: | ||
| * [Overriding the root key](https://github.com/rails-api/active_model_serializers/blob/master/docs/general/rendering.md#overriding-the-root-key) | ||
| * [Setting `type`](https://github.com/rails-api/active_model_serializers/blob/master/docs/general/serializers.md#type) | ||
| * Passing an argument like `root: 'specific_name'` to the serializer's initialization. |
There was a problem hiding this comment.
I'd rather change it a bit to something like:
-* Passing an argument like `root: 'specific_name'` to the serializer's initialization.
+* Specifying the `root` option, e.g. `root: 'specific_name'`, during the serializer's initialization:
+
+```ruby
+ActiveModelSerializers::SerializableResource.new(foo, root: 'bar')
+```| @@ -217,7 +217,15 @@ The object being serialized. | |||
|
|
|||
| #### #root | |||
|
|
|||
| PR please :) | |||
| Resource root which is included in `JSON` adapter. As you can see at [Adapters Document](https://github.com/rails-api/active_model_serializers/blob/master/docs/general/adapters.md), `Attribute` adapter (default) and `JSON API` adapter dose not include root at top level. | |||
| By default, the resource root comes from the class name of the serialized class. | |||
There was a problem hiding this comment.
There is a small mistake here. Could you change it to:
-By default, the resource root comes from the class name of the serialized class.
+By default, the resource root comes from the `model_name` of the serialized object's class.
There was a problem hiding this comment.
should be a relative link.
s/dose/does
| Resource root which is included in `JSON` adapter. As you can see at [Adapters Document](https://github.com/rails-api/active_model_serializers/blob/master/docs/general/adapters.md), `Attribute` adapter (default) and `JSON API` adapter dose not include root at top level. | ||
| By default, the resource root comes from the class name of the serialized class. | ||
|
|
||
| There are some ways to specify root like below: |
| @@ -217,7 +217,15 @@ The object being serialized. | |||
|
|
|||
| #### #root | |||
There was a problem hiding this comment.
lazy ref to discussion of some of the various way root can be configured and what we want to do about it https://github.com/rails-api/active_model_serializers/pull/1794/files
| * Specifying the `root` option, e.g. `root: 'specific_name'`, during the serializer's initialization: | ||
|
|
||
| ```ruby | ||
| +ActiveModelSerializers::SerializableResource.new(foo, root: 'bar') |
There was a problem hiding this comment.
There is a + that sneaked into the ruby code here. Once you remove it I'll merge 😉 Thanks for the work!
|
@groyoh oops! I have removed the |
Purpose
Provide a document for
rootat serializers#root.Changes
Adds new lines to
docs/general/serializers.md.Caveats
Nothing.
Related GitHub issues
No issue.
Additional helpful information