[DOC] Update descriptions of findRecord() and findAll() #4581
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
This commit adds documentation on the use of the `include` query parameter in `DS.Store` methods `findRecord()` and `findAll()`. This feature allows records of models related to those requested to be retrieved from JSON API compliant server in a single request. This capability was added in emberjs#3976 but is not currently documented.
|
Thanks @MarkMT. Overall this is looking good 👍. |
bmac
suggested changes
Oct 18, 2016
| comments in the same request: | ||
|
|
||
| ``` | ||
| // app/routes/post.js |
There was a problem hiding this comment.
Instead of writing the filename in a comment you can write it after the 3 back ticks and it will get rendered as a header for the code block.
There was a problem hiding this comment.
Thanks, I thought that was the case, but initially I was using https://github.com/emberjs/api to render the edits locally and it seems for some reason that that doesn't actually support that behavior, so I put the filenames in the comment instead. I've switched to https://github.com/emberjs/website for local rendering and it's now working as advertised.
bmac
approved these changes
Oct 18, 2016
|
Thanks @MarkMT. |
homu
added a commit
to emberjs/guides
that referenced
this pull request
Nov 1, 2016
Explain retrieval of related records This commit adds a sub-section to Models: Relationships to explain how to retrieve records from related models using the JSON API 'include' query parameter. This reflects recent changes to the `DS.Store` API documented in emberjs/data#4581
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.
This commit adds documentation on the use of the
includequery parameter inDS.StoremethodsfindRecord()andfindAll(). This feature allows records of models related to those requested to be retrieved from JSON API compliant server in a single request. This capability was added in #3976 but is not currently documented.