Fields doc #1808
Fields doc #1808
Conversation
|
@luizkowalski thanks for this 👍 Could you add an entry to the CHANGELOG under the |
| @@ -73,7 +73,11 @@ See [ARCHITECTURE](../ARCHITECTURE.md) for more information. | |||
|
|
|||
| #### fields | |||
|
|
|||
| PR please :) | |||
| ```ruby | |||
| render json: @user, fields: [:access_token] | |||
There was a problem hiding this comment.
This is only valid for the json and attributes adapter. For the json_api adapter, you would use
render json: @user, fields: { users: [:access_token] }Where users is the JSONAPI type.
Could you add the missing code snippet with a brief description (stating for which adapter each snippet is valid) or add a description above your code that states that it only valid for json and attributes adapter?
|
@luizkowalski once you've updated the PR please squash your commits into a single one. Thanks again for spending the time on this! 💯 |
Added md file Changelog Better phrases
|
I guess thats it. |
| end | ||
| ``` | ||
|
|
||
| Note that this is only valid for the `json` adapter. For the `json_api` adapter, you would use |
There was a problem hiding this comment.
Sorry to add another comment (last one I promise 😄 ) but could you add that it is also valid for the attributes adapter (also in the other file) e.g.
-Note that this is only valid for the `json` adapter.
+Note that this is only valid for the `json` and `attributes` adapters.This is very important as it may be confusing for people using the attributes adapter if it is omitted.
And kudos for your quick responsiveness!
Added md file Changelog Better phrases Added info for other adapters
|
Just updated |
| For example, if you have a serializer like this | ||
|
|
||
| ```ruby | ||
| class UserSerializer < ActiveModel::Serializer |
There was a problem hiding this comment.
I wonder if we should begin recommending ApplicationSerializer...
| @@ -17,6 +17,7 @@ Fixes: | |||
| Misc: | |||
| - [#1734](https://github.com/rails-api/active_model_serializers/pull/1734) Adds documentation for conditional attribute (@lambda2) | |||
| - [#1685](https://github.com/rails-api/active_model_serializers/pull/1685) Replace `IncludeTree` with `IncludeDirective` from the jsonapi gem. | |||
| - [#1808](https://github.com/rails-api/active_model_serializers/pull/1808) Adds documentation for `fields` option. (@luizkowalski) | |||
There was a problem hiding this comment.
This will need to go in the 'unreleased' section
There was a problem hiding this comment.
@bf4 isn't it already the case? Or was it updated already?
There was a problem hiding this comment.
rebase against master will show this is not in 0.10.1
There was a problem hiding this comment.
@luizkowalski could you rebased and update the changelog please?
There was a problem hiding this comment.
Trying to rebase from master but it says its up to date
There was a problem hiding this comment.
also, I didn't understood what should be changed on changelog, sorry. this is becoming confusing
There was a problem hiding this comment.
The latest master has a v0.10.1 section. The version of the CHANGELOG in your PR has the newest release section as v0.10.0 (2016-05-17). I believe other maintainers are asking that you rebase from rails-api/active_model_serializers master to get the latest CHANGELOG and ensure your CHANGELOG entry remains under the master (unreleased) section.
Added md file Changelog Better phrases
Added md file Changelog Better phrases Added info for other adapters
Added docs for
fieldsparamSee #1807