Update the API docs on the JSONAPISerializer #4653
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
locks
requested changes
Nov 15, 2016
| Dasherizes and singularizes the model name in the payload to match | ||
| the format Ember Data uses internally for the model name. | ||
|
|
||
| For Example: `posts` => `post`, `studentAssesments` => |
There was a problem hiding this comment.
I believe yuidoc has an @example metatag, can you confirm?
There was a problem hiding this comment.
Actually, that might not makes much sense. Could you instead write it out in prose? the => is a bit confusing as it's also the syntax for arrow functions.
| @@ -401,6 +390,11 @@ const JSONAPISerializer = JSONSerializer.extend({ | |||
| }, | |||
|
|
|||
| /** | |||
| Converts the model name to a pluralized version of the model name. | |||
|
|
|||
| For Example: `post` => `posts`, `student-assesment` => | |||
bmac
force-pushed
the
doc-json-api-serializer
branch
from
200f81d
to
0f8fb7a
Compare
locks
approved these changes
Nov 20, 2016
runspired
added
🏷️ doc
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.
No description provided.