Add note clarifying context hash usage when passing resources through the ResourceSerializer#821
Merged
lgebhardt merged 1 commit intoJSONAPI-Resources:masterfrom Sep 12, 2016
Conversation
Contributor
|
@kevinzwh Thanks! |
This file contains hidden or 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
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.
Description:
I found the documentation to be lacking in explaining how context is passed in when using the ResourceSerializer.
Only after playing around with the ResourceSerializer for some time that I found that the second argument for initializing a resource was the context itself. In the documentation, this second argument was simply
nilwithout explanation that this was actually the context the resource initializes with:JSONAPI::ResourceSerializer.new(PostResource).serialize_to_hash(PostResource.new(post, nil))Changes Proposed:
Hopefully this will help newcomers who might need context for their resource while using ResourceSerializers. Hope this helps @lgebhardt!