Improve doc for :root option in as_json() #36092
Conversation
| @@ -42,6 +42,13 @@ module JSON | |||
| # # => { "user" => { "id" => 1, "name" => "Konata Izumi", "age" => 16, | |||
| # # "created_at" => "2006-08-01T17:27:13.000Z", "awesome" => true } } | |||
| # | |||
| # If you prefer to use custom name than the object's type, set <tt>:root</tt> to the custom name as in: | |||
There was a problem hiding this comment.
I would say If you prefer, <tt>:root</tt> may also be set to a custom string key: instead. as_json(root: :author) would make the root a symbol which I don't think we want. This might also signal room for improvement in the API since we are expecting keys to be strings here, and not calling to_s on custom roots.
There was a problem hiding this comment.
Reworded d8c5b08
as_json(root: :author) would make the root a symbol which I don't think we want.
It makes root a string key, not symbol.
There was a problem hiding this comment.
It doesn't call root.to_s on this line so calling user.as_json(root: :author) would result in a symbol root key. Unless I'm misunderstanding the intent of this patch, please update the example code to use a string.
Also, please squash you commits into one, and then I'll merge this. Thanks! 🙏
There was a problem hiding this comment.
@gmcgibbon I was just deceived by what render json was doing. But I was able to see what you were saying. My bad.
I have made the change and squashed my commit. Hope it's good now.
|
Guess I triggered CI build, can someone stop it plz. Thanks |
Remove trailing whitespace [ci skip] Reword Root value should be string [ci skip]
:rootoption is much more pleasant than I'd imagined.