aboutsummaryrefslogtreecommitdiffstats
path: root/api-guide/relations.html
diff options
context:
space:
mode:
Diffstat (limited to 'api-guide/relations.html')
-rw-r--r--api-guide/relations.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/api-guide/relations.html b/api-guide/relations.html
index d774972d..d9e1a8a1 100644
--- a/api-guide/relations.html
+++ b/api-guide/relations.html
@@ -330,7 +330,7 @@ class Track(models.Model):
<p>By default this field is read-write, although you can change this behavior using the <code>read_only</code> flag.</p>
<p><strong>Arguments</strong>:</p>
<ul>
-<li><code>view_name</code> - The view name that should be used as the target of the relationship. <strong>required</strong>.</li>
+<li><code>view_name</code> - The view name that should be used as the target of the relationship. If you're using <a href="http://django-rest-framework.org/api-guide/routers#defaultrouter">the standard router classes</a> this wil be a string with the format <code>&lt;modelname&gt;-detail</code>. <strong>required</strong>.</li>
<li><code>many</code> - If applied to a to-many relationship, you should set this argument to <code>True</code>.</li>
<li><code>required</code> - If set to <code>False</code>, the field will accept values of <code>None</code> or the empty-string for nullable relationships.</li>
<li><code>queryset</code> - By default <code>ModelSerializer</code> classes will use the default queryset for the relationship. <code>Serializer</code> classes must either set a queryset explicitly, or set <code>read_only=True</code>.</li>
@@ -388,7 +388,7 @@ class Track(models.Model):
<p>This field is always read-only.</p>
<p><strong>Arguments</strong>:</p>
<ul>
-<li><code>view_name</code> - The view name that should be used as the target of the relationship. <strong>required</strong>.</li>
+<li><code>view_name</code> - The view name that should be used as the target of the relationship. If you're using <a href="http://django-rest-framework.org/api-guide/routers#defaultrouter">the standard router classes</a> this wil be a string with the format <code>&lt;model_name&gt;-detail</code>. <strong>required</strong>.</li>
<li><code>lookup_field</code> - The field on the target that should be used for the lookup. Should correspond to a URL keyword argument on the referenced view. Default is <code>'pk'</code>.</li>
<li><code>format</code> - If using format suffixes, hyperlinked fields will use the same format suffix for the target unless overridden by using the <code>format</code> argument.</li>
</ul>