Commit 95e7ed4

nattyg93sliverc

authored and

committed

Clarify docs on controlling compound documents (#579)

1 parent 876892f commit 95e7ed4Copy full SHA for 95e7ed4

File tree

-5

lines changed

-5

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,3 +23,4 @@ Mohammed Ali Zubair <mazg1493@gmail.com>`
`23`	`23`	`Jason Housley <housleyjk@gmail.com>`
`24`	`24`	`Beni Keller <beni@matraxi.ch>`
`25`	`25`	`Stas S. <stas@nerd.ro>`
	`26`	`+Nathanael Gordon <nathanael.l.gordon@gmail.com>`

Lines changed: 3 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -789,8 +789,9 @@ that are related to the primary resource.`
`789`	`789`
`790`	`790`	`To make a Compound Document,`
`791`	`791`	you need to modify your `ModelSerializer`.
`792`		-The two required additions are `included_resources`
`793`		-and `included_serializers`.
	`792`	+`included_serializers` is required to inform DJA of what and how you would like
	`793`	`+to include.`
	`794`	+`included_resources` tells DJA what you want to include by default.
`794`	`795`
`795`	`796`	`For example,`
`796`	`797`	`suppose you are making an app to go on quests,`
`@@ -818,9 +819,6 @@ class QuestSerializer(serializers.ModelSerializer):`
`818`	`819`	`included_resources = ['knight']`
`819`	`820`	```
`820`	`821`
`821`		-`included_resources` informs DJA of what you would like to include.
`822`		-`included_serializers` tells DJA how you want to include it.
`823`		`-`
`824`	`822`	`#### Performance improvements`
`825`	`823`
`826`	`824`	`Be aware that using included resources without any form of prefetching WILL HURT PERFORMANCE as it will introduce m\*(n+1) queries.`

Comments

(0)