diff options
| author | Tom Christie | 2012-09-05 10:01:43 +0100 | 
|---|---|---|
| committer | Tom Christie | 2012-09-05 10:01:43 +0100 | 
| commit | 40d1821f2d81f822fff9b85691073ab069edb847 (patch) | |
| tree | ff46d03e0a7def9c218d444718788cbe473ce03b /docs/api-guide | |
| parent | da4fa9bded9bbbbacf2a3009e1e211bdd51e287a (diff) | |
| download | django-rest-framework-40d1821f2d81f822fff9b85691073ab069edb847.tar.bz2 | |
Add missing doc files
Diffstat (limited to 'docs/api-guide')
| -rw-r--r-- | docs/api-guide/authentication.md | 9 | ||||
| -rw-r--r-- | docs/api-guide/permissions.md | 1 | ||||
| -rw-r--r-- | docs/api-guide/reverse.md (renamed from docs/api-guide/urls.md) | 0 | ||||
| -rw-r--r-- | docs/api-guide/settings.md | 31 | ||||
| -rw-r--r-- | docs/api-guide/throttling.md | 1 | 
5 files changed, 42 insertions, 0 deletions
| diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md new file mode 100644 index 00000000..76aaba8a --- /dev/null +++ b/docs/api-guide/authentication.md @@ -0,0 +1,9 @@ +# Authentication + +REST framework provides a number of authentication policies out of the box, and also allows you to implement custom policies. + +## BasicAuthentication + +## TokenBasicAuthentication + +## SessionAuthentication diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/docs/api-guide/permissions.md @@ -0,0 +1 @@ + diff --git a/docs/api-guide/urls.md b/docs/api-guide/reverse.md index c39ff8f6..c39ff8f6 100644 --- a/docs/api-guide/urls.md +++ b/docs/api-guide/reverse.md diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md new file mode 100644 index 00000000..c7bae30d --- /dev/null +++ b/docs/api-guide/settings.md @@ -0,0 +1,31 @@ +# Settings + +Settings for REST framework are all namespaced in the `API_SETTINGS` setting. +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. + +Default: + +    ( +    'djangorestframework.renderers.JSONRenderer', +    'djangorestframework.renderers.DocumentingHTMLRenderer')` + +## DEFAULT_PARSERS + +A list or tuple of parser classes. + +Default: `()` diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/docs/api-guide/throttling.md @@ -0,0 +1 @@ + | 
