From 670723f0216e5aea3aa133c99703949900be3d20 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 6 Feb 2015 15:45:02 +0000 Subject: Minor cleanups/improvements to ModelSerializer API --- docs/api-guide/serializers.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'docs/api-guide') diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 9a9d5032..940eb424 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -577,9 +577,25 @@ Normally if a `ModelSerializer` does not generate the fields you need by default A mapping of Django model classes to REST framework serializer classes. You can override this mapping to alter the default serializer classes that should be used for each model class. -### `.serializer_relational_field` +### `.serializer_related_field` -This property should be the serializer field class, that is used for relational fields by default. For `ModelSerializer` this defaults to `PrimaryKeyRelatedField`. For `HyperlinkedModelSerializer` this defaults to `HyperlinkedRelatedField`. +This property should be the serializer field class, that is used for relational fields by default. + +For `ModelSerializer` this defaults to `PrimaryKeyRelatedField`. + +For `HyperlinkedModelSerializer` this defaults to `serializers.HyperlinkedRelatedField`. + +### `serializer_url_field` + +The serializer field class that should be used for any `url` field on the serializer. + +Defaults to `serializers.HyperlinkedIdentityField` + +### `serializer_choice_field` + +The serializer field class that should be used for any choice fields on the serializer. + +Defaults to `serializers.ChoiceField` ### The field_class and field_kwargs API -- cgit v1.2.3