encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-02-02 20:54:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Tweak related field docs now that queryset is no longer required.

Browse Source
This commit is contained in:
Tom Christie 2012-11-05 16:44:26 +00:00
parent 867033e676
commit 1418d104a8
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api-guide/fields.md
View File

@ -243,7 +243,7 @@ Be default these fields read-write, although you can change this behaviour using
**Arguments**:
* `queryset` - All relational fields must either set a queryset, or set `read_only=True`
* `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`.
## SlugRelatedField / ManySlugRelatedField
@ -254,7 +254,7 @@ Be default these fields read-write, although you can change this behaviour using
**Arguments**:
* `slug_field` - The field on the target that should used as the representation. This should be a field that uniquely identifies any given instance. For example, `username`.
* `queryset` - All relational fields must either set a queryset, or set `read_only=True`
* `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`.
## HyperlinkedRelatedField / ManyHyperlinkedRelatedField
@ -266,9 +266,9 @@ Be default, `HyperlinkedRelatedField` is read-write, although you can change thi
* `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.
* `queryset` - All relational fields must either set a queryset, or set `read_only=True`
* `slug_url_kwarg` - The named url parameter for the slug field lookup. Default is `slug`
* `slug_field` - The field on the target that should be used for the lookup. Default is `slug`
* `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'`.
* `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