diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 50a09701e..80c7a859f 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -322,6 +322,7 @@ By default, `HyperlinkedRelatedField` is read-write, although you can change thi * `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`. * `null` - If set to `True`, the field will accept values of `None` or the emptystring for nullable relationships. +* `use_absolute_urls` - This option will overwrite the serializer option `use_absolute_urls`. ## HyperLinkedIdentityField diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 19efde3c7..5f7839f4c 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -189,6 +189,14 @@ As an example, let's create a field that can be used represent the class name of """ pass +## Meta options + +**TODO** add remaining serializer meta options + +### `use_absolute_urls` + +This setting will overwrite the `REST_FRAMEWORK` option `USE_ABSOLUTE_URLS` and can also be overwritten by the field attribute `use_absolute_urls`. + --- # ModelSerializers diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 84fef1cf9..a9ab12319 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -170,4 +170,6 @@ Default: `'format'` Default: `True` +This setting can overwritten by the serializer meta option `use_absolute_urls` which also can be overwritten by the field attribute `use_absolute_urls`. + [cite]: http://www.python.org/dev/peps/pep-0020/