diff options
| author | Tom Christie | 2013-03-06 12:19:39 +0000 | 
|---|---|---|
| committer | Tom Christie | 2013-03-06 12:19:39 +0000 | 
| commit | 1106596c80218569a56ff5ea04d759e3d0c541dd (patch) | |
| tree | abef8464aad8d551113243b430b436ce4449fee2 /docs/api-guide | |
| parent | 4f7b028a0a983b79ebca63b2ba48ce97e7a06175 (diff) | |
| download | django-rest-framework-1106596c80218569a56ff5ea04d759e3d0c541dd.tar.bz2 | |
Clean ups to datetime formatting
Diffstat (limited to 'docs/api-guide')
| -rw-r--r-- | docs/api-guide/fields.md | 20 | ||||
| -rw-r--r-- | docs/api-guide/settings.md | 104 | 
2 files changed, 78 insertions, 46 deletions
| diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 68e619a0..9a745cf1 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -2,7 +2,7 @@  # Serializer fields -> Each field in a Form class is responsible not only for validating data, but also for "cleaning" it -- normalizing it to a consistent format.  +> Each field in a Form class is responsible not only for validating data, but also for "cleaning" it — normalizing it to a consistent format.   >  > — [Django documentation][cite] @@ -199,10 +199,10 @@ If you want to override this behavior, you'll need to declare the `DateTimeField  **Signature:** `DateTimeField(format=None, input_formats=None)` -* `format` - A string representing the output format.  If not specified, the `DATETIME_FORMAT` setting will be used, which defaults to `'iso8601'`. -* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso8601']`. +* `format` - A string representing the output format.  If not specified, the `DATETIME_FORMAT` setting will be used, which defaults to `'iso-8601'`. +* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`. -DateTime format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'is8601'`, which indicates that [ISO 8601][iso8601] style datetimes should be used. (eg `'2013-01-29T12:34:56.000000'`) +DateTime format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style datetimes should be used. (eg `'2013-01-29T12:34:56.000000'`)  ## DateField @@ -212,10 +212,10 @@ Corresponds to `django.db.models.fields.DateField`  **Signature:** `DateField(format=None, input_formats=None)` -* `format` - A string representing the output format.  If not specified, the `DATE_FORMAT` setting will be used, which defaults to `'iso8601'`. -* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATE_INPUT_FORMATS` setting will be used, which defaults to `['iso8601']`.  +* `format` - A string representing the output format.  If not specified, the `DATE_FORMAT` setting will be used, which defaults to `'iso-8601'`. +* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATE_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.  -Date format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'is8601'`, which indicates that [ISO 8601][iso8601] style dates should be used. (eg `'2013-01-29'`) +Date format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style dates should be used. (eg `'2013-01-29'`)  ## TimeField @@ -227,10 +227,10 @@ Corresponds to `django.db.models.fields.TimeField`  **Signature:** `TimeField(format=None, input_formats=None)` -* `format` - A string representing the output format.  If not specified, the `TIME_FORMAT` setting will be used, which defaults to `'iso8601'`. -* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `TIME_INPUT_FORMATS` setting will be used, which defaults to `['iso8601']`. +* `format` - A string representing the output format.  If not specified, the `TIME_FORMAT` setting will be used, which defaults to `'iso-8601'`. +* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `TIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`. -Time format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'is8601'`, which indicates that [ISO 8601][iso8601] style times should be used. (eg `'12:34:56.000000'`) +Time format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style times should be used. (eg `'12:34:56.000000'`)  ## IntegerField diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 82730225..11638696 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -34,7 +34,11 @@ The `api_settings` object will check for any user-defined settings, and otherwis  # API Reference -## DEFAULT_RENDERER_CLASSES +## API policy settings + +*The following settings control the basic API policies, and are applied to every `APIView` class based view, or `@api_view` function based view.* + +#### DEFAULT_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. @@ -45,7 +49,7 @@ Default:          'rest_framework.renderers.BrowsableAPIRenderer',      ) -## DEFAULT_PARSER_CLASSES +#### DEFAULT_PARSER_CLASSES  A list or tuple of parser classes, that determines the default set of parsers used when accessing the `request.DATA` property. @@ -57,7 +61,7 @@ Default:          'rest_framework.parsers.MultiPartParser'      ) -## DEFAULT_AUTHENTICATION_CLASSES +#### DEFAULT_AUTHENTICATION_CLASSES  A list or tuple of authentication classes, that determines the default set of authenticators used when accessing the `request.user` or `request.auth` properties. @@ -68,7 +72,7 @@ Default:          'rest_framework.authentication.BasicAuthentication'      ) -## DEFAULT_PERMISSION_CLASSES +#### DEFAULT_PERMISSION_CLASSES  A list or tuple of permission classes, that determines the default set of permissions checked at the start of a view. @@ -78,59 +82,77 @@ Default:          'rest_framework.permissions.AllowAny',      ) -## DEFAULT_THROTTLE_CLASSES +#### DEFAULT_THROTTLE_CLASSES  A list or tuple of throttle classes, that determines the default set of throttles checked at the start of a view.  Default: `()` -## DEFAULT_CONTENT_NEGOTIATION_CLASS +#### DEFAULT_CONTENT_NEGOTIATION_CLASS  A content negotiation class, that determines how a renderer is selected for the response, given an incoming request.  Default: `'rest_framework.negotiation.DefaultContentNegotiation'` -## DEFAULT_MODEL_SERIALIZER_CLASS +--- + +## Generic view settings + +*The following settings control the behavior of the generic class based views.* + +#### DEFAULT_MODEL_SERIALIZER_CLASS  A class that determines the default type of model serializer that should be used by a generic view if `model` is specified, but `serializer_class` is not provided.  Default: `'rest_framework.serializers.ModelSerializer'` -## DEFAULT_PAGINATION_SERIALIZER_CLASS +#### DEFAULT_PAGINATION_SERIALIZER_CLASS  A class the determines the default serialization style for paginated responses.  Default: `rest_framework.pagination.PaginationSerializer` -## FILTER_BACKEND +#### FILTER_BACKEND  The filter backend class that should be used for generic filtering.  If set to `None` then generic filtering is disabled. -## PAGINATE_BY +#### PAGINATE_BY  The default page size to use for pagination.  If set to `None`, pagination is disabled by default.  Default: `None` -## PAGINATE_BY_PARAM +#### PAGINATE_BY_PARAM  The name of a query parameter, which can be used by the client to overide the default page size to use for pagination.  If set to `None`, clients may not override the default page size.  Default: `None` -## UNAUTHENTICATED_USER +--- + +## Authentication settings + +*The following settings control the behavior of unauthenticated requests.* + +#### UNAUTHENTICATED_USER  The class that should be used to initialize `request.user` for unauthenticated requests.  Default: `django.contrib.auth.models.AnonymousUser` -## UNAUTHENTICATED_TOKEN +#### UNAUTHENTICATED_TOKEN  The class that should be used to initialize `request.auth` for unauthenticated requests.  Default: `None` -## FORM_METHOD_OVERRIDE +--- + +## Browser overrides + +*The following settings provide URL or form-based overrides of the default browser behavior.* + +#### FORM_METHOD_OVERRIDE  The name of a form field that may be used to override the HTTP method of the form. @@ -138,7 +160,7 @@ If the value of this setting is `None` then form method overloading will be disa  Default: `'_method'` -## FORM_CONTENT_OVERRIDE +#### FORM_CONTENT_OVERRIDE  The name of a form field that may be used to override the content of the form payload.  Must be used together with `FORM_CONTENTTYPE_OVERRIDE`. @@ -146,7 +168,7 @@ If either setting is `None` then form content overloading will be disabled.  Default: `'_content'` -## FORM_CONTENTTYPE_OVERRIDE +#### FORM_CONTENTTYPE_OVERRIDE  The name of a form field that may be used to override the content type of the form payload.  Must be used together with `FORM_CONTENT_OVERRIDE`. @@ -154,7 +176,7 @@ If either setting is `None` then form content overloading will be disabled.  Default: `'_content_type'` -## URL_ACCEPT_OVERRIDE +#### URL_ACCEPT_OVERRIDE  The name of a URL parameter that may be used to override the HTTP `Accept` header. @@ -162,52 +184,62 @@ If the value of this setting is `None` then URL accept overloading will be disab  Default: `'accept'` -## URL_FORMAT_OVERRIDE +#### URL_FORMAT_OVERRIDE  The name of a URL parameter that may be used to override the default `Accept` header based content negotiation.  Default: `'format'` -## FORMAT_SUFFIX_KWARG +--- -The name of a parameter in the URL conf that may be used to provide a format suffix. +## Date/Time formatting -Default: `'format'` +*The following settings are used to control how date and time representations may be parsed and rendered.* -## DATETIME_FORMAT +#### DATETIME_FORMAT -A format string that should be used by default for `DateTimeField` serializer fields. +A format string that should be used by default for rendering the output of `DateTimeField` serializer fields. -Default: `'iso8601'` +Default: `'iso-8601'` -## DATETIME_INPUT_FORMATS +#### DATETIME_INPUT_FORMATS  A list of format strings that should be used by default for parsing inputs to `DateTimeField` serializer fields. -Default: `['iso8601']` +Default: `['iso-8601']` -## DATE_FORMAT +#### DATE_FORMAT -A format string that should be used by default for `DateField` serializer fields. +A format string that should be used by default for rendering the output of `DateField` serializer fields. -Default: `'iso8601'` +Default: `'iso-8601'` -## DATE_INPUT_FORMATS +#### DATE_INPUT_FORMATS  A list of format strings that should be used by default for parsing inputs to `DateField` serializer fields. -Default: `['iso8601']` +Default: `['iso-8601']` -## TIME_FORMAT +#### TIME_FORMAT -A format string that should be used by default for `TimeField` serializer fields. +A format string that should be used by default for rendering the output of `TimeField` serializer fields. -Default: `'iso8601'` +Default: `'iso-8601'` -## TIME_INPUT_FORMATS +#### TIME_INPUT_FORMATS  A list of format strings that should be used by default for parsing inputs to `TimeField` serializer fields. -Default: `['iso8601']` +Default: `['iso-8601']` + +--- + +## Miscellaneous settings + +#### FORMAT_SUFFIX_KWARG + +The name of a parameter in the URL conf that may be used to provide a format suffix. + +Default: `'format'`  [cite]: http://www.python.org/dev/peps/pep-0020/ | 
