Document serialization interface and what to test #967
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
Merged
| - `#to_json(options)`: string representation (JSON) to Hash from `as_json` | ||
| - `#cache_key`: a (self-expiring) unique key for the instance, used by the adapter | ||
| - `#id`: a unique identifier for the object | ||
| - `::model_name`: an ActiveModel::Name instance, used by the serializer to identify the type |
|
@bf4 hi :) left you some notes |
|
Oof, my brain can't handle code right now, I'll review prose though! 😄 |
This was referenced Aug 30, 2015
| Serializable resources must include [`ActiveModel::Serialization`](https://github.com/rails/rails/blob/master/activemodel/lib/active_model/serialization.rb) | ||
| or implement its interface: | ||
|
|
||
| - `#serializable_hash(options)`: hash representation of a resources attributes |
There was a problem hiding this comment.
Could we detail the current/future options?
|
BTW not README anymore, focus on spread this information the docs. 😄 |
|
I've been meaning to come back to this to add serializer test helpers. the linter and and interface docs are done |
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.
Extracted from #954
ref: #878 (comment)