Add documentation about wildcard includes #1201
Conversation
| render @posts, include: params[:include] | ||
| ``` | ||
|
|
||
| This raises some security concerns since the user could pass in `include=**`, so filter the values for `include` appropriately if you decide to support this JSON API feature. |
|
@hut8 Thanks for the PR, we really need this. Please see my comments. |
|
@beauby Better? |
| render @posts, include: '**' # or '*' for a single layer | ||
| ``` | ||
|
|
||
| The following would render posts and include every resource referenced by the posts' authors' comments (recursively). It could be combined, like above, with other paths in any combination desired. |
There was a problem hiding this comment.
How about
include the author, the author's comments, and every resource referenced by the authors' comments (recursively)
There was a problem hiding this comment.
LGTM other than this. Sorry for being a bit a bit tedious on this PR but I can foresee many issues caused by people misunderstanding this functionality.
|
@beauby Not tedious at all! It's important to make these things clear and this is a pretty awesome gem. I'm glad to be able to help. |
| render @posts, include: '**' # or '*' for a single layer | ||
| ``` | ||
|
|
||
| The following would render posts and include the author, the author's comments, and every resource by the author's comments (recursively). It could be combined, like above, with other paths in any combination desired. |
There was a problem hiding this comment.
There seems to be a missing word here:
and every ??? resource by the author's comments (recursively)
|
See my last remark, then let's squash and merge! |
|
Seemas though I accidentally a word. Fixed. Squashed and pushed. |
|
LGTM, merging. Thanks a lot @hut8! |
Add documentation about wildcard includes
Resolves #1200