-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[0.10] add docs for include #2081
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -141,18 +141,25 @@ This adapter follows **version 1.0** of the [format specified](../jsonapi/schema | |
} | ||
``` | ||
|
||
#### Included | ||
### Include option | ||
|
||
It will include the associated resources in the `"included"` member | ||
when the resource names are included in the `include` option. | ||
Including nested associated resources is also supported. | ||
Which [serializer associations](https://github.com/rails-api/active_model_serializers/blob/master/docs/general/serializers.md#associations) are rendered can be specified using the `include` option. The option usage is consistent with [the include option in the JSON API spec](http://jsonapi.org/format/#fetching-includes), but is available in all adapters. | ||
|
||
Example of the usage: | ||
```ruby | ||
render json: @posts, include: ['author', 'comments', 'comments.author'] | ||
# or | ||
render json: @posts, include: 'author,comments,comments.author' | ||
``` | ||
|
||
The format of the `include` option can be either: | ||
|
||
- a String composed of a comma-separated list of [relationship paths](http://jsonapi.org/format/#fetching-includes). | ||
- an Array of Symbols and Hashes. | ||
- a mix of both. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💯 |
||
|
||
An empty string or an empty array will prevent rendering of any associations. | ||
|
||
In addition, two types of wildcards may be used: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe note the wildcards are AMS-specific. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am afraid, I don't fully understand, what does "AMS-specific" mean. Can you elaborate, please? |
||
|
||
- `*` includes one level of associations. | ||
|
@@ -164,11 +171,6 @@ These can be combined with other paths. | |
render json: @posts, include: '**' # or '*' for a single layer | ||
``` | ||
|
||
The format of the `include` option can be either: | ||
|
||
- a String composed of a comma-separated list of [relationship paths](http://jsonapi.org/format/#fetching-includes). | ||
- an Array of Symbols and Hashes. | ||
- a mix of both. | ||
|
||
The following would render posts and include: | ||
|
||
|
@@ -182,6 +184,20 @@ It could be combined, like above, with other paths in any combination desired. | |
render json: @posts, include: 'author.comments.**' | ||
``` | ||
|
||
**Note:** Wildcards are AMS-specific, they are not part of the JSON API spec. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
The default include for the JSON API adapter is no associations. The default for the JSON and Attributes adapters is all associations. | ||
|
||
For the JSON API adapter associated resources will be gathered in the `"included"` member. For the JSON and Attributes | ||
adapters associated resources will be rendered among the other attributes. | ||
|
||
Only for the JSON API adapter you can specify, which attributes of associated resources will be rendered. This feature | ||
is called [sparse fieldset](http://jsonapi.org/format/#fetching-sparse-fieldsets): | ||
|
||
```ruby | ||
render json: @posts, include: 'comments', fields: { comments: ['content', 'created_at'] } | ||
``` | ||
|
||
##### Security Considerations | ||
|
||
Since the included options may come from the query params (i.e. user-controller): | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/but is/and is