Add method argument to key serialization docs #3035
Conversation
| return Ember.String.underscore(attr).toUpperCase(); | ||
| } else { | ||
| return Ember.String.camelize(attr.toLowerCase()); | ||
| } |
There was a problem hiding this comment.
Lets leave this example as it was (although feel free to add the method parameter to the function declaration). The new implementation doesn't match the text above it.
There was a problem hiding this comment.
The original example would work fine if the data is never saved back to the server. If it is, though, we do need to perform the reverse conversion. Perhaps I should instead expand the text above and and a bit clarifying this reverse procedure?
There was a problem hiding this comment.
The keyForAttribute method's attr parameter is always the name of the attribute as defined on the Model. So if the API you are working with consistently uses the same keys when serializing and deserializing then you should not need to include a check on the method argument.
Using method method is usually reserved for the rare case where an API returns data using one key, but then expects it to be listed under a different key when updating.
There was a problem hiding this comment.
That makes sense now, thanks! I'll update the PR.
Dremora
force-pushed
the
key_serializer_docs
branch
from
59055e1
to
e23bcea
Compare
Add method argument to key serialization docs
|
Thanks! |
In
JSONSerializer, bothkeyForAttributeandkeyForRelationshipget an extra undocumented parameter,method(which can be eitherserializeordeserialize). This PR adds the missing bits.Also there was a call to
keyForAttributewith amethodargument missing — 'serialize` is now explicitly being passed there.