From 6d3bb67aa654d5f4c555746655a312000422d474 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Tue, 6 Nov 2012 17:11:52 +0000
Subject: Add pk_url_kwarg to hyperlinked fields

---
 docs/api-guide/fields.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs/api-guide/fields.md')

diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index 2a8949a1..0485b158 100644
--- a/docs/api-guide/fields.md
+++ b/docs/api-guide/fields.md
@@ -268,6 +268,7 @@ By default, `HyperlinkedRelatedField` is read-write, although you can change thi
 * `format` - If using format suffixes, hyperlinked fields will use the same format suffix for the target unless overridden by using the `format` argument.
 * `queryset` - By default `ModelSerializer` classes will use the default queryset for the relationship.  `Serializer` classes must either set a queryset explicitly, or set `read_only=True`.
 * `slug_field` - The field on the target that should be used for the lookup. Default is `'slug'`.
+* `pk_url_kwarg` - The named url parameter for the pk field lookup. Default is `pk`.
 * `slug_url_kwarg` - The named url parameter for the slug field lookup. Default is to use the same value as given for `slug_field`.
 
 ## HyperLinkedIdentityField
@@ -281,6 +282,7 @@ This field is always read-only.
 * `view_name` - The view name that should be used as the target of the relationship.  **required**.
 * `format` - If using format suffixes, hyperlinked fields will use the same format suffix for the target unless overridden by using the `format` argument.
 * `slug_field` - The field on the target that should be used for the lookup. Default is `'slug'`.
+* `pk_url_kwarg` - The named url parameter for the pk field lookup. Default is `pk`.
 * `slug_url_kwarg` - The named url parameter for the slug field lookup. Default is to use the same value as given for `slug_field`.
 
 [cite]: http://www.python.org/dev/peps/pep-0020/
-- 
cgit v1.2.3