Adding documentation on conditional attributes #1734
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -34,6 +34,18 @@ Serialization of the resource `title` | |||
| | `attribute :title { 'A Different Title'}` | `{ title: 'A Different Title' } ` | |||
| | `attribute :title`<br>`def title 'A Different Title' end` | `{ title: 'A Different Title' }` | |||
|
|
|||
| An `if` or `unless` parameter can make an attribute conditional. It take a symbol of a method name on the serializer. | |||
|
Thanks for this PR! I think we merged the PR allowing lambdas as values for the |
| object.id == current_user.id | ||
| end | ||
| ``` | ||
|
|
||
| [PR please for conditional attributes:)](https://github.com/rails-api/active_model_serializers/pull/1403) |
There was a problem hiding this comment.
is this breadcrumb taken care of then?
There was a problem hiding this comment.
Yup, seems so. Good catch @cgmckeever. @lambda2 could you remove the reminder?
|
@lambda2 great! would you like to add yourself to the changelog under misc or rebase? If not, we can handle it. |
|
@bf4 Yes, I added it under misc :) |
|
@lambda2 Thanks very much for this! Could you do the following:
Once those items are taken care of we can get this merged in. |
|
@remear yeah, of course. Seems good now ! |
| @@ -34,7 +34,18 @@ Serialization of the resource `title` | |||
| | `attribute :title { 'A Different Title'}` | `{ title: 'A Different Title' } ` | |||
| | `attribute :title`<br>`def title 'A Different Title' end` | `{ title: 'A Different Title' }` | |||
|
|
|||
| [PR please for conditional attributes:)](https://github.com/rails-api/active_model_serializers/pull/1403) | |||
| An `if` or `unless` parameter can make an attribute conditional. It takes a symbol of a method name on the serializer, or a lambda literal. | |||
There was a problem hiding this comment.
I'd rather use option instead of parameter here.
Adding documentation and short example ([from this pull request](rails-api#1403)) on conditional attributes. Adding lambda literal notation and example. Adding lambda literal notation and example, and fixing typo. Removing PR reminder Adding Changelog entry Moving CHANGELOG entry under master (unreleased) Use option instead of parameter
|
👌 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Adding documentation on conditional attributes for the
attributemethod.Changes
Adding documentation and short example (from this pull request) on conditional attributes for the
attributemethod.Related GitHub issues
#1403