From ef5279e97c0aa083d44489cf374fa75c7c8f53b7 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 5 Sep 2012 13:03:55 +0100 Subject: Improve docs --- docs/api-guide/settings.md | 74 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 68 insertions(+), 6 deletions(-) (limited to 'docs/api-guide/settings.md') diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index c7bae30d..af8c4ec9 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -5,27 +5,89 @@ For example your project's `settings.py` file might look like this: API_SETTINGS = { 'DEFAULT_RENDERERS': ( - 'djangorestframework.renderers.JSONRenderer', 'djangorestframework.renderers.YAMLRenderer', ) 'DEFAULT_PARSERS': ( - 'djangorestframework.parsers.JSONParser', 'djangorestframework.parsers.YAMLParser', ) } ## DEFAULT_RENDERERS -A list or tuple of renderer classes. +A list or tuple of renderer classes, that determines the default set of renderers that may be used when returning a `Response` object. Default: ( - 'djangorestframework.renderers.JSONRenderer', - 'djangorestframework.renderers.DocumentingHTMLRenderer')` + 'djangorestframework.renderers.JSONRenderer', + 'djangorestframework.renderers.DocumentingHTMLRenderer' + 'djangorestframework.renderers.TemplateHTMLRenderer' + ) ## DEFAULT_PARSERS -A list or tuple of parser classes. +A list or tuple of parser classes, that determines the default set of parsers used when accessing the `request.DATA` property. + +Default: + + ( + 'djangorestframework.parsers.JSONParser', + 'djangorestframework.parsers.FormParser' + ) + +## DEFAULT_AUTHENTICATION + +A list or tuple of authentication classes, that determines the default set of authenticators used when accessing the `request.user` or `request.auth` properties. + +Default if `DEBUG` is `True`: + + ( + 'djangorestframework.authentication.SessionAuthentication', + 'djangorestframework.authentication.UserBasicAuthentication' + ) + +Default if `DEBUG` is `False`: + + ( + 'djangorestframework.authentication.SessionAuthentication', + ) + +## DEFAULT_PERMISSIONS + +Default: `()` + +## DEFAULT_THROTTLES Default: `()` + +## DEFAULT_MODEL_SERIALIZER + +Default: `djangorestframework.serializers.ModelSerializer` + +## DEFAULT_PAGINATION_SERIALIZER + +Default: `djangorestframework.pagination.PaginationSerializer` + +## FORMAT_SUFFIX_KWARG + +Default: `format` + +## UNAUTHENTICATED_USER_CLASS + +Default: `django.contrib.auth.models.AnonymousUser` + +## FORM_METHOD_OVERRIDE + +Default: `_method` + +## FORM_CONTENT_OVERRIDE + +Default: `_content` + +## FORM_CONTENTTYPE_OVERRIDE + +Default: `_content_type` + +## URL_ACCEPT_OVERRIDE + +Default: `_accept` -- cgit v1.2.3