From 41a0688b04cbdd3ccaa49819192b7b5ab61dd916 Mon Sep 17 00:00:00 2001 From: Mateusz Sikora Date: Thu, 9 Oct 2014 14:53:39 +0200 Subject: [PATCH] update configuration doc --- docs/configuration.rst | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 9018549..ca296fd 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,31 +1,33 @@ 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. -Possible key values: + 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: - - 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`` - - PASSWORD_RESET_SERIALIZER - serializer class in ``rest_auth.views.PasswordReset``, default value ``rest_auth.serializers.PasswordResetSerializer`` + - PASSWORD_RESET_SERIALIZER - serializer class in ``rest_auth.views.PasswordReset``, default value ``rest_auth.serializers.PasswordResetSerializer`` - - PASSWORD_RESET_CONFIRM_SERIALIZER - serializer class in ``rest_auth.views.PasswordResetConfirm``, default value ``rest_auth.serializers.PasswordResetConfirmSerializer`` + - PASSWORD_RESET_CONFIRM_SERIALIZER - serializer class in ``rest_auth.views.PasswordResetConfirm``, default value ``rest_auth.serializers.PasswordResetConfirmSerializer`` - - PASSWORD_CHANGE_SERIALIZER - serializer class in ``rest_auth.views.PasswordChange``, default value ``rest_auth.serializers.PasswordChangeSerializer`` + - PASSWORD_CHANGE_SERIALIZER - serializer class in ``rest_auth.views.PasswordChange``, default value ``rest_auth.serializers.PasswordChangeSerializer`` -Example configuration: + Example configuration: -.. code-block:: python + .. code-block:: python - REST_AUTH_SERIALIZERS = { - 'LOGIN_SERIALIZER': 'path.to.custom.LoginSerializer', - 'TOKEN_SERIALIZER': 'path.to.custom.TokenSerializer', - ... - } + REST_AUTH_SERIALIZERS = { + 'LOGIN_SERIALIZER': 'path.to.custom.LoginSerializer', + 'TOKEN_SERIALIZER': 'path.to.custom.TokenSerializer', + ... + } + + +- **REST_SESSION_LOGIN** - Enable session login in Login API view (default: True)