Improve the API docs for the JSONAPI adapter #4652
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
| @@ -9,6 +9,135 @@ import isEnabled from 'ember-data/-private/features'; | |||
| import { instrument, deprecate } from 'ember-data/-private/debug'; | |||
|
|
|||
| /** | |||
| The `JSONAPIAdapter` is the default adapter used by Ember Data. It is | |||
| responsible for transforming the store's requests into HTTP request | |||
| ## JSON API Conventions | ||
|
|
||
| The JSONAPIAdapter uses JSON API conventions for building the url | ||
| for a record and selecting the HTTP verb to use with a request. The |
There was a problem hiding this comment.
Extra whitespace after period.
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
| Failed responses with status code 422 ("Unprocessable Entity") will | ||
| be considered "invalid". The response will be discarded, except for | ||
| the `errors` key. The request promise will be rejected with a | ||
| `DS.InvalidError`. This error object will encapsulate the saved |
There was a problem hiding this comment.
Extra whitespace after period.
| `DS.InvalidError`. This error object will encapsulate the saved | ||
| `errors` value. | ||
|
|
||
| Any other status codes will be treated as an "adapter error". The |
There was a problem hiding this comment.
why the double quotes here and around invalid?
bmac
commented
Nov 15, 2016
| @param {Array} ids | ||
| @param {Array} snapshots | ||
| @return {Promise} promise | ||
| */ |
There was a problem hiding this comment.
The RESTAdapter has better docs for these apis and these minimal doc blocks in the JSONAPIAdapter are preventing the better docs from being rendered. They will still be listed as public on the doc page.
bmac
force-pushed
the
doc-json-api-adapter
branch
from
0c63c80
to
55c34ed
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.