update configuration doc

This commit is contained in:
Mateusz Sikora 2014-10-09 14:53:39 +02:00
parent 7ed1388b3b
commit 41a0688b04

View File

@ -1,15 +1,14 @@
Configuration Configuration
============= =============
Custom Serializers - **REST_AUTH_SERIALIZERS**
------------------
You can define your custom serializers for each endpoint without overriding urls and views by adding ``REST_AUTH_SERIALIZERS`` dictionary in your django settings. You can define your custom serializers for each endpoint without overriding urls and views by adding ``REST_AUTH_SERIALIZERS`` dictionary in your django settings.
Possible key values: Possible key values:
- LOGIN_SERIALIZER - serializer class in ``rest_auth.views.Login``, default value ``rest_auth.serializers.LoginSerializer`` - LOGIN_SERIALIZER - serializer class in ``rest_auth.views.Login``, default value ``rest_auth.serializers.LoginSerializer``
- TOKEN_SERIALIZER - response for successful authentication in ``rest_auth.views.Login`, default value ``rest_auth.serializers.TokenSerializer`` - TOKEN_SERIALIZER - response for successful authentication in ``rest_auth.views.Login``, default value ``rest_auth.serializers.TokenSerializer``
- USER_DETAILS_SERIALIZER - serializer class in ``rest_auth.views.UserDetails``, default value ``rest_auth.serializers.UserDetailsSerializer`` - USER_DETAILS_SERIALIZER - serializer class in ``rest_auth.views.UserDetails``, default value ``rest_auth.serializers.UserDetailsSerializer``
@ -29,3 +28,6 @@ Example configuration:
'TOKEN_SERIALIZER': 'path.to.custom.TokenSerializer', 'TOKEN_SERIALIZER': 'path.to.custom.TokenSerializer',
... ...
} }
- **REST_SESSION_LOGIN** - Enable session login in Login API view (default: True)