aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/relations.md
diff options
context:
space:
mode:
authorMatías Lang2014-12-23 12:22:10 -0300
committerMatías Lang2014-12-23 12:22:10 -0300
commit18687f075d9fb998b82c6fb8f6cb37eb1ed7e5bf (patch)
treeb1169627605ccd124a7474c7964732dbe81e5ffb /docs/api-guide/relations.md
parent201e7eaa4b468c68cbd716f1cdacc31d8908deaf (diff)
downloaddjango-rest-framework-18687f075d9fb998b82c6fb8f6cb37eb1ed7e5bf.tar.bz2
Documented an optional argument of HyperlinkedIdentityField
lookup_url_kwarg argument of HyperlinkedIdentityField wasn't documented
Diffstat (limited to 'docs/api-guide/relations.md')
-rw-r--r--docs/api-guide/relations.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md
index e56db229..50e3b7b5 100644
--- a/docs/api-guide/relations.md
+++ b/docs/api-guide/relations.md
@@ -231,6 +231,7 @@ This field is always read-only.
* `view_name` - The view name that should be used as the target of the relationship. If you're using [the standard router classes][routers] this will be a string with the format `<model_name>-detail`. **required**.
* `lookup_field` - 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 `'pk'`.
+* `lookup_url_kwarg` - The name of the keyword argument defined in the URL conf that corresponds to the lookup field. Defaults to using the same value as `lookup_field`.
* `format` - If using format suffixes, hyperlinked fields will use the same format suffix for the target unless overridden by using the `format` argument.
---