.editorconfig

@@ -0,0 +1,7 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.github/FUNDING.yml

@@ -1,2 +0,0 @@
-github: encode
-custom: https://fund.django-rest-framework.org/topics/funding/

.github/dependabot.yml

@@ -1,13 +0,0 @@
-# Keep GitHub Actions up to date with GitHub's Dependabot...
-# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
-# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
-version: 2
-updates:
-  - package-ecosystem: github-actions
-    directory: /
-    groups:
-      github-actions:
-        patterns:
-          - "*"  # Group all Action updates into a single larger pull request
-    schedule:
-      interval: weekly

.github/stale.yml

@@ -1,22 +0,0 @@
-# Documentation: https://github.com/probot/stale
-
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 60
-
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
-
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false
-
-# Limit the number of actions per hour, from 1-30. Default is 30
-limitPerRun: 1
-
-# Label to use when marking as stale
-staleLabel: stale

.github/workflows/main.yml

@@ -1,73 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-    - master
-  pull_request:
-
-jobs:
-  tests:
-    name: Python ${{ matrix.python-version }}
-    runs-on: ubuntu-24.04
-
-    strategy:
-      matrix:
-        python-version:
-        - '3.9'
-        - '3.10'
-        - '3.11'
-        - '3.12'
-        - '3.13'
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-        cache: 'pip'
-        cache-dependency-path: 'requirements/*.txt'
-
-    - name: Upgrade packaging tools
-      run: python -m pip install --upgrade pip setuptools virtualenv wheel
-
-    - name: Install dependencies
-      run: python -m pip install --upgrade tox
-
-    - name: Run tox targets for ${{ matrix.python-version }}
-      run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d . | cut -f 1 -d '-')
-
-    - name: Run extra tox targets
-      if: ${{ matrix.python-version == '3.9' }}
-      run: |
-        tox -e base,dist,docs
-
-    - name: Upload coverage
-      uses: codecov/codecov-action@v5
-      with:
-        env_vars: TOXENV,DJANGO
-
-  test-docs:
-    name: Test documentation links
-    runs-on: ubuntu-24.04
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.9'
-
-    - name: Install dependencies
-      run: pip install -r requirements/requirements-documentation.txt
-    
-    # Start mkdocs server and wait for it to be ready
-    - run: mkdocs serve &
-    - run: WAIT_TIME=0 && until nc -vzw 2 localhost 8000 || [ $WAIT_TIME -eq 5 ]; do sleep $(( WAIT_TIME++ )); done
-    - run: if [ $WAIT_TIME == 5 ]; then echo cannot start mkdocs server on http://localhost:8000; exit 1; fi
-    
-    - name: Check links
-      continue-on-error: true
-      run: pylinkvalidate.py -P http://localhost:8000/
-  
-    - run: echo "Done"

.github/workflows/pre-commit.yml

@@ -1,22 +0,0 @@
-name: pre-commit
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-jobs:
-  pre-commit:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.10"
-
-      - uses: pre-commit/action@v3.0.1

.gitignore

@@ -2,8 +2,6 @@
 *.db
 *~
 .*
-*.py.bak
-
 
 /site/
 /htmlcov/
@@ -15,6 +13,7 @@
 MANIFEST
 coverage.*
 
-!.github
+!.editorconfig
 !.gitignore
-!.pre-commit-config.yaml
+!.travis.yml
+!.isort.cfg

.pre-commit-config.yaml

@@ -1,39 +0,0 @@
-repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
-  hooks:
-  - id: check-added-large-files
-  - id: check-case-conflict
-  - id: check-json
-  - id: check-merge-conflict
-  - id: check-symlinks
-  - id: check-toml
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
-- repo: https://github.com/PyCQA/flake8
-  rev: 7.0.0
-  hooks:
-  - id: flake8
-    additional_dependencies:
-    - flake8-tidy-imports
-- repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.16.0
-  hooks:
-  - id: blacken-docs
-    exclude: ^(?!docs).*$
-    additional_dependencies:
-    - black==23.1.0
-- repo: https://github.com/codespell-project/codespell
-  # Configuration for codespell is in .codespellrc
-  rev: v2.2.6
-  hooks:
-  - id: codespell
-    exclude: locale|kickstarter-announcement.md|coreapi-0.1.1.js
-
-- repo: https://github.com/asottile/pyupgrade
-  rev: v3.19.1
-  hooks:
-  - id: pyupgrade
-    args: ["--py39-plus", "--keep-percent-format"]

.travis.yml

@@ -0,0 +1,57 @@
+language: python
+cache: pip
+
+python:
+    - "2.7"
+    - "3.4"
+    - "3.5"
+
+sudo: false
+
+env:
+    - DJANGO=1.10
+    - DJANGO=1.11
+    - DJANGO=2.0
+    - DJANGO=master
+
+matrix:
+    fast_finish: true
+    include:
+      - { python: "3.6", env: DJANGO=master }
+      - { python: "3.6", env: DJANGO=1.11 }
+      - { python: "3.6", env: DJANGO=2.0 }
+      - { python: "2.7", env: TOXENV=lint }
+      - { python: "2.7", env: TOXENV=docs }
+
+      - python: "3.6"
+        env: TOXENV=dist
+        script:
+          - python setup.py bdist_wheel
+          - tox --installpkg ./dist/djangorestframework-*.whl
+          - tox  # test sdist
+
+      - python: "3.6"
+        env: TOXENV=readme
+        addons:
+          apt_packages: pandoc
+
+    exclude:
+      - { python: "2.7", env: DJANGO=master }
+      - { python: "2.7", env: DJANGO=2.0 }
+      - { python: "3.4", env: DJANGO=master }
+
+    allow_failures:
+      - env: DJANGO=master
+
+install:
+    - pip install tox tox-travis
+
+script:
+    - tox
+
+after_success:
+    - pip install codecov
+    - codecov -e TOXENV,DJANGO
+
+notifications:
+    email: false

CONTRIBUTING.md

@@ -1,5 +1,207 @@
 # Contributing to REST framework
 
-At this point in its lifespan we consider Django REST framework to be essentially feature-complete. We may accept pull requests that track the continued development of Django versions, but would prefer not to accept new features or code formatting changes.
+> The world can only really be changed one piece at a time.  The art is picking that piece.
+>
+> — [Tim Berners-Lee][cite]
 
-The [Contributing guide in the documentation](https://www.django-rest-framework.org/community/contributing/) gives some more information on our process and code of conduct.
+There are many ways you can contribute to Django REST framework.  We'd like it to be a community-led project, so please get involved and help shape the future of the project.
+
+## Community
+
+The most important thing you can do to help push the REST framework project forward is to be actively involved wherever possible.  Code contributions are often overvalued as being the primary way to get involved in a project, we don't believe that needs to be the case.
+
+If you use REST framework, we'd love you to be vocal about your experiences with it - you might consider writing a blog post about using REST framework, or publishing a tutorial about building a project with a particular JavaScript framework.  Experiences from beginners can be particularly helpful because you'll be in the best position to assess which bits of REST framework are more difficult to understand and work with.
+
+Other really great ways you can help move the community forward include helping to answer questions on the [discussion group][google-group], or setting up an [email alert on StackOverflow][so-filter] so that you get notified of any new questions with the `django-rest-framework` tag.
+
+When answering questions make sure to help future contributors find their way around by hyperlinking wherever possible to related threads and tickets, and include backlinks from those items if relevant.
+
+## Code of conduct
+
+Please keep the tone polite & professional.  For some users a discussion on the REST framework mailing list or ticket tracker may be their first engagement with the open source community.  First impressions count, so let's try to make everyone feel welcome.
+
+Be mindful in the language you choose.  As an example, in an environment that is heavily male-dominated, posts that start 'Hey guys,' can come across as unintentionally exclusive.  It's just as easy, and more inclusive to use gender neutral language in those situations.
+
+The [Django code of conduct][code-of-conduct] gives a fuller set of guidelines for participating in community forums.
+
+# Issues
+
+It's really helpful if you can make sure to address issues on the correct channel.  Usage questions should be directed to the [discussion group][google-group].  Feature requests, bug reports and other issues should be raised on the GitHub [issue tracker][issues].
+
+Some tips on good issue reporting:
+
+* When describing issues try to phrase your ticket in terms of the *behavior* you think needs changing rather than the *code* you think need changing.
+* Search the issue list first for related items, and make sure you're running the latest version of REST framework before reporting an issue.
+* If reporting a bug, then try to include a pull request with a failing test case.  This will help us quickly identify if there is a valid issue, and make sure that it gets fixed more quickly if there is one.
+* Feature requests will often be closed with a recommendation that they be implemented outside of the core REST framework library.  Keeping new feature requests implemented as third party libraries allows us to keep down the maintenance overhead of REST framework, so that the focus can be on continued stability, bug fixes, and great documentation.
+* Closing an issue doesn't necessarily mean the end of a discussion.  If you believe your issue has been closed incorrectly, explain why and we'll consider if it needs to be reopened.
+
+## Triaging issues
+
+Getting involved in triaging incoming issues is a good way to start contributing.  Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be.  Anyone can help out with this, you just need to be willing to:
+
+* Read through the ticket - does it make sense, is it missing any context that would help explain it better?
+* Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?
+* If the ticket is a bug report, can you reproduce it? Are you able to write a failing test case that demonstrates the issue and that can be submitted as a pull request?
+* If the ticket is a feature request, do you agree with it, and could the feature request instead be implemented as a third party package?
+* If a ticket hasn't had much activity and it addresses something you need, then comment on the ticket and try to find out what's needed to get it moving again.
+
+# Development
+
+To start developing on Django REST framework, clone the repo:
+
+    git clone git@github.com:encode/django-rest-framework.git
+
+Changes should broadly follow the [PEP 8][pep-8] style conventions, and we recommend you set up your editor to automatically indicate non-conforming styles.
+
+## Testing
+
+To run the tests, clone the repository, and then:
+
+    # Setup the virtual environment
+    virtualenv env
+    source env/bin/activate
+    pip install django
+    pip install -r requirements.txt
+
+    # Run the tests
+    ./runtests.py
+
+### Test options
+
+Run using a more concise output style.
+
+    ./runtests.py -q
+
+Run the tests using a more concise output style, no coverage, no flake8.
+
+    ./runtests.py --fast
+
+Don't run the flake8 code linting.
+
+    ./runtests.py --nolint
+
+Only run the flake8 code linting, don't run the tests.
+
+    ./runtests.py --lintonly
+
+Run the tests for a given test case.
+
+    ./runtests.py MyTestCase
+
+Run the tests for a given test method.
+
+    ./runtests.py MyTestCase.test_this_method
+
+Shorter form to run the tests for a given test method.
+
+    ./runtests.py test_this_method
+
+Note: The test case and test method matching is fuzzy and will sometimes run other tests that contain a partial string match to the given  command line input.
+
+### Running against multiple environments
+
+You can also use the excellent [tox][tox] testing tool to run the tests against all supported versions of Python and Django.  Install `tox` globally, and then simply run:
+
+    tox
+
+## Pull requests
+
+It's a good idea to make pull requests early on.  A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.
+
+It's also always best to make a new branch before starting work on a pull request.  This means that you'll be able to later switch back to working on another separate issue without interfering with an ongoing pull requests.
+
+It's also useful to remember that if you have an outstanding pull request then pushing new commits to your GitHub repo will also automatically update the pull requests.
+
+GitHub's documentation for working on pull requests is [available here][pull-requests].
+
+Always run the tests before submitting pull requests, and ideally run `tox` in order to check that your modifications are compatible with both Python 2 and Python 3, and that they run properly on all supported versions of Django.
+
+Once you've made a pull request take a look at the Travis build status in the GitHub interface and make sure the tests are running as you'd expect.
+
+## Managing compatibility issues
+
+Sometimes, in order to ensure your code works on various different versions of Django, Python or third party libraries, you'll need to run slightly different code depending on the environment.  Any code that branches in this way should be isolated into the `compat.py` module, and should provide a single common interface that the rest of the codebase can use.
+
+# Documentation
+
+The documentation for REST framework is built from the [Markdown][markdown] source files in [the docs directory][docs].
+
+There are many great Markdown editors that make working with the documentation really easy.  The [Mou editor for Mac][mou] is one such editor that comes highly recommended.
+
+## Building the documentation
+
+To build the documentation, install MkDocs with `pip install mkdocs` and then run the following command.
+
+    mkdocs build
+
+This will build the documentation into the `site` directory.
+
+You can build the documentation and open a preview in a browser window by using the `serve` command.
+
+    mkdocs serve
+
+## Language style
+
+Documentation should be in American English.  The tone of the documentation is very important - try to stick to a simple, plain, objective and well-balanced style where possible.
+
+Some other tips:
+
+* Keep paragraphs reasonably short.
+* Don't use abbreviations such as 'e.g.' but instead use the long form, such as 'For example'.
+
+## Markdown style
+
+There are a couple of conventions you should follow when working on the documentation.
+
+##### 1. Headers
+
+Headers should use the hash style.  For example:
+
+    ### Some important topic
+
+The underline style should not be used.  **Don't do this:**
+
+    Some important topic
+    ====================
+
+##### 2. Links
+
+Links should always use the reference style, with the referenced hyperlinks kept at the end of the document.
+
+    Here is a link to [some other thing][other-thing].
+
+    More text...
+
+    [other-thing]: http://example.com/other/thing
+
+This style helps keep the documentation source consistent and readable.
+
+If you are hyperlinking to another REST framework document, you should use a relative link, and link to the `.md` suffix.  For example:
+
+    [authentication]: ../api-guide/authentication.md
+
+Linking in this style means you'll be able to click the hyperlink in your Markdown editor to open the referenced document.  When the documentation is built, these links will be converted into regular links to HTML pages.
+
+##### 3. Notes
+
+If you want to draw attention to a note or warning, use a pair of enclosing lines, like so:
+
+    ---
+
+    **Note:** A useful documentation note.
+
+    ---
+
+
+[cite]: https://www.w3.org/People/Berners-Lee/FAQ.html
+[code-of-conduct]: https://www.djangoproject.com/conduct/
+[google-group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
+[so-filter]: https://stackexchange.com/filters/66475/rest-framework
+[issues]: https://github.com/encode/django-rest-framework/issues?state=open
+[pep-8]: https://www.python.org/dev/peps/pep-0008/
+[pull-requests]: https://help.github.com/articles/using-pull-requests
+[tox]: https://tox.readthedocs.io/en/latest/
+[markdown]: https://daringfireball.net/projects/markdown/basics
+[docs]: https://github.com/encode/django-rest-framework/tree/master/docs
+[mou]: http://mouapp.com/

ISSUE_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Checklist
+
+- [ ] I have verified that that issue exists against the `master` branch of Django REST framework.
+- [ ] I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
+- [ ] This is not a usage question. (Those should be directed to the [discussion group](https://groups.google.com/forum/#!forum/django-rest-framework) instead.)
+- [ ] This cannot be dealt with as a third party library. (We prefer new functionality to be [in the form of third party libraries](http://www.django-rest-framework.org/topics/third-party-resources/#about-third-party-packages) where possible.)
+- [ ] I have reduced the issue to the simplest possible case.
+- [ ] I have included a failing test as a pull request. (If you are unable to do so we can still accept the issue.)
+
+## Steps to reproduce
+
+## Expected behavior
+
+## Actual behavior

LICENSE.md

@@ -1,21 +1,16 @@
 # License
 
-Copyright © 2011-present, [Encode OSS Ltd](https://www.encode.io/).
+Copyright (c) 2011-2017, Tom Christie
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

MANIFEST.in

@@ -1,7 +1,6 @@
 include README.md
 include LICENSE.md
-recursive-include tests/ *
-recursive-include rest_framework/static *.js *.css *.map *.png *.ico *.eot *.svg *.ttf *.woff *.woff2
+recursive-include rest_framework/static *.js *.css *.png *.ico *.eot *.svg *.ttf *.woff *.woff2
 recursive-include rest_framework/templates *.html schema.js
 recursive-include rest_framework/locale *.mo
 global-exclude __pycache__

PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-*Note*: Before submitting a code change, please review our [contributing guidelines](https://www.django-rest-framework.org/community/contributing/#pull-requests).
+*Note*: Before submitting this pull request, please review our [contributing guidelines](https://github.com/encode/django-rest-framework/blob/master/CONTRIBUTING.md#pull-requests).
 
 ## Description
 

README.md

@@ -1,12 +1,12 @@
 # [Django REST framework][docs]
 
-[![build-status-image]][build-status]
+[![build-status-image]][travis]
 [![coverage-status-image]][codecov]
 [![pypi-version]][pypi]
 
 **Awesome web-browsable Web APIs.**
 
-Full documentation for the project is available at [https://www.django-rest-framework.org/][docs].
+Full documentation for the project is available at [http://www.django-rest-framework.org][docs].
 
 ---
 
@@ -19,18 +19,13 @@ continued development by [signing up for a paid plan][funding].
 The initial aim is to provide a single full-time position on REST framework.
 *Every single sign-up makes a significant impact towards making that possible.*
 
+[![][rover-img]][rover-url]
 [![][sentry-img]][sentry-url]
 [![][stream-img]][stream-url]
-[![][spacinov-img]][spacinov-url]
-[![][retool-img]][retool-url]
-[![][bitio-img]][bitio-url]
-[![][posthog-img]][posthog-url]
-[![][cryptapi-img]][cryptapi-url]
-[![][fezto-img]][fezto-url]
-[![][svix-img]][svix-url]
-[![][zuplo-img]][zuplo-url]
+[![][machinalis-img]][machinalis-url]
+[![][rollbar-img]][rollbar-url]
 
-Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry][sentry-url], [Stream][stream-url], [Spacinov][spacinov-url], [Retool][retool-url], [bit.io][bitio-url], [PostHog][posthog-url], [CryptAPI][cryptapi-url], [FEZTO][fezto-url], [Svix][svix-url], and [Zuplo][zuplo-url].
+Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Rover][rover-url], [Sentry][sentry-url], [Stream][stream-url], [Machinalis][machinalis-url], and [Rollbar][rollbar-url].
 
 ---
 
@@ -40,12 +35,14 @@ Django REST framework is a powerful and flexible toolkit for building Web APIs.
 
 Some reasons you might want to use REST framework:
 
-* The Web browsable API is a huge usability win for your developers.
+* The [Web browsable API][sandbox] is a huge usability win for your developers.
 * [Authentication policies][authentication] including optional packages for [OAuth1a][oauth1-section] and [OAuth2][oauth2-section].
 * [Serialization][serializers] that supports both [ORM][modelserializer-section] and [non-ORM][serializer-section] data sources.
 * Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views] [powerful][viewsets] [features][routers].
 * [Extensive documentation][docs], and [great community support][group].
 
+There is a live example API for testing purposes, [available here][sandbox].
+
 **Below**: *Screenshot from the browsable API*
 
 ![Screenshot][image]
@@ -54,11 +51,8 @@ Some reasons you might want to use REST framework:
 
 # Requirements
 
-* Python 3.9+
-* Django 4.2, 5.0, 5.1, 5.2
-
-We **highly recommend** and only officially support the latest patch release of
-each Python and Django series.
+* Python (2.7, 3.4, 3.5, 3.6)
+* Django (1.10, 1.11, 2.0)
 
 # Installation
 
@@ -67,12 +61,11 @@ Install using `pip`...
     pip install djangorestframework
 
 Add `'rest_framework'` to your `INSTALLED_APPS` setting.
-```python
-INSTALLED_APPS = [
-    ...
-    'rest_framework',
-]
-```
+
+    INSTALLED_APPS = (
+        ...
+        'rest_framework',
+    )
 
 # Example
 
@@ -82,7 +75,7 @@ Startup up a new project like so...
 
     pip install django
     pip install djangorestframework
-    django-admin startproject example .
+    django-admin.py startproject example .
     ./manage.py migrate
     ./manage.py createsuperuser
 
@@ -90,16 +83,15 @@ Startup up a new project like so...
 Now edit the `example/urls.py` module in your project:
 
 ```python
+from django.conf.urls import url, include
 from django.contrib.auth.models import User
-from django.urls import include, path
-from rest_framework import routers, serializers, viewsets
-
+from rest_framework import serializers, viewsets, routers
 
 # Serializers define the API representation.
 class UserSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = User
-        fields = ['url', 'username', 'email', 'is_staff']
+        fields = ('url', 'username', 'email', 'is_staff')
 
 
 # ViewSets define the view behavior.
@@ -112,11 +104,12 @@ class UserViewSet(viewsets.ModelViewSet):
 router = routers.DefaultRouter()
 router.register(r'users', UserViewSet)
 
+
 # Wire up our API using automatic URL routing.
 # Additionally, we include login URLs for the browsable API.
 urlpatterns = [
-    path('', include(router.urls)),
-    path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    url(r'^', include(router.urls)),
+    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
 ]
 ```
 
@@ -125,16 +118,16 @@ We'd also like to configure a couple of settings for our API.
 Add the following to your `settings.py` module:
 
 ```python
-INSTALLED_APPS = [
+INSTALLED_APPS = (
     ...  # Make sure to include the default installed apps here.
     'rest_framework',
-]
+)
 
 REST_FRAMEWORK = {
     # Use Django's standard `django.contrib.auth` permissions,
     # or allow read-only access for unauthenticated users.
     'DEFAULT_PERMISSION_CLASSES': [
-        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
+        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
     ]
 }
 ```
@@ -148,14 +141,14 @@ You can now open the API in your browser at `http://127.0.0.1:8000/`, and view y
 You can also interact with the API using command line tools such as [`curl`](https://curl.haxx.se/). For example, to list the users endpoint:
 
     $ curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
-    [
-        {
-            "url": "http://127.0.0.1:8000/users/1/",
-            "username": "admin",
-            "email": "admin@example.com",
-            "is_staff": true,
-        }
-    ]
+	[
+	    {
+	        "url": "http://127.0.0.1:8000/users/1/",
+	        "username": "admin",
+	        "email": "admin@example.com",
+	        "is_staff": true,
+	    }
+	]
 
 Or to create a new user:
 
@@ -169,58 +162,54 @@ Or to create a new user:
 
 # Documentation & Support
 
-Full documentation for the project is available at [https://www.django-rest-framework.org/][docs].
+Full documentation for the project is available at [http://www.django-rest-framework.org][docs].
 
-For questions and support, use the [REST framework discussion group][group], or `#restframework` on libera.chat IRC.
+For questions and support, use the [REST framework discussion group][group], or `#restframework` on freenode IRC.
+
+You may also want to [follow the author on Twitter][twitter].
 
 # Security
 
-Please see the [security policy][security-policy].
+If you believe you've found something in Django REST framework which has security implications, please **do not raise the issue in a public forum**.
 
-[build-status-image]: https://github.com/encode/django-rest-framework/actions/workflows/main.yml/badge.svg
-[build-status]: https://github.com/encode/django-rest-framework/actions/workflows/main.yml
+Send a description of the issue via email to [rest-framework-security@googlegroups.com][security-mail].  The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.
+
+[build-status-image]: https://secure.travis-ci.org/encode/django-rest-framework.svg?branch=master
+[travis]: https://travis-ci.org/encode/django-rest-framework?branch=master
 [coverage-status-image]: https://img.shields.io/codecov/c/github/encode/django-rest-framework/master.svg
 [codecov]: https://codecov.io/github/encode/django-rest-framework?branch=master
 [pypi-version]: https://img.shields.io/pypi/v/djangorestframework.svg
-[pypi]: https://pypi.org/project/djangorestframework/
+[pypi]: https://pypi.python.org/pypi/djangorestframework
+[twitter]: https://twitter.com/_tomchristie
 [group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
+[sandbox]: https://restframework.herokuapp.com/
 
 [funding]: https://fund.django-rest-framework.org/topics/funding/
 [sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
 
+[rover-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/rover-readme.png
 [sentry-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/sentry-readme.png
 [stream-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/stream-readme.png
-[spacinov-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/spacinov-readme.png
-[retool-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/retool-readme.png
-[bitio-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/bitio-readme.png
-[posthog-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/posthog-readme.png
-[cryptapi-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/cryptapi-readme.png
-[fezto-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/fezto-readme.png
-[svix-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/svix-premium.png
-[zuplo-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/zuplo-readme.png
+[machinalis-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/machinalis-readme.png
+[rollbar-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/rollbar-readme.png
 
+[rover-url]: http://jobs.rover.com/
 [sentry-url]: https://getsentry.com/welcome/
-[stream-url]: https://getstream.io/?utm_source=DjangoRESTFramework&utm_medium=Webpage_Logo_Ad&utm_content=Developer&utm_campaign=DjangoRESTFramework_Jan2022_HomePage
-[spacinov-url]: https://www.spacinov.com/
-[retool-url]: https://retool.com/?utm_source=djangorest&utm_medium=sponsorship
-[bitio-url]: https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship
-[posthog-url]: https://posthog.com?utm_source=drf&utm_medium=sponsorship&utm_campaign=open-source-sponsorship
-[cryptapi-url]: https://cryptapi.io
-[fezto-url]: https://www.fezto.xyz/?utm_source=DjangoRESTFramework
-[svix-url]: https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship
-[zuplo-url]: https://zuplo.link/django-gh
+[stream-url]: https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf
+[machinalis-url]: https://hello.machinalis.co.uk/
+[rollbar-url]: https://rollbar.com/
 
-[oauth1-section]: https://www.django-rest-framework.org/api-guide/authentication/#django-rest-framework-oauth
-[oauth2-section]: https://www.django-rest-framework.org/api-guide/authentication/#django-oauth-toolkit
-[serializer-section]: https://www.django-rest-framework.org/api-guide/serializers/#serializers
-[modelserializer-section]: https://www.django-rest-framework.org/api-guide/serializers/#modelserializer
-[functionview-section]: https://www.django-rest-framework.org/api-guide/views/#function-based-views
-[generic-views]: https://www.django-rest-framework.org/api-guide/generic-views/
-[viewsets]: https://www.django-rest-framework.org/api-guide/viewsets/
-[routers]: https://www.django-rest-framework.org/api-guide/routers/
-[serializers]: https://www.django-rest-framework.org/api-guide/serializers/
-[authentication]: https://www.django-rest-framework.org/api-guide/authentication/
-[image]: https://www.django-rest-framework.org/img/quickstart.png
+[oauth1-section]: http://www.django-rest-framework.org/api-guide/authentication/#django-rest-framework-oauth
+[oauth2-section]: http://www.django-rest-framework.org/api-guide/authentication/#django-oauth-toolkit
+[serializer-section]: http://www.django-rest-framework.org/api-guide/serializers/#serializers
+[modelserializer-section]: http://www.django-rest-framework.org/api-guide/serializers/#modelserializer
+[functionview-section]: http://www.django-rest-framework.org/api-guide/views/#function-based-views
+[generic-views]: http://www.django-rest-framework.org/api-guide/generic-views/
+[viewsets]: http://www.django-rest-framework.org/api-guide/viewsets/
+[routers]: http://www.django-rest-framework.org/api-guide/routers/
+[serializers]: http://www.django-rest-framework.org/api-guide/serializers/
+[authentication]: http://www.django-rest-framework.org/api-guide/authentication/
+[image]: http://www.django-rest-framework.org/img/quickstart.png
 
-[docs]: https://www.django-rest-framework.org/
-[security-policy]: https://github.com/encode/django-rest-framework/security/policy
+[docs]: http://www.django-rest-framework.org/
+[security-mail]: mailto:rest-framework-security@googlegroups.com

SECURITY.md

@@ -1,7 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-**Please report security issues by emailing security@encode.io**.
-
-The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.

codecov.yml

@@ -1,11 +1,7 @@
 coverage:
-  precision: 2
-  round: down
-  range: "80...100"
-
   status:
-    project: yes
-    patch: no
-    changes: no
+    project: false
+    patch: false
+    changes: false
 
 comment: off

docs/api-guide/authentication.md

@@ -1,7 +1,4 @@
----
-source:
-    - authentication.py
----
+source: authentication.py
 
 # Authentication
 
@@ -11,9 +8,9 @@ source:
 
 Authentication is the mechanism of associating an incoming request with a set of identifying credentials, such as the user the request came from, or the token that it was signed with.  The [permission] and [throttling] policies can then use those credentials to determine if the request should be permitted.
 
-REST framework provides several authentication schemes out of the box, and also allows you to implement custom schemes.
+REST framework provides a number of authentication schemes out of the box, and also allows you to implement custom schemes.
 
-Authentication always runs at the very start of the view, before the permission and throttling checks occur, and before any other code is allowed to proceed.
+Authentication is always run at the very start of the view, before the permission and throttling checks occur, and before any other code is allowed to proceed.
 
 The `request.user` property will typically be set to an instance of the `contrib.auth` package's `User` class.
 
@@ -23,7 +20,7 @@ The `request.auth` property is used for any additional authentication informatio
 
 **Note:** Don't forget that **authentication by itself won't allow or disallow an incoming request**, it simply identifies the credentials that the request was made with.
 
-For information on how to set up the permission policies for your API please see the [permissions documentation][permission].
+For information on how to setup the permission polices for your API please see the [permissions documentation][permission].
 
 ---
 
@@ -40,10 +37,10 @@ The value of `request.user` and `request.auth` for unauthenticated requests can
 The default authentication schemes may be set globally, using the `DEFAULT_AUTHENTICATION_CLASSES` setting.  For example.
 
     REST_FRAMEWORK = {
-        'DEFAULT_AUTHENTICATION_CLASSES': [
+        'DEFAULT_AUTHENTICATION_CLASSES': (
             'rest_framework.authentication.BasicAuthentication',
             'rest_framework.authentication.SessionAuthentication',
-        ]
+        )
     }
 
 You can also set the authentication scheme on a per-view or per-viewset basis,
@@ -55,25 +52,25 @@ using the `APIView` class-based views.
     from rest_framework.views import APIView
 
     class ExampleView(APIView):
-        authentication_classes = [SessionAuthentication, BasicAuthentication]
-        permission_classes = [IsAuthenticated]
+        authentication_classes = (SessionAuthentication, BasicAuthentication)
+        permission_classes = (IsAuthenticated,)
 
         def get(self, request, format=None):
             content = {
-                'user': str(request.user),  # `django.contrib.auth.User` instance.
-                'auth': str(request.auth),  # None
+                'user': unicode(request.user),  # `django.contrib.auth.User` instance.
+                'auth': unicode(request.auth),  # None
             }
             return Response(content)
 
 Or, if you're using the `@api_view` decorator with function based views.
 
     @api_view(['GET'])
-    @authentication_classes([SessionAuthentication, BasicAuthentication])
-    @permission_classes([IsAuthenticated])
+    @authentication_classes((SessionAuthentication, BasicAuthentication))
+    @permission_classes((IsAuthenticated,))
     def example_view(request, format=None):
         content = {
-            'user': str(request.user),  # `django.contrib.auth.User` instance.
-            'auth': str(request.auth),  # None
+            'user': unicode(request.user),  # `django.contrib.auth.User` instance.
+            'auth': unicode(request.auth),  # None
         }
         return Response(content)
 
@@ -90,12 +87,6 @@ The kind of response that will be used depends on the authentication scheme.  Al
 
 Note that when a request may successfully authenticate, but still be denied permission to perform the request, in which case a `403 Permission Denied` response will always be used, regardless of the authentication scheme.
 
-## Django 5.1+ `LoginRequiredMiddleware`
-
-If you're running Django 5.1+ and use the [`LoginRequiredMiddleware`][login-required-middleware], please note that all views from DRF are opted-out of this middleware.  This is because the authentication in DRF is based authentication and permissions classes, which may be determined after the middleware has been applied.  Additionally, when the request is not authenticated, the middleware redirects the user to the login page, which is not suitable for API requests, where it's preferable to return a 401 status code.
-
-REST framework offers an equivalent mechanism for DRF views via the global settings, `DEFAULT_AUTHENTICATION_CLASSES` and `DEFAULT_PERMISSION_CLASSES`.  They should be changed accordingly if you need to enforce that API requests are logged in.
-
 ## Apache mod_wsgi specific configuration
 
 Note that if deploying to [Apache using mod_wsgi][mod_wsgi_official], the authorization header is not passed through to a WSGI application by default, as it is assumed that authentication will be handled by Apache, rather than at an application level.
@@ -126,39 +117,33 @@ Unauthenticated responses that are denied permission will result in an `HTTP 401
 
 ## TokenAuthentication
 
----
-
-**Note:** The token authentication provided by Django REST framework is a fairly simple implementation.
-
-For an implementation which allows more than one token per user, has some tighter security implementation details, and supports token expiry, please see the [Django REST Knox][django-rest-knox] third party package.
-
----
-
 This authentication scheme uses a simple token-based HTTP Authentication scheme.  Token authentication is appropriate for client-server setups, such as native desktop and mobile clients.
 
 To use the `TokenAuthentication` scheme you'll need to [configure the authentication classes](#setting-the-authentication-scheme) to include `TokenAuthentication`, and additionally include `rest_framework.authtoken` in your `INSTALLED_APPS` setting:
 
-    INSTALLED_APPS = [
+    INSTALLED_APPS = (
         ...
         'rest_framework.authtoken'
-    ]
+    )
 
-Make sure to run `manage.py migrate` after changing your settings.
+---
 
-The `rest_framework.authtoken` app provides Django database migrations.
+**Note:** Make sure to run `manage.py migrate` after changing your settings. The `rest_framework.authtoken` app provides Django database migrations.
+
+---
 
 You'll also need to create tokens for your users.
 
     from rest_framework.authtoken.models import Token
 
     token = Token.objects.create(user=...)
-    print(token.key)
+    print token.key
 
 For clients to authenticate, the token key should be included in the `Authorization` HTTP header.  The key should be prefixed by the string literal "Token", with whitespace separating the two strings.  For example:
 
     Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b
 
-*If you want to use a different keyword in the header, such as `Bearer`, simply subclass `TokenAuthentication` and set the `keyword` class variable.*
+**Note:** If you want to use a different keyword in the header, such as `Bearer`, simply subclass `TokenAuthentication` and set the `keyword` class variable.
 
 If successfully authenticated, `TokenAuthentication` provides the following credentials.
 
@@ -179,9 +164,9 @@ The `curl` command line tool may be useful for testing token authenticated APIs.
 
 ---
 
-### Generating Tokens
+#### Generating Tokens
 
-#### By using signals
+##### By using signals
 
 If you want every user to have an automatically generated Token, you can simply catch the User's `post_save` signal.
 
@@ -205,13 +190,13 @@ If you've already created some users, you can generate tokens for all existing u
     for user in User.objects.all():
         Token.objects.get_or_create(user=user)
 
-#### By exposing an api endpoint
+##### By exposing an api endpoint
 
 When using `TokenAuthentication`, you may want to provide a mechanism for clients to obtain a token given the username and password.  REST framework provides a built-in view to provide this behavior.  To use it, add the `obtain_auth_token` view to your URLconf:
 
     from rest_framework.authtoken import views
     urlpatterns += [
-        path('api-token-auth/', views.obtain_auth_token)
+        url(r'^api-token-auth/', views.obtain_auth_token)
     ]
 
 Note that the URL part of the pattern can be whatever you want to use.
@@ -222,7 +207,7 @@ The `obtain_auth_token` view will return a JSON response when valid `username` a
 
 Note that the default `obtain_auth_token` view explicitly uses JSON requests and responses, rather than using default renderer and parser classes in your settings.
 
-By default, there are no permissions or throttling applied to the `obtain_auth_token` view. If you do wish to apply throttling you'll need to override the view class,
+By default there are no permissions or throttling applied to the  `obtain_auth_token` view. If you do wish to apply throttling you'll need to override the view class,
 and include them using the `throttle_classes` attribute.
 
 If you need a customized version of the `obtain_auth_token` view, you can do so by subclassing the `ObtainAuthToken` view class, and using that in your url conf instead.
@@ -250,19 +235,19 @@ For example, you may return additional user information beyond the `token` value
 And in your `urls.py`:
 
     urlpatterns += [
-        path('api-token-auth/', CustomAuthToken.as_view())
+        url(r'^api-token-auth/', CustomAuthToken.as_view())
     ]
 
 
-#### With Django admin
+##### With Django admin
 
-It is also possible to create Tokens manually through the admin interface. In case you are using a large user base, we recommend that you monkey patch the `TokenAdmin` class to customize it to your needs, more specifically by declaring the `user` field as `raw_field`.
+It is also possible to create Tokens manually through admin interface. In case you are using a large user base, we recommend that you monkey patch the `TokenAdmin` class to customize it to your needs, more specifically by declaring the `user` field as `raw_field`.
 
 `your_app/admin.py`:
 
     from rest_framework.authtoken.admin import TokenAdmin
 
-    TokenAdmin.raw_id_fields = ['user']
+    TokenAdmin.raw_id_fields = ('user',)
 
 
 #### Using Django manage.py command
@@ -291,11 +276,11 @@ If successfully authenticated, `SessionAuthentication` provides the following cr
 
 Unauthenticated responses that are denied permission will result in an `HTTP 403 Forbidden` response.
 
-If you're using an AJAX-style API with SessionAuthentication, you'll need to make sure you include a valid CSRF token for any "unsafe" HTTP method calls, such as `PUT`, `PATCH`, `POST` or `DELETE` requests.  See the [Django CSRF documentation][csrf-ajax] for more details.
+If you're using an AJAX style API with SessionAuthentication, you'll need to make sure you include a valid CSRF token for any "unsafe" HTTP method calls, such as `PUT`, `PATCH`, `POST` or `DELETE` requests.  See the [Django CSRF documentation][csrf-ajax] for more details.
 
 **Warning**: Always use Django's standard login view when creating login pages. This will ensure your login views are properly protected.
 
-CSRF validation in REST framework works slightly differently from standard Django due to the need to support both session and non-session based authentication to the same views. This means that only authenticated requests require CSRF tokens, and anonymous requests may be sent without CSRF tokens. This behavior is not suitable for login views, which should always have CSRF validation applied.
+CSRF validation in REST framework works slightly differently to standard Django due to the need to support both session and non-session based authentication to the same views. This means that only authenticated requests require CSRF tokens, and anonymous requests may be sent without CSRF tokens. This behaviour is not suitable for login views, which should always have CSRF validation applied.
 
 
 ## RemoteUserAuthentication
@@ -305,7 +290,7 @@ environment variable.
 
 To use it, you must have `django.contrib.auth.backends.RemoteUserBackend` (or a subclass) in your
 `AUTHENTICATION_BACKENDS` setting. By default, `RemoteUserBackend` creates `User` objects for usernames that don't
-already exist. To change this and other behavior, consult the
+already exist. To change this and other behaviour, consult the
 [Django documentation](https://docs.djangoproject.com/en/stable/howto/auth-remote-user/).
 
 If successfully authenticated, `RemoteUserAuthentication` provides the following credentials:
@@ -313,10 +298,10 @@ If successfully authenticated, `RemoteUserAuthentication` provides the following
 * `request.user` will be a Django `User` instance.
 * `request.auth` will be `None`.
 
-Consult your web server's documentation for information about configuring an authentication method, for example:
+Consult your web server's documentation for information about configuring an authentication method, e.g.:
 
 * [Apache Authentication How-To](https://httpd.apache.org/docs/2.4/howto/auth.html)
-* [NGINX (Restricting Access)](https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-http-basic-authentication/)
+* [NGINX (Restricting Access)](https://www.nginx.com/resources/admin-guide/#restricting_access)
 
 
 # Custom authentication
@@ -328,7 +313,7 @@ In some circumstances instead of returning `None`, you may want to raise an `Aut
 Typically the approach you should take is:
 
 * If authentication is not attempted, return `None`.  Any other authentication schemes also in use will still be checked.
-* If authentication is attempted but fails, raise an `AuthenticationFailed` exception.  An error response will be returned immediately, regardless of any permissions checks, and without checking any other authentication schemes.
+* If authentication is attempted but fails, raise a `AuthenticationFailed` exception.  An error response will be returned immediately, regardless of any permissions checks, and without checking any other authentication schemes.
 
 You *may* also override the `.authenticate_header(self, request)` method.  If implemented, it should return a string that will be used as the value of the `WWW-Authenticate` header in a `HTTP 401 Unauthorized` response.
 
@@ -336,21 +321,21 @@ If the `.authenticate_header()` method is not overridden, the authentication sch
 
 ---
 
-**Note:** When your custom authenticator is invoked by the request object's `.user` or `.auth` properties, you may see an `AttributeError` re-raised as a `WrappedAttributeError`. This is necessary to prevent the original exception from being suppressed by the outer property access. Python will not recognize that the `AttributeError` originates from your custom authenticator and will instead assume that the request object does not have a `.user` or `.auth` property. These errors should be fixed or otherwise handled by your authenticator.
+**Note:** When your custom authenticator is invoked by the request object's `.user` or `.auth` properties, you may see an `AttributeError` re-raised as a `WrappedAttributeError`. This is necessary to prevent the original exception from being suppressed by the outer property access. Python will not recognize that the `AttributeError` orginates from your custom authenticator and will instead assume that the request object does not have a `.user` or `.auth` property. These errors should be fixed or otherwise handled by your authenticator.
 
 ---
 
 ## Example
 
-The following example will authenticate any incoming request as the user given by the username in a custom request header named 'X-USERNAME'.
+The following example will authenticate any incoming request as the user given by the username in a custom request header named 'X_USERNAME'.
 
-    from django.contrib.auth.models import User
+	from django.contrib.auth.models import User
     from rest_framework import authentication
     from rest_framework import exceptions
 
     class ExampleAuthentication(authentication.BaseAuthentication):
         def authenticate(self, request):
-            username = request.META.get('HTTP_X_USERNAME')
+            username = request.META.get('X_USERNAME')
             if not username:
                 return None
 
@@ -365,17 +350,13 @@ The following example will authenticate any incoming request as the user given b
 
 # Third party packages
 
-The following third-party packages are also available.
-
-## django-rest-knox
-
-[Django-rest-knox][django-rest-knox] library provides models and views to handle token-based authentication in a more secure and extensible way than the built-in TokenAuthentication scheme - with Single Page Applications and Mobile clients in mind. It provides per-client tokens, and views to generate them when provided some other authentication (usually basic authentication), to delete the token (providing a server enforced logout) and to delete all tokens (logs out all clients that a user is logged into).
+The following third party packages are also available.
 
 ## Django OAuth Toolkit
 
-The [Django OAuth Toolkit][django-oauth-toolkit] package provides OAuth 2.0 support and works with Python 3.4+. The package is maintained by [jazzband][jazzband] and uses the excellent [OAuthLib][oauthlib].  The package is well documented, and well supported and is currently our **recommended package for OAuth 2.0 support**.
+The [Django OAuth Toolkit][django-oauth-toolkit] package provides OAuth 2.0 support, and works with Python 2.7 and Python 3.3+. The package is maintained by [Evonove][evonove] and uses the excellent [OAuthLib][oauthlib].  The package is well documented, and well supported and is currently our **recommended package for OAuth 2.0 support**.
 
-### Installation & configuration
+#### Installation & configuration
 
 Install using `pip`.
 
@@ -383,15 +364,15 @@ Install using `pip`.
 
 Add the package to your `INSTALLED_APPS` and modify your REST framework settings.
 
-    INSTALLED_APPS = [
+    INSTALLED_APPS = (
         ...
         'oauth2_provider',
-    ]
+    )
 
     REST_FRAMEWORK = {
-        'DEFAULT_AUTHENTICATION_CLASSES': [
+        'DEFAULT_AUTHENTICATION_CLASSES': (
             'oauth2_provider.contrib.rest_framework.OAuth2Authentication',
-        ]
+        )
     }
 
 For more details see the [Django REST framework - Getting started][django-oauth-toolkit-getting-started] documentation.
@@ -400,9 +381,9 @@ For more details see the [Django REST framework - Getting started][django-oauth-
 
 The [Django REST framework OAuth][django-rest-framework-oauth] package provides both OAuth1 and OAuth2 support for REST framework.
 
-This package was previously included directly in the REST framework but is now supported and maintained as a third-party package.
+This package was previously included directly in REST framework but is now supported and maintained as a third party package.
 
-### Installation & configuration
+#### Installation & configuration
 
 Install the package using `pip`.
 
@@ -410,9 +391,17 @@ Install the package using `pip`.
 
 For details on configuration and usage see the Django REST framework OAuth documentation for [authentication][django-rest-framework-oauth-authentication] and [permissions][django-rest-framework-oauth-permissions].
 
+## Digest Authentication
+
+HTTP digest authentication is a widely implemented scheme that was intended to replace HTTP basic authentication, and which provides a simple encrypted authentication mechanism. [Juan Riaza][juanriaza] maintains the [djangorestframework-digestauth][djangorestframework-digestauth] package which provides HTTP digest authentication support for REST framework.
+
+## Django OAuth2 Consumer
+
+The [Django OAuth2 Consumer][doac] library from [Rediker Software][rediker] is another package that provides [OAuth 2.0 support for REST framework][doac-rest-framework].  The package includes token scoping permissions on tokens, which allows finer-grained access to your API.
+
 ## JSON Web Token Authentication
 
-JSON Web Token is a fairly new standard which can be used for token-based authentication. Unlike the built-in TokenAuthentication scheme, JWT Authentication doesn't need to use a database to validate a token. A package for JWT authentication is [djangorestframework-simplejwt][djangorestframework-simplejwt] which provides some features as well as a pluggable token blacklist app.
+JSON Web Token is a fairly new standard which can be used for token-based authentication. Unlike the built-in TokenAuthentication scheme, JWT Authentication doesn't need to use a database to validate a token. [Blimp][blimp] maintains the [djangorestframework-jwt][djangorestframework-jwt] package which provides a JWT Authentication class as well as a mechanism for clients to obtain a JWT given the username and password. An alternative package for JWT authentication is [djangorestframework-simplejwt][djangorestframework-simplejwt] which provides different features as well as a pluggable token blacklist app.
 
 ## Hawk HTTP Authentication
 
@@ -420,45 +409,27 @@ The [HawkREST][hawkrest] library builds on the [Mohawk][mohawk] library to let y
 
 ## HTTP Signature Authentication
 
-HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a way to achieve origin authentication and message integrity for HTTP messages. Similar to [Amazon's HTTP Signature scheme][amazon-http-signature], used by many of its services, it permits stateless, per-request authentication. [Elvio Toccalino][etoccalino] maintains the [djangorestframework-httpsignature][djangorestframework-httpsignature] (outdated) package which provides an easy-to-use HTTP Signature Authentication mechanism. You can use the updated fork version of [djangorestframework-httpsignature][djangorestframework-httpsignature], which is [drf-httpsig][drf-httpsig].
+HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a way to achieve origin authentication and message integrity for HTTP messages. Similar to [Amazon's HTTP Signature scheme][amazon-http-signature], used by many of its services, it permits stateless, per-request authentication. [Elvio Toccalino][etoccalino] maintains the [djangorestframework-httpsignature][djangorestframework-httpsignature] package which provides an easy to use HTTP Signature Authentication mechanism.
 
 ## Djoser
 
-[Djoser][djoser] library provides a set of views to handle basic actions such as registration, login, logout, password reset and account activation. The package works with a custom user model and uses token-based authentication. This is a ready to use REST implementation of the Django authentication system.
+[Djoser][djoser] library provides a set of views to handle basic actions such as registration, login, logout, password reset and account activation. The package works with a custom user model and it uses token based authentication. This is a ready to use REST implementation of Django authentication system.
 
-## django-rest-auth / dj-rest-auth
+## django-rest-auth
 
-This library provides a set of REST API endpoints for registration, authentication (including social media authentication), password reset, retrieve and update user details, etc. By having these API endpoints, your client apps such as AngularJS, iOS, Android, and others can communicate to your Django backend site independently via REST APIs for user management.
+[Django-rest-auth][django-rest-auth] library provides a set of REST API endpoints for registration, authentication (including social media authentication), password reset, retrieve and update user details, etc. By having these API endpoints, your client apps such as AngularJS, iOS, Android, and others can communicate to your Django backend site independently via REST APIs for user management.
 
+## django-rest-framework-social-oauth2
 
-There are currently two forks of this project.
+[Django-rest-framework-social-oauth2][django-rest-framework-social-oauth2] library provides an easy way to integrate social plugins (facebook, twitter, google, etc.) to your authentication system and an easy oauth2 setup. With this library, you will be able to authenticate users based on external tokens (e.g. facebook access token), convert these tokens to "in-house" oauth2 tokens and use and generate oauth2 tokens to authenticate your users.
 
-* [Django-rest-auth][django-rest-auth] is the original project, [but is not currently receiving updates](https://github.com/Tivix/django-rest-auth/issues/568).
-* [Dj-rest-auth][dj-rest-auth] is a newer fork of the project.
+## django-rest-knox
 
-## drf-social-oauth2
-
-[Drf-social-oauth2][drf-social-oauth2] is a framework that helps you authenticate with major social oauth2 vendors, such as Facebook, Google, Twitter, Orcid, etc. It generates tokens in a JWTed way with an easy setup.
+[Django-rest-knox][django-rest-knox] library provides models and views to handle token based authentication in a more secure and extensible way than the built-in TokenAuthentication scheme - with Single Page Applications and Mobile clients in mind. It provides per-client tokens, and views to generate them when provided some other authentication (usually basic authentication), to delete the token (providing a server enforced logout) and to delete all tokens (logs out all clients that a user is logged into).
 
 ## drfpasswordless
 
-[drfpasswordless][drfpasswordless] adds (Medium, Square Cash inspired) passwordless support to Django REST Framework's TokenAuthentication scheme. Users log in and sign up with a token sent to a contact point like an email address or a mobile number.
-
-## django-rest-authemail
-
-[django-rest-authemail][django-rest-authemail] provides a RESTful API interface for user signup and authentication. Email addresses are used for authentication, rather than usernames.  API endpoints are available for signup, signup email verification, login, logout, password reset, password reset verification, email change, email change verification, password change, and user detail.  A fully functional example project and detailed instructions are included.
-
-## Django-Rest-Durin
-
-[Django-Rest-Durin][django-rest-durin] is built with the idea to have one library that does token auth for multiple Web/CLI/Mobile API clients via one interface but allows different token configuration for each API Client that consumes the API. It provides support for multiple tokens per user via custom models, views, permissions that work with Django-Rest-Framework. The token expiration time can be different per API client and is customizable via the Django Admin Interface.
-
-More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/en/latest/index.html).
-
-## django-pyoidc
-
-[dango-pyoidc][django_pyoidc] adds support for OpenID Connect (OIDC) authentication. This allows you to delegate user management to an Identity Provider, which can be used to implement Single-Sign-On (SSO). It provides support for most uses-cases, such as customizing how token info are mapped to user models, using OIDC audiences for access control, etc.
-
-More information can be found in the [Documentation](https://django-pyoidc.readthedocs.io/latest/index.html).
+[drfpasswordless][drfpasswordless] adds (Medium, Square Cash inspired) passwordless support to Django REST Framework's own TokenAuthentication scheme. Users log in and sign up with a token sent to a contact point like an email address or a mobile number.
 
 [cite]: https://jacobian.org/writing/rest-worst-practices/
 [http401]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
@@ -466,7 +437,7 @@ More information can be found in the [Documentation](https://django-pyoidc.readt
 [basicauth]: https://tools.ietf.org/html/rfc2617
 [permission]: permissions.md
 [throttling]: throttling.md
-[csrf-ajax]: https://docs.djangoproject.com/en/stable/howto/csrf/#using-csrf-protection-with-ajax
+[csrf-ajax]: https://docs.djangoproject.com/en/stable/ref/csrf/#ajax
 [mod_wsgi_official]: https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIPassAuthorization.html
 [django-oauth-toolkit-getting-started]: https://django-oauth-toolkit.readthedocs.io/en/latest/rest-framework/getting_started.html
 [django-rest-framework-oauth]: https://jpadilla.github.io/django-rest-framework-oauth/
@@ -476,12 +447,16 @@ More information can be found in the [Documentation](https://django-pyoidc.readt
 [djangorestframework-digestauth]: https://github.com/juanriaza/django-rest-framework-digestauth
 [oauth-1.0a]: https://oauth.net/core/1.0a/
 [django-oauth-toolkit]: https://github.com/evonove/django-oauth-toolkit
-[jazzband]: https://github.com/jazzband/
+[evonove]: https://github.com/evonove/
 [oauthlib]: https://github.com/idan/oauthlib
+[doac]: https://github.com/Rediker-Software/doac
+[rediker]: https://github.com/Rediker-Software
+[doac-rest-framework]: https://github.com/Rediker-Software/doac/blob/master/docs/integrations.md#
+[blimp]: https://github.com/GetBlimp
+[djangorestframework-jwt]: https://github.com/GetBlimp/django-rest-framework-jwt
 [djangorestframework-simplejwt]: https://github.com/davesque/django-rest-framework-simplejwt
 [etoccalino]: https://github.com/etoccalino/
 [djangorestframework-httpsignature]: https://github.com/etoccalino/django-rest-framework-httpsignature
-[drf-httpsig]: https://github.com/ahknight/drf-httpsig
 [amazon-http-signature]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
 [http-signature-ietf-draft]: https://datatracker.ietf.org/doc/draft-cavage-http-signatures/
 [hawkrest]: https://hawkrest.readthedocs.io/en/latest/
@@ -490,11 +465,6 @@ More information can be found in the [Documentation](https://django-pyoidc.readt
 [mac]: https://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05
 [djoser]: https://github.com/sunscrapers/djoser
 [django-rest-auth]: https://github.com/Tivix/django-rest-auth
-[dj-rest-auth]: https://github.com/jazzband/dj-rest-auth
-[drf-social-oauth2]: https://github.com/wagnerdelima/drf-social-oauth2
+[django-rest-framework-social-oauth2]: https://github.com/PhilipGarnero/django-rest-framework-social-oauth2
 [django-rest-knox]: https://github.com/James1345/django-rest-knox
 [drfpasswordless]: https://github.com/aaronn/django-rest-framework-passwordless
-[django-rest-authemail]: https://github.com/celiao/django-rest-authemail
-[django-rest-durin]: https://github.com/eshaan7/django-rest-durin
-[login-required-middleware]: https://docs.djangoproject.com/en/stable/ref/middleware/#django.contrib.auth.middleware.LoginRequiredMiddleware
-[django-pyoidc] : https://github.com/makinacorpus/django_pyoidc

docs/api-guide/caching.md

@@ -1,6 +1,6 @@
 # Caching
 
-> A certain woman had a very sharp consciousness but almost no
+> A certain woman had a very sharp conciousness but almost no
 > memory ... She remembered enough to work, and she worked hard.
 > - Lydia Davis
 
@@ -13,79 +13,40 @@ provided in Django.
 
 Django provides a [`method_decorator`][decorator] to use
 decorators with class based views. This can be used with
-other cache decorators such as [`cache_page`][page],
-[`vary_on_cookie`][cookie] and [`vary_on_headers`][headers].
+with other cache decorators such as [`cache_page`][page] and
+[`vary_on_cookie`][cookie].
 
 ```python
-from django.utils.decorators import method_decorator
-from django.views.decorators.cache import cache_page
-from django.views.decorators.vary import vary_on_cookie, vary_on_headers
-
 from rest_framework.response import Response
 from rest_framework.views import APIView
 from rest_framework import viewsets
 
+class UserViewSet(viewsets.Viewset):
 
-class UserViewSet(viewsets.ViewSet):
-    # With cookie: cache requested url for each user for 2 hours
-    @method_decorator(cache_page(60 * 60 * 2))
+    # Cache requested url for each user for 2 hours
+    @method_decorator(cache_page(60*60*2))
     @method_decorator(vary_on_cookie)
     def list(self, request, format=None):
         content = {
-            "user_feed": request.user.get_user_feed(),
+            'user_feed': request.user.get_user_feed()
         }
         return Response(content)
 
-
-class ProfileView(APIView):
-    # With auth: cache requested url for each user for 2 hours
-    @method_decorator(cache_page(60 * 60 * 2))
-    @method_decorator(vary_on_headers("Authorization"))
-    def get(self, request, format=None):
-        content = {
-            "user_feed": request.user.get_user_feed(),
-        }
-        return Response(content)
-
-
 class PostView(APIView):
+
     # Cache page for the requested url
-    @method_decorator(cache_page(60 * 60 * 2))
+    @method_decorator(cache_page(60*60*2))
     def get(self, request, format=None):
         content = {
-            "title": "Post title",
-            "body": "Post content",
+            'title': 'Post title',
+            'body': 'Post content'
         }
         return Response(content)
 ```
 
-
-## Using cache with @api_view decorator
-
-When using @api_view decorator, the Django-provided method-based cache decorators such as [`cache_page`][page],
-[`vary_on_cookie`][cookie] and [`vary_on_headers`][headers] can be called directly.
-
-```python
-from django.views.decorators.cache import cache_page
-from django.views.decorators.vary import vary_on_cookie
-
-from rest_framework.decorators import api_view
-from rest_framework.response import Response
-
-
-@cache_page(60 * 15)
-@vary_on_cookie
-@api_view(["GET"])
-def get_user_list(request):
-    content = {"user_feed": request.user.get_user_feed()}
-    return Response(content)
-```
-
-
 **NOTE:** The [`cache_page`][page] decorator only caches the
 `GET` and `HEAD` responses with status 200.
 
-[page]: https://docs.djangoproject.com/en/stable/topics/cache/#the-per-view-cache
-[cookie]: https://docs.djangoproject.com/en/stable/topics/http/decorators/#django.views.decorators.vary.vary_on_cookie
-[headers]: https://docs.djangoproject.com/en/stable/topics/http/decorators/#django.views.decorators.vary.vary_on_headers
-[decorator]: https://docs.djangoproject.com/en/stable/topics/class-based-views/intro/#decorating-the-class
+[page]: https://docs.djangoproject.com/en/dev/topics/cache/#the-per-view-cache
+[cookie]: https://docs.djangoproject.com/en/dev/topics/http/decorators/#django.views.decorators.vary.vary_on_cookie
+[decorator]: https://docs.djangoproject.com/en/dev/topics/class-based-views/intro/#decorating-the-class

docs/api-guide/content-negotiation.md

@@ -1,7 +1,4 @@
----
-source:
-    - negotiation.py
----
+source: negotiation.py
 
 # Content negotiation
 
@@ -82,7 +79,7 @@ The default content negotiation class may be set globally, using the `DEFAULT_CO
 
 You can also set the content negotiation used for an individual view, or viewset, using the `APIView` class-based views.
 
-    from myapp.negotiation import IgnoreClientContentNegotiation
+	from myapp.negotiation import IgnoreClientContentNegotiation
     from rest_framework.response import Response
     from rest_framework.views import APIView
 

docs/api-guide/exceptions.md

@@ -1,7 +1,4 @@
----
-source:
-    - exceptions.py
----
+source: exceptions.py
 
 # Exceptions
 
@@ -38,7 +35,7 @@ Might receive an error response indicating that the `DELETE` method is not allow
 
 Validation errors are handled slightly differently, and will include the field names as the keys in the response. If the validation error was not specific to a particular field then it will use the "non_field_errors" key, or whatever string value has been set for the `NON_FIELD_ERRORS_KEY` setting.
 
-An example validation error might look like this:
+Any example validation error might look like this:
 
     HTTP/1.1 400 Bad Request
     Content-Type: application/json
@@ -101,7 +98,7 @@ Note that the exception handler will only be called for responses generated by r
 
 The **base class** for all exceptions raised inside an `APIView` class or `@api_view`.
 
-To provide a custom exception, subclass `APIException` and set the `.status_code`, `.default_detail`, and `.default_code` attributes on the class.
+To provide a custom exception, subclass `APIException` and set the `.status_code`, `.default_detail`, and `default_code` attributes on the class.
 
 For example, if your API relies on a third party service that may sometimes be unreachable, you might want to implement an exception for the "503 Service Unavailable" HTTP response code.  You could do this like so:
 
@@ -179,7 +176,7 @@ By default this exception results in a response with the HTTP status code "403 F
 
 **Signature:** `NotFound(detail=None, code=None)`
 
-Raised when a resource does not exist at the given URL. This exception is equivalent to the standard `Http404` Django exception.
+Raised when a resource does not exists at the given URL. This exception is equivalent to the standard `Http404` Django exception.
 
 By default this exception results in a response with the HTTP status code "404 Not Found".
 
@@ -217,11 +214,12 @@ By default this exception results in a response with the HTTP status code "429 T
 
 ## ValidationError
 
-**Signature:** `ValidationError(detail=None, code=None)`
+**Signature:** `ValidationError(detail, code=None)`
 
 The `ValidationError` exception is slightly different from the other `APIException` classes:
 
-* The `detail` argument may be a list or dictionary of error details, and may also be a nested data structure. By using a dictionary, you can specify field-level errors while performing object-level validation in the `validate()` method of a serializer. For example. `raise serializers.ValidationError({'name': 'Please enter a valid name.'})`
+* The `detail` argument is mandatory, not optional.
+* The `detail` argument may be a list or dictionary of error details, and may also be a nested data structure.
 * By convention you should import the serializers module and use a fully qualified `ValidationError` style, in order to differentiate it from Django's built-in validation error. For example. `raise serializers.ValidationError('This field must be an integer value.')`
 
 The `ValidationError` class should be used for serializer and field validation, and by validator classes. It is also raised when calling `serializer.is_valid` with the `raise_exception` keyword argument:
@@ -251,7 +249,7 @@ Set as `handler500`:
 
     handler500 = 'rest_framework.exceptions.server_error'
 
-## `rest_framework.exceptions.bad_request`
+## `rest_framework.exceptions.server_error`
 
 Returns a response with status code `400` and `application/json` content type.
 
@@ -259,15 +257,6 @@ Set as `handler400`:
 
     handler400 = 'rest_framework.exceptions.bad_request'
 
-# Third party packages
-
-The following third-party packages are also available.
-
-## DRF Standardized Errors
-
-The [drf-standardized-errors][drf-standardized-errors] package provides an exception handler that generates the same format for all 4xx and 5xx responses. It is a drop-in replacement for the default exception handler and allows customizing the error response format without rewriting the whole exception handler. The standardized error response format is easier to document and easier to handle by API consumers.
-
 [cite]: https://doughellmann.com/blog/2009/06/19/python-exception-handling-techniques/
 [authentication]: authentication.md
-[django-custom-error-views]: https://docs.djangoproject.com/en/stable/topics/http/views/#customizing-error-views
-[drf-standardized-errors]: https://github.com/ghazi-git/drf-standardized-errors
+[django-custom-error-views]: https://docs.djangoproject.com/en/dev/topics/http/views/#customizing-error-views

docs/api-guide/fields.md

@@ -1,7 +1,4 @@
----
-source:
-    - fields.py
----
+source: fields.py
 
 # Serializer fields
 
@@ -42,29 +39,17 @@ Set to false if this field is not required to be present during deserialization.
 
 Setting this to `False` also allows the object attribute or dictionary key to be omitted from output when serializing the instance. If the key is not present it will simply not be included in the output representation.
 
-Defaults to `True`. If you're using [Model Serializer](https://www.django-rest-framework.org/api-guide/serializers/#modelserializer), the default value will be `False` when you have specified a `default`, or when the corresponding `Model` field has `blank=True` or `null=True` and is not part of a unique constraint at the same time. (Note that without a `default` value, [unique constraints will cause the field to be required](https://www.django-rest-framework.org/api-guide/validators/#optional-fields).)
+Defaults to `True`.
 
 ### `default`
 
-If set, this gives the default value that will be used for the field if no input value is supplied. If not set the default behavior is to not populate the attribute at all.
+If set, this gives the default value that will be used for the field if no input value is supplied. If not set the default behaviour is to not populate the attribute at all.
 
 The `default` is not applied during partial update operations. In the partial update case only fields that are provided in the incoming data will have a validated value returned.
 
-May be set to a function or other callable, in which case the value will be evaluated each time it is used. When called, it will receive no arguments. If the callable has a `requires_context = True` attribute, then the serializer field will be passed as an argument.
+May be set to a function or other callable, in which case the value will be evaluated each time it is used. When called, it will receive no arguments. If the callable has a `set_context` method, that will be called each time before getting the value with the field instance as only argument. This works the same way as for [validators](validators.md#using-set_context).
 
-For example:
-
-    class CurrentUserDefault:
-        """
-        May be applied as a `default=...` value on a serializer field.
-        Returns the current user.
-        """
-        requires_context = True
-
-        def __call__(self, serializer_field):
-            return serializer_field.context['request'].user
-
-When serializing the instance, default will be used if the object attribute or dictionary key is not present in the instance.
+When serializing the instance, default will be used if the the object attribute or dictionary key is not present in the instance.
 
 Note that setting a `default` value implies that the field is not required. Including both the `default` and `required` keyword arguments is invalid and will raise an error.
 
@@ -78,14 +63,7 @@ Defaults to `False`
 
 ### `source`
 
-The name of the attribute that will be used to populate the field.  May be a method that only takes a `self` argument, such as `URLField(source='get_absolute_url')`, or may use dotted notation to traverse attributes, such as `EmailField(source='user.email')`.
-
-When serializing fields with dotted notation, it may be necessary to provide a `default` value if any object is not present or is empty during attribute traversal. Beware of possible n+1 problems when using source attribute if you are accessing a relational orm model. For example:
-
-    class CommentSerializer(serializers.Serializer):
-        email = serializers.EmailField(source="user.email")
-
-This case would require user object to be fetched from database when it is not prefetched. If that is not wanted, be sure to be using `prefetch_related` and `select_related` methods appropriately. For more information about the methods refer to [django documentation][django-docs-select-related].
+The name of the attribute that will be used to populate the field.  May be a method that only takes a `self` argument, such as `URLField(source='get_absolute_url')`, or may use dotted notation to traverse attributes, such as `EmailField(source='user.email')`. When serializing fields with dotted notation, it may be necessary to provide a `default` value if any object is not present or is empty during attribute traversal.
 
 The value `source='*'` has a special meaning, and is used to indicate that the entire object should be passed through to the field.  This can be useful for creating nested representations, or for fields which require access to the complete object in order to determine the output representation.
 
@@ -146,19 +124,20 @@ A boolean representation.
 
 When using HTML encoded form input be aware that omitting a value will always be treated as setting a field to `False`, even if it has a `default=True` option specified. This is because HTML checkbox inputs represent the unchecked state by omitting the value, so REST framework treats omission as if it is an empty checkbox input.
 
-Note that Django 2.1 removed the `blank` kwarg from `models.BooleanField`.
-Prior to Django 2.1 `models.BooleanField` fields were always `blank=True`. Thus
-since Django 2.1 default `serializers.BooleanField` instances will be generated
-without the `required` kwarg (i.e. equivalent to `required=True`) whereas with
-previous versions of Django, default `BooleanField` instances will be generated
-with a `required=False` option.  If you want to control this behavior manually,
-explicitly declare the `BooleanField` on the serializer class, or use the
-`extra_kwargs` option to set the `required` flag.
+Note that default `BooleanField` instances will be generated with a `required=False` option (since Django `models.BooleanField` is always `blank=True`). If you want to change this behaviour explicitly declare the `BooleanField` on the serializer class.
 
 Corresponds to `django.db.models.fields.BooleanField`.
 
 **Signature:** `BooleanField()`
 
+## NullBooleanField
+
+A boolean representation that also accepts `None` as a valid value.
+
+Corresponds to `django.db.models.fields.NullBooleanField`.
+
+**Signature:** `NullBooleanField()`
+
 ---
 
 # String fields
@@ -171,10 +150,10 @@ Corresponds to `django.db.models.fields.CharField` or `django.db.models.fields.T
 
 **Signature:** `CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)`
 
-* `max_length` - Validates that the input contains no more than this number of characters.
-* `min_length` - Validates that the input contains no fewer than this number of characters.
-* `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`.
-* `trim_whitespace` - If set to `True` then leading and trailing whitespace is trimmed. Defaults to `True`.
+- `max_length` - Validates that the input contains no more than this number of characters.
+- `min_length` - Validates that the input contains no fewer than this number of characters.
+- `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`.
+- `trim_whitespace` - If set to `True` then leading and trailing whitespace is trimmed. Defaults to `True`.
 
 The `allow_null` option is also available for string fields, although its usage is discouraged in favor of `allow_blank`. It is valid to set both `allow_blank=True` and `allow_null=True`, but doing so means that there will be two differing types of empty value permissible for string representations, which can lead to data inconsistencies and subtle application bugs.
 
@@ -222,11 +201,11 @@ A field that ensures the input is a valid UUID string. The `to_internal_value` m
 
 **Signature:** `UUIDField(format='hex_verbose')`
 
-* `format`: Determines the representation format of the uuid value
-    * `'hex_verbose'` - The canonical hex representation, including hyphens: `"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
-    * `'hex'` - The compact hex representation of the UUID, not including hyphens: `"5ce0e9a55ffa654bcee01238041fb31a"`
-    * `'int'` - A 128 bit integer representation of the UUID: `"123456789012312313134124512351145145114"`
-    * `'urn'` - RFC 4122 URN representation of the UUID: `"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
+- `format`: Determines the representation format of the uuid value
+    - `'hex_verbose'` - The cannoncical hex representation, including hyphens: `"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
+    - `'hex'` - The compact hex representation of the UUID, not including hyphens: `"5ce0e9a55ffa654bcee01238041fb31a"`
+    - `'int'` - A 128 bit integer representation of the UUID: `"123456789012312313134124512351145145114"`
+    - `'urn'` - RFC 4122 URN representation of the UUID: `"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
   Changing the `format` parameters only affects representation values. All formats are accepted by `to_internal_value`
 
 ## FilePathField
@@ -237,11 +216,11 @@ Corresponds to `django.forms.fields.FilePathField`.
 
 **Signature:** `FilePathField(path, match=None, recursive=False, allow_files=True, allow_folders=False, required=None, **kwargs)`
 
-* `path` - The absolute filesystem path to a directory from which this FilePathField should get its choice.
-* `match` - A regular expression, as a string, that FilePathField will use to filter filenames.
-* `recursive` - Specifies whether all subdirectories of path should be included.  Default is `False`.
-* `allow_files` - Specifies whether files in the specified location should be included. Default is `True`. Either this or `allow_folders` must be `True`.
-* `allow_folders` - Specifies whether folders in the specified location should be included. Default is `False`. Either this or `allow_files` must be `True`.
+- `path` - The absolute filesystem path to a directory from which this FilePathField should get its choice.
+- `match` - A regular expression, as a string, that FilePathField will use to filter filenames.
+- `recursive` - Specifies whether all subdirectories of path should be included.  Default is `False`.
+- `allow_files` - Specifies whether files in the specified location should be included. Default is `True`. Either this or `allow_folders` must be `True`.
+- `allow_folders` - Specifies whether folders in the specified location should be included. Default is `False`. Either this or `allow_files` must be `True`.
 
 ## IPAddressField
 
@@ -251,8 +230,8 @@ Corresponds to `django.forms.fields.IPAddressField` and `django.forms.fields.Gen
 
 **Signature**: `IPAddressField(protocol='both', unpack_ipv4=False, **options)`
 
-* `protocol` Limits valid inputs to the specified protocol. Accepted values are 'both' (default), 'IPv4' or 'IPv6'. Matching is case-insensitive.
-* `unpack_ipv4` Unpacks IPv4 mapped addresses like ::ffff:192.0.2.1. If this option is enabled that address would be unpacked to 192.0.2.1. Default is disabled. Can only be used when protocol is set to 'both'.
+- `protocol` Limits valid inputs to the specified protocol. Accepted values are 'both' (default), 'IPv4' or 'IPv6'. Matching is case insensitive.
+- `unpack_ipv4` Unpacks IPv4 mapped addresses like ::ffff:192.0.2.1. If this option is enabled that address would be unpacked to 192.0.2.1. Default is disabled. Can only be used when protocol is set to 'both'.
 
 ---
 
@@ -266,8 +245,8 @@ Corresponds to `django.db.models.fields.IntegerField`, `django.db.models.fields.
 
 **Signature**: `IntegerField(max_value=None, min_value=None)`
 
-* `max_value` Validate that the number provided is no greater than this value.
-* `min_value` Validate that the number provided is no less than this value.
+- `max_value` Validate that the number provided is no greater than this value.
+- `min_value` Validate that the number provided is no less than this value.
 
 ## FloatField
 
@@ -277,8 +256,8 @@ Corresponds to `django.db.models.fields.FloatField`.
 
 **Signature**: `FloatField(max_value=None, min_value=None)`
 
-* `max_value` Validate that the number provided is no greater than this value.
-* `min_value` Validate that the number provided is no less than this value.
+- `max_value` Validate that the number provided is no greater than this value.
+- `min_value` Validate that the number provided is no less than this value.
 
 ## DecimalField
 
@@ -288,14 +267,13 @@ Corresponds to `django.db.models.fields.DecimalField`.
 
 **Signature**: `DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None)`
 
-* `max_digits` The maximum number of digits allowed in the number. It must be either `None` or an integer greater than or equal to `decimal_places`.
-* `decimal_places` The number of decimal places to store with the number.
-* `coerce_to_string` Set to `True` if string values should be returned for the representation, or `False` if `Decimal` objects should be returned. Defaults to the same value as the `COERCE_DECIMAL_TO_STRING` settings key, which will be `True` unless overridden. If `Decimal` objects are returned by the serializer, then the final output format will be determined by the renderer. Note that setting `localize` will force the value to `True`.
-* `max_value` Validate that the number provided is no greater than this value. Should be an integer or `Decimal` object.
-* `min_value` Validate that the number provided is no less than this value. Should be an integer or `Decimal` object.
-* `localize` Set to `True` to enable localization of input and output based on the current locale. This will also force `coerce_to_string` to `True`. Defaults to `False`. Note that data formatting is enabled if you have set `USE_L10N=True` in your settings file.
-* `rounding` Sets the rounding mode used when quantizing to the configured precision. Valid values are [`decimal` module rounding modes][python-decimal-rounding-modes]. Defaults to `None`.
-* `normalize_output` Will normalize the decimal value when serialized. This will strip all trailing zeroes and change the value's precision to the minimum required precision to be able to represent the value without losing data. Defaults to `False`.
+- `max_digits` The maximum number of digits allowed in the number. It must be either `None` or an integer greater than or equal to `decimal_places`.
+- `decimal_places` The number of decimal places to store with the number.
+- `coerce_to_string` Set to `True` if string values should be returned for the representation, or `False` if `Decimal` objects should be returned. Defaults to the same value as the `COERCE_DECIMAL_TO_STRING` settings key, which will be `True` unless overridden. If `Decimal` objects are returned by the serializer, then the final output format will be determined by the renderer. Note that setting `localize` will force the value to `True`.
+- `max_value` Validate that the number provided is no greater than this value.
+- `min_value` Validate that the number provided is no less than this value.
+- `localize` Set to `True` to enable localization of input and output based on the current locale. This will also force `coerce_to_string` to `True`. Defaults to `False`. Note that data formatting is enabled if you have set `USE_L10N=True` in your settings file.
+- `rounding` Sets the rounding mode used when quantising to the configured precision. Valid values are [`decimal` module rounding modes][python-decimal-rounding-modes]. Defaults to `None`.
 
 #### Example usage
 
@@ -307,6 +285,10 @@ And to validate numbers up to anything less than one billion with a resolution o
 
     serializers.DecimalField(max_digits=19, decimal_places=10)
 
+This field also takes an optional argument, `coerce_to_string`. If set to `True` the representation will be output as a string. If set to `False` the representation will be left as a `Decimal` instance and the final representation will be determined by the renderer.
+
+If unset, this will default to the same value as the `COERCE_DECIMAL_TO_STRING` setting, which is `True` unless set otherwise.
+
 ---
 
 # Date and time fields
@@ -317,17 +299,16 @@ A date and time representation.
 
 Corresponds to `django.db.models.fields.DateTimeField`.
 
-**Signature:** `DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None, default_timezone=None)`
+**Signature:** `DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)`
 
 * `format` - A string representing the output format. If not specified, this defaults to the same value as the `DATETIME_FORMAT` settings key, which will be `'iso-8601'` unless set. Setting to a format string indicates that `to_representation` return values should be coerced to string output. Format strings are described below. Setting this value to `None` indicates that Python `datetime` objects should be returned by `to_representation`. In this case the datetime encoding will be determined by the renderer.
 * `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']`.
-* `default_timezone` - A `tzinfo` subclass (`zoneinfo` or `pytz`) representing the timezone. If not specified and the `USE_TZ` setting is enabled, this defaults to the [current timezone][django-current-timezone]. If `USE_TZ` is disabled, then datetime objects will be naive.
 
 #### `DateTimeField` format strings.
 
 Format strings may either be [Python strftime formats][strftime] which explicitly specify 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.000000Z'`)
 
-When a value of `None` is used for the format `datetime` objects will be returned by `to_representation` and the final output representation will be determined by the renderer class.
+When a value of `None` is used for the format `datetime` objects will be returned by `to_representation` and the final output representation will determined by the renderer class.
 
 #### `auto_now` and `auto_now_add` model fields.
 
@@ -367,7 +348,7 @@ Corresponds to `django.db.models.fields.TimeField`
 * `format` - A string representing the output format.  If not specified, this defaults to the same value as the `TIME_FORMAT` settings key, which will be `'iso-8601'` unless set. Setting to a format string indicates that `to_representation` return values should be coerced to string output. Format strings are described below. Setting this value to `None` indicates that Python `time` objects should be returned by `to_representation`. In this case the time encoding will be determined by the renderer.
 * `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']`.
 
-#### `TimeField` format strings
+#### `TimeField` format strings
 
 Format strings may either be [Python strftime formats][strftime] which explicitly specify the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style times should be used. (eg `'12:34:56.000000'`)
 
@@ -379,10 +360,7 @@ Corresponds to `django.db.models.fields.DurationField`
 The `validated_data` for these fields will contain a `datetime.timedelta` instance.
 The representation is a string following this format `'[DD] [HH:[MM:]]ss[.uuuuuu]'`.
 
-**Signature:** `DurationField(max_value=None, min_value=None)`
-
-* `max_value` Validate that the duration provided is no greater than this value.
-* `min_value` Validate that the duration provided is no less than this value.
+**Signature:** `DurationField()`
 
 ---
 
@@ -396,10 +374,10 @@ Used by `ModelSerializer` to automatically generate fields if the corresponding
 
 **Signature:** `ChoiceField(choices)`
 
-* `choices` - A list of valid values, or a list of `(key, display_name)` tuples.
-* `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`.
-* `html_cutoff` - If set this will be the maximum number of choices that will be displayed by a HTML select drop down. Can be used to ensure that automatically generated ChoiceFields with very large possible selections do not prevent a template from rendering. Defaults to `None`.
-* `html_cutoff_text` - If set this will display a textual indicator if the maximum number of items have been cutoff in an HTML select drop down. Defaults to `"More than {count} items…"`
+- `choices` - A list of valid values, or a list of `(key, display_name)` tuples.
+- `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`.
+- `html_cutoff` - If set this will be the maximum number of choices that will be displayed by a HTML select drop down. Can be used to ensure that automatically generated ChoiceFields with very large possible selections do not prevent a template from rendering. Defaults to `None`.
+- `html_cutoff_text` - If set this will display a textual indicator if the maximum number of items have been cutoff in an HTML select drop down. Defaults to `"More than {count} items…"`
 
 Both the `allow_blank` and `allow_null` are valid options on `ChoiceField`, although it is highly recommended that you only use one and not both. `allow_blank` should be preferred for textual choices, and `allow_null` should be preferred for numeric or other non-textual choices.
 
@@ -409,10 +387,10 @@ A field that can accept a set of zero, one or many values, chosen from a limited
 
 **Signature:** `MultipleChoiceField(choices)`
 
-* `choices` - A list of valid values, or a list of `(key, display_name)` tuples.
-* `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`.
-* `html_cutoff` - If set this will be the maximum number of choices that will be displayed by a HTML select drop down. Can be used to ensure that automatically generated ChoiceFields with very large possible selections do not prevent a template from rendering. Defaults to `None`.
-* `html_cutoff_text` - If set this will display a textual indicator if the maximum number of items have been cutoff in an HTML select drop down. Defaults to `"More than {count} items…"`
+- `choices` - A list of valid values, or a list of `(key, display_name)` tuples.
+- `allow_blank` - If set to `True` then the empty string should be considered a valid value. If set to `False` then the empty string is considered invalid and will raise a validation error. Defaults to `False`.
+- `html_cutoff` - If set this will be the maximum number of choices that will be displayed by a HTML select drop down. Can be used to ensure that automatically generated ChoiceFields with very large possible selections do not prevent a template from rendering. Defaults to `None`.
+- `html_cutoff_text` - If set this will display a textual indicator if the maximum number of items have been cutoff in an HTML select drop down. Defaults to `"More than {count} items…"`
 
 As with `ChoiceField`, both the `allow_blank` and `allow_null` options are valid, although it is highly recommended that you only use one and not both. `allow_blank` should be preferred for textual choices, and `allow_null` should be preferred for numeric or other non-textual choices.
 
@@ -433,9 +411,9 @@ Corresponds to `django.forms.fields.FileField`.
 
 **Signature:** `FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)`
 
-* `max_length` - Designates the maximum length for the file name.
-* `allow_empty_file` - Designates if empty files are allowed.
-* `use_url` - If set to `True` then URL string values will be used for the output representation. If set to `False` then filename string values will be used for the output representation. Defaults to the value of the `UPLOADED_FILES_USE_URL` settings key, which is `True` unless set otherwise.
+ - `max_length` - Designates the maximum length for the file name.
+ - `allow_empty_file` - Designates if empty files are allowed.
+- `use_url` - If set to `True` then URL string values will be used for the output representation. If set to `False` then filename string values will be used for the output representation. Defaults to the value of the `UPLOADED_FILES_USE_URL` settings key, which is `True` unless set otherwise.
 
 ## ImageField
 
@@ -445,9 +423,9 @@ Corresponds to `django.forms.fields.ImageField`.
 
 **Signature:** `ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)`
 
-* `max_length` - Designates the maximum length for the file name.
-* `allow_empty_file` - Designates if empty files are allowed.
-* `use_url` - If set to `True` then URL string values will be used for the output representation. If set to `False` then filename string values will be used for the output representation. Defaults to the value of the `UPLOADED_FILES_USE_URL` settings key, which is `True` unless set otherwise.
+ - `max_length` - Designates the maximum length for the file name.
+ - `allow_empty_file` - Designates if empty files are allowed.
+- `use_url` - If set to `True` then URL string values will be used for the output representation. If set to `False` then filename string values will be used for the output representation. Defaults to the value of the `UPLOADED_FILES_USE_URL` settings key, which is `True` unless set otherwise.
 
 Requires either the `Pillow` package or `PIL` package.  The `Pillow` package is recommended, as `PIL` is no longer actively maintained.
 
@@ -459,12 +437,11 @@ Requires either the `Pillow` package or `PIL` package.  The `Pillow` package is
 
 A field class that validates a list of objects.
 
-**Signature**: `ListField(child=<A_FIELD_INSTANCE>, allow_empty=True, min_length=None, max_length=None)`
+**Signature**: `ListField(child=<A_FIELD_INSTANCE>, min_length=None, max_length=None)`
 
-* `child` - A field instance that should be used for validating the objects in the list. If this argument is not provided then objects in the list will not be validated.
-* `allow_empty` - Designates if empty lists are allowed.
-* `min_length` - Validates that the list contains no fewer than this number of elements.
-* `max_length` - Validates that the list contains no more than this number of elements.
+- `child` - A field instance that should be used for validating the objects in the list. If this argument is not provided then objects in the list will not be validated.
+- `min_length` - Validates that the list contains no fewer than this number of elements.
+- `max_length` - Validates that the list contains no more than this number of elements.
 
 For example, to validate a list of integers you might use something like the following:
 
@@ -483,10 +460,9 @@ We can now reuse our custom `StringListField` class throughout our application,
 
 A field class that validates a dictionary of objects. The keys in `DictField` are always assumed to be string values.
 
-**Signature**: `DictField(child=<A_FIELD_INSTANCE>, allow_empty=True)`
+**Signature**: `DictField(child=<A_FIELD_INSTANCE>)`
 
-* `child` - A field instance that should be used for validating the values in the dictionary. If this argument is not provided then values in the mapping will not be validated.
-* `allow_empty` - Designates if empty dictionaries are allowed.
+- `child` - A field instance that should be used for validating the values in the dictionary. If this argument is not provided then values in the mapping will not be validated.
 
 For example, to create a field that validates a mapping of strings to strings, you would write something like this:
 
@@ -501,10 +477,9 @@ You can also use the declarative style, as with `ListField`. For example:
 
 A preconfigured `DictField` that is compatible with Django's postgres `HStoreField`.
 
-**Signature**: `HStoreField(child=<A_FIELD_INSTANCE>, allow_empty=True)`
+**Signature**: `HStoreField(child=<A_FIELD_INSTANCE>)`
 
-* `child` - A field instance that is used for validating the values in the dictionary. The default child field accepts both empty strings and null values.
-* `allow_empty` - Designates if empty dictionaries are allowed.
+- `child` - A field instance that is used for validating the values in the dictionary. The default child field accepts both empty strings and null values.
 
 Note that the child field **must** be an instance of `CharField`, as the hstore extension stores values as strings.
 
@@ -512,10 +487,9 @@ Note that the child field **must** be an instance of `CharField`, as the hstore
 
 A field class that validates that the incoming data structure consists of valid JSON primitives. In its alternate binary mode, it will represent and validate JSON-encoded binary strings.
 
-**Signature**: `JSONField(binary, encoder)`
+**Signature**: `JSONField(binary)`
 
-* `binary` - If set to `True` then the field will output and validate a JSON encoded string, rather than a primitive data structure. Defaults to `False`.
-* `encoder` - Use this JSON encoder to serialize input object. Defaults to `None`.
+- `binary` - If set to `True` then the field will output and validate a JSON encoded string, rather than a primitive data structure. Defaults to `False`.
 
 ---
 
@@ -534,7 +508,7 @@ For example, if `has_expired` was a property on the `Account` model, then the fo
     class AccountSerializer(serializers.ModelSerializer):
         class Meta:
             model = Account
-            fields = ['id', 'account_name', 'has_expired']
+            fields = ('id', 'account_name', 'has_expired')
 
 ## HiddenField
 
@@ -550,12 +524,6 @@ The `HiddenField` class is usually only needed if you have some validation that
 
 For further examples on `HiddenField` see the [validators](validators.md) documentation.
 
----
-
-**Note:** `HiddenField()` does not appear in `partial=True` serializer (when making `PATCH` request).
-
----
-
 ## ModelField
 
 A generic field that can be tied to any arbitrary model field. The `ModelField` class delegates the task of serialization/deserialization to its associated model field.  This field can be used to create serializer fields for custom model fields, without having to create a new custom serializer field.
@@ -572,7 +540,7 @@ This is a read-only field. It gets its value by calling a method on the serializ
 
 **Signature**: `SerializerMethodField(method_name=None)`
 
-* `method_name` - The name of the method on the serializer to be called. If not included this defaults to `get_<field_name>`.
+- `method_name` - The name of the method on the serializer to be called. If not included this defaults to `get_<field_name>`.
 
 The serializer method referred to by the `method_name` argument should accept a single argument (in addition to `self`), which is the object being serialized. It should return whatever you want to be included in the serialized representation of the object. For example:
 
@@ -585,7 +553,6 @@ The serializer method referred to by the `method_name` argument should accept a
 
         class Meta:
             model = User
-            fields = '__all__'
 
         def get_days_since_joined(self, obj):
             return (now() - obj.date_joined).days
@@ -598,7 +565,9 @@ If you want to create a custom field, you'll need to subclass `Field` and then o
 
 The `.to_representation()` method is called to convert the initial datatype into a primitive, serializable datatype.
 
-The `.to_internal_value()` method is called to restore a primitive datatype into its internal python representation. This method should raise a `serializers.ValidationError` if the data is invalid.
+The `to_internal_value()` method is called to restore a primitive datatype into its internal python representation. This method should raise a `serializers.ValidationError` if the data is invalid.
+
+Note that the `WritableField` class that was present in version 2.x no longer exists. You should subclass `Field` and override `to_internal_value()` if the field supports data input.
 
 ## Examples
 
@@ -606,7 +575,7 @@ The `.to_internal_value()` method is called to restore a primitive datatype into
 
 Let's look at an example of serializing a class that represents an RGB color value:
 
-    class Color:
+    class Color(object):
         """
         A color represented in the RGB colorspace.
         """
@@ -619,8 +588,8 @@ Let's look at an example of serializing a class that represents an RGB color val
         """
         Color objects are serialized into 'rgb(#, #, #)' notation.
         """
-        def to_representation(self, value):
-            return "rgb(%d, %d, %d)" % (value.red, value.green, value.blue)
+        def to_representation(self, obj):
+            return "rgb(%d, %d, %d)" % (obj.red, obj.green, obj.blue)
 
         def to_internal_value(self, data):
             data = data.strip('rgb(').rstrip(')')
@@ -632,16 +601,16 @@ By default field values are treated as mapping to an attribute on the object.  I
 As an example, let's create a field that can be used to represent the class name of the object being serialized:
 
     class ClassNameField(serializers.Field):
-        def get_attribute(self, instance):
+        def get_attribute(self, obj):
             # We pass the object instance onto `to_representation`,
             # not just the field attribute.
-            return instance
+            return obj
 
-        def to_representation(self, value):
+        def to_representation(self, obj):
             """
-            Serialize the value's class name.
+            Serialize the object's class name.
             """
-            return value.__class__.__name__
+            return obj.__class__.__name__
 
 ### Raising validation errors
 
@@ -649,7 +618,7 @@ Our `ColorField` class above currently does not perform any data validation.
 To indicate invalid data, we should raise a `serializers.ValidationError`, like so:
 
     def to_internal_value(self, data):
-        if not isinstance(data, str):
+        if not isinstance(data, six.text_type):
             msg = 'Incorrect type. Expected a string, but got %s'
             raise ValidationError(msg % type(data).__name__)
 
@@ -673,7 +642,7 @@ The `.fail()` method is a shortcut for raising `ValidationError` that takes a me
     }
 
     def to_internal_value(self, data):
-        if not isinstance(data, str):
+        if not isinstance(data, six.text_type):
             self.fail('incorrect_type', input_type=type(data).__name__)
 
         if not re.match(r'^rgb\([0-9]+,[0-9]+,[0-9]+\)$', data):
@@ -703,10 +672,10 @@ the coordinate pair:
 
     class CoordinateField(serializers.Field):
 
-        def to_representation(self, value):
+        def to_representation(self, obj):
             ret = {
-                "x": value.x_coordinate,
-                "y": value.y_coordinate
+                "x": obj.x_coordinate,
+                "y": obj.y_coordinate
             }
             return ret
 
@@ -726,7 +695,7 @@ the coordinate pair:
             fields = ['label', 'coordinates']
 
 Note that this example doesn't handle validation. Partly for that reason, in a
-real project, the coordinate nesting might be better handled with a nested serializer
+real project, the coordinate nesting might be better handled with a nested serialiser
 using `source='*'`, with two `IntegerField` instances, each with their own `source`
 pointing to the relevant field.
 
@@ -738,7 +707,7 @@ to the desired output.
         >>> instance = DataPoint(label='Example', x_coordinate=1, y_coordinate=2)
         >>> out_serializer = DataPointSerializer(instance)
         >>> out_serializer.data
-        ReturnDict([('label', 'Example'), ('coordinates', {'x': 1, 'y': 2})])
+        ReturnDict([('label', 'testing'), ('coordinates', {'x': 1, 'y': 2})])
 
 * Unless our field is to be read-only, `to_internal_value` must map back to a dict
 suitable for updating our target object. With `source='*'`, the return from
@@ -759,7 +728,7 @@ suitable for updating our target object. With `source='*'`, the return from
                      ('y_coordinate', 4),
                      ('x_coordinate', 3)])
 
-For completeness lets do the same thing again but with the nested serializer
+For completeness lets do the same thing again but with the nested serialiser
 approach suggested above:
 
     class NestedCoordinateSerializer(serializers.Serializer):
@@ -778,17 +747,17 @@ Here the mapping between the target and source attribute pairs (`x` and
 `x_coordinate`, `y` and `y_coordinate`) is handled in the `IntegerField`
 declarations. It's our `NestedCoordinateSerializer` that takes `source='*'`.
 
-Our new `DataPointSerializer` exhibits the same behavior as the custom field
+Our new `DataPointSerializer` exhibits the same behaviour as the custom field
 approach.
 
-Serializing:
+Serialising:
 
     >>> out_serializer = DataPointSerializer(instance)
     >>> out_serializer.data
     ReturnDict([('label', 'testing'),
                 ('coordinates', OrderedDict([('x', 1), ('y', 2)]))])
 
-Deserializing:
+Deserialising:
 
     >>> in_serializer = DataPointSerializer(data=data)
     >>> in_serializer.is_valid()
@@ -815,8 +784,8 @@ But we also get the built-in validation for free:
                  {'x': ['A valid integer is required.'],
                   'y': ['A valid integer is required.']})])
 
-For this reason, the nested serializer approach would be the first to try. You
-would use the custom field approach when the nested serializer becomes infeasible
+For this reason, the nested serialiser approach would be the first to try. You
+would use the custom field approach when the nested serialiser becomes infeasible
 or overly complex.
 
 
@@ -838,7 +807,7 @@ the [djangorestframework-recursive][djangorestframework-recursive] package provi
 
 ## django-rest-framework-gis
 
-The [django-rest-framework-gis][django-rest-framework-gis] package provides geographic addons for django rest framework like a `GeometryField` field and a GeoJSON serializer.
+The [django-rest-framework-gis][django-rest-framework-gis] package provides geographic addons for django rest framework like a  `GeometryField` field and a GeoJSON serializer.
 
 ## django-rest-framework-hstore
 
@@ -856,5 +825,3 @@ The [django-rest-framework-hstore][django-rest-framework-hstore] package provide
 [django-rest-framework-hstore]: https://github.com/djangonauts/django-rest-framework-hstore
 [django-hstore]: https://github.com/djangonauts/django-hstore
 [python-decimal-rounding-modes]: https://docs.python.org/3/library/decimal.html#rounding-modes
-[django-current-timezone]: https://docs.djangoproject.com/en/stable/topics/i18n/timezones/#default-time-zone-and-current-time-zone
-[django-docs-select-related]: https://docs.djangoproject.com/en/stable/ref/models/querysets/#django.db.models.query.QuerySet.select_related

docs/api-guide/filtering.md

@@ -1,7 +1,4 @@
----
-source:
-    - filters.py
----
+source: filters.py
 
 # Filtering
 
@@ -45,7 +42,7 @@ Another style of filtering might involve restricting the queryset based on some
 
 For example if your URL config contained an entry like this:
 
-    re_path('^purchases/(?P<username>.+)/$', PurchaseList.as_view()),
+    url('^purchases/(?P<username>.+)/$', PurchaseList.as_view()),
 
 You could then write a view that returned a purchase queryset filtered by the username portion of the URL:
 
@@ -75,7 +72,7 @@ We can override `.get_queryset()` to deal with URLs such as `http://example.com/
             by filtering against a `username` query parameter in the URL.
             """
             queryset = Purchase.objects.all()
-            username = self.request.query_params.get('username')
+            username = self.request.query_params.get('username', None)
             if username is not None:
                 queryset = queryset.filter(purchaser__username=username)
             return queryset
@@ -95,7 +92,7 @@ Generic filters can also present themselves as HTML controls in the browsable AP
 The default filter backends may be set globally, using the `DEFAULT_FILTER_BACKENDS` setting. For example.
 
     REST_FRAMEWORK = {
-        'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend']
+        'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
     }
 
 You can also set the filter backends on a per-view, or per-viewset basis,
@@ -109,7 +106,7 @@ using the `GenericAPIView` class-based views.
     class UserListView(generics.ListAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        filter_backends = [django_filters.rest_framework.DjangoFilterBackend]
+        filter_backends = (django_filters.rest_framework.DjangoFilterBackend,)
 
 ## Filtering and object lookups
 
@@ -130,7 +127,7 @@ Note that you can use both an overridden `.get_queryset()` and generic filtering
         """
         model = Product
         serializer_class = ProductSerializer
-        filterset_class = ProductFilter
+        filter_class = ProductFilter
 
         def get_queryset(self):
             user = self.request.user
@@ -142,25 +139,17 @@ Note that you can use both an overridden `.get_queryset()` and generic filtering
 
 ## DjangoFilterBackend
 
-The [`django-filter`][django-filter-docs] library includes a `DjangoFilterBackend` class which
+The `django-filter` library includes a `DjangoFilterBackend` class which
 supports highly customizable field filtering for REST framework.
 
-To use `DjangoFilterBackend`, first install `django-filter`.
+To use `DjangoFilterBackend`, first install `django-filter`. Then add `django_filters` to Django's `INSTALLED_APPS`
 
     pip install django-filter
 
-Then add `'django_filters'` to Django's `INSTALLED_APPS`:
-
-    INSTALLED_APPS = [
-        ...
-        'django_filters',
-        ...
-    ]
-
 You should now either add the filter backend to your settings:
 
     REST_FRAMEWORK = {
-        'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend']
+        'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
     }
 
 Or add the filter backend to an individual View or ViewSet.
@@ -169,15 +158,15 @@ Or add the filter backend to an individual View or ViewSet.
 
     class UserListView(generics.ListAPIView):
         ...
-        filter_backends = [DjangoFilterBackend]
+        filter_backends = (DjangoFilterBackend,)
 
-If all you need is simple equality-based filtering, you can set a `filterset_fields` attribute on the view, or viewset, listing the set of fields you wish to filter against.
+If all you need is simple equality-based filtering, you can set a `filter_fields` attribute on the view, or viewset, listing the set of fields you wish to filter against.
 
     class ProductList(generics.ListAPIView):
         queryset = Product.objects.all()
         serializer_class = ProductSerializer
-        filter_backends = [DjangoFilterBackend]
-        filterset_fields = ['category', 'in_stock']
+        filter_backends = (DjangoFilterBackend,)
+        filter_fields = ('category', 'in_stock')
 
 This will automatically create a `FilterSet` class for the given fields, and will allow you to make requests such as:
 
@@ -198,13 +187,11 @@ When in use, the browsable API will include a `SearchFilter` control:
 
 The `SearchFilter` class will only be applied if the view has a `search_fields` attribute set.  The `search_fields` attribute should be a list of names of text type fields on the model, such as `CharField` or `TextField`.
 
-    from rest_framework import filters
-
     class UserListView(generics.ListAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        filter_backends = [filters.SearchFilter]
-        search_fields = ['username', 'email']
+        filter_backends = (filters.SearchFilter,)
+        search_fields = ('username', 'email')
 
 This will allow the client to filter the items in the list by making queries such as:
 
@@ -212,40 +199,22 @@ This will allow the client to filter the items in the list by making queries suc
 
 You can also perform a related lookup on a ForeignKey or ManyToManyField with the lookup API double-underscore notation:
 
-    search_fields = ['username', 'email', 'profile__profession']
+    search_fields = ('username', 'email', 'profile__profession')
 
-For [JSONField][JSONField] and [HStoreField][HStoreField] fields you can filter based on nested values within the data structure using the same double-underscore notation:
+By default, searches will use case-insensitive partial matches.  The search parameter may contain multiple search terms, which should be whitespace and/or comma separated.  If multiple search terms are used then objects will be returned in the list only if all the provided terms are matched.
 
-    search_fields = ['data__breed', 'data__owner__other_pets__0__name']
+The search behavior may be restricted by prepending various characters to the `search_fields`.
 
-By default, searches will use case-insensitive partial matches. The search parameter may contain multiple search terms, which should be whitespace and/or comma separated. If multiple search terms are used then objects will be returned in the list only if all the provided terms are matched. Searches may contain _quoted phrases_ with spaces, each phrase is considered as a single search term.
-
-
-The search behavior may be specified by prefixing field names in `search_fields` with one of the following characters (which is equivalent to adding `__<lookup>` to the field):
-
-| Prefix | Lookup        |                    |
-| ------ | --------------| ------------------ |
-| `^`    | `istartswith` | Starts-with search.|
-| `=`    | `iexact`      | Exact matches.     |
-| `$`    | `iregex`      | Regex search.      |
-| `@`    | `search`      | Full-text search (Currently only supported Django's [PostgreSQL backend][postgres-search]). |
-| None   | `icontains`   | Contains search (Default).  |
+* '^' Starts-with search.
+* '=' Exact matches.
+* '@' Full-text search.  (Currently only supported Django's MySQL backend.)
+* '$' Regex search.
 
 For example:
 
-    search_fields = ['=username', '=email']
+    search_fields = ('=username', '=email')
 
-By default, the search parameter is named `'search'`, but this may be overridden with the `SEARCH_PARAM` setting.
-
-To dynamically change search fields based on request content, it's possible to subclass the `SearchFilter` and override the `get_search_fields()` function. For example, the following subclass will only search on `title` if the query parameter `title_only` is in the request:
-
-    from rest_framework import filters
-
-    class CustomSearchFilter(filters.SearchFilter):
-        def get_search_fields(self, view, request):
-            if request.query_params.get('title_only'):
-                return ['title']
-            return super().get_search_fields(view, request)
+By default, the search parameter is named `'search`', but this may be overridden with the `SEARCH_PARAM` setting.
 
 For more details, see the [Django documentation][search-django-admin].
 
@@ -257,7 +226,7 @@ The `OrderingFilter` class supports simple query parameter controlled ordering o
 
 ![Ordering Filter](../img/ordering-filter.png)
 
-By default, the query parameter is named `'ordering'`, but this may be overridden with the `ORDERING_PARAM` setting.
+By default, the query parameter is named `'ordering'`, but this may by overridden with the `ORDERING_PARAM` setting.
 
 For example, to order users by username:
 
@@ -273,13 +242,13 @@ Multiple orderings may also be specified:
 
 ### Specifying which fields may be ordered against
 
-It's recommended that you explicitly specify which fields the API should allow in the ordering filter.  You can do this by setting an `ordering_fields` attribute on the view, like so:
+It's recommended that you explicitly specify which fields the API should allowing in the ordering filter.  You can do this by setting an `ordering_fields` attribute on the view, like so:
 
     class UserListView(generics.ListAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        filter_backends = [filters.OrderingFilter]
-        ordering_fields = ['username', 'email']
+        filter_backends = (filters.OrderingFilter,)
+        ordering_fields = ('username', 'email')
 
 This helps prevent unexpected data leakage, such as allowing users to order against a password hash field or other sensitive data.
 
@@ -290,7 +259,7 @@ If you are confident that the queryset being used by the view doesn't contain an
     class BookingsListView(generics.ListAPIView):
         queryset = Booking.objects.all()
         serializer_class = BookingSerializer
-        filter_backends = [filters.OrderingFilter]
+        filter_backends = (filters.OrderingFilter,)
         ordering_fields = '__all__'
 
 ### Specifying a default ordering
@@ -302,14 +271,55 @@ Typically you'd instead control this by setting `order_by` on the initial querys
     class UserListView(generics.ListAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        filter_backends = [filters.OrderingFilter]
-        ordering_fields = ['username', 'email']
-        ordering = ['username']
+        filter_backends = (filters.OrderingFilter,)
+        ordering_fields = ('username', 'email')
+        ordering = ('username',)
 
 The `ordering` attribute may be either a string or a list/tuple of strings.
 
 ---
 
+## DjangoObjectPermissionsFilter
+
+The `DjangoObjectPermissionsFilter` is intended to be used together with the [`django-guardian`][guardian] package, with custom `'view'` permissions added.  The filter will ensure that querysets only returns objects for which the user has the appropriate view permission.
+
+If you're using `DjangoObjectPermissionsFilter`, you'll probably also want to add an appropriate object permissions class, to ensure that users can only operate on instances if they have the appropriate object permissions.  The easiest way to do this is to subclass `DjangoObjectPermissions` and add `'view'` permissions to the `perms_map` attribute.
+
+A complete example using both `DjangoObjectPermissionsFilter` and `DjangoObjectPermissions` might look something like this.
+
+**permissions.py**:
+
+    class CustomObjectPermissions(permissions.DjangoObjectPermissions):
+		"""
+		Similar to `DjangoObjectPermissions`, but adding 'view' permissions.
+		"""
+        perms_map = {
+            'GET': ['%(app_label)s.view_%(model_name)s'],
+            'OPTIONS': ['%(app_label)s.view_%(model_name)s'],
+            'HEAD': ['%(app_label)s.view_%(model_name)s'],
+            'POST': ['%(app_label)s.add_%(model_name)s'],
+            'PUT': ['%(app_label)s.change_%(model_name)s'],
+            'PATCH': ['%(app_label)s.change_%(model_name)s'],
+            'DELETE': ['%(app_label)s.delete_%(model_name)s'],
+        }
+
+**views.py**:
+
+    class EventViewSet(viewsets.ModelViewSet):
+    	"""
+    	Viewset that only lists events if user has 'view' permissions, and only
+    	allows operations on individual events if user has appropriate 'view', 'add',
+    	'change' or 'delete' permissions.
+		"""
+        queryset = Event.objects.all()
+        serializer_class = EventSerializer
+        filter_backends = (filters.DjangoObjectPermissionsFilter,)
+        permission_classes = (myapp.permissions.CustomObjectPermissions,)
+
+For more information on adding `'view'` permissions for models, see the [relevant section][view-permissions] of the `django-guardian` documentation, and [this blogpost][view-permissions-blogpost].
+
+---
+
 # Custom generic filtering
 
 You can also provide your own generic filtering backend, or write an installable app for other developers to use.
@@ -339,6 +349,15 @@ Generic filters may also present an interface in the browsable API. To do so you
 
 The method should return a rendered HTML string.
 
+## Pagination & schemas
+
+You can also make the filter controls available to the schema autogeneration
+that REST framework provides, by implementing a `get_schema_fields()` method. This method should have the following signature:
+
+`get_schema_fields(self, view)`
+
+The method should return a list of `coreapi.Field` instances.
+
 # Third party packages
 
 The following third party packages provide additional filter implementations.
@@ -362,11 +381,11 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter]
 [cite]: https://docs.djangoproject.com/en/stable/topics/db/queries/#retrieving-specific-objects-with-filters
 [django-filter-docs]: https://django-filter.readthedocs.io/en/latest/index.html
 [django-filter-drf-docs]: https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html
+[guardian]: https://django-guardian.readthedocs.io/
+[view-permissions]: https://django-guardian.readthedocs.io/en/latest/userguide/assign.html
+[view-permissions-blogpost]: https://blog.nyaruka.com/adding-a-view-permission-to-django-models
 [search-django-admin]: https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields
 [django-rest-framework-filters]: https://github.com/philipn/django-rest-framework-filters
 [django-rest-framework-word-search-filter]: https://github.com/trollknurr/django-rest-framework-word-search-filter
 [django-url-filter]: https://github.com/miki725/django-url-filter
 [drf-url-filter]: https://github.com/manjitkumar/drf-url-filters
-[HStoreField]: https://docs.djangoproject.com/en/stable/ref/contrib/postgres/fields/#hstorefield
-[JSONField]: https://docs.djangoproject.com/en/stable/ref/models/fields/#django.db.models.JSONField
-[postgres-search]: https://docs.djangoproject.com/en/stable/ref/contrib/postgres/search/

docs/api-guide/format-suffixes.md

@@ -1,7 +1,4 @@
----
-source:
-    - urlpatterns.py
----
+source: urlpatterns.py
 
 # Format suffixes
 
@@ -23,8 +20,8 @@ Returns a URL pattern list which includes format suffix patterns appended to eac
 Arguments:
 
 * **urlpatterns**: Required.  A URL pattern list.
-* **suffix_required**: Optional.  A boolean indicating if suffixes in the URLs should be optional or mandatory.  Defaults to `False`, meaning that suffixes are optional by default.
-* **allowed**: Optional.  A list or tuple of valid format suffixes.  If not provided, a wildcard format suffix pattern will be used.
+* **suffix_required**:  Optional.  A boolean indicating if suffixes in the URLs should be optional or mandatory.  Defaults to `False`, meaning that suffixes are optional by default.
+* **allowed**:  Optional.  A list or tuple of valid format suffixes.  If not provided, a wildcard format suffix pattern will be used.
 
 Example:
 
@@ -32,16 +29,16 @@ Example:
     from blog import views
 
     urlpatterns = [
-        path('', views.apt_root),
-        path('comments/', views.comment_list),
-        path('comments/<int:pk>/', views.comment_detail)
+        url(r'^/$', views.apt_root),
+        url(r'^comments/$', views.comment_list),
+        url(r'^comments/(?P<pk>[0-9]+)/$', views.comment_detail)
     ]
 
     urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'html'])
 
 When using `format_suffix_patterns`, you must make sure to add the `'format'` keyword argument to the corresponding views.  For example:
 
-    @api_view(['GET', 'POST'])
+    @api_view(('GET', 'POST'))
     def comment_list(request, format=None):
         # do stuff...
 
@@ -62,7 +59,7 @@ Also note that `format_suffix_patterns` does not support descending into `includ
 
 If using the `i18n_patterns` function provided by Django, as well as `format_suffix_patterns` you should make sure that the `i18n_patterns` function is applied as the final, or outermost function. For example:
 
-    urlpatterns = [
+    url patterns = [
         …
     ]
 
@@ -93,4 +90,4 @@ It is actually a misconception.  For example, take the following quote from Roy
 The quote does not mention Accept headers, but it does make it clear that format suffixes should be considered an acceptable pattern.
 
 [cite]: http://tech.groups.yahoo.com/group/rest-discuss/message/5857
-[cite2]: https://groups.yahoo.com/neo/groups/rest-discuss/conversations/topics/14844
+[cite2]: http://tech.groups.yahoo.com/group/rest-discuss/message/14844

docs/api-guide/generic-views.md

@@ -1,8 +1,5 @@
----
-source:
-    - mixins.py
-    - generics.py
----
+source: mixins.py
+        generics.py
 
 # Generic views
 
@@ -28,14 +25,14 @@ Typically when using the generic views, you'll override the view, and set severa
     class UserList(generics.ListCreateAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        permission_classes = [IsAdminUser]
+        permission_classes = (IsAdminUser,)
 
 For more complex cases you might also want to override various methods on the view class.  For example.
 
     class UserList(generics.ListCreateAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        permission_classes = [IsAdminUser]
+        permission_classes = (IsAdminUser,)
 
         def list(self, request):
             # Note the use of `get_queryset()` instead of `self.queryset`
@@ -45,7 +42,7 @@ For more complex cases you might also want to override various methods on the vi
 
 For very simple cases you might want to pass through any class attributes using the `.as_view()` method.  For example, your URLconf might include something like the following entry:
 
-    path('users/', ListCreateAPIView.as_view(queryset=User.objects.all(), serializer_class=UserSerializer), name='user-list')
+    url(r'^/users/', ListCreateAPIView.as_view(queryset=User.objects.all(), serializer_class=UserSerializer), name='user-list')
 
 ---
 
@@ -65,7 +62,7 @@ The following attributes control the basic view behavior.
 
 * `queryset` - The queryset that should be used for returning objects from this view.  Typically, you must either set this attribute, or override the `get_queryset()` method. If you are overriding a view method, it is important that you call `get_queryset()` instead of accessing this property directly, as `queryset` will get evaluated once, and those results will be cached for all subsequent requests.
 * `serializer_class` - The serializer class that should be used for validating and deserializing input, and for serializing output.  Typically, you must either set this attribute, or override the `get_serializer_class()` method.
-* `lookup_field` - The model field that should be used for performing object lookup of individual model instances.  Defaults to `'pk'`.  Note that when using hyperlinked APIs you'll need to ensure that *both* the API views *and* the serializer classes set the lookup fields if you need to use a custom value.
+* `lookup_field` - The model field that should be used to for performing object lookup of individual model instances.  Defaults to `'pk'`.  Note that when using hyperlinked APIs you'll need to ensure that *both* the API views *and* the serializer classes set the lookup fields if you need to use a custom value.
 * `lookup_url_kwarg` - The URL keyword argument that should be used for object lookup.  The URL conf should include a keyword argument corresponding to this value.  If unset this defaults to using the same value as `lookup_field`.
 
 **Pagination**:
@@ -96,12 +93,6 @@ For example:
         user = self.request.user
         return user.accounts.all()
 
----
-
-**Note:** If the `serializer_class` used in the generic view spans orm relations, leading to an n+1 problem, you could optimize your queryset in this method using `select_related` and `prefetch_related`. To get more information about n+1 problem and use cases of the mentioned methods refer to related section in [django documentation][django-docs-select-related].
-
----
-
 #### `get_object(self)`
 
 Returns an object instance that should be used for detail views.  Defaults to using the `lookup_field` parameter to filter the base queryset.
@@ -129,12 +120,12 @@ Given a queryset, filter it with whichever filter backends are in use, returning
 For example:
 
     def filter_queryset(self, queryset):
-        filter_backends = [CategoryFilter]
+        filter_backends = (CategoryFilter,)
 
         if 'geo_route' in self.request.query_params:
-            filter_backends = [GeoRouteFilter, CategoryFilter]
+            filter_backends = (GeoRouteFilter, CategoryFilter)
         elif 'geo_point' in self.request.query_params:
-            filter_backends = [GeoPointFilter, CategoryFilter]
+            filter_backends = (GeoPointFilter, CategoryFilter)
 
         for backend in list(filter_backends):
             queryset = backend().filter_queryset(self.request, queryset, view=self)
@@ -181,6 +172,8 @@ You can also use these hooks to provide additional validation, by raising a `Val
             raise ValidationError('You have already signed up')
         serializer.save(user=self.request.user)
 
+**Note**: These methods replace the old-style version 2.x `pre_save`, `post_save`, `pre_delete` and `post_delete` methods, which are no longer available.
+
 **Other methods**:
 
 You won't typically need to override the following methods, although you might need to call into them if you're writing custom views using `GenericAPIView`.
@@ -217,7 +210,7 @@ If the request data provided for creating the object was invalid, a `400 Bad Req
 
 Provides a `.retrieve(request, *args, **kwargs)` method, that implements returning an existing model instance in a response.
 
-If an object can be retrieved this returns a `200 OK` response, with a serialized representation of the object as the body of the response.  Otherwise, it will return a `404 Not Found`.
+If an object can be retrieved this returns a `200 OK` response, with a serialized representation of the object as the body of the response.  Otherwise it will return a `404 Not Found`.
 
 ## UpdateModelMixin
 
@@ -325,7 +318,7 @@ Often you'll want to use the existing generic views, but use some slightly custo
 
 For example, if you need to lookup objects based on multiple fields in the URL conf, you could create a mixin class like the following:
 
-    class MultipleFieldLookupMixin:
+    class MultipleFieldLookupMixin(object):
         """
         Apply this mixin to any view or viewset to get multiple field filtering
         based on a `lookup_fields` attribute, instead of the default single field filtering.
@@ -335,7 +328,7 @@ For example, if you need to lookup objects based on multiple fields in the URL c
             queryset = self.filter_queryset(queryset)  # Apply any filter backends
             filter = {}
             for field in self.lookup_fields:
-                if self.kwargs.get(field): # Ignore empty fields.
+                if self.kwargs[field]: # Ignore empty fields.
                     filter[field] = self.kwargs[field]
             obj = get_object_or_404(queryset, **filter)  # Lookup the object
             self.check_object_permissions(self.request, obj)
@@ -346,7 +339,7 @@ You can then simply apply this mixin to a view or viewset anytime you need to ap
     class RetrieveUserView(MultipleFieldLookupMixin, generics.RetrieveAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-        lookup_fields = ['account', 'username']
+        lookup_fields = ('account', 'username')
 
 Using custom mixins is a good option if you have custom behavior that needs to be used.
 
@@ -382,6 +375,10 @@ If you need to generic PUT-as-create behavior you may want to include something
 
 The following third party packages provide additional generic view implementations.
 
+## Django REST Framework bulk
+
+The [django-rest-framework-bulk package][django-rest-framework-bulk] implements generic view mixins as well as some common concrete generic views to allow to apply bulk operations via API requests.
+
 ## Django Rest Multiple Models
 
 [Django Rest Multiple Models][django-rest-multiple-models] provides a generic view (and mixin) for sending multiple serialized models and/or querysets via a single API request.
@@ -394,5 +391,5 @@ The following third party packages provide additional generic view implementatio
 [RetrieveModelMixin]: #retrievemodelmixin
 [UpdateModelMixin]: #updatemodelmixin
 [DestroyModelMixin]: #destroymodelmixin
+[django-rest-framework-bulk]: https://github.com/miki725/django-rest-framework-bulk
 [django-rest-multiple-models]: https://github.com/MattBroach/DjangoRestMultipleModels
-[django-docs-select-related]: https://docs.djangoproject.com/en/stable/ref/models/querysets/#django.db.models.query.QuerySet.select_related

docs/api-guide/metadata.md

@@ -1,7 +1,4 @@
----
-source:
-    - metadata.py
----
+source: metadata.py
 
 # Metadata
 
@@ -71,7 +68,7 @@ If you have specific requirements for creating schema endpoints that are accesse
 For example, the following additional route could be used on a viewset to provide a linkable schema endpoint.
 
     @action(methods=['GET'], detail=False)
-    def api_schema(self, request):
+    def schema(self, request):
         meta = self.metadata_class()
         data = meta.determine_metadata(request, self)
         return Response(data)
@@ -120,5 +117,5 @@ If you wish to do so, it also provides an exporter that can export those schema
 
 [cite]: https://tools.ietf.org/html/rfc7231#section-4.3.7
 [no-options]: https://www.mnot.net/blog/2012/10/29/NO_OPTIONS
-[json-schema]: https://json-schema.org/
+[json-schema]: http://json-schema.org/
 [drf-schema-adapter]: https://github.com/drf-forms/drf-schema-adapter

docs/api-guide/pagination.md

@@ -1,7 +1,4 @@
----
-source:
-    - pagination.py
----
+source: pagination.py
 
 # Pagination
 
@@ -49,7 +46,7 @@ If you want to modify particular aspects of the pagination style, you'll want to
         page_size_query_param = 'page_size'
         max_page_size = 1000
 
-You can then apply your new style to a view using the `pagination_class` attribute:
+You can then apply your new style to a view using the `.pagination_class` attribute:
 
     class BillingRecordsView(generics.ListAPIView):
         queryset = Billing.objects.all()
@@ -78,7 +75,7 @@ This pagination style accepts a single number page number in the request query p
 
     HTTP 200 OK
     {
-        "count": 1023,
+        "count": 1023
         "next": "https://api.example.org/accounts/?page=5",
         "previous": "https://api.example.org/accounts/?page=3",
         "results": [
@@ -126,7 +123,7 @@ This pagination style mirrors the syntax used when looking up multiple database
 
     HTTP 200 OK
     {
-        "count": 1023,
+        "count": 1023
         "next": "https://api.example.org/accounts/?limit=100&offset=500",
         "previous": "https://api.example.org/accounts/?limit=100&offset=300",
         "results": [
@@ -218,16 +215,16 @@ To set these attributes you should override the `CursorPagination` class, and th
 
 # Custom pagination styles
 
-To create a custom pagination serializer class, you should inherit the subclass `pagination.BasePagination`, override the `paginate_queryset(self, queryset, request, view=None)`, and `get_paginated_response(self, data)` methods:
+To create a custom pagination serializer class you should subclass `pagination.BasePagination` and override the `paginate_queryset(self, queryset, request, view=None)` and `get_paginated_response(self, data)` methods:
 
-* The `paginate_queryset` method is passed to the initial queryset and should return an iterable object. That object contains only the data in the requested page.
-* The `get_paginated_response` method is passed to the serialized page data and should return a `Response` instance.
+* The `paginate_queryset` method is passed the initial queryset and should return an iterable object that contains only the data in the requested page.
+* The `get_paginated_response` method is passed the serialized page data and should return a `Response` instance.
 
 Note that the `paginate_queryset` method may set state on the pagination instance, that may later be used by the `get_paginated_response` method.
 
 ## Example
 
-Suppose we want to replace the default pagination output style with a modified format that includes the next and previous links under in a nested 'links' key. We could specify a custom pagination class like so:
+Suppose we want to replace the default pagination output style with a modified format that  includes the next and previous links under in a nested 'links' key. We could specify a custom pagination class like so:
 
     class CustomPagination(pagination.PageNumberPagination):
         def get_paginated_response(self, data):
@@ -240,7 +237,7 @@ Suppose we want to replace the default pagination output style with a modified f
                 'results': data
             })
 
-We'd then need to set up the custom class in our configuration:
+We'd then need to setup the custom class in our configuration:
 
     REST_FRAMEWORK = {
         'DEFAULT_PAGINATION_CLASS': 'my_project.apps.core.pagination.CustomPagination',
@@ -260,9 +257,20 @@ To have your custom pagination class be used by default, use the `DEFAULT_PAGINA
 
 API responses for list endpoints will now include a `Link` header, instead of including the pagination links as part of the body of the response, for example:
 
+## Pagination & schemas
+
+You can also make the pagination controls available to the schema autogeneration
+that REST framework provides, by implementing a `get_schema_fields()` method. This method should have the following signature:
+
+`get_schema_fields(self, view)`
+
+The method should return a list of `coreapi.Field` instances.
+
+---
+
 ![Link Header][link-header]
 
-*A custom pagination style, using the 'Link' header*
+*A custom pagination style, using the 'Link' header'*
 
 ---
 
@@ -303,7 +311,7 @@ The [`drf-proxy-pagination` package][drf-proxy-pagination] includes a `ProxyPagi
 
 ## link-header-pagination
 
-The [`django-rest-framework-link-header-pagination` package][drf-link-header-pagination] includes a `LinkHeaderPagination` class which provides pagination via an HTTP `Link` header as described in [GitHub REST API documentation][github-traversing-with-pagination].
+The [`django-rest-framework-link-header-pagination` package][drf-link-header-pagination] includes a `LinkHeaderPagination` class which provides pagination via an HTTP `Link` header as desribed in [Github's developer documentation](github-link-pagination).
 
 [cite]: https://docs.djangoproject.com/en/stable/topics/pagination/
 [link-header]: ../img/link-header-pagination.png
@@ -311,6 +319,5 @@ The [`django-rest-framework-link-header-pagination` package][drf-link-header-pag
 [paginate-by-max-mixin]: https://chibisov.github.io/drf-extensions/docs/#paginatebymaxmixin
 [drf-proxy-pagination]: https://github.com/tuffnatty/drf-proxy-pagination
 [drf-link-header-pagination]: https://github.com/tbeadle/django-rest-framework-link-header-pagination
-[disqus-cursor-api]: https://cra.mr/2011/03/08/building-cursors-for-the-disqus-api
+[disqus-cursor-api]: http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api
 [float_cursor_pagination_example]: https://gist.github.com/keturn/8bc88525a183fd41c73ffb729b8865be#file-fpcursorpagination-py
-[github-traversing-with-pagination]: https://docs.github.com/en/rest/guides/traversing-with-pagination

docs/api-guide/parsers.md

@@ -1,7 +1,4 @@
----
-source:
-    - parsers.py
----
+source: parsers.py
 
 # Parsers
 
@@ -11,11 +8,11 @@ sending more complex data than simple forms
 >
 > — Malcom Tredinnick, [Django developers group][cite]
 
-REST framework includes a number of built-in Parser classes, that allow you to accept requests with various media types.  There is also support for defining your own custom parsers, which gives you the flexibility to design the media types that your API accepts.
+REST framework includes a number of built in Parser classes, that allow you to accept requests with various media types.  There is also support for defining your own custom parsers, which gives you the flexibility to design the media types that your API accepts.
 
 ## How the parser is determined
 
-The set of valid parsers for a view is always defined as a list of classes.  When `request.data` is accessed, REST framework will examine the `Content-Type` header on the incoming request, and determine which parser to use to parse the request content.
+The set of valid parsers for a view is always defined as a list of classes.  When  `request.data` is accessed, REST framework will examine the `Content-Type` header on the incoming request, and determine which parser to use to parse the request content.
 
 ---
 
@@ -32,9 +29,9 @@ As an example, if you are sending `json` encoded data using jQuery with the [.aj
 The default set of parsers may be set globally, using the `DEFAULT_PARSER_CLASSES` setting. For example, the following settings would allow only requests with `JSON` content, instead of the default of JSON or form data.
 
     REST_FRAMEWORK = {
-        'DEFAULT_PARSER_CLASSES': [
+        'DEFAULT_PARSER_CLASSES': (
             'rest_framework.parsers.JSONParser',
-        ]
+        )
     }
 
 You can also set the parsers used for an individual view, or viewset,
@@ -48,7 +45,7 @@ using the `APIView` class-based views.
         """
         A view that can accept POST requests with JSON content.
         """
-        parser_classes = [JSONParser]
+        parser_classes = (JSONParser,)
 
         def post(self, request, format=None):
             return Response({'received data': request.data})
@@ -60,7 +57,7 @@ Or, if you're using the `@api_view` decorator with function based views.
     from rest_framework.parsers import JSONParser
 
     @api_view(['POST'])
-    @parser_classes([JSONParser])
+    @parser_classes((JSONParser,))
     def example_view(request, format=None):
         """
         A view that can accept POST requests with JSON content.
@@ -73,7 +70,7 @@ Or, if you're using the `@api_view` decorator with function based views.
 
 ## JSONParser
 
-Parses `JSON` request content. `request.data` will be populated with a dictionary of data.
+Parses `JSON` request content.
 
 **.media_type**: `application/json`
 
@@ -87,7 +84,7 @@ You will typically want to use both `FormParser` and `MultiPartParser` together
 
 ## MultiPartParser
 
-Parses multipart HTML form content, which supports file uploads. `request.data` and `request.FILES` will be populated with a `QueryDict` and `MultiValueDict` respectively.
+Parses multipart HTML form content, which supports file uploads.  Both `request.data` will be populated with a `QueryDict`.
 
 You will typically want to use both `FormParser` and `MultiPartParser` together in order to fully support HTML form data.
 
@@ -105,7 +102,7 @@ If it is called without a `filename` URL keyword argument, then the client must
 
 ##### Notes:
 
-* The `FileUploadParser` is for usage with native clients that can upload the file as a raw data request.  For web-based uploads, or for native clients with multipart upload support, you should use the `MultiPartParser` instead.
+* The `FileUploadParser` is for usage with native clients that can upload the file as a raw data request.  For web-based uploads, or for native clients with multipart upload support, you should use the `MultiPartParser` parser instead.
 * Since this parser's `media_type` matches any content type, `FileUploadParser` should generally be the only parser set on an API view.
 * `FileUploadParser` respects Django's standard `FILE_UPLOAD_HANDLERS` setting, and the `request.upload_handlers` attribute.  See the [Django documentation][upload-handlers] for more details.
 
@@ -113,7 +110,7 @@ If it is called without a `filename` URL keyword argument, then the client must
 
     # views.py
     class FileUploadView(views.APIView):
-        parser_classes = [FileUploadParser]
+        parser_classes = (FileUploadParser,)
 
         def put(self, request, filename, format=None):
             file_obj = request.data['file']
@@ -125,7 +122,7 @@ If it is called without a `filename` URL keyword argument, then the client must
     # urls.py
     urlpatterns = [
         # ...
-        re_path(r'^upload/(?P<filename>[^/]+)$', FileUploadView.as_view())
+        url(r'^upload/(?P<filename>[^/]+)$', FileUploadView.as_view())
     ]
 
 ---
@@ -189,12 +186,12 @@ Install using pip.
 Modify your REST framework settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_PARSER_CLASSES': [
+        'DEFAULT_PARSER_CLASSES': (
             'rest_framework_yaml.parsers.YAMLParser',
-        ],
-        'DEFAULT_RENDERER_CLASSES': [
+        ),
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework_yaml.renderers.YAMLRenderer',
-        ],
+        ),
     }
 
 ## XML
@@ -210,12 +207,12 @@ Install using pip.
 Modify your REST framework settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_PARSER_CLASSES': [
+        'DEFAULT_PARSER_CLASSES': (
             'rest_framework_xml.parsers.XMLParser',
-        ],
-        'DEFAULT_RENDERER_CLASSES': [
+        ),
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework_xml.renderers.XMLRenderer',
-        ],
+        ),
     }
 
 ## MessagePack

docs/api-guide/permissions.md

@@ -1,7 +1,4 @@
----
-source:
-    - permissions.py
----
+source: permissions.py
 
 # Permissions
 
@@ -13,9 +10,9 @@ Together with [authentication] and [throttling], permissions determine whether a
 
 Permission checks are always run at the very start of the view, before any other code is allowed to proceed.  Permission checks will typically use the authentication information in the `request.user` and `request.auth` properties to determine if the incoming request should be permitted.
 
-Permissions are used to grant or deny access for different classes of users to different parts of the API.
+Permissions are used to grant or deny access different classes of users to different parts of the API.
 
-The simplest style of permission would be to allow access to any authenticated user, and deny access to any unauthenticated user. This corresponds to the `IsAuthenticated` class in REST framework.
+The simplest style of permission would be to allow access to any authenticated user, and deny access to any unauthenticated user. This corresponds the `IsAuthenticated` class in REST framework.
 
 A slightly less strict style of permission would be to allow full access to authenticated users, but allow read-only access to unauthenticated users. This corresponds to the `IsAuthenticatedOrReadOnly` class in REST framework.
 
@@ -24,9 +21,9 @@ A slightly less strict style of permission would be to allow full access to auth
 Permissions in REST framework are always defined as a list of permission classes.
 
 Before running the main body of the view each permission in the list is checked.
-If any permission check fails, an `exceptions.PermissionDenied` or `exceptions.NotAuthenticated` exception will be raised, and the main body of the view will not run.
+If any permission check fails an `exceptions.PermissionDenied` or `exceptions.NotAuthenticated` exception will be raised, and the main body of the view will not run.
 
-When the permission checks fail, either a "403 Forbidden" or a "401 Unauthorized" response will be returned, according to the following rules:
+When the permissions checks fail either a "403 Forbidden" or a "401 Unauthorized" response will be returned, according to the following rules:
 
 * The request was successfully authenticated, but permission was denied. *— An HTTP 403 Forbidden response will be returned.*
 * The request was not successfully authenticated, and the highest priority authentication class *does not* use `WWW-Authenticate` headers. *— An HTTP 403 Forbidden response will be returned.*
@@ -51,42 +48,27 @@ For example:
         self.check_object_permissions(self.request, obj)
         return obj
 
----
-
-**Note**: With the exception of `DjangoObjectPermissions`, the provided
-permission classes in `rest_framework.permissions` **do not** implement the
-methods necessary to check object permissions.
-
-If you wish to use the provided permission classes in order to check object
-permissions, **you must** subclass them and implement the
-`has_object_permission()` method described in the [_Custom
-permissions_](#custom-permissions) section (below).
-
----
-
 #### Limitations of object level permissions
 
 For performance reasons the generic views will not automatically apply object level permissions to each instance in a queryset when returning a list of objects.
 
 Often when you're using object level permissions you'll also want to [filter the queryset][filtering] appropriately, to ensure that users only have visibility onto instances that they are permitted to view.
 
-Because the `get_object()` method is not called, object level permissions from the `has_object_permission()` method **are not applied** when creating objects. In order to restrict object creation you need to implement the permission check either in your Serializer class or override the `perform_create()` method of your ViewSet class.
-
 ## Setting the permission policy
 
 The default permission policy may be set globally, using the `DEFAULT_PERMISSION_CLASSES` setting.  For example.
 
     REST_FRAMEWORK = {
-        'DEFAULT_PERMISSION_CLASSES': [
+        'DEFAULT_PERMISSION_CLASSES': (
             'rest_framework.permissions.IsAuthenticated',
-        ]
+        )
     }
 
 If not specified, this setting defaults to allowing unrestricted access:
 
-    'DEFAULT_PERMISSION_CLASSES': [
+    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.AllowAny',
-    ]
+    )
 
 You can also set the authentication policy on a per-view, or per-viewset basis,
 using the `APIView` class-based views.
@@ -96,7 +78,7 @@ using the `APIView` class-based views.
     from rest_framework.views import APIView
 
     class ExampleView(APIView):
-        permission_classes = [IsAuthenticated]
+        permission_classes = (IsAuthenticated,)
 
         def get(self, request, format=None):
             content = {
@@ -111,35 +93,14 @@ Or, if you're using the `@api_view` decorator with function based views.
     from rest_framework.response import Response
 
     @api_view(['GET'])
-    @permission_classes([IsAuthenticated])
+    @permission_classes((IsAuthenticated, ))
     def example_view(request, format=None):
         content = {
             'status': 'request was permitted'
         }
         return Response(content)
 
-__Note:__ when you set new permission classes via the class attribute or decorators you're telling the view to ignore the default list set in the __settings.py__ file.
-
-Provided they inherit from `rest_framework.permissions.BasePermission`, permissions can be composed using standard Python bitwise operators. For example, `IsAuthenticatedOrReadOnly` could be written:
-
-    from rest_framework.permissions import BasePermission, IsAuthenticated, SAFE_METHODS
-    from rest_framework.response import Response
-    from rest_framework.views import APIView
-
-    class ReadOnly(BasePermission):
-        def has_permission(self, request, view):
-            return request.method in SAFE_METHODS
-
-    class ExampleView(APIView):
-        permission_classes = [IsAuthenticated|ReadOnly]
-
-        def get(self, request, format=None):
-            content = {
-                'status': 'request was permitted'
-            }
-            return Response(content)
-
-__Note:__ it supports & (and), | (or) and ~ (not).
+__Note:__ when you set new permission classes through class attribute or decorators you're telling the view to ignore the default list set over the __settings.py__ file.
 
 ---
 
@@ -165,22 +126,28 @@ This permission is suitable if you want your API to only be accessible to a subs
 
 ## IsAuthenticatedOrReadOnly
 
-The `IsAuthenticatedOrReadOnly` will allow authenticated users to perform any request.  Requests for unauthenticated users will only be permitted if the request method is one of the "safe" methods; `GET`, `HEAD` or `OPTIONS`.
+The `IsAuthenticatedOrReadOnly` will allow authenticated users to perform any request.  Requests for unauthorised users will only be permitted if the request method is one of the "safe" methods; `GET`, `HEAD` or `OPTIONS`.
 
 This permission is suitable if you want to your API to allow read permissions to anonymous users, and only allow write permissions to authenticated users.
 
 ## DjangoModelPermissions
 
-This permission class ties into Django's standard `django.contrib.auth` [model permissions][contribauth].  This permission must only be applied to views that have a `.queryset` property or `get_queryset()` method. Authorization will only be granted if the user *is authenticated* and has the *relevant model permissions* assigned. The appropriate model is determined by checking `get_queryset().model` or `queryset.model`.
+This permission class ties into Django's standard `django.contrib.auth` [model permissions][contribauth].  This permission must only be applied to views that have a `.queryset` property set. Authorization will only be granted if the user *is authenticated* and has the *relevant model permissions* assigned.
 
 * `POST` requests require the user to have the `add` permission on the model.
 * `PUT` and `PATCH` requests require the user to have the `change` permission on the model.
 * `DELETE` requests require the user to have the `delete` permission on the model.
 
-The default behavior can also be overridden to support custom model permissions.  For example, you might want to include a `view` model permission for `GET` requests.
+The default behaviour can also be overridden to support custom model permissions.  For example, you might want to include a `view` model permission for `GET` requests.
 
 To use custom model permissions, override `DjangoModelPermissions` and set the `.perms_map` property.  Refer to the source code for details.
 
+#### Using with views that do not include a `queryset` attribute.
+
+If you're using this permission with a view that uses an overridden `get_queryset()` method there may not be a `queryset` attribute on the view. In this case we suggest also marking the view with a sentinel queryset, so that this class can determine the required permissions. For example:
+
+    queryset = User.objects.none()  # Required for DjangoModelPermissions
+
 ## DjangoModelPermissionsOrAnonReadOnly
 
 Similar to `DjangoModelPermissions`, but also allows unauthenticated users to have read-only access to the API.
@@ -201,7 +168,9 @@ As with `DjangoModelPermissions` you can use custom model permissions by overrid
 
 ---
 
-**Note**: If you need object level `view` permissions for `GET`, `HEAD` and `OPTIONS` requests and are using django-guardian for your object-level permissions backend, you'll want to consider using the `DjangoObjectPermissionsFilter` class provided by the [`djangorestframework-guardian` package][django-rest-framework-guardian]. It ensures that list endpoints only return results including objects for which the user has appropriate view permissions.
+**Note**: If you need object level `view` permissions for `GET`, `HEAD` and `OPTIONS` requests, you'll want to consider also adding the `DjangoObjectPermissionsFilter` class to ensure that list endpoints only return results including objects for which the user has appropriate view permissions.
+
+---
 
 ---
 
@@ -227,7 +196,7 @@ If you need to test if a request is a read operation or a write operation, you s
 
 ---
 
-Custom permissions will raise a `PermissionDenied` exception if the test fails. To change the error message associated with the exception, implement a `message` attribute directly on your custom permission. Otherwise the `default_detail` attribute from `PermissionDenied` will be used. Similarly, to change the code identifier associated with the exception, implement a `code` attribute directly on your custom permission - otherwise the `default_code` attribute from `PermissionDenied` will be used.
+Custom permissions will raise a `PermissionDenied` exception if the test fails. To change the error message associated with the exception, implement a `message` attribute directly on your custom permission. Otherwise the `default_detail` attribute from `PermissionDenied` will be used.
 
     from rest_framework import permissions
 
@@ -239,19 +208,19 @@ Custom permissions will raise a `PermissionDenied` exception if the test fails.
 
 ## Examples
 
-The following is an example of a permission class that checks the incoming request's IP address against a blocklist, and denies the request if the IP has been blocked.
+The following is an example of a permission class that checks the incoming request's IP address against a blacklist, and denies the request if the IP has been blacklisted.
 
     from rest_framework import permissions
 
-    class BlocklistPermission(permissions.BasePermission):
+    class BlacklistPermission(permissions.BasePermission):
         """
-        Global permission check for blocked IPs.
+        Global permission check for blacklisted IPs.
         """
 
         def has_permission(self, request, view):
             ip_addr = request.META['REMOTE_ADDR']
-            blocked = Blocklist.objects.filter(ip_addr=ip_addr).exists()
-            return not blocked
+            blacklisted = Blacklist.objects.filter(ip_addr=ip_addr).exists()
+            return not blacklisted
 
 As well as global permissions, that are run against all incoming requests, you can also create object-level permissions, that are only run against operations that affect a particular object instance.  For example:
 
@@ -274,47 +243,19 @@ Note that the generic views will check the appropriate object level permissions,
 
 Also note that the generic views will only check the object-level permissions for views that retrieve a single model instance.  If you require object-level filtering of list views, you'll need to filter the queryset separately.  See the [filtering documentation][filtering] for more details.
 
-# Overview of access restriction methods
-
-REST framework offers three different methods to customize access restrictions on a case-by-case basis. These apply in different scenarios and have different effects and limitations.
-
- * `queryset`/`get_queryset()`: Limits the general visibility of existing objects from the database. The queryset limits which objects will be listed and which objects can be modified or deleted. The `get_queryset()` method can apply different querysets based on the current action.
- * `permission_classes`/`get_permissions()`: General permission checks based on the current action, request and targeted object. Object level permissions can only be applied to retrieve, modify and deletion actions. Permission checks for list and create will be applied to the entire object type. (In case of list: subject to restrictions in the queryset.)
- * `serializer_class`/`get_serializer()`: Instance level restrictions that apply to all objects on input and output. The serializer may have access to the request context. The `get_serializer()` method can apply different serializers based on the current action.
-
-The following table lists the access restriction methods and the level of control they offer over which actions.
-
-|                                    | `queryset` | `permission_classes` | `serializer_class` |
-|------------------------------------|------------|----------------------|--------------------|
-| Action: list                       | global     | global               | object-level*      |
-| Action: create                     | no         | global               | object-level       |
-| Action: retrieve                   | global     | object-level         | object-level       |
-| Action: update                     | global     | object-level         | object-level       |
-| Action: partial_update             | global     | object-level         | object-level       |
-| Action: destroy                    | global     | object-level         | no                 |
-| Can reference action in decision   | no**       | yes                  | no**               |
-| Can reference request in decision  | no**       | yes                  | yes                |
-
- \* A Serializer class should not raise PermissionDenied in a list action, or the entire list would not be returned. <br>
- \** The `get_*()` methods have access to the current view and can return different Serializer or QuerySet instances based on the request or action.
-
 ---
 
 # Third party packages
 
 The following third party packages are also available.
 
-## DRF - Access Policy
-
-The [Django REST - Access Policy][drf-access-policy] package provides a way to define complex access rules in declarative policy classes that are attached to view sets or function-based views. The policies are defined in JSON in a format similar to AWS' Identity & Access Management policies. 
-
 ## Composed Permissions
 
 The [Composed Permissions][composed-permissions] package provides a simple way to define complex and multi-depth (with logic operators) permission objects, using small and reusable components.
 
 ## REST Condition
 
-The [REST Condition][rest-condition] package is another extension for building complex permissions in a simple and convenient way. The extension allows you to combine permissions with logical operators.
+The [REST Condition][rest-condition] package is another extension for building complex permissions in a simple and convenient way.  The extension allows you to combine permissions with logical operators.
 
 ## DRY Rest Permissions
 
@@ -324,23 +265,14 @@ The [DRY Rest Permissions][dry-rest-permissions] package provides the ability to
 
 The [Django Rest Framework Roles][django-rest-framework-roles] package makes it easier to parameterize your API over multiple types of users.
 
-## Rest Framework Roles
+## Django Rest Framework API Key
 
-The [Rest Framework Roles][rest-framework-roles] makes it super easy to protect views based on roles. Most importantly allows you to decouple accessibility logic from models and views in a clean human-readable way.
-
-## Django REST Framework API Key
-
-The [Django REST Framework API Key][djangorestframework-api-key] package provides permissions classes, models and helpers to add API key authorization to your API. It can be used to authorize internal or third-party backends and services (i.e. _machines_) which do not have a user account. API keys are stored securely using Django's password hashing infrastructure, and they can be viewed, edited and revoked at anytime in the Django admin.
+The [Django Rest Framework API Key][django-rest-framework-api-key] package allows you to ensure that every request made to the server requires an API key header. You can generate one from the django admin interface.
 
 ## Django Rest Framework Role Filters
 
 The [Django Rest Framework Role Filters][django-rest-framework-role-filters] package provides simple filtering over multiple types of roles.
 
-## Django Rest Framework PSQ
-
-The [Django Rest Framework PSQ][drf-psq] package is an extension that gives support for having action-based **permission_classes**, **serializer_class**, and **queryset** dependent on permission-based rules.
-
-
 [cite]: https://developer.apple.com/library/mac/#documentation/security/Conceptual/AuthenticationAndAuthorizationGuide/Authorization/Authorization.html
 [authentication]: authentication.md
 [throttling]: throttling.md
@@ -351,11 +283,7 @@ The [Django Rest Framework PSQ][drf-psq] package is an extension that gives supp
 [filtering]: filtering.md
 [composed-permissions]: https://github.com/niwibe/djangorestframework-composed-permissions
 [rest-condition]: https://github.com/caxap/rest_condition
-[dry-rest-permissions]: https://github.com/FJNR-inc/dry-rest-permissions
+[dry-rest-permissions]: https://github.com/Helioscene/dry-rest-permissions
 [django-rest-framework-roles]: https://github.com/computer-lab/django-rest-framework-roles
-[rest-framework-roles]: https://github.com/Pithikos/rest-framework-roles
-[djangorestframework-api-key]: https://florimondmanca.github.io/djangorestframework-api-key/
+[django-rest-framework-api-key]: https://github.com/manosim/django-rest-framework-api-key
 [django-rest-framework-role-filters]: https://github.com/allisson/django-rest-framework-role-filters
-[django-rest-framework-guardian]: https://github.com/rpkilby/django-rest-framework-guardian
-[drf-access-policy]: https://github.com/rsinger86/drf-access-policy
-[drf-psq]: https://github.com/drf-psq/drf-psq

docs/api-guide/relations.md

@@ -1,13 +1,12 @@
----
-source:
-    - relations.py
----
+source: relations.py
 
 # Serializer relations
 
-> Data structures, not algorithms, are central to programming.
+> Bad programmers worry about the code.
+> Good programmers worry about data structures and their relationships.
 >
-> — [Rob Pike][cite]
+> — [Linus Torvalds][cite]
+
 
 Relational fields are used to represent model relationships.  They can be applied to `ForeignKey`, `ManyToManyField` and `OneToOneField` relationships, as well as to reverse relationships, and custom relationships such as `GenericForeignKey`.
 
@@ -17,37 +16,6 @@ Relational fields are used to represent model relationships.  They can be applie
 
 ---
 
----
-
-**Note:** REST Framework does not attempt to automatically optimize querysets passed to serializers in terms of `select_related` and `prefetch_related` since it would be too much magic. A serializer with a field spanning an orm relation through its source attribute could require an additional database hit to fetch related objects from the database. It is the programmer's responsibility to optimize queries to avoid additional database hits which could occur while using such a serializer.
-
-For example, the following serializer would lead to a database hit each time evaluating the tracks field if it is not prefetched:
-
-    class AlbumSerializer(serializers.ModelSerializer):
-        tracks = serializers.SlugRelatedField(
-            many=True,
-            read_only=True,
-            slug_field='title'
-        )
-
-        class Meta:
-            model = Album
-            fields = ['album_name', 'artist', 'tracks']
-
-    # For each album object, tracks should be fetched from database
-    qs = Album.objects.all()
-    print(AlbumSerializer(qs, many=True).data)
-
-If `AlbumSerializer` is used to serialize a fairly large queryset with `many=True` then it could be a serious performance problem. Optimizing the queryset passed to `AlbumSerializer` with:
-
-    qs = Album.objects.prefetch_related('tracks')
-    # No additional database hits required
-    print(AlbumSerializer(qs, many=True).data)
-
-would solve the issue.
-
----
-
 #### Inspecting relationships.
 
 When using the `ModelSerializer` class, serializer fields and relationships will be automatically generated for you. Inspecting these automatically generated fields can be a useful tool for determining how to customize the relationship style.
@@ -56,7 +24,7 @@ To do so, open the Django shell, using `python manage.py shell`, then import the
 
     >>> from myapp.serializers import AccountSerializer
     >>> serializer = AccountSerializer()
-    >>> print(repr(serializer))
+    >>> print repr(serializer)  # Or `print(repr(serializer))` in Python 3.x.
     AccountSerializer():
         id = IntegerField(label='ID', read_only=True)
         name = CharField(allow_blank=True, max_length=100, required=False)
@@ -77,26 +45,26 @@ In order to explain the various types of relational fields, we'll use a couple o
         duration = models.IntegerField()
 
         class Meta:
-            unique_together = ['album', 'order']
+            unique_together = ('album', 'order')
             ordering = ['order']
 
-        def __str__(self):
+        def __unicode__(self):
             return '%d: %s' % (self.order, self.title)
 
 ## StringRelatedField
 
-`StringRelatedField` may be used to represent the target of the relationship using its `__str__` method.
+`StringRelatedField` may be used to represent the target of the relationship using its `__unicode__` method.
 
-For example, the following serializer:
+For example, the following serializer.
 
     class AlbumSerializer(serializers.ModelSerializer):
         tracks = serializers.StringRelatedField(many=True)
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
-Would serialize to the following representation:
+Would serialize to the following representation.
 
     {
         'album_name': 'Things We Lost In The Fire',
@@ -126,7 +94,7 @@ For example, the following serializer:
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
 Would serialize to a representation like this:
 
@@ -166,7 +134,7 @@ For example, the following serializer:
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
 Would serialize to a representation like this:
 
@@ -218,7 +186,7 @@ For example, the following serializer:
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
 Would serialize to a representation like this:
 
@@ -246,14 +214,14 @@ When using `SlugRelatedField` as a read-write field, you will normally want to e
 
 ## HyperlinkedIdentityField
 
-This field can be applied as an identity relationship, such as the `'url'` field on a HyperlinkedModelSerializer.  It can also be used for an attribute on the object.  For example, the following serializer:
+This field can be applied as an identity relationship, such as the `'url'` field on  a HyperlinkedModelSerializer.  It can also be used for an attribute on the object.  For example, the following serializer:
 
     class AlbumSerializer(serializers.HyperlinkedModelSerializer):
         track_listing = serializers.HyperlinkedIdentityField(view_name='track-list')
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'track_listing']
+            fields = ('album_name', 'artist', 'track_listing')
 
 Would serialize to a representation like this:
 
@@ -276,9 +244,7 @@ This field is always read-only.
 
 # Nested relationships
 
-As opposed to previously discussed _references_ to another entity, the referred entity can instead also be embedded or _nested_
-in the representation of the object that refers to it.
-Such nested relationships can be expressed by using serializers as fields.
+Nested relationships can be expressed by using serializers as fields.
 
 If the field is used to represent a to-many relationship, you should add the `many=True` flag to the serializer field.
 
@@ -289,14 +255,14 @@ For example, the following serializer:
     class TrackSerializer(serializers.ModelSerializer):
         class Meta:
             model = Track
-            fields = ['order', 'title', 'duration']
+            fields = ('order', 'title', 'duration')
 
     class AlbumSerializer(serializers.ModelSerializer):
         tracks = TrackSerializer(many=True, read_only=True)
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
 Would serialize to a nested representation like this:
 
@@ -322,19 +288,19 @@ Would serialize to a nested representation like this:
 
 ## Writable nested serializers
 
-By default nested serializers are read-only. If you want to support write-operations to a nested serializer field you'll need to create `create()` and/or `update()` methods in order to explicitly specify how the child relationships should be saved:
+By default nested serializers are read-only. If you want to support write-operations to a nested serializer field you'll need to create `create()` and/or `update()` methods in order to explicitly specify how the child relationships should be saved.
 
     class TrackSerializer(serializers.ModelSerializer):
         class Meta:
             model = Track
-            fields = ['order', 'title', 'duration']
+            fields = ('order', 'title', 'duration')
 
     class AlbumSerializer(serializers.ModelSerializer):
         tracks = TrackSerializer(many=True)
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
         def create(self, validated_data):
             tracks_data = validated_data.pop('tracks')
@@ -368,13 +334,13 @@ output representation should be generated from the model instance.
 
 To implement a custom relational field, you should override `RelatedField`, and implement the `.to_representation(self, value)` method. This method takes the target of the field as the `value` argument, and should return the representation that should be used to serialize the target. The `value` argument will typically be a model instance.
 
-If you want to implement a read-write relational field, you must also implement the [`.to_internal_value(self, data)` method][to_internal_value].
+If you want to implement a read-write relational field, you must also implement the `.to_internal_value(self, data)` method.
 
 To provide a dynamic queryset based on the `context`, you can also override `.get_queryset(self)` instead of specifying `.queryset` on the class or when initializing the field.
 
 ## Example
 
-For example, we could define a relational field to serialize a track to a custom string representation, using its ordering, title, and duration:
+For example, we could define a relational field to serialize a track to a custom string representation, using its ordering, title, and duration.
 
     import time
 
@@ -388,9 +354,9 @@ For example, we could define a relational field to serialize a track to a custom
 
         class Meta:
             model = Album
-            fields = ['album_name', 'artist', 'tracks']
+            fields = ('album_name', 'artist', 'tracks')
 
-This custom field would then serialize to the following representation:
+This custom field would then serialize to the following representation.
 
     {
         'album_name': 'Sometimes I Wish We Were an Eagle',
@@ -418,7 +384,7 @@ The `get_url` method is used to map the object instance to its URL representatio
 May raise a `NoReverseMatch` if the `view_name` and `lookup_field`
 attributes are not configured to correctly match the URL conf.
 
-**get_object(self, view_name, view_args, view_kwargs)**
+**get_object(self, queryset, view_name, view_args, view_kwargs)**
 
 If you want to support a writable hyperlinked field then you'll also want to override `get_object`, in order to map incoming URLs back to the object they represent. For read-only hyperlinked fields there is no need to override this method.
 
@@ -494,8 +460,8 @@ This behavior is intended to prevent a template from being unable to render in a
 
 There are two keyword arguments you can use to control this behavior:
 
-* `html_cutoff` - If set this will be the maximum number of choices that will be displayed by a HTML select drop down. Set to `None` to disable any limiting. Defaults to `1000`.
-* `html_cutoff_text` - If set this will display a textual indicator if the maximum number of items have been cutoff in an HTML select drop down. Defaults to `"More than {count} items…"`
+- `html_cutoff` - If set this will be the maximum number of choices that will be displayed by a HTML select drop down. Set to `None` to disable any limiting. Defaults to `1000`.
+- `html_cutoff_text` - If set this will display a textual indicator if the maximum number of items have been cutoff in an HTML select drop down. Defaults to `"More than {count} items…"`
 
 You can also control these globally using the settings `HTML_SELECT_CUTOFF` and `HTML_SELECT_CUTOFF_TEXT`.
 
@@ -513,7 +479,7 @@ Note that reverse relationships are not automatically included by the `ModelSeri
 
     class AlbumSerializer(serializers.ModelSerializer):
         class Meta:
-            fields = ['tracks', ...]
+            fields = ('tracks', ...)
 
 You'll normally want to ensure that you've set an appropriate `related_name` argument on the relationship, that you can use as the field name.  For example:
 
@@ -525,7 +491,7 @@ If you have not set a related name for the reverse relationship, you'll need to
 
     class AlbumSerializer(serializers.ModelSerializer):
         class Meta:
-            fields = ['track_set', ...]
+            fields = ('track_set', ...)
 
 See the Django documentation on [reverse relationships][reverse-relationships] for more details.
 
@@ -546,7 +512,7 @@ For example, given the following model for a tag, which has a generic relationsh
         object_id = models.PositiveIntegerField()
         tagged_object = GenericForeignKey('content_type', 'object_id')
 
-        def __str__(self):
+        def __unicode__(self):
             return self.tag_name
 
 And the following two models, which may have associated tags:
@@ -566,7 +532,7 @@ And the following two models, which may have associated tags:
         text = models.CharField(max_length=1000)
         tags = GenericRelation(TaggedItem)
 
-We could define a custom field that could be used to serialize tagged instances, using the type of each instance to determine how it should be serialized:
+We could define a custom field that could be used to serialize tagged instances, using the type of each instance to determine how it should be serialized.
 
     class TaggedObjectRelatedField(serializers.RelatedField):
         """
@@ -612,8 +578,6 @@ If you explicitly specify a relational field pointing to a
 ``ManyToManyField`` with a through model, be sure to set ``read_only``
 to ``True``.
 
-If you wish to represent [extra fields on a through model][django-intermediary-manytomany] then you may serialize the through model as [a nested object][dealing-with-nested-objects].
-
 ---
 
 # Third Party Packages
@@ -628,16 +592,9 @@ The [drf-nested-routers package][drf-nested-routers] provides routers and relati
 
 The [rest-framework-generic-relations][drf-nested-relations] library provides read/write serialization for generic foreign keys.
 
-The [rest-framework-gm2m-relations][drf-gm2m-relations] library provides read/write serialization for [django-gm2m][django-gm2m-field].
-
-[cite]: http://users.ece.utexas.edu/~adnan/pike.html
+[cite]: https://lwn.net/Articles/193245/
 [reverse-relationships]: https://docs.djangoproject.com/en/stable/topics/db/queries/#following-relationships-backward
-[routers]: https://www.django-rest-framework.org/api-guide/routers#defaultrouter
+[routers]: http://www.django-rest-framework.org/api-guide/routers#defaultrouter
 [generic-relations]: https://docs.djangoproject.com/en/stable/ref/contrib/contenttypes/#id1
 [drf-nested-routers]: https://github.com/alanjds/drf-nested-routers
 [drf-nested-relations]: https://github.com/Ian-Foote/rest-framework-generic-relations
-[drf-gm2m-relations]: https://github.com/mojtabaakbari221b/rest-framework-gm2m-relations
-[django-gm2m-field]: https://github.com/tkhyn/django-gm2m
-[django-intermediary-manytomany]: https://docs.djangoproject.com/en/stable/topics/db/models/#intermediary-manytomany
-[dealing-with-nested-objects]: https://www.django-rest-framework.org/api-guide/serializers/#dealing-with-nested-objects
-[to_internal_value]: https://www.django-rest-framework.org/api-guide/serializers/#to_internal_valueself-data

docs/api-guide/renderers.md

@@ -1,7 +1,4 @@
----
-source:
-    - renderers.py
----
+source: renderers.py
 
 # Renderers
 
@@ -24,10 +21,10 @@ For more information see the documentation on [content negotiation][conneg].
 The default set of renderers may be set globally, using the `DEFAULT_RENDERER_CLASSES` setting.  For example, the following settings would use `JSON` as the main media type and also include the self describing API.
 
     REST_FRAMEWORK = {
-        'DEFAULT_RENDERER_CLASSES': [
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework.renderers.JSONRenderer',
             'rest_framework.renderers.BrowsableAPIRenderer',
-        ]
+        )
     }
 
 You can also set the renderers used for an individual view, or viewset,
@@ -42,7 +39,7 @@ using the `APIView` class-based views.
         """
         A view that returns the count of active users in JSON.
         """
-        renderer_classes = [JSONRenderer]
+        renderer_classes = (JSONRenderer, )
 
         def get(self, request, format=None):
             user_count = User.objects.filter(active=True).count()
@@ -52,7 +49,7 @@ using the `APIView` class-based views.
 Or, if you're using the `@api_view` decorator with function based views.
 
     @api_view(['GET'])
-    @renderer_classes([JSONRenderer])
+    @renderer_classes((JSONRenderer,))
     def user_count_view(request, format=None):
         """
         A view that returns the count of active users in JSON.
@@ -92,7 +89,7 @@ The default JSON encoding style can be altered using the `UNICODE_JSON` and `COM
 
 **.media_type**: `application/json`
 
-**.format**: `'json'`
+**.format**: `'.json'`
 
 **.charset**: `None`
 
@@ -103,16 +100,6 @@ Unlike other renderers, the data passed to the `Response` does not need to be se
 
 The TemplateHTMLRenderer will create a `RequestContext`, using the `response.data` as the context dict, and determine a template name to use to render the context.
 
----
-
-**Note:** When used with a view that makes use of a serializer the `Response` sent for rendering may not be a dictionary and will need to be wrapped in a dict before returning to allow the `TemplateHTMLRenderer` to render it. For example:
-
-```
-response.data = {'results': response.data}
-```
-
----
-
 The template name is determined by (in order of preference):
 
 1. An explicit `template_name` argument passed to the response.
@@ -126,7 +113,7 @@ An example of a view that uses `TemplateHTMLRenderer`:
         A view that returns a templated HTML representation of a given user.
         """
         queryset = User.objects.all()
-        renderer_classes = [TemplateHTMLRenderer]
+        renderer_classes = (TemplateHTMLRenderer,)
 
         def get(self, request, *args, **kwargs):
             self.object = self.get_object()
@@ -140,7 +127,7 @@ See the [_HTML & Forms_ Topic Page][html-and-forms] for further examples of `Tem
 
 **.media_type**: `text/html`
 
-**.format**: `'html'`
+**.format**: `'.html'`
 
 **.charset**: `utf-8`
 
@@ -152,8 +139,8 @@ A simple renderer that simply returns pre-rendered HTML.  Unlike other renderers
 
 An example of a view that uses `StaticHTMLRenderer`:
 
-    @api_view(['GET'])
-    @renderer_classes([StaticHTMLRenderer])
+    @api_view(('GET',))
+    @renderer_classes((StaticHTMLRenderer,))
     def simple_html_view(request):
         data = '<html><body><h1>Hello, world</h1></body></html>'
         return Response(data)
@@ -162,7 +149,7 @@ You can use `StaticHTMLRenderer` either to return regular HTML pages using REST
 
 **.media_type**: `text/html`
 
-**.format**: `'html'`
+**.format**: `'.html'`
 
 **.charset**: `utf-8`
 
@@ -178,7 +165,7 @@ This renderer will determine which other renderer would have been given highest
 
 **.media_type**: `text/html`
 
-**.format**: `'api'`
+**.format**: `'.api'`
 
 **.charset**: `utf-8`
 
@@ -192,7 +179,7 @@ By default the response content will be rendered with the highest priority rende
         def get_default_renderer(self, view):
             return JSONRenderer()
 
-## AdminRenderer
+##  AdminRenderer
 
 Renders data into HTML for an admin-like display:
 
@@ -213,7 +200,7 @@ Note that views that have nested or list serializers for their input won't work
 
 **.media_type**: `text/html`
 
-**.format**: `'admin'`
+**.format**: `'.admin'`
 
 **.charset**: `utf-8`
 
@@ -237,7 +224,7 @@ For more information see the [HTML & Forms][html-and-forms] documentation.
 
 **.media_type**: `text/html`
 
-**.format**: `'form'`
+**.format**: `'.form'`
 
 **.charset**: `utf-8`
 
@@ -249,7 +236,7 @@ This renderer is used for rendering HTML multipart form data.  **It is not suita
 
 **.media_type**: `multipart/form-data; boundary=BoUnDaRyStRiNg`
 
-**.format**: `'multipart'`
+**.format**: `'.multipart'`
 
 **.charset**: `utf-8`
 
@@ -257,7 +244,7 @@ This renderer is used for rendering HTML multipart form data.  **It is not suita
 
 # Custom renderers
 
-To implement a custom renderer, you should override `BaseRenderer`, set the `.media_type` and `.format` properties, and implement the `.render(self, data, accepted_media_type=None, renderer_context=None)` method.
+To implement a custom renderer, you should override `BaseRenderer`, set the `.media_type` and `.format` properties, and implement the `.render(self, data, media_type=None, renderer_context=None)` method.
 
 The method should return a bytestring, which will be used as the body of the HTTP response.
 
@@ -267,7 +254,7 @@ The arguments passed to the `.render()` method are:
 
 The request data, as set by the `Response()` instantiation.
 
-### `accepted_media_type=None`
+### `media_type=None`
 
 Optional.  If provided, this is the accepted media type, as determined by the content negotiation stage.
 
@@ -283,7 +270,7 @@ By default this will include the following keys: `view`, `request`, `response`,
 
 The following is an example plaintext renderer that will return a response with the `data` parameter as the content of the response.
 
-    from django.utils.encoding import smart_str
+    from django.utils.encoding import smart_unicode
     from rest_framework import renderers
 
 
@@ -291,8 +278,8 @@ The following is an example plaintext renderer that will return a response with
         media_type = 'text/plain'
         format = 'txt'
 
-        def render(self, data, accepted_media_type=None, renderer_context=None):
-            return smart_str(data, encoding=self.charset)
+        def render(self, data, media_type=None, renderer_context=None):
+            return data.encode(self.charset)
 
 ## Setting the character set
 
@@ -303,7 +290,7 @@ By default renderer classes are assumed to be using the `UTF-8` encoding.  To us
         format = 'txt'
         charset = 'iso-8859-1'
 
-        def render(self, data, accepted_media_type=None, renderer_context=None):
+        def render(self, data, media_type=None, renderer_context=None):
             return data.encode(self.charset)
 
 Note that if a renderer class returns a unicode string, then the response content will be coerced into a bytestring by the `Response` class, with the `charset` attribute set on the renderer used to determine the encoding.
@@ -318,7 +305,7 @@ In some cases you may also want to set the `render_style` attribute to `'binary'
         charset = None
         render_style = 'binary'
 
-        def render(self, data, accepted_media_type=None, renderer_context=None):
+        def render(self, data, media_type=None, renderer_context=None):
             return data
 
 ---
@@ -332,14 +319,14 @@ You can do some pretty flexible things using REST framework's renderers.  Some e
 * Specify multiple types of HTML representation for API clients to use.
 * Underspecify a renderer's media type, such as using `media_type = 'image/*'`, and use the `Accept` header to vary the encoding of the response.
 
-## Varying behavior by media type
+## Varying behaviour by media type
 
 In some cases you might want your view to use different serialization styles depending on the accepted media type.  If you need to do this you can access `request.accepted_renderer` to determine the negotiated renderer that will be used for the response.
 
 For example:
 
-    @api_view(['GET'])
-    @renderer_classes([TemplateHTMLRenderer, JSONRenderer])
+    @api_view(('GET',))
+    @renderer_classes((TemplateHTMLRenderer, JSONRenderer))
     def list_users(request):
         """
         A view that can return JSON or HTML representations
@@ -411,12 +398,12 @@ Install using pip.
 Modify your REST framework settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_PARSER_CLASSES': [
+        'DEFAULT_PARSER_CLASSES': (
             'rest_framework_yaml.parsers.YAMLParser',
-        ],
-        'DEFAULT_RENDERER_CLASSES': [
+        ),
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework_yaml.renderers.YAMLRenderer',
-        ],
+        ),
     }
 
 ## XML
@@ -432,12 +419,12 @@ Install using pip.
 Modify your REST framework settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_PARSER_CLASSES': [
+        'DEFAULT_PARSER_CLASSES': (
             'rest_framework_xml.parsers.XMLParser',
-        ],
-        'DEFAULT_RENDERER_CLASSES': [
+        ),
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework_xml.renderers.XMLRenderer',
-        ],
+        ),
     }
 
 ## JSONP
@@ -461,59 +448,22 @@ Install using pip.
 Modify your REST framework settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_RENDERER_CLASSES': [
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework_jsonp.renderers.JSONPRenderer',
-        ],
+        ),
     }
 
 ## MessagePack
 
 [MessagePack][messagepack] is a fast, efficient binary serialization format.  [Juan Riaza][juanriaza] maintains the [djangorestframework-msgpack][djangorestframework-msgpack] package which provides MessagePack renderer and parser support for REST framework.
 
-## Microsoft Excel: XLSX (Binary Spreadsheet Endpoints)
-
-XLSX is the world's most popular binary spreadsheet format. [Tim Allen][flipperpa] of [The Wharton School][wharton] maintains [drf-excel][drf-excel], which renders an endpoint as an XLSX spreadsheet using OpenPyXL, and allows the client to download it. Spreadsheets can be styled on a per-view basis.
-
-#### Installation & configuration
-
-Install using pip.
-
-    $ pip install drf-excel
-
-Modify your REST framework settings.
-
-    REST_FRAMEWORK = {
-        ...
-
-        'DEFAULT_RENDERER_CLASSES': [
-            'rest_framework.renderers.JSONRenderer',
-            'rest_framework.renderers.BrowsableAPIRenderer',
-            'drf_excel.renderers.XLSXRenderer',
-        ],
-    }
-
-To avoid having a file streamed without a filename (which the browser will often default to the filename "download", with no extension), we need to use a mixin to override the `Content-Disposition` header. If no filename is provided, it will default to `export.xlsx`. For example:
-
-    from rest_framework.viewsets import ReadOnlyModelViewSet
-    from drf_excel.mixins import XLSXFileMixin
-    from drf_excel.renderers import XLSXRenderer
-
-    from .models import MyExampleModel
-    from .serializers import MyExampleSerializer
-
-    class MyExampleViewSet(XLSXFileMixin, ReadOnlyModelViewSet):
-        queryset = MyExampleModel.objects.all()
-        serializer_class = MyExampleSerializer
-        renderer_classes = [XLSXRenderer]
-        filename = 'my_export.xlsx'
-
 ## CSV
 
 Comma-separated values are a plain-text tabular data format, that can be easily imported into spreadsheet applications. [Mjumbe Poe][mjumbewu] maintains the [djangorestframework-csv][djangorestframework-csv] package which provides CSV renderer support for REST framework.
 
 ## UltraJSON
 
-[UltraJSON][ultrajson] is an optimized C JSON encoder which can give significantly faster JSON rendering. [Adam Mertz][Amertz08] maintains [drf_ujson2][drf_ujson2], a fork of the now unmaintained [drf-ujson-renderer][drf-ujson-renderer], which implements JSON rendering using the UJSON package.
+[UltraJSON][ultrajson] is an optimized C JSON encoder which can give significantly faster JSON rendering. [Jacob Haslehurst][hzy] maintains the [drf-ujson-renderer][drf-ujson-renderer] package which implements JSON rendering using the UJSON package.
 
 ## CamelCase JSON
 
@@ -525,31 +475,28 @@ Comma-separated values are a plain-text tabular data format, that can be easily
 
 ## LaTeX
 
-[Rest Framework Latex] provides a renderer that outputs PDFs using Lualatex. It is maintained by [Pebble (S/F Software)][mypebble].
+[Rest Framework Latex] provides a renderer that outputs PDFs using Laulatex. It is maintained by [Pebble (S/F Software)][mypebble].
 
 
-[cite]: https://docs.djangoproject.com/en/stable/ref/template-response/#the-rendering-process
+[cite]: https://docs.djangoproject.com/en/stable/stable/template-response/#the-rendering-process
 [conneg]: content-negotiation.md
 [html-and-forms]: ../topics/html-and-forms.md
 [browser-accept-headers]: http://www.gethifi.com/blog/browser-rest-http-accept-headers
 [testing]: testing.md
 [HATEOAS]: http://timelessrepo.com/haters-gonna-hateoas
-[quote]: https://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
+[quote]: http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
 [application/vnd.github+json]: https://developer.github.com/v3/media/
 [application/vnd.collection+json]: http://www.amundsen.com/media-types/collection/
 [django-error-views]: https://docs.djangoproject.com/en/stable/topics/http/views/#customizing-error-views
 [rest-framework-jsonp]: https://jpadilla.github.io/django-rest-framework-jsonp/
 [cors]: https://www.w3.org/TR/cors/
-[cors-docs]: https://www.django-rest-framework.org/topics/ajax-csrf-cors/
+[cors-docs]: http://www.django-rest-framework.org/topics/ajax-csrf-cors/
 [jsonp-security]: https://stackoverflow.com/questions/613962/is-jsonp-safe-to-use
 [rest-framework-yaml]: https://jpadilla.github.io/django-rest-framework-yaml/
 [rest-framework-xml]: https://jpadilla.github.io/django-rest-framework-xml/
 [messagepack]: https://msgpack.org/
 [juanriaza]: https://github.com/juanriaza
 [mjumbewu]: https://github.com/mjumbewu
-[flipperpa]: https://github.com/flipperpa
-[wharton]: https://github.com/wharton
-[drf-excel]: https://github.com/wharton/drf-excel
 [vbabiy]: https://github.com/vbabiy
 [rest-framework-yaml]: https://jpadilla.github.io/django-rest-framework-yaml/
 [rest-framework-xml]: https://jpadilla.github.io/django-rest-framework-xml/
@@ -557,9 +504,8 @@ Comma-separated values are a plain-text tabular data format, that can be easily
 [djangorestframework-msgpack]: https://github.com/juanriaza/django-rest-framework-msgpack
 [djangorestframework-csv]: https://github.com/mjumbewu/django-rest-framework-csv
 [ultrajson]: https://github.com/esnme/ultrajson
-[Amertz08]: https://github.com/Amertz08
+[hzy]: https://github.com/hzy
 [drf-ujson-renderer]: https://github.com/gizmag/drf-ujson-renderer
-[drf_ujson2]: https://github.com/Amertz08/drf_ujson2
 [djangorestframework-camel-case]: https://github.com/vbabiy/djangorestframework-camel-case
 [Django REST Pandas]: https://github.com/wq/django-rest-pandas
 [Pandas]: https://pandas.pydata.org/

docs/api-guide/requests.md

@@ -1,7 +1,4 @@
----
-source:
-    - request.py
----
+source: request.py
 
 # Requests
 
@@ -23,7 +20,7 @@ REST framework's Request objects provide flexible request parsing that allows yo
 
 * It includes all parsed content, including *file and non-file* inputs.
 * It supports parsing the content of HTTP methods other than `POST`, meaning that you can access the content of `PUT` and `PATCH` requests.
-* It supports REST framework's flexible request parsing, rather than just supporting form data.  For example you can handle incoming [JSON data] similarly to how you handle incoming [form data].
+* It supports REST framework's flexible request parsing, rather than just supporting form data.  For example you can handle incoming JSON data in the same way that you handle incoming form data.
 
 For more details see the [parsers documentation].
 
@@ -49,11 +46,11 @@ If a client sends a request with a content-type that cannot be parsed then a `Un
 
 # Content negotiation
 
-The request exposes some properties that allow you to determine the result of the content negotiation stage. This allows you to implement behavior such as selecting a different serialization schemes for different media types.
+The request exposes some properties that allow you to determine the result of the content negotiation stage. This allows you to implement behaviour such as selecting a different serialisation schemes for different media types.
 
 ## .accepted_renderer
 
-The renderer instance that was selected by the content negotiation stage.
+The renderer instance what was selected by the content negotiation stage.
 
 ## .accepted_media_type
 
@@ -93,7 +90,7 @@ You won't typically need to access this property.
 
 ---
 
-**Note:** You may see a `WrappedAttributeError` raised when calling the `.user` or `.auth` properties. These errors originate from an authenticator as a standard `AttributeError`, however it's necessary that they be re-raised as a different exception type in order to prevent them from being suppressed by the outer property access. Python will not recognize that the `AttributeError` originates from the authenticator and will instead assume that the request object does not have a `.user` or `.auth` property. The authenticator will need to be fixed.
+**Note:** You may see a `WrappedAttributeError` raised when calling the `.user` or `.auth` properties. These errors originate from an authenticator as a standard `AttributeError`, however it's necessary that they be re-raised as a different exception type in order to prevent them from being suppressed by the outer property access. Python will not recognize that the `AttributeError` orginates from the authenticator and will instaed assume that the request object does not have a `.user` or `.auth` property. The authenticator will need to be fixed.
 
 ---
 
@@ -136,7 +133,5 @@ Note that due to implementation reasons the `Request` class does not inherit fro
 
 [cite]: https://groups.google.com/d/topic/django-developers/dxI4qVzrBY4/discussion
 [parsers documentation]: parsers.md
-[JSON data]: parsers.md#jsonparser
-[form data]: parsers.md#formparser
 [authentication documentation]: authentication.md
 [browser enhancements documentation]: ../topics/browser-enhancements.md

docs/api-guide/responses.md

@@ -1,7 +1,4 @@
----
-source:
-    - response.py
----
+source: response.py
 
 # Responses
 
@@ -94,5 +91,5 @@ As with any other `TemplateResponse`, this method is called to render the serial
 
 You won't typically need to call `.render()` yourself, as it's handled by Django's standard response cycle.
 
-[cite]: https://docs.djangoproject.com/en/stable/ref/template-response/
+[cite]: https://docs.djangoproject.com/en/stable/stable/template-response/
 [statuscodes]: status-codes.md

docs/api-guide/reverse.md

@@ -1,7 +1,4 @@
----
-source:
-    - reverse.py
----
+source: reverse.py
 
 # Returning URLs
 
@@ -32,16 +29,16 @@ You should **include the request as a keyword argument** to the function, for ex
 
     from rest_framework.reverse import reverse
     from rest_framework.views import APIView
-    from django.utils.timezone import now
+	from django.utils.timezone import now
 
-    class APIRootView(APIView):
-        def get(self, request):
-            year = now().year
-            data = {
-                ...
-                'year-summary-url': reverse('year-summary', args=[year], request=request)
+	class APIRootView(APIView):
+	    def get(self, request):
+	        year = now().year
+			data = {
+ 				...
+    		    'year-summary-url': reverse('year-summary', args=[year], request=request)
             }
-            return Response(data)
+    		return Response(data)
 
 ## reverse_lazy
 
@@ -54,5 +51,5 @@ As with the `reverse` function, you should **include the request as a keyword ar
     api_root = reverse_lazy('api-root', request=request)
 
 [cite]: https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm#sec_5_1_5
-[reverse]: https://docs.djangoproject.com/en/stable/ref/urlresolvers/#reverse
-[reverse-lazy]: https://docs.djangoproject.com/en/stable/ref/urlresolvers/#reverse-lazy
+[reverse]: https://docs.djangoproject.com/en/stable/topics/http/urls/#reverse
+[reverse-lazy]: https://docs.djangoproject.com/en/stable/topics/http/urls/#reverse-lazy

docs/api-guide/routers.md

@@ -1,7 +1,4 @@
----
-source:
-    - routers.py
----
+source: routers.py
 
 # Routers
 
@@ -31,7 +28,7 @@ There are two mandatory arguments to the `register()` method:
 
 Optionally, you may also specify an additional argument:
 
-* `basename` - The base to use for the URL names that are created.  If unset the basename will be automatically generated based on the `queryset` attribute of the viewset, if it has one.  Note that if the viewset does not include a `queryset` attribute then you must set `basename` when registering the viewset.
+* `base_name` - The base to use for the URL names that are created.  If unset the basename will be automatically generated based on the `queryset` attribute of the viewset, if it has one.  Note that if the viewset does not include a `queryset` attribute then you must set `base_name` when registering the viewset.
 
 The example above would generate the following URL patterns:
 
@@ -42,13 +39,13 @@ The example above would generate the following URL patterns:
 
 ---
 
-**Note**: The `basename` argument is used to specify the initial part of the view name pattern.  In the example above, that's the `user` or `account` part.
+**Note**: The `base_name` argument is used to specify the initial part of the view name pattern.  In the example above, that's the `user` or `account` part.
 
-Typically you won't *need* to specify the `basename` argument, but if you have a viewset where you've defined a custom `get_queryset` method, then the viewset may not have a `.queryset` attribute set.  If you try to register that viewset you'll see an error like this:
+Typically you won't *need* to specify the `base_name` argument, but if you have a viewset where you've defined a custom `get_queryset` method, then the viewset may not have a `.queryset` attribute set.  If you try to register that viewset you'll see an error like this:
 
-    'basename' argument not specified, and could not automatically determine the name from the viewset, as it does not have a '.queryset' attribute.
+    'base_name' argument not specified, and could not automatically determine the name from the viewset, as it does not have a '.queryset' attribute.
 
-This means you'll need to explicitly set the `basename` argument when registering the viewset, as it could not be automatically determined from the model name.
+This means you'll need to explicitly set the `base_name` argument when registering the viewset, as it could not be automatically determined from the model name.
 
 ---
 
@@ -56,37 +53,37 @@ This means you'll need to explicitly set the `basename` argument when registerin
 
 The `.urls` attribute on a router instance is simply a standard list of URL patterns. There are a number of different styles for how you can include these URLs.
 
-For example, you can append `router.urls` to a list of existing views...
+For example, you can append `router.urls` to a list of existing views…
 
     router = routers.SimpleRouter()
     router.register(r'users', UserViewSet)
     router.register(r'accounts', AccountViewSet)
 
     urlpatterns = [
-        path('forgot-password/', ForgotPasswordFormView.as_view()),
+        url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
     ]
 
     urlpatterns += router.urls
 
-Alternatively you can use Django's `include` function, like so...
+Alternatively you can use Django's `include` function, like so…
 
     urlpatterns = [
-        path('forgot-password', ForgotPasswordFormView.as_view()),
-        path('', include(router.urls)),
+        url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
+        url(r'^', include(router.urls)),
     ]
 
 You may use `include` with an application namespace:
 
     urlpatterns = [
-        path('forgot-password/', ForgotPasswordFormView.as_view()),
-        path('api/', include((router.urls, 'app_name'))),
+        url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
+        url(r'^api/', include((router.urls, 'app_name'))),
     ]
 
 Or both an application and instance namespace:
 
     urlpatterns = [
-        path('forgot-password/', ForgotPasswordFormView.as_view()),
-        path('api/', include((router.urls, 'app_name'), namespace='instance_name')),
+        url(r'^forgot-password/$', ForgotPasswordFormView.as_view()),
+        url(r'^api/', include((router.urls, 'app_name'), namespace='instance_name')),
     ]
 
 See Django's [URL namespaces docs][url-namespace-docs] and the [`include` API reference][include-api-reference] for more details.
@@ -142,24 +139,6 @@ The above example would now generate the following URL pattern:
 * URL path: `^users/{pk}/change-password/$`
 * URL name: `'user-change_password'`
 
-### Using Django `path()` with routers
-
-By default, the URLs created by routers use regular expressions. This behavior can be modified by setting the `use_regex_path` argument to `False` when instantiating the router, in this case [path converters][path-converters-topic-reference] are used. For example:
-
-    router = SimpleRouter(use_regex_path=False)
-
-The router will match lookup values containing any characters except slashes and period characters.  For a more restrictive (or lenient) lookup pattern, set the `lookup_value_regex` attribute on the viewset or `lookup_value_converter` if using path converters.  For example, you can limit the lookup to valid UUIDs:
-
-    class MyModelViewSet(mixins.RetrieveModelMixin, viewsets.GenericViewSet):
-        lookup_field = 'my_model_id'
-        lookup_value_regex = '[0-9a-f]{32}'
-
-    class MyPathModelViewSet(mixins.RetrieveModelMixin, viewsets.GenericViewSet):
-        lookup_field = 'my_model_uuid'
-        lookup_value_converter = 'uuid'
-
-Note that path converters will be used on all URLs registered in the router, including viewset actions.
-
 # API Guide
 
 ## SimpleRouter
@@ -178,13 +157,19 @@ This router includes routes for the standard set of `list`, `create`, `retrieve`
     <tr><td>{prefix}/{lookup}/{url_path}/</td><td>GET, or as specified by `methods` argument</td><td>`@action(detail=True)` decorated method</td><td>{basename}-{url_name}</td></tr>
 </table>
 
-By default, the URLs created by `SimpleRouter` are appended with a trailing slash.
+By default the URLs created by `SimpleRouter` are appended with a trailing slash.
 This behavior can be modified by setting the `trailing_slash` argument to `False` when instantiating the router.  For example:
 
     router = SimpleRouter(trailing_slash=False)
 
 Trailing slashes are conventional in Django, but are not used by default in some other frameworks such as Rails.  Which style you choose to use is largely a matter of preference, although some javascript frameworks may expect a particular routing style.
 
+The router will match lookup values containing any characters except slashes and period characters.  For a more restrictive (or lenient) lookup pattern, set the `lookup_value_regex` attribute on the viewset.  For example, you can limit the lookup to valid UUIDs:
+
+    class MyModelViewSet(mixins.RetrieveModelMixin, viewsets.GenericViewSet):
+        lookup_field = 'my_model_id'
+        lookup_value_regex = '[0-9a-f]{32}'
+
 ## DefaultRouter
 
 This router is similar to `SimpleRouter` as above, but additionally includes a default API root view, that returns a response containing hyperlinks to all the list views.  It also generates routes for optional `.json` style format suffixes.
@@ -256,14 +241,12 @@ The following example will only route to the `list` and `retrieve` actions, and
                 url=r'^{prefix}$',
                 mapping={'get': 'list'},
                 name='{basename}-list',
-                detail=False,
                 initkwargs={'suffix': 'List'}
             ),
             Route(
                 url=r'^{prefix}/{lookup}$',
                 mapping={'get': 'retrieve'},
                 name='{basename}-detail',
-                detail=True,
                 initkwargs={'suffix': 'Detail'}
             ),
             DynamicRoute(
@@ -308,7 +291,7 @@ The following mappings would be generated...
     <tr><th>URL</th><th>HTTP Method</th><th>Action</th><th>URL Name</th></tr>
     <tr><td>/users</td><td>GET</td><td>list</td><td>user-list</td></tr>
     <tr><td>/users/{username}</td><td>GET</td><td>retrieve</td><td>user-detail</td></tr>
-    <tr><td>/users/{username}/group_names</td><td>GET</td><td>group_names</td><td>user-group-names</td></tr>
+    <tr><td>/users/{username}/group-names</td><td>GET</td><td>group_names</td><td>user-group-names</td></tr>
 </table>
 
 For another example of setting the `.routes` attribute, see the source code for the `SimpleRouter` class.
@@ -317,7 +300,7 @@ For another example of setting the `.routes` attribute, see the source code for
 
 If you want to provide totally custom behavior, you can override `BaseRouter` and override the `get_urls(self)` method.  The method should inspect the registered viewsets and return a list of URL patterns.  The registered prefix, viewset and basename tuples may be inspected by accessing the `self.registry` attribute.
 
-You may also want to override the `get_default_basename(self, viewset)` method, or else always explicitly set the `basename` argument when registering your viewsets with the router.
+You may also want to override the `get_default_base_name(self, viewset)` method, or else always explicitly set the `base_name` argument when registering your viewsets with the router.
 
 # Third Party Packages
 
@@ -340,7 +323,7 @@ The [wq.db package][wq.db] provides an advanced [ModelRouter][wq.db-router] clas
 
 The [`DRF-extensions` package][drf-extensions] provides [routers][drf-extensions-routers] for creating [nested viewsets][drf-extensions-nested-viewsets], [collection level controllers][drf-extensions-collection-level-controllers] with [customizable endpoint names][drf-extensions-customizable-endpoint-names].
 
-[cite]: https://guides.rubyonrails.org/routing.html
+[cite]: http://guides.rubyonrails.org/routing.html
 [route-decorators]: viewsets.md#marking-extra-actions-for-routing
 [drf-nested-routers]: https://github.com/alanjds/drf-nested-routers
 [wq.db]: https://wq.io/wq.db
@@ -350,6 +333,5 @@ The [`DRF-extensions` package][drf-extensions] provides [routers][drf-extensions
 [drf-extensions-nested-viewsets]: https://chibisov.github.io/drf-extensions/docs/#nested-routes
 [drf-extensions-collection-level-controllers]: https://chibisov.github.io/drf-extensions/docs/#collection-level-controllers
 [drf-extensions-customizable-endpoint-names]: https://chibisov.github.io/drf-extensions/docs/#controller-endpoint-name
-[url-namespace-docs]: https://docs.djangoproject.com/en/stable/topics/http/urls/#url-namespaces
-[include-api-reference]: https://docs.djangoproject.com/en/stable/ref/urls/#include
-[path-converters-topic-reference]: https://docs.djangoproject.com/en/stable/topics/http/urls/#path-converters
+[url-namespace-docs]: https://docs.djangoproject.com/en/1.11/topics/http/urls/#url-namespaces
+[include-api-reference]: https://docs.djangoproject.com/en/2.0/ref/urls/#include

docs/api-guide/serializers.md

@@ -1,7 +1,4 @@
----
-source:
-    - serializers.py
----
+source: serializers.py
 
 # Serializers
 
@@ -21,7 +18,7 @@ Let's start by creating a simple object we can use for example purposes:
 
     from datetime import datetime
 
-    class Comment:
+    class Comment(object):
         def __init__(self, email, content, created=None):
             self.email = email
             self.content = content
@@ -60,10 +57,10 @@ At this point we've translated the model instance into Python native datatypes.
 
 Deserialization is similar. First we parse a stream into Python native datatypes...
 
-    import io
+    from django.utils.six import BytesIO
     from rest_framework.parsers import JSONParser
 
-    stream = io.BytesIO(json)
+    stream = BytesIO(json)
     data = JSONParser().parse(stream)
 
 ...then we restore those native datatypes into a dictionary of validated data.
@@ -116,7 +113,7 @@ Calling `.save()` will either create a new instance, or update an existing insta
     # .save() will update the existing `comment` instance.
     serializer = CommentSerializer(comment, data=data)
 
-Both the `.create()` and `.update()` methods are optional. You can implement either none, one, or both of them, depending on the use-case for your serializer class.
+Both the `.create()` and `.update()` methods are optional. You can implement either neither, one, or both of them, depending on the use-case for your serializer class.
 
 #### Passing additional attributes to `.save()`
 
@@ -155,13 +152,13 @@ When deserializing data, you always need to call `is_valid()` before attempting
     serializer.is_valid()
     # False
     serializer.errors
-    # {'email': ['Enter a valid e-mail address.'], 'created': ['This field is required.']}
+    # {'email': [u'Enter a valid e-mail address.'], 'created': [u'This field is required.']}
 
 Each key in the dictionary will be the field name, and the values will be lists of strings of any error messages corresponding to that field.  The `non_field_errors` key may also be present, and will list any general validation errors. The name of the `non_field_errors` key may be customized using the `NON_FIELD_ERRORS_KEY` REST framework setting.
 
 When deserializing a list of items, errors will be returned as a list of dictionaries representing each of the deserialized items.
 
-#### Raising an exception on invalid data
+#### Raising an exception on invalid data
 
 The `.is_valid()` method takes an optional `raise_exception` flag that will cause it to raise a `serializers.ValidationError` exception if there are validation errors.
 
@@ -211,7 +208,7 @@ To do any other validation that requires access to multiple fields, add a method
 
         def validate(self, data):
             """
-            Check that start is before finish.
+            Check that the start is before the stop.
             """
             if data['start'] > data['finish']:
                 raise serializers.ValidationError("finish must occur after start")
@@ -226,24 +223,22 @@ Individual fields on a serializer can include validators, by declaring them on t
             raise serializers.ValidationError('Not a multiple of ten')
 
     class GameRecord(serializers.Serializer):
-        score = serializers.IntegerField(validators=[multiple_of_ten])
+        score = IntegerField(validators=[multiple_of_ten])
         ...
 
 Serializer classes can also include reusable validators that are applied to the complete set of field data. These validators are included by declaring them on an inner `Meta` class, like so:
 
     class EventSerializer(serializers.Serializer):
         name = serializers.CharField()
-        room_number = serializers.ChoiceField(choices=[101, 102, 103, 201])
+        room_number = serializers.IntegerField(choices=[101, 102, 103, 201])
         date = serializers.DateField()
 
         class Meta:
             # Each room only has one event per day.
-            validators = [
-                UniqueTogetherValidator(
-                    queryset=Event.objects.all(),
-                    fields=['room_number', 'date']
-                )
-            ]
+            validators = UniqueTogetherValidator(
+                queryset=Event.objects.all(),
+                fields=['room_number', 'date']
+            )
 
 For more information see the [validators documentation](validators.md).
 
@@ -251,14 +246,14 @@ For more information see the [validators documentation](validators.md).
 
 When passing an initial object or queryset to a serializer instance, the object will be made available as `.instance`. If no initial object is passed then the `.instance` attribute will be `None`.
 
-When passing data to a serializer instance, the unmodified data will be made available as `.initial_data`. If the `data` keyword argument is not passed then the `.initial_data` attribute will not exist.
+When passing data to a serializer instance, the unmodified data will be made available as `.initial_data`. If the data keyword argument is not passed then the `.initial_data` attribute will not exist.
 
 ## Partial updates
 
 By default, serializers must be passed values for all required fields or they will raise validation errors. You can use the `partial` argument in order to allow partial updates.
 
     # Update `comment` with partial data
-    serializer = CommentSerializer(comment, data={'content': 'foo bar'}, partial=True)
+    serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)
 
 ## Dealing with nested objects
 
@@ -282,7 +277,7 @@ If a nested representation may optionally accept the `None` value you should pas
         content = serializers.CharField(max_length=200)
         created = serializers.DateTimeField()
 
-Similarly if a nested representation should be a list of items, you should pass the `many=True` flag to the nested serializer.
+Similarly if a nested representation should be a list of items, you should pass the `many=True` flag to the nested serialized.
 
     class CommentSerializer(serializers.Serializer):
         user = UserSerializer(required=False)
@@ -298,7 +293,7 @@ When dealing with nested representations that support deserializing the data, an
     serializer.is_valid()
     # False
     serializer.errors
-    # {'user': {'email': ['Enter a valid e-mail address.']}, 'created': ['This field is required.']}
+    # {'user': {'email': [u'Enter a valid e-mail address.']}, 'created': [u'This field is required.']}
 
 Similarly, the `.validated_data` property will include nested data structures.
 
@@ -313,7 +308,7 @@ The following example demonstrates how you might handle creating a user with a n
 
         class Meta:
             model = User
-            fields = ['username', 'email', 'profile']
+            fields = ('username', 'email', 'profile')
 
         def create(self, validated_data):
             profile_data = validated_data.pop('profile')
@@ -335,7 +330,7 @@ Here's an example for an `.update()` method on our previous `UserSerializer` cla
         def update(self, instance, validated_data):
             profile_data = validated_data.pop('profile')
             # Unless the application properly enforces that this field is
-            # always set, the following could raise a `DoesNotExist`, which
+            # always set, the follow could raise a `DoesNotExist`, which
             # would need to be handled.
             profile = instance.profile
 
@@ -384,8 +379,8 @@ This manager class now more nicely encapsulates that user instances and profile
     def create(self, validated_data):
         return User.objects.create(
             username=validated_data['username'],
-            email=validated_data['email'],
-            is_premium_member=validated_data['profile']['is_premium_member'],
+            email=validated_data['email']
+            is_premium_member=validated_data['profile']['is_premium_member']
             has_support_contract=validated_data['profile']['has_support_contract']
         )
 
@@ -420,7 +415,7 @@ You can provide arbitrary additional context by passing a `context` argument whe
 
     serializer = AccountSerializer(account, context={'request': request})
     serializer.data
-    # {'id': 6, 'owner': 'denvercoder9', 'created': datetime.datetime(2013, 2, 12, 09, 44, 56, 678870), 'details': 'http://example.com/accounts/6/details'}
+    # {'id': 6, 'owner': u'denvercoder9', 'created': datetime.datetime(2013, 2, 12, 09, 44, 56, 678870), 'details': 'http://example.com/accounts/6/details'}
 
 The context dictionary can be used within any serializer field logic, such as a custom `.to_representation()` method, by accessing the `self.context` attribute.
 
@@ -443,7 +438,7 @@ Declaring a `ModelSerializer` looks like this:
     class AccountSerializer(serializers.ModelSerializer):
         class Meta:
             model = Account
-            fields = ['id', 'account_name', 'users', 'created']
+            fields = ('id', 'account_name', 'users', 'created')
 
 By default, all the model fields on the class will be mapped to a corresponding serializer fields.
 
@@ -472,7 +467,7 @@ For example:
     class AccountSerializer(serializers.ModelSerializer):
         class Meta:
             model = Account
-            fields = ['id', 'account_name', 'users', 'created']
+            fields = ('id', 'account_name', 'users', 'created')
 
 You can also set the `fields` attribute to the special value `'__all__'` to indicate that all fields in the model should be used.
 
@@ -490,7 +485,7 @@ For example:
     class AccountSerializer(serializers.ModelSerializer):
         class Meta:
             model = Account
-            exclude = ['users']
+            exclude = ('users',)
 
 In the example above, if the `Account` model had 3 fields `account_name`, `users`, and `created`, this will result in the fields `account_name` and `created` to be serialized.
 
@@ -507,7 +502,7 @@ The default `ModelSerializer` uses primary keys for relationships, but you can a
     class AccountSerializer(serializers.ModelSerializer):
         class Meta:
             model = Account
-            fields = ['id', 'account_name', 'users', 'created']
+            fields = ('id', 'account_name', 'users', 'created')
             depth = 1
 
 The `depth` option should be set to an integer value that indicates the depth of relationships that should be traversed before reverting to a flat representation.
@@ -524,7 +519,6 @@ You can add extra fields to a `ModelSerializer` or override the default fields b
 
         class Meta:
             model = Account
-            fields = ['url', 'groups']
 
 Extra fields can correspond to any property or callable on the model.
 
@@ -537,8 +531,8 @@ This option should be a list or tuple of field names, and is declared as follows
     class AccountSerializer(serializers.ModelSerializer):
         class Meta:
             model = Account
-            fields = ['id', 'account_name', 'users', 'created']
-            read_only_fields = ['account_name']
+            fields = ('id', 'account_name', 'users', 'created')
+            read_only_fields = ('account_name',)
 
 Model fields which have `editable=False` set, and `AutoField` fields will be set to read-only by default, and do not need to be added to the `read_only_fields` option.
 
@@ -566,7 +560,7 @@ This option is a dictionary, mapping field names to a dictionary of keyword argu
     class CreateUserSerializer(serializers.ModelSerializer):
         class Meta:
             model = User
-            fields = ['email', 'username', 'password']
+            fields = ('email', 'username', 'password')
             extra_kwargs = {'password': {'write_only': True}}
 
         def create(self, validated_data):
@@ -578,8 +572,6 @@ This option is a dictionary, mapping field names to a dictionary of keyword argu
             user.save()
             return user
 
-Please keep in mind that, if the field has already been explicitly declared on the serializer class, then the `extra_kwargs` option will be ignored.
-
 ## Relational fields
 
 When serializing model instances, there are a number of different ways you might choose to represent relationships.  The default representation for `ModelSerializer` is to use the primary keys of the related instances.
@@ -594,15 +586,15 @@ The ModelSerializer class also exposes an API that you can override in order to
 
 Normally if a `ModelSerializer` does not generate the fields you need by default then you should either add them to the class explicitly, or simply use a regular `Serializer` class instead. However in some cases you may want to create a new base class that defines how the serializer fields are created for any given model.
 
-### `serializer_field_mapping`
+### `.serializer_field_mapping`
 
-A mapping of Django model fields to REST framework serializer fields. You can override this mapping to alter the default serializer fields that should be used for each model field.
+A mapping of Django model classes to REST framework serializer classes. You can override this mapping to alter the default serializer classes that should be used for each model class.
 
-### `serializer_related_field`
+### `.serializer_related_field`
 
 This property should be the serializer field class, that is used for relational fields by default.
 
-For `ModelSerializer` this defaults to `serializers.PrimaryKeyRelatedField`.
+For `ModelSerializer` this defaults to `PrimaryKeyRelatedField`.
 
 For `HyperlinkedModelSerializer` this defaults to `serializers.HyperlinkedRelatedField`.
 
@@ -622,21 +614,21 @@ Defaults to `serializers.ChoiceField`
 
 The following methods are called to determine the class and keyword arguments for each field that should be automatically included on the serializer. Each of these methods should return a two tuple of `(field_class, field_kwargs)`.
 
-### `build_standard_field(self, field_name, model_field)`
+### `.build_standard_field(self, field_name, model_field)`
 
 Called to generate a serializer field that maps to a standard model field.
 
 The default implementation returns a serializer class based on the `serializer_field_mapping` attribute.
 
-### `build_relational_field(self, field_name, relation_info)`
+### `.build_relational_field(self, field_name, relation_info)`
 
 Called to generate a serializer field that maps to a relational model field.
 
-The default implementation returns a serializer class based on the `serializer_related_field` attribute.
+The default implementation returns a serializer class based on the `serializer_relational_field` attribute.
 
 The `relation_info` argument is a named tuple, that contains `model_field`, `related_model`, `to_many` and `has_through_model` properties.
 
-### `build_nested_field(self, field_name, relation_info, nested_depth)`
+### `.build_nested_field(self, field_name, relation_info, nested_depth)`
 
 Called to generate a serializer field that maps to a relational model field, when the `depth` option has been set.
 
@@ -646,17 +638,17 @@ The `nested_depth` will be the value of the `depth` option, minus one.
 
 The `relation_info` argument is a named tuple, that contains `model_field`, `related_model`, `to_many` and `has_through_model` properties.
 
-### `build_property_field(self, field_name, model_class)`
+### `.build_property_field(self, field_name, model_class)`
 
 Called to generate a serializer field that maps to a property or zero-argument method on the model class.
 
 The default implementation returns a `ReadOnlyField` class.
 
-### `build_url_field(self, field_name, model_class)`
+### `.build_url_field(self, field_name, model_class)`
 
 Called to generate a serializer field for the serializer's own `url` field. The default implementation returns a `HyperlinkedIdentityField` class.
 
-### `build_unknown_field(self, field_name, model_class)`
+### `.build_unknown_field(self, field_name, model_class)`
 
 Called when the field name did not map to any model field or model property.
 The default implementation raises an error, although subclasses may customize this behavior.
@@ -676,7 +668,7 @@ You can explicitly include the primary key by adding it to the `fields` option,
     class AccountSerializer(serializers.HyperlinkedModelSerializer):
         class Meta:
             model = Account
-            fields = ['url', 'id', 'account_name', 'users', 'created']
+            fields = ('url', 'id', 'account_name', 'users', 'created')
 
 ## Absolute and relative URLs
 
@@ -708,7 +700,7 @@ You can override a URL field view name and lookup field by using either, or both
     class AccountSerializer(serializers.HyperlinkedModelSerializer):
         class Meta:
             model = Account
-            fields = ['account_url', 'account_name', 'users', 'created']
+            fields = ('account_url', 'account_name', 'users', 'created')
             extra_kwargs = {
                 'url': {'view_name': 'accounts', 'lookup_field': 'account_name'},
                 'users': {'lookup_field': 'username'}
@@ -730,7 +722,7 @@ Alternatively you can set the fields on the serializer explicitly. For example:
 
         class Meta:
             model = Account
-            fields = ['url', 'account_name', 'users', 'created']
+            fields = ('url', 'account_name', 'users', 'created')
 
 ---
 
@@ -756,14 +748,6 @@ The following argument can also be passed to a `ListSerializer` field or a seria
 
 This is `True` by default, but can be set to `False` if you want to disallow empty lists as valid input.
 
-### `max_length`
-
-This is `None` by default, but can be set to a positive integer if you want to validate that the list contains no more than this number of elements.
-
-### `min_length`
-
-This is `None` by default, but can be set to a positive integer if you want to validate that the list contains no fewer than this number of elements.
-
 ### Customizing `ListSerializer` behavior
 
 There *are* a few use cases when you might want to customize the `ListSerializer` behavior. For example:
@@ -845,6 +829,8 @@ Here's an example of how you might choose to implement multiple updates:
         class Meta:
             list_serializer_class = BookListSerializer
 
+It is possible that a third party package may be included alongside the 3.1 release that provides some automatic support for multiple update operations, similar to the `allow_add_remove` behavior that was present in REST framework 2.
+
 #### Customizing ListSerializer initialization
 
 When a serializer with `many=True` is instantiated, we need to determine which arguments and keyword arguments should be passed to the `.__init__()` method for both the child `Serializer` class, and for the parent `ListSerializer` class.
@@ -884,7 +870,7 @@ Because this class provides the same interface as the `Serializer` class, you ca
 
 The only difference you'll notice when doing so is the `BaseSerializer` classes will not generate HTML forms in the browsable API. This is because the data they return does not include all the field information that would allow each field to be rendered into a suitable HTML input.
 
-#### Read-only `BaseSerializer` classes
+##### Read-only `BaseSerializer` classes
 
 To implement a read-only serializer using the `BaseSerializer` class, we just need to override the `.to_representation()` method. Let's take a look at an example using a simple Django model:
 
@@ -896,10 +882,10 @@ To implement a read-only serializer using the `BaseSerializer` class, we just ne
 It's simple to create a read-only serializer for converting `HighScore` instances into primitive data types.
 
     class HighScoreSerializer(serializers.BaseSerializer):
-        def to_representation(self, instance):
+        def to_representation(self, obj):
             return {
-                'score': instance.score,
-                'player_name': instance.player_name
+                'score': obj.score,
+                'player_name': obj.player_name
             }
 
 We can now use this class to serialize single `HighScore` instances:
@@ -908,7 +894,7 @@ We can now use this class to serialize single `HighScore` instances:
     def high_score(request, pk):
         instance = HighScore.objects.get(pk=pk)
         serializer = HighScoreSerializer(instance)
-        return Response(serializer.data)
+	    return Response(serializer.data)
 
 Or use it to serialize multiple instances:
 
@@ -916,9 +902,9 @@ Or use it to serialize multiple instances:
     def all_high_scores(request):
         queryset = HighScore.objects.order_by('-score')
         serializer = HighScoreSerializer(queryset, many=True)
-        return Response(serializer.data)
+	    return Response(serializer.data)
 
-#### Read-write `BaseSerializer` classes
+##### Read-write `BaseSerializer` classes
 
 To create a read-write serializer we first need to implement a `.to_internal_value()` method. This method returns the validated values that will be used to construct the object instance, and may raise a `serializers.ValidationError` if the supplied data is in an incorrect format.
 
@@ -947,17 +933,17 @@ Here's a complete example of our previous `HighScoreSerializer`, that's been upd
                     'player_name': 'May not be more than 10 characters.'
                 })
 
-            # Return the validated values. This will be available as
-            # the `.validated_data` property.
+			# Return the validated values. This will be available as
+			# the `.validated_data` property.
             return {
                 'score': int(score),
                 'player_name': player_name
             }
 
-        def to_representation(self, instance):
+        def to_representation(self, obj):
             return {
-                'score': instance.score,
-                'player_name': instance.player_name
+                'score': obj.score,
+                'player_name': obj.player_name
             }
 
         def create(self, validated_data):
@@ -967,18 +953,17 @@ Here's a complete example of our previous `HighScoreSerializer`, that's been upd
 
 The `BaseSerializer` class is also useful if you want to implement new generic serializer classes for dealing with particular serialization styles, or for integrating with alternative storage backends.
 
-The following class is an example of a generic serializer that can handle coercing arbitrary complex objects into primitive representations.
+The following class is an example of a generic serializer that can handle coercing arbitrary objects into primitive representations.
 
     class ObjectSerializer(serializers.BaseSerializer):
         """
         A read-only serializer that coerces arbitrary complex objects
         into primitive representations.
         """
-        def to_representation(self, instance):
-            output = {}
-            for attribute_name in dir(instance):
-                attribute = getattr(instance, attribute_name)
-                if attribute_name.startswith('_'):
+        def to_representation(self, obj):
+            for attribute_name in dir(obj):
+                attribute = getattr(obj, attribute_name)
+                if attribute_name('_'):
                     # Ignore private attributes.
                     pass
                 elif hasattr(attribute, '__call__'):
@@ -1001,7 +986,6 @@ The following class is an example of a generic serializer that can handle coerci
                 else:
                     # Force anything else to its string representation.
                     output[attribute_name] = str(attribute)
-            return output
 
 ---
 
@@ -1019,11 +1003,11 @@ Some reasons this might be useful include...
 
 The signatures for these methods are as follows:
 
-#### `to_representation(self, instance)`
+#### `.to_representation(self, obj)`
 
 Takes the object instance that requires serialization, and should return a primitive representation. Typically this means returning a structure of built-in Python datatypes. The exact types that can be handled will depend on the render classes you have configured for your API.
 
-May be overridden in order to modify the representation style. For example:
+May be overridden in order modify the representation style. For example:
 
     def to_representation(self, instance):
         """Convert `username` to lowercase."""
@@ -1031,7 +1015,7 @@ May be overridden in order to modify the representation style. For example:
         ret['username'] = ret['username'].lower()
         return ret
 
-#### ``to_internal_value(self, data)``
+#### ``.to_internal_value(self, data)``
 
 Takes the unvalidated incoming data as input and should return the validated data that will be made available as `serializer.validated_data`. The return value will also be passed to the `.create()` or `.update()` methods if `.save()` is called on the serializer class.
 
@@ -1046,7 +1030,7 @@ Similar to Django forms, you can extend and reuse serializers through inheritanc
     class MyBaseSerializer(Serializer):
         my_field = serializers.CharField()
 
-        def validate_my_field(self, value):
+        def validate_my_field(self):
             ...
 
     class MySerializer(MyBaseSerializer):
@@ -1094,7 +1078,7 @@ For example, if you wanted to be able to set which fields should be used by a se
             fields = kwargs.pop('fields', None)
 
             # Instantiate the superclass normally
-            super().__init__(*args, **kwargs)
+            super(DynamicFieldsModelSerializer, self).__init__(*args, **kwargs)
 
             if fields is not None:
                 # Drop any fields that are not specified in the `fields` argument.
@@ -1108,12 +1092,12 @@ This would then allow you to do the following:
     >>> class UserSerializer(DynamicFieldsModelSerializer):
     >>>     class Meta:
     >>>         model = User
-    >>>         fields = ['id', 'username', 'email']
+    >>>         fields = ('id', 'username', 'email')
     >>>
-    >>> print(UserSerializer(user))
+    >>> print UserSerializer(user)
     {'id': 2, 'username': 'jonwatts', 'email': 'jon@example.com'}
     >>>
-    >>> print(UserSerializer(user, fields=('id', 'email')))
+    >>> print UserSerializer(user, fields=('id', 'email'))
     {'id': 2, 'email': 'jon@example.com'}
 
 ## Customizing the default fields
@@ -1185,17 +1169,12 @@ The [html-json-forms][html-json-forms] package provides an algorithm and seriali
 
 The [drf-writable-nested][drf-writable-nested] package provides writable nested model serializer which allows to create/update models with nested related data.
 
-## DRF Encrypt Content
-
-The [drf-encrypt-content][drf-encrypt-content] package helps you encrypt your data, serialized through ModelSerializer. It also contains some helper functions. Which helps you to encrypt your data.
-
-
 [cite]: https://groups.google.com/d/topic/django-users/sVFaOfQi4wY/discussion
 [relations]: relations.md
 [model-managers]: https://docs.djangoproject.com/en/stable/topics/db/managers/
 [encapsulation-blogpost]: https://www.dabapps.com/blog/django-models-and-encapsulation/
 [thirdparty-writable-nested]: serializers.md#drf-writable-nested
-[django-rest-marshmallow]: https://marshmallow-code.github.io/django-rest-marshmallow/
+[django-rest-marshmallow]: https://tomchristie.github.io/django-rest-marshmallow/
 [marshmallow]: https://marshmallow.readthedocs.io/en/latest/
 [serpy]: https://github.com/clarkduvall/serpy
 [mongoengine]: https://github.com/umutbozkurt/django-rest-framework-mongoengine
@@ -1211,4 +1190,3 @@ The [drf-encrypt-content][drf-encrypt-content] package helps you encrypt your da
 [drf-serializer-extensions]: https://github.com/evenicoulddoit/django-rest-framework-serializer-extensions
 [djangorestframework-queryfields]: https://djangorestframework-queryfields.readthedocs.io/
 [drf-writable-nested]: https://github.com/beda-software/drf-writable-nested
-[drf-encrypt-content]: https://github.com/oguzhancelikarslan/drf-encrypt-content

docs/api-guide/settings.md

@@ -1,7 +1,4 @@
----
-source:
-    - settings.py
----
+source: settings.py
 
 # Settings
 
@@ -14,12 +11,12 @@ Configuration for REST framework is all namespaced inside a single Django settin
 For example your project's `settings.py` file might include something like this:
 
     REST_FRAMEWORK = {
-        'DEFAULT_RENDERER_CLASSES': [
+        'DEFAULT_RENDERER_CLASSES': (
             'rest_framework.renderers.JSONRenderer',
-        ],
-        'DEFAULT_PARSER_CLASSES': [
+        ),
+        'DEFAULT_PARSER_CLASSES': (
             'rest_framework.parsers.JSONParser',
-        ]
+        )
     }
 
 ## Accessing settings
@@ -29,7 +26,7 @@ you should use the `api_settings` object.  For example.
 
     from rest_framework.settings import api_settings
 
-    print(api_settings.DEFAULT_AUTHENTICATION_CLASSES)
+    print api_settings.DEFAULT_AUTHENTICATION_CLASSES
 
 The `api_settings` object will check for any user-defined settings, and otherwise fall back to the default values.  Any setting that uses string import paths to refer to a class will automatically import and return the referenced class, instead of the string literal.
 
@@ -47,10 +44,10 @@ A list or tuple of renderer classes, that determines the default set of renderer
 
 Default:
 
-    [
+    (
         'rest_framework.renderers.JSONRenderer',
         'rest_framework.renderers.BrowsableAPIRenderer',
-    ]
+    )
 
 #### DEFAULT_PARSER_CLASSES
 
@@ -58,11 +55,11 @@ A list or tuple of parser classes, that determines the default set of parsers us
 
 Default:
 
-    [
+    (
         'rest_framework.parsers.JSONParser',
         'rest_framework.parsers.FormParser',
         'rest_framework.parsers.MultiPartParser'
-    ]
+    )
 
 #### DEFAULT_AUTHENTICATION_CLASSES
 
@@ -70,10 +67,10 @@ A list or tuple of authentication classes, that determines the default set of au
 
 Default:
 
-    [
+    (
         'rest_framework.authentication.SessionAuthentication',
         'rest_framework.authentication.BasicAuthentication'
-    ]
+    )
 
 #### DEFAULT_PERMISSION_CLASSES
 
@@ -81,15 +78,15 @@ A list or tuple of permission classes, that determines the default set of permis
 
 Default:
 
-    [
+    (
         'rest_framework.permissions.AllowAny',
-    ]
+    )
 
 #### 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: `()`
 
 #### DEFAULT_CONTENT_NEGOTIATION_CLASS
 
@@ -101,7 +98,7 @@ Default: `'rest_framework.negotiation.DefaultContentNegotiation'`
 
 A view inspector class that will be used for schema generation.
 
-Default: `'rest_framework.schemas.openapi.AutoSchema'`
+Default: `'rest_framework.schemas.AutoSchema'`
 
 ---
 
@@ -109,19 +106,32 @@ Default: `'rest_framework.schemas.openapi.AutoSchema'`
 
 *The following settings control the behavior of the generic class-based views.*
 
+#### DEFAULT_PAGINATION_SERIALIZER_CLASS
+
+---
+
+**This setting has been removed.**
+
+The pagination API does not use serializers to determine the output format, and
+you'll need to instead override the `get_paginated_response method on a
+pagination class in order to specify how the output format is controlled.
+
+---
+
 #### DEFAULT_FILTER_BACKENDS
 
 A list of filter backend classes that should be used for generic filtering.
 If set to `None` then generic filtering is disabled.
 
-#### DEFAULT_PAGINATION_CLASS
+#### PAGINATE_BY
 
-The default class to use for queryset pagination. If set to `None`, pagination
-is disabled by default. See the pagination documentation for further guidance on
-[setting](pagination.md#setting-the-pagination-style) and
-[modifying](pagination.md#modifying-the-pagination-style) the pagination style.
+---
 
-Default: `None`
+**This setting has been removed.**
+
+See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
+
+---
 
 #### PAGE_SIZE
 
@@ -129,6 +139,26 @@ The default page size to use for pagination.  If set to `None`, pagination is di
 
 Default: `None`
 
+#### PAGINATE_BY_PARAM
+
+---
+
+**This setting has been removed.**
+
+See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
+
+---
+
+#### MAX_PAGINATE_BY
+
+---
+
+**This setting has been removed.**
+
+See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
+
+---
+
 ### SEARCH_PARAM
 
 The name of a query parameter, which can be used to specify the search term used by `SearchFilter`.
@@ -163,12 +193,6 @@ The string that should used for any versioning parameters, such as in the media
 
 Default: `'version'`
 
-#### DEFAULT_VERSIONING_CLASS
-
-The default versioning scheme to use.
-
-Default: `None`
-
 ---
 
 ## Authentication settings
@@ -211,10 +235,10 @@ The format of any of these renderer classes may be used when constructing a test
 
 Default:
 
-    [
+    (
         'rest_framework.renderers.MultiPartRenderer',
         'rest_framework.renderers.JSONRenderer'
-    ]
+    )
 
 ---
 
@@ -374,15 +398,10 @@ A string representing the function that should be used when generating view name
 
 This should be a function with the following signature:
 
-    view_name(self)
+    view_name(cls, suffix=None)
 
-* `self`: The view instance.  Typically the name function would inspect the name of the class when generating a descriptive name, by accessing `self.__class__.__name__`.
-
-If the view instance inherits `ViewSet`, it may have been initialized with several optional arguments:
-
-* `name`: A name explicitly provided to a view in the viewset. Typically, this value should be used as-is when provided.
-* `suffix`: Text used when differentiating individual views in a viewset. This argument is mutually exclusive to `name`.
-* `detail`: Boolean that differentiates an individual view in a viewset as either being a 'list' or 'detail' view.
+* `cls`: The view class.  Typically the name function would inspect the name of the class when generating a descriptive name, by accessing `cls.__name__`.
+* `suffix`: The optional suffix used when differentiating individual views in a viewset.
 
 Default: `'rest_framework.views.get_view_name'`
 
@@ -394,15 +413,11 @@ This setting can be changed to support markup styles other than the default mark
 
 This should be a function with the following signature:
 
-    view_description(self, html=False)
+    view_description(cls, html=False)
 
-* `self`: The view instance.  Typically the description function would inspect the docstring of the class when generating a description, by accessing `self.__class__.__doc__`
+* `cls`: The view class.  Typically the description function would inspect the docstring of the class when generating a description, by accessing `cls.__doc__`
 * `html`: A boolean indicating if HTML output is required.  `True` when used in the browsable API, and `False` when used in generating `OPTIONS` responses.
 
-If the view instance inherits `ViewSet`, it may have been initialized with several optional arguments:
-
-* `description`: A description explicitly provided to the view in the viewset. Typically, this is set by extra viewset `action`s, and should be used as-is.
-
 Default: `'rest_framework.views.get_view_description'`
 
 ## HTML Select Field cutoffs
@@ -460,4 +475,4 @@ Default: `None`
 [cite]: https://www.python.org/dev/peps/pep-0020/
 [rfc4627]: https://www.ietf.org/rfc/rfc4627.txt
 [heroku-minified-json]: https://github.com/interagent/http-api-design#keep-json-minified-in-all-responses
-[strftime]: https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes
+[strftime]: https://docs.python.org/3/library/time.html#time.strftime

docs/api-guide/status-codes.md

@@ -1,7 +1,4 @@
----
-source:
-    - status.py
----
+source: status.py
 
 # Status Codes
 
@@ -23,13 +20,13 @@ The full set of HTTP status codes included in the `status` module is listed belo
 The module also includes a set of helper functions for testing if a status code is in a given range.
 
     from rest_framework import status
-    from rest_framework.test import APITestCase
+	from rest_framework.test import APITestCase
 
-    class ExampleTestCase(APITestCase):
-        def test_url_root(self):
-            url = reverse('index')
-            response = self.client.get(url)
-            self.assertTrue(status.is_success(response.status_code))
+	class ExampleTestCase(APITestCase):
+	    def test_url_root(self):
+	        url = reverse('index')
+	        response = self.client.get(url)
+	        self.assertTrue(status.is_success(response.status_code))
 
 
 For more information on proper usage of HTTP status codes see [RFC 2616][rfc2616]
@@ -41,8 +38,6 @@ This class of status code indicates a provisional response.  There are no 1xx st
 
     HTTP_100_CONTINUE
     HTTP_101_SWITCHING_PROTOCOLS
-    HTTP_102_PROCESSING
-    HTTP_103_EARLY_HINTS
 
 ## Successful - 2xx
 
@@ -56,8 +51,6 @@ This class of status code indicates that the client's request was successfully r
     HTTP_205_RESET_CONTENT
     HTTP_206_PARTIAL_CONTENT
     HTTP_207_MULTI_STATUS
-    HTTP_208_ALREADY_REPORTED
-    HTTP_226_IM_USED
 
 ## Redirection - 3xx
 
@@ -71,7 +64,6 @@ This class of status code indicates that further action needs to be taken by the
     HTTP_305_USE_PROXY
     HTTP_306_RESERVED
     HTTP_307_TEMPORARY_REDIRECT
-    HTTP_308_PERMANENT_REDIRECT
 
 ## Client Error - 4xx
 
@@ -95,12 +87,9 @@ The 4xx class of status code is intended for cases in which the client seems to
     HTTP_415_UNSUPPORTED_MEDIA_TYPE
     HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
     HTTP_417_EXPECTATION_FAILED
-    HTTP_421_MISDIRECTED_REQUEST
     HTTP_422_UNPROCESSABLE_ENTITY
     HTTP_423_LOCKED
     HTTP_424_FAILED_DEPENDENCY
-    HTTP_425_TOO_EARLY
-    HTTP_426_UPGRADE_REQUIRED
     HTTP_428_PRECONDITION_REQUIRED
     HTTP_429_TOO_MANY_REQUESTS
     HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
@@ -116,11 +105,7 @@ Response status codes beginning with the digit "5" indicate cases in which the s
     HTTP_503_SERVICE_UNAVAILABLE
     HTTP_504_GATEWAY_TIMEOUT
     HTTP_505_HTTP_VERSION_NOT_SUPPORTED
-    HTTP_506_VARIANT_ALSO_NEGOTIATES
     HTTP_507_INSUFFICIENT_STORAGE
-    HTTP_508_LOOP_DETECTED
-    HTTP_509_BANDWIDTH_LIMIT_EXCEEDED
-    HTTP_510_NOT_EXTENDED
     HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
 
 ## Helper functions

docs/api-guide/testing.md

@@ -1,7 +1,4 @@
----
-source:
-    - test.py
----
+source: test.py
 
 # Testing
 
@@ -25,12 +22,9 @@ The `APIRequestFactory` class supports an almost identical API to Django's stand
     factory = APIRequestFactory()
     request = factory.post('/notes/', {'title': 'new idea'})
 
-    # Using the standard RequestFactory API to encode JSON data
-    request = factory.post('/notes/', {'title': 'new idea'}, content_type='application/json')
-
 #### Using the `format` argument
 
-Methods which create a request body, such as `post`, `put` and `patch`, include a `format` argument, which make it easy to generate requests using a wide set of request formats.  When using this argument, the factory will select an appropriate renderer and its configured `content_type`.  For example:
+Methods which create a request body, such as `post`, `put` and `patch`, include a `format` argument, which make it easy to generate requests using a content type other than multipart form data.  For example:
 
     # Create a JSON POST request
     factory = APIRequestFactory()
@@ -44,7 +38,7 @@ To support a wider set of request formats, or change the default format, [see th
 
 If you need to explicitly encode the request body, you can do so by setting the `content_type` flag.  For example:
 
-    request = factory.post('/notes/', yaml.dump({'title': 'new idea'}), content_type='application/yaml')
+    request = factory.post('/notes/', json.dumps({'title': 'new idea'}), content_type='application/json')
 
 #### PUT and PATCH with form data
 
@@ -125,7 +119,7 @@ Extends [Django's existing `Client` class][client].
 
 ## Making requests
 
-The `APIClient` class supports the same request interface as Django's standard `Client` class.  This means that the standard `.get()`, `.post()`, `.put()`, `.patch()`, `.delete()`, `.head()` and `.options()` methods are all available.  For example:
+The `APIClient` class supports the same request interface as Django's standard `Client` class.  This means the that standard `.get()`, `.post()`, `.put()`, `.patch()`, `.delete()`, `.head()` and `.options()` methods are all available.  For example:
 
     from rest_framework.test import APIClient
 
@@ -207,15 +201,13 @@ live environment. (See "Live tests" below.)
 This exposes exactly the same interface as if you were using a requests session
 directly.
 
-    from rest_framework.test import RequestsClient
-    
     client = RequestsClient()
     response = client.get('http://testserver/users/')
     assert response.status_code == 200
 
 Note that the requests client requires you to pass fully qualified URLs.
 
-## RequestsClient and working with the database
+## `RequestsClient` and working with the database
 
 The `RequestsClient` class is useful if you want to write tests that solely interact with the service interface. This is a little stricter than using the standard Django test client, as it means that all interactions should be via the API.
 
@@ -224,7 +216,7 @@ If you're using `RequestsClient` you'll want to ensure that test setup, and resu
 ## Headers & Authentication
 
 Custom headers and authentication credentials can be provided in the same way
-as [when using a standard `requests.Session` instance][session_objects].
+as [when using a standard `requests.Session` instance](http://docs.python-requests.org/en/master/user/advanced/#session-objects).
 
     from requests.auth import HTTPBasicAuth
 
@@ -237,7 +229,7 @@ If you're using `SessionAuthentication` then you'll need to include a CSRF token
 for any `POST`, `PUT`, `PATCH` or `DELETE` requests.
 
 You can do so by following the same flow that a JavaScript based client would use.
-First, make a `GET` request in order to obtain a CSRF token, then present that
+First make a `GET` request in order to obtain a CRSF token, then present that
 token in the following request.
 
 For example...
@@ -245,12 +237,12 @@ For example...
     client = RequestsClient()
 
     # Obtain a CSRF token.
-    response = client.get('http://testserver/homepage/')
+    response = client.get('/homepage/')
     assert response.status_code == 200
     csrftoken = response.cookies['csrftoken']
 
     # Interact with the API.
-    response = client.post('http://testserver/organisations/', json={
+    response = client.post('/organisations/', json={
         'name': 'MegaCorp',
         'status': 'active'
     }, headers={'X-CSRFToken': csrftoken})
@@ -262,7 +254,7 @@ With careful usage both the `RequestsClient` and the `CoreAPIClient` provide
 the ability to write test cases that can run either in development, or be run
 directly against your staging server or production environment.
 
-Using this style to create basic tests of a few core pieces of functionality is
+Using this style to create basic tests of a few core piece of functionality is
 a powerful way to validate your live service. Doing so may require some careful
 attention to setup and teardown to ensure that the tests run in a way that they
 do not directly affect customer data.
@@ -302,7 +294,7 @@ similar way as with `RequestsClient`.
 
 # API Test cases
 
-REST framework includes the following test case classes, that mirror the existing [Django's test case classes][provided_test_case_classes], but use `APIClient` instead of Django's default `Client`.
+REST framework includes the following test case classes, that mirror the existing Django test case classes, but use `APIClient` instead of Django's default `Client`.
 
 * `APISimpleTestCase`
 * `APITransactionTestCase`
@@ -405,17 +397,15 @@ For example, to add support for using `format='html'` in test requests, you migh
 
     REST_FRAMEWORK = {
         ...
-        'TEST_REQUEST_RENDERER_CLASSES': [
+        'TEST_REQUEST_RENDERER_CLASSES': (
             'rest_framework.renderers.MultiPartRenderer',
             'rest_framework.renderers.JSONRenderer',
             'rest_framework.renderers.TemplateHTMLRenderer'
-        ]
+        )
     }
 
 [cite]: https://jacobian.org/writing/django-apps-with-buildout/#s-create-a-test-wrapper
 [client]: https://docs.djangoproject.com/en/stable/topics/testing/tools/#the-test-client
 [requestfactory]: https://docs.djangoproject.com/en/stable/topics/testing/advanced/#django.test.client.RequestFactory
 [configuration]: #configuration
-[refresh_from_db_docs]: https://docs.djangoproject.com/en/stable/ref/models/instances/#django.db.models.Model.refresh_from_db
-[session_objects]: https://requests.readthedocs.io/en/master/user/advanced/#session-objects
-[provided_test_case_classes]: https://docs.djangoproject.com/en/stable/topics/testing/tools/#provided-test-case-classes
+[refresh_from_db_docs]: https://docs.djangoproject.com/en/1.11/ref/models/instances/#django.db.models.Model.refresh_from_db

docs/api-guide/throttling.md

@@ -1,7 +1,4 @@
----
-source:
-    - throttling.py
----
+source: throttling.py
 
 # Throttling
 
@@ -19,10 +16,6 @@ Multiple throttles can also be used if you want to impose both burst throttling
 
 Throttles do not necessarily only refer to rate-limiting requests.  For example a storage service might also need to throttle against bandwidth, and a paid data service might want to throttle against a certain number of a records being accessed.
 
-**The application-level throttling that REST framework provides should not be considered a security measure or protection against brute forcing or denial-of-service attacks. Deliberately malicious actors will always be able to spoof IP origins. In addition to this, the built-in throttling implementations are implemented using Django's cache framework, and use non-atomic operations to determine the request rate, which may sometimes result in some fuzziness.
-
-The application-level throttling provided by REST framework is intended for implementing policies such as different business tiers and basic protections against service over-use.**
-
 ## How throttling is determined
 
 As with permissions and authentication, throttling in REST framework is always defined as a list of classes.
@@ -35,27 +28,27 @@ If any throttle check fails an `exceptions.Throttled` exception will be raised,
 The default throttling policy may be set globally, using the `DEFAULT_THROTTLE_CLASSES` and `DEFAULT_THROTTLE_RATES` settings.  For example.
 
     REST_FRAMEWORK = {
-        'DEFAULT_THROTTLE_CLASSES': [
+        'DEFAULT_THROTTLE_CLASSES': (
             'rest_framework.throttling.AnonRateThrottle',
             'rest_framework.throttling.UserRateThrottle'
-        ],
+        ),
         'DEFAULT_THROTTLE_RATES': {
             'anon': '100/day',
             'user': '1000/day'
         }
     }
 
-The rates used in `DEFAULT_THROTTLE_RATES` can be specified over a period of second, minute, hour or day. The period must be specified after the `/` separator using `s`, `m`, `h` or `d`, respectively. For increased clarity, extended units such as `second`, `minute`, `hour`, `day` or even abbreviations like `sec`, `min`, `hr` are allowed, as only the first character is relevant to identify the rate.
+The rate descriptions used in `DEFAULT_THROTTLE_RATES` may include `second`, `minute`, `hour` or `day` as the throttle period.
 
 You can also set the throttling policy on a per-view or per-viewset basis,
 using the `APIView` class-based views.
 
-    from rest_framework.response import Response
+	from rest_framework.response import Response
     from rest_framework.throttling import UserRateThrottle
-    from rest_framework.views import APIView
+	from rest_framework.views import APIView
 
     class ExampleView(APIView):
-        throttle_classes = [UserRateThrottle]
+        throttle_classes = (UserRateThrottle,)
 
         def get(self, request, format=None):
             content = {
@@ -63,7 +56,7 @@ using the `APIView` class-based views.
             }
             return Response(content)
 
-If you're using the `@api_view` decorator with function based views you can use the following decorator.
+Or, if you're using the `@api_view` decorator with function based views.
 
     @api_view(['GET'])
     @throttle_classes([UserRateThrottle])
@@ -73,17 +66,7 @@ If you're using the `@api_view` decorator with function based views you can use
         }
         return Response(content)
 
-It's also possible to set throttle classes for routes that are created using the `@action` decorator.
-Throttle classes set in this way will override any viewset level class settings.
-
-    @action(detail=True, methods=["post"], throttle_classes=[UserRateThrottle])
-    def example_adhoc_method(request, pk=None):
-        content = {
-            'status': 'request was permitted'
-        }
-        return Response(content)
-
-## How clients are identified
+## How clients are identified
 
 The `X-Forwarded-For` HTTP header and `REMOTE_ADDR` WSGI variable are used to uniquely identify client IP addresses for throttling.  If the `X-Forwarded-For` header is present then it will be used, otherwise the value of the `REMOTE_ADDR` variable from the WSGI environment will be used.
 
@@ -91,7 +74,7 @@ If you need to strictly identify unique client IP addresses, you'll need to firs
 
 It is important to understand that if you configure the `NUM_PROXIES` setting, then all clients behind a unique [NAT'd](https://en.wikipedia.org/wiki/Network_address_translation) gateway will be treated as a single client.
 
-Further context on how the `X-Forwarded-For` header works, and identifying a remote client IP can be [found here][identifying-clients].
+Further context on how the `X-Forwarded-For` header works, and identifying a remote client IP can be [found here][identifing-clients].
 
 ## Setting up the cache
 
@@ -99,19 +82,11 @@ The throttle classes provided by REST framework use Django's cache backend.  You
 
 If you need to use a cache other than `'default'`, you can do so by creating a custom throttle class and setting the `cache` attribute.  For example:
 
-    from django.core.cache import caches
-
     class CustomAnonRateThrottle(AnonRateThrottle):
-        cache = caches['alternate']
+        cache = get_cache('alternate')
 
 You'll need to remember to also set your custom throttle class in the `'DEFAULT_THROTTLE_CLASSES'` settings key, or using the `throttle_classes` view attribute.
 
-## A note on concurrency
-
-The built-in throttle implementations are open to [race conditions][race], so under high concurrency they may allow a few extra requests through.
-
-If your project relies on guaranteeing the number of requests during concurrent requests, you will need to implement your own throttle class.
-
 ---
 
 # API Reference
@@ -149,10 +124,10 @@ For example, multiple user throttle rates could be implemented by using the foll
 ...and the following settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_THROTTLE_CLASSES': [
+        'DEFAULT_THROTTLE_CLASSES': (
             'example.throttles.BurstRateThrottle',
             'example.throttles.SustainedRateThrottle'
-        ],
+        ),
         'DEFAULT_THROTTLE_RATES': {
             'burst': '60/min',
             'sustained': '1000/day'
@@ -184,9 +159,9 @@ For example, given the following views...
 ...and the following settings.
 
     REST_FRAMEWORK = {
-        'DEFAULT_THROTTLE_CLASSES': [
+        'DEFAULT_THROTTLE_CLASSES': (
             'rest_framework.throttling.ScopedRateThrottle',
-        ],
+        ),
         'DEFAULT_THROTTLE_RATES': {
             'contacts': '1000/day',
             'uploads': '20/day'
@@ -217,7 +192,6 @@ The following is an example of a rate throttle, that will randomly throttle 1 in
 
 [cite]: https://developer.twitter.com/en/docs/basics/rate-limiting
 [permissions]: permissions.md
-[identifying-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster
+[identifing-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster
 [cache-setting]: https://docs.djangoproject.com/en/stable/ref/settings/#caches
 [cache-docs]: https://docs.djangoproject.com/en/stable/topics/cache/#setting-up-the-cache
-[race]: https://en.wikipedia.org/wiki/Race_condition#Data_race

docs/api-guide/validators.md

@@ -1,7 +1,4 @@
----
-source:
-    - validators.py
----
+source: validators.py
 
 # Validators
 
@@ -20,7 +17,7 @@ Validation in Django REST framework serializers is handled a little differently
 With `ModelForm` the validation is performed partially on the form, and partially on the model instance. With REST framework the validation is performed entirely on the serializer class. This is advantageous for the following reasons:
 
 * It introduces a proper separation of concerns, making your code behavior more obvious.
-* It is easy to switch between using shortcut `ModelSerializer` classes and using explicit `Serializer` classes. Any validation behavior being used for `ModelSerializer` is simple to replicate.
+* It is easy to switch between using shortcut `ModelSerializer` classes and using  explicit `Serializer` classes. Any validation behavior being used for `ModelSerializer` is simple to replicate.
 * Printing the `repr` of a serializer instance will show you exactly what validation rules it applies. There's no extra hidden validation behavior being called on the model instance.
 
 When you're using `ModelSerializer` all of this is handled automatically for you. If you want to drop down to using `Serializer` classes instead, then you need to define the validation rules explicitly.
@@ -48,12 +45,12 @@ If we open up the Django shell using `manage.py shell` we can now
     CustomerReportSerializer():
         id = IntegerField(label='ID', read_only=True)
         time_raised = DateTimeField(read_only=True)
-        reference = CharField(max_length=20, validators=[UniqueValidator(queryset=CustomerReportRecord.objects.all())])
+        reference = CharField(max_length=20, validators=[<UniqueValidator(queryset=CustomerReportRecord.objects.all())>])
         description = CharField(style={'type': 'textarea'})
 
 The interesting bit here is the `reference` field. We can see that the uniqueness constraint is being explicitly enforced by a validator on the serializer field.
 
-Because of this more explicit style REST framework includes a few validator classes that are not available in core Django. These classes are detailed below.  REST framework validators, like their Django counterparts, implement the `__eq__` method, allowing you to compare instances for equality.
+Because of this more explicit style REST framework includes a few validator classes that are not available in core Django. These classes are detailed below.
 
 ---
 
@@ -97,13 +94,13 @@ The validator should be applied to *serializer classes*, like so:
             validators = [
                 UniqueTogetherValidator(
                     queryset=ToDoItem.objects.all(),
-                    fields=['list', 'position']
+                    fields=('list', 'position')
                 )
             ]
 
 ---
 
-**Note**: The `UniqueTogetherValidator` class always imposes an implicit constraint that all the fields it applies to are always treated as required. Fields with `default` values are an exception to this as they always supply a value even when omitted from user input.
+**Note**: The `UniqueTogetherValidation` class always imposes an implicit constraint that all the fields it applies to are always treated as required. Fields with `default` values are an exception to this as they always supply a value even when omitted from user input.
 
 ---
 
@@ -152,6 +149,8 @@ If you want the date field to be visible, but not editable by the user, then set
 
     published = serializers.DateTimeField(read_only=True, default=timezone.now)
 
+The field will not be writable to the user, but the default value will still be passed through to the `validated_data`.
+
 #### Using with a hidden date field.
 
 If you want the date field to be entirely hidden from the user, then use `HiddenField`. This field type does not accept user input, but instead always returns its default value to the `validated_data` in the serializer.
@@ -160,22 +159,18 @@ If you want the date field to be entirely hidden from the user, then use `Hidden
 
 ---
 
-**Note**: The `UniqueFor<Range>Validator` classes impose an implicit constraint that the fields they are applied to are always treated as required. Fields with `default` values are an exception to this as they always supply a value even when omitted from user input.
-
----
-
----
-
-**Note:** `HiddenField()` does not appear in `partial=True` serializer (when making `PATCH` request).
+**Note**: The `UniqueFor<Range>Validation` classes impose an implicit constraint that the fields they are applied to are always treated as required. Fields with `default` values are an exception to this as they always supply a value even when omitted from user input.
 
 ---
 
 # Advanced field defaults
 
 Validators that are applied across multiple fields in the serializer can sometimes require a field input that should not be provided by the API client, but that *is* available as input to the validator.
-For this purposes use `HiddenField`. This field will be present in `validated_data` but *will not* be used in the serializer output representation.
 
-**Note:** Using a `read_only=True` field is excluded from writable fields so it won't use a `default=…` argument. Look [3.8 announcement](https://www.django-rest-framework.org/community/3.8-announcement/#altered-the-behaviour-of-read_only-plus-default-on-field).
+Two patterns that you may want to use for this sort of validation include:
+
+* Using `HiddenField`. This field will be present in `validated_data` but *will not* be used in the serializer output representation.
+* Using a standard field with `read_only=True`, but that also includes a `default=…` argument. This field *will* be used in the serializer output representation, but cannot be set directly by the user.
 
 REST framework includes a couple of defaults that may be useful in this context.
 
@@ -187,7 +182,7 @@ A default class that can be used to represent the current user. In order to use
         default=serializers.CurrentUserDefault()
     )
 
-#### CreateOnlyDefault
+#### CreateOnlyDefault
 
 A default class that can be used to *only set a default argument during create operations*. During updates the field is omitted.
 
@@ -212,7 +207,7 @@ by specifying an empty list for the serializer `Meta.validators` attribute.
 
 By default "unique together" validation enforces that all fields be
 `required=True`. In some cases, you might want to explicit apply
-`required=False` to one of the fields, in which case the desired behavior
+`required=False` to one of the fields, in which case the desired behaviour
 of the validation is ambiguous.
 
 In this case you will typically need to exclude the validator from the
@@ -222,11 +217,11 @@ in the `.validate()` method, or else in the view.
 For example:
 
     class BillingRecordSerializer(serializers.ModelSerializer):
-        def validate(self, attrs):
+        def validate(self, data):
             # Apply custom validation either here, or in the view.
 
         class Meta:
-            fields = ['client', 'date', 'amount']
+            fields = ('client', 'date', 'amount')
             extra_kwargs = {'client': {'required': False}}
             validators = []  # Remove a default "unique together" constraint.
 
@@ -242,7 +237,7 @@ In the case of update operations on *nested* serializers there's no way of
 applying this exclusion, because the instance is not available.
 
 Again, you'll probably want to explicitly remove the validator from the
-serializer class, and write the code for the validation constraint
+serializer class, and write the code the for the validation constraint
 explicitly, in a `.validate()` method, or in the view.
 
 ## Debugging complex cases
@@ -280,13 +275,13 @@ A validator may be any callable that raises a `serializers.ValidationError` on f
 
 You can specify custom field-level validation by adding `.validate_<field_name>` methods
 to your `Serializer` subclass. This is documented in the
-[Serializer docs](https://www.django-rest-framework.org/api-guide/serializers/#field-level-validation)
+[Serializer docs](http://www.django-rest-framework.org/api-guide/serializers/#field-level-validation)
 
 ## Class-based
 
 To write a class-based validator, use the `__call__` method. Class-based validators are useful as they allow you to parameterize and reuse behavior.
 
-    class MultipleOf:
+    class MultipleOf(object):
         def __init__(self, base):
             self.base = base
 
@@ -295,18 +290,13 @@ To write a class-based validator, use the `__call__` method. Class-based validat
                 message = 'This field must be a multiple of %d.' % self.base
                 raise serializers.ValidationError(message)
 
-#### Accessing the context
+#### Using `set_context()`
 
-In some advanced cases you might want a validator to be passed the serializer
-field it is being used with as additional context. You can do so by setting
-a `requires_context = True` attribute on the validator class. The `__call__` method
-will then be called with the `serializer_field`
-or `serializer` as an additional argument.
+In some advanced cases you might want a validator to be passed the serializer field it is being used with as additional context. You can do so by declaring a `set_context` method on a class-based validator.
 
-    class MultipleOf:
-        requires_context = True
-
-        def __call__(self, value, serializer_field):
-            ...
+    def set_context(self, serializer_field):
+        # Determine if this is an update or a create operation.
+        # In `__call__` we can then use that information to modify the validation behavior.
+        self.is_update = serializer_field.parent.instance is not None
 
 [cite]: https://docs.djangoproject.com/en/stable/ref/validators/

docs/api-guide/versioning.md

@@ -1,7 +1,4 @@
----
-source:
-    - versioning.py
----
+source: versioning.py
 
 # Versioning
 
@@ -132,12 +129,12 @@ This scheme requires the client to specify the version as part of the URL path.
 Your URL conf must include a pattern that matches the version with a `'version'` keyword argument, so that this information is available to the versioning scheme.
 
     urlpatterns = [
-        re_path(
+        url(
             r'^(?P<version>(v1|v2))/bookings/$',
             bookings_list,
             name='bookings-list'
         ),
-        re_path(
+        url(
             r'^(?P<version>(v1|v2))/bookings/(?P<pk>[0-9]+)/$',
             bookings_detail,
             name='bookings-detail'
@@ -158,14 +155,14 @@ In the following example we're giving a set of views two different possible URL
 
     # bookings/urls.py
     urlpatterns = [
-        re_path(r'^$', bookings_list, name='bookings-list'),
-        re_path(r'^(?P<pk>[0-9]+)/$', bookings_detail, name='bookings-detail')
+        url(r'^$', bookings_list, name='bookings-list'),
+        url(r'^(?P<pk>[0-9]+)/$', bookings_detail, name='bookings-detail')
     ]
 
     # urls.py
     urlpatterns = [
-        re_path(r'^v1/bookings/', include('bookings.urls', namespace='v1')),
-        re_path(r'^v2/bookings/', include('bookings.urls', namespace='v2'))
+        url(r'^v1/bookings/', include('bookings.urls', namespace='v1')),
+        url(r'^v2/bookings/', include('bookings.urls', namespace='v2'))
     ]
 
 Both `URLPathVersioning` and `NamespaceVersioning` are reasonable if you just need a simple versioning scheme. The `URLPathVersioning` approach might be better suitable for small ad-hoc projects, and the `NamespaceVersioning` is probably easier to manage for larger projects.

docs/api-guide/views.md

@@ -1,8 +1,5 @@
----
-source:
-    - decorators.py
-    - views.py
----
+source: decorators.py
+        views.py
 
 # Class-based Views
 
@@ -35,8 +32,8 @@ For example:
         * Requires token authentication.
         * Only admin users are able to access this view.
         """
-        authentication_classes = [authentication.TokenAuthentication]
-        permission_classes = [permissions.IsAdminUser]
+        authentication_classes = (authentication.TokenAuthentication,)
+        permission_classes = (permissions.IsAdminUser,)
 
         def get(self, request, format=None):
             """
@@ -145,7 +142,6 @@ REST framework also allows you to work with regular function based views.  It pr
 The core of this functionality is the `api_view` decorator, which takes a list of HTTP methods that your view should respond to. For example, this is how you would write a very simple view that just manually returns some data:
 
     from rest_framework.decorators import api_view
-    from rest_framework.response import Response
 
     @api_view()
     def hello_world(request):
@@ -153,7 +149,7 @@ The core of this functionality is the `api_view` decorator, which takes a list o
 
 This view will use the default renderers, parsers, authentication classes etc specified in the [settings].
 
-By default only `GET` methods will be accepted. Other methods will respond with "405 Method Not Allowed". To alter this behavior, specify which methods the view allows, like so:
+By default only `GET` methods will be accepted. Other methods will respond with "405 Method Not Allowed". To alter this behaviour, specify which methods the view allows, like so:
 
     @api_view(['GET', 'POST'])
     def hello_world(request):
@@ -170,7 +166,7 @@ To override the default settings, REST framework provides a set of additional de
     from rest_framework.throttling import UserRateThrottle
 
     class OncePerDayUserThrottle(UserRateThrottle):
-        rate = '1/day'
+            rate = '1/day'
 
     @api_view(['GET'])
     @throttle_classes([OncePerDayUserThrottle])

docs/api-guide/viewsets.md

@@ -1,7 +1,4 @@
----
-source:
-    - viewsets.py
----
+source: viewsets.py
 
 # ViewSets
 
@@ -54,7 +51,7 @@ Typically we wouldn't do this, but would instead register the viewset with a rou
     from rest_framework.routers import DefaultRouter
 
     router = DefaultRouter()
-    router.register(r'users', UserViewSet, basename='user')
+    router.register(r'users', UserViewSet, base_name='user')
     urlpatterns = router.urls
 
 Rather than writing your own viewsets, you'll often want to use the existing base classes that provide a default set of behavior.  For example:
@@ -113,10 +110,8 @@ During dispatch, the following attributes are available on the `ViewSet`.
 * `action` - the name of the current action (e.g., `list`, `create`).
 * `detail` - boolean indicating if the current action is configured for a list or detail view.
 * `suffix` - the display suffix for the viewset type - mirrors the `detail` attribute.
-* `name` - the display name for the viewset. This argument is mutually exclusive to `suffix`.
-* `description` - the display description for the individual view of a viewset.
 
-You may inspect these attributes to adjust behavior based on the current action. For example, you could restrict permissions to everything except the `list` action similar to this:
+You may inspect these attributes to adjust behaviour based on the current action. For example, you could restrict permissions to everything except the `list` action similar to this:
 
     def get_permissions(self):
         """
@@ -125,14 +120,12 @@ You may inspect these attributes to adjust behavior based on the current action.
         if self.action == 'list':
             permission_classes = [IsAuthenticated]
         else:
-            permission_classes = [IsAdminUser]
+            permission_classes = [IsAdmin]
         return [permission() for permission in permission_classes]
 
-**Note**: the `action` attribute is not available in the `get_parsers`, `get_authenticators` and `get_content_negotiator` methods, as it is set _after_ they are called in the framework lifecycle. If you override one of these methods and try to access the `action` attribute in them, you will get an `AttributeError` error.
-
 ## Marking extra actions for routing
 
-If you have ad-hoc methods that should be routable, you can mark them as such with the `@action` decorator. Like regular actions, extra actions may be intended for either a single object, or an entire collection. To indicate this, set the `detail` argument to `True` or `False`. The router will configure its URL patterns accordingly. e.g., the `DefaultRouter` will configure detail actions to contain `pk` in their URL patterns.
+If you have ad-hoc methods that should be routable, you can mark them as such with the `@action` decorator. Like regular actions, extra actions may be intended for either a list of objects, or a single instance. To indicate this, set the `detail` argument to `True` or `False`. The router will configure its URL patterns accordingly. e.g., the `DefaultRouter` will configure detail actions to contain `pk` in their URL patterns.
 
 A more complete example of extra actions:
 
@@ -149,12 +142,12 @@ A more complete example of extra actions:
         queryset = User.objects.all()
         serializer_class = UserSerializer
 
-        @action(detail=True, methods=['post'])
+        @action(methods=['post'], detail=True)
         def set_password(self, request, pk=None):
             user = self.get_object()
             serializer = PasswordSerializer(data=request.data)
             if serializer.is_valid():
-                user.set_password(serializer.validated_data['password'])
+                user.set_password(serializer.data['password'])
                 user.save()
                 return Response({'status': 'password set'})
             else:
@@ -163,7 +156,7 @@ A more complete example of extra actions:
 
         @action(detail=False)
         def recent_users(self, request):
-            recent_users = User.objects.all().order_by('-last_login')
+            recent_users = User.objects.all().order('-last_login')
 
             page = self.paginate_queryset(recent_users)
             if page is not None:
@@ -173,48 +166,22 @@ A more complete example of extra actions:
             serializer = self.get_serializer(recent_users, many=True)
             return Response(serializer.data)
 
+The decorator can additionally take extra arguments that will be set for the routed view only.  For example:
 
-The `action` decorator will route `GET` requests by default, but may also accept other HTTP methods by setting the `methods` argument.  For example:
-
-        @action(detail=True, methods=['post', 'delete'])
-        def unset_password(self, request, pk=None):
-           ...
-
-Argument `methods` also supports HTTP methods defined as [HTTPMethod](https://docs.python.org/3/library/http.html#http.HTTPMethod). Example below is identical to the one above: 
-
-        from http import HTTPMethod
-
-        @action(detail=True, methods=[HTTPMethod.POST, HTTPMethod.DELETE])
-        def unset_password(self, request, pk=None):
-           ...
-
-The decorator allows you to override any viewset-level configuration such as `permission_classes`, `serializer_class`, `filter_backends`...:
-
-        @action(detail=True, methods=['post'], permission_classes=[IsAdminOrIsSelf])
+        @action(methods=['post'], detail=True, permission_classes=[IsAdminOrIsSelf])
         def set_password(self, request, pk=None):
            ...
 
-The two new actions will then be available at the urls `^users/{pk}/set_password/$` and `^users/{pk}/unset_password/$`. Use the `url_path` and `url_name` parameters to change the URL segment and the reverse URL name of the action.
+These decorator will route `GET` requests by default, but may also accept other HTTP methods by setting the `methods` argument.  For example:
+
+        @action(methods=['post', 'delete'], detail=True)
+        def unset_password(self, request, pk=None):
+           ...
+
+The two new actions will then be available at the urls `^users/{pk}/set_password/$` and `^users/{pk}/unset_password/$`
 
 To view all extra actions, call the `.get_extra_actions()` method.
 
-### Routing additional HTTP methods for extra actions
-
-Extra actions can map additional HTTP methods to separate `ViewSet` methods. For example, the above password set/unset methods could be consolidated into a single route. Note that additional mappings do not accept arguments.
-
-```python
-@action(detail=True, methods=["put"], name="Change Password")
-def password(self, request, pk=None):
-    """Update the user's password."""
-    ...
-
-
-@password.mapping.delete
-def delete_password(self, request, pk=None):
-    """Delete the user's password."""
-    ...
-```
-
 ## Reversing action URLs
 
 If you need to get the URL of an action, use the `.reverse_action()` method. This is a convenience wrapper for `reverse()`, automatically passing the view's `request` object and prepending the `url_name` with the `.basename` attribute.
@@ -223,14 +190,14 @@ Note that the `basename` is provided by the router during `ViewSet` registration
 
 Using the example from the previous section:
 
-```pycon
->>> view.reverse_action("set-password", args=["1"])
+```python
+>>> view.reverse_action('set-password', args=['1'])
 'http://localhost:8000/api/users/1/set_password'
 ```
 
 Alternatively, you can use the `url_name` attribute set by the `@action` decorator.
 
-```pycon
+```python
 >>> view.reverse_action(view.set_password.url_name, args=['1'])
 'http://localhost:8000/api/users/1/set_password'
 ```
@@ -257,7 +224,7 @@ In order to use a `GenericViewSet` class you'll override the class and either mi
 
 The `ModelViewSet` class inherits from `GenericAPIView` and includes implementations for various actions, by mixing in the behavior of the various mixin classes.
 
-The actions provided by the `ModelViewSet` class are `.list()`, `.retrieve()`, `.create()`, `.update()`, `.partial_update()`, and `.destroy()`.
+The actions provided by the `ModelViewSet` class are `.list()`, `.retrieve()`,  `.create()`, `.update()`, `.partial_update()`, and `.destroy()`.
 
 #### Example
 
@@ -284,7 +251,7 @@ Note that you can use any of the standard attributes or method overrides provide
         def get_queryset(self):
             return self.request.user.accounts.all()
 
-Note however that upon removal of the `queryset` property from your `ViewSet`, any associated [router][routers] will be unable to derive the basename of your Model automatically, and so you will have to specify the `basename` kwarg as part of your [router registration][routers].
+Note however that upon removal of the `queryset` property from your `ViewSet`, any associated [router][routers] will be unable to derive the base_name of your Model automatically, and so you will have to specify the `base_name` kwarg as part of your [router registration][routers].
 
 Also note that although this class provides the complete set of create/list/retrieve/update/destroy actions by default, you can restrict the available operations by using the standard permission classes.
 
@@ -313,7 +280,7 @@ You may need to provide custom `ViewSet` classes that do not have the full set o
 
 To create a base viewset class that provides `create`, `list` and `retrieve` operations, inherit from `GenericViewSet`, and mixin the required actions:
 
-    from rest_framework import mixins, viewsets
+    from rest_framework import mixins
 
     class CreateListRetrieveViewSet(mixins.CreateModelMixin,
                                     mixins.ListModelMixin,
@@ -329,5 +296,5 @@ To create a base viewset class that provides `create`, `list` and `retrieve` ope
 
 By creating your own base `ViewSet` classes, you can provide common behavior that can be reused in multiple viewsets across your API.
 
-[cite]: https://guides.rubyonrails.org/action_controller_overview.html
+[cite]: http://guides.rubyonrails.org/routing.html
 [routers]: routers.md

docs/community/3.10-announcement.md

@@ -1,148 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.10
-
-The 3.10 release drops support for Python 2.
-
-* Our supported Python versions are now: 3.5, 3.6, and 3.7.
-* Our supported Django versions are now: 1.11, 2.0, 2.1, and 2.2.
-
-## OpenAPI Schema Generation
-
-Since we first introduced schema support in Django REST Framework 3.5, OpenAPI has emerged as the widely adopted standard for modeling Web APIs.
-
-This release begins the deprecation process for the CoreAPI based schema generation, and introduces OpenAPI schema generation in its place.
-
----
-
-## Continuing to use CoreAPI
-
-If you're currently using the CoreAPI schemas, you'll need to make sure to
-update your REST framework settings to include `DEFAULT_SCHEMA_CLASS` explicitly.
-
-**settings.py**:
-
-```python
-REST_FRAMEWORK = {
-    ...: ...,
-    "DEFAULT_SCHEMA_CLASS": "rest_framework.schemas.coreapi.AutoSchema",
-}
-```
-
-You'll still be able to keep using CoreAPI schemas, API docs, and client for the
-foreseeable future. We'll aim to ensure that the CoreAPI schema generator remains
-available as a third party package, even once it has eventually been removed
-from REST framework, scheduled for version 3.12.
-
-We have removed the old documentation for the CoreAPI based schema generation.
-You may view the [Legacy CoreAPI documentation here][legacy-core-api-docs].
-
-----
-
-## OpenAPI Quickstart
-
-You can generate a static OpenAPI schema, using the `generateschema` management
-command.
-
-Alternately, to have the project serve an API schema, use the `get_schema_view()`
-shortcut.
-
-In your `urls.py`:
-
-```python
-from rest_framework.schemas import get_schema_view
-
-urlpatterns = [
-    # ...
-    # Use the `get_schema_view()` helper to add a `SchemaView` to project URLs.
-    #   * `title` and `description` parameters are passed to `SchemaGenerator`.
-    #   * Provide view name for use with `reverse()`.
-    path(
-        "openapi",
-        get_schema_view(title="Your Project", description="API for all things …"),
-        name="openapi-schema",
-    ),
-    # ...
-]
-```
-
-### Customization
-
-For customizations that you want to apply across the entire API, you can subclass `rest_framework.schemas.openapi.SchemaGenerator` and provide it as an argument
-to the `generateschema` command or `get_schema_view()` helper function.
-
-For specific per-view customizations, you can subclass `AutoSchema`,
-making sure to set `schema = <YourCustomClass>` on the view.
-
-For more details, see the [API Schema documentation](../api-guide/schemas.md).
-
-### API Documentation
-
-There are some great third party options for documenting your API, based on the
-OpenAPI schema.
-
-See the [Documenting you API](../topics/documenting-your-api.md) section for more details.
-
----
-
-## Feature Roadmap
-
-Given that our OpenAPI schema generation is a new feature, it's likely that there
-will still be some iterative improvements for us to make. There will be two
-main cases here:
-
-* Expanding the supported range of OpenAPI schemas that are generated by default.
-* Improving the ability for developers to customize the output.
-
-We'll aim to bring the first type of change quickly in point releases. For the
-second kind we'd like to adopt a slower approach, to make sure we keep the API
-simple, and as widely applicable as possible, before we bring in API changes.
-
-It's also possible that we'll end up implementing API documentation and API client
-tooling that are driven by the OpenAPI schema. The `apistar` project has a
-significant amount of work towards this. However, if we do so, we'll plan
-on keeping any tooling outside of the core framework.
-
----
-
-## Funding
-
-REST framework is a *collaboratively funded project*. If you use
-REST framework commercially we strongly encourage you to invest in its
-continued development by **[signing up for a paid plan][funding]**.
-
-*Every single sign-up helps us make REST framework long-term financially sustainable.*
-
-<ul class="premium-promo promo">
-    <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
-    <li><a href="https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
-    <li><a href="https://software.esg-usa.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/esg-new-logo.png)">ESG</a></li>
-    <li><a href="https://rollbar.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li>
-    <li><a href="https://cadre.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cadre.png)">Cadre</a></li>
-    <li><a href="https://hubs.ly/H0f30Lf0" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/kloudless-plus-text.png)">Kloudless</a></li>
-    <li><a href="https://lightsonsoftware.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/lightson-dark.png)">Lights On Software</a></li>
-</ul>
-<div style="clear: both; padding-bottom: 20px;"></div>
-
-*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), and [Lights On Software](https://lightsonsoftware.com).*
-
-[legacy-core-api-docs]:https://github.com/encode/django-rest-framework/blob/3.14.0/docs/coreapi/index.md
-[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
-[funding]: funding.md

docs/community/3.11-announcement.md

@@ -1,118 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.11
-
-The 3.11 release adds support for Django 3.0.
-
-* Our supported Python versions are now: 3.5, 3.6, 3.7, and 3.8.
-* Our supported Django versions are now: 1.11, 2.0, 2.1, 2.2, and 3.0.
-
-This release will be the last to support Python 3.5 or Django 1.11.
-
-## OpenAPI Schema Generation Improvements
-
-The OpenAPI schema generation continues to mature. Some highlights in 3.11
-include:
-
-* Automatic mapping of Django REST Framework renderers and parsers into OpenAPI
-  request and response media-types.
-* Improved mapping JSON schema mapping types, for example in HStoreFields, and
-  with large integer values.
-* Porting of the old CoreAPI parsing of docstrings to form OpenAPI operation
-  descriptions.
-
-In this example view operation descriptions for the `get` and `post` methods will
-be extracted from the class docstring:
-
-```python
-class DocStringExampleListView(APIView):
-    """
-    get: A description of my GET operation.
-    post: A description of my POST operation.
-    """
-
-    permission_classes = [permissions.IsAuthenticatedOrReadOnly]
-
-    def get(self, request, *args, **kwargs):
-        ...
-
-    def post(self, request, *args, **kwargs):
-        ...
-```
-
-## Validator / Default Context
-
-In some circumstances a Validator class or a Default class may need to access the serializer field with which it is called, or the `.context` with which the serializer was instantiated. In particular:
-
-* Uniqueness validators need to be able to determine the name of the field to which they are applied, in order to run an appropriate database query.
-* The `CurrentUserDefault` needs to be able to determine the context with which the serializer was instantiated, in order to return the current user instance.
-
-Our previous approach to this was that implementations could include a `set_context` method, which would be called prior to validation. However this approach had issues with potential race conditions. We have now move this approach into a pending deprecation state. It will continue to function, but will be escalated to a deprecated state in 3.12, and removed entirely in 3.13.
-
-Instead, validators or defaults which require the serializer context, should include a `requires_context = True` attribute on the class.
-
-The `__call__` method should then include an additional `serializer_field` argument.
-
-Validator implementations will look like this:
-
-```python
-class CustomValidator:
-    requires_context = True
-
-    def __call__(self, value, serializer_field):
-        ...
-```
-
-Default implementations will look like this:
-
-```python
-class CustomDefault:
-    requires_context = True
-
-    def __call__(self, serializer_field):
-        ...
-```
-
----
-
-## Funding
-
-REST framework is a *collaboratively funded project*. If you use
-REST framework commercially we strongly encourage you to invest in its
-continued development by **[signing up for a paid plan][funding]**.
-
-*Every single sign-up helps us make REST framework long-term financially sustainable.*
-
-<ul class="premium-promo promo">
-    <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
-    <li><a href="https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
-    <li><a href="https://software.esg-usa.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/esg-new-logo.png)">ESG</a></li>
-    <li><a href="https://rollbar.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li>
-    <li><a href="https://cadre.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cadre.png)">Cadre</a></li>
-    <li><a href="https://hubs.ly/H0f30Lf0" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/kloudless-plus-text.png)">Kloudless</a></li>
-    <li><a href="https://lightsonsoftware.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/lightson-dark.png)">Lights On Software</a></li>
-    <li><a href="https://retool.com/?utm_source=djangorest&utm_medium=sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/retool-sidebar.png)">Retool</a></li>
-</ul>
-<div style="clear: both; padding-bottom: 20px;"></div>
-
-*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), [Lights On Software](https://lightsonsoftware.com), and [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship).*
-
-[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
-[funding]: funding.md

docs/community/3.12-announcement.md

@@ -1,181 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.12
-
-REST framework 3.12 brings a handful of refinements to the OpenAPI schema
-generation, plus support for Django's new database-agnostic `JSONField`,
-and some improvements to the `SearchFilter` class.
-
-## Grouping operations with tags.
-
-Open API schemas will now automatically include tags, based on the first element
-in the URL path.
-
-For example...
-
-Method                          | Path            | Tags
---------------------------------|-----------------|-------------
-`GET`, `PUT`, `PATCH`, `DELETE` | `/users/{id}/`  | `['users']`
-`GET`, `POST`                   | `/users/`       | `['users']`
-`GET`, `PUT`, `PATCH`, `DELETE` | `/orders/{id}/` | `['orders']`
-`GET`, `POST`                   | `/orders/`      | `['orders']`
-
-The tags used for a particular view may also be overridden...
-
-```python
-class MyOrders(APIView):
-    schema = AutoSchema(tags=["users", "orders"])
-    ...
-```
-
-See [the schema documentation](https://www.django-rest-framework.org/api-guide/schemas/#grouping-operations-with-tags) for more information.
-
-## Customizing the operation ID.
-
-REST framework automatically determines operation IDs to use in OpenAPI
-schemas. The latest version provides more control for overriding the behaviour
-used to generate the operation IDs.
-
-See [the schema documentation](https://www.django-rest-framework.org/api-guide/schemas/#operationid) for more information.
-
-## Support for OpenAPI components.
-
-In order to output more graceful OpenAPI schemes, REST framework 3.12 now
-defines components in the schema, and then references them inside request
-and response objects. This is in contrast with the previous approach, which
-fully expanded the request and response bodies for each operation.
-
-The names used for a component default to using the serializer class name, [but
-may be overridden if needed](https://www.django-rest-framework.org/api-guide/schemas/#components
-)...
-
-```python
-class MyOrders(APIView):
-    schema = AutoSchema(component_name="OrderDetails")
-```
-
-## More Public API
-
-Many methods on the `AutoSchema` class have now been promoted to public API,
-allowing you to more fully customize the schema generation. The following methods
-are now available for overriding...
-
-* `get_path_parameters`
-* `get_pagination_parameters`
-* `get_filter_parameters`
-* `get_request_body`
-* `get_responses`
-* `get_serializer`
-* `get_paginator`
-* `map_serializer`
-* `map_field`
-* `map_choice_field`
-* `map_field_validators`
-* `allows_filters`.
-
-See [the schema docs](https://www.django-rest-framework.org/api-guide/schemas/#per-view-customization)
-for details on using custom `AutoSchema` subclasses.
-
-## Support for JSONField.
-
-Django 3.1 deprecated the existing `django.contrib.postgres.fields.JSONField`
-in favour of a new database-agnositic `JSONField`.
-
-REST framework 3.12 now supports this new model field, and `ModelSerializer`
-classes will correctly map the model field.
-
-## SearchFilter improvements
-
-There are a couple of significant improvements to the `SearchFilter` class.
-
-### Nested searches against JSONField and HStoreField
-
-The class now supports nested search within `JSONField` and `HStoreField`, using
-the double underscore notation for traversing which element of the field the
-search should apply to.
-
-```python
-class SitesSearchView(generics.ListAPIView):
-    """
-    An API view to return a list of archaeological sites, optionally filtered
-    by a search against the site name or location. (Location searches are
-    matched against the region and country names.)
-    """
-
-    queryset = Sites.objects.all()
-    serializer_class = SitesSerializer
-    filter_backends = [filters.SearchFilter]
-    search_fields = ["site_name", "location__region", "location__country"]
-```
-
-### Searches against annotate fields
-
-Django allows querysets to create additional virtual fields, using the `.annotate`
-method. We now support searching against annotate fields.
-
-```python
-class PublisherSearchView(generics.ListAPIView):
-    """
-    Search for publishers, optionally filtering the search against the average
-    rating of all their books.
-    """
-
-    queryset = Publisher.objects.annotate(avg_rating=Avg("book__rating"))
-    serializer_class = PublisherSerializer
-    filter_backends = [filters.SearchFilter]
-    search_fields = ["avg_rating"]
-```
-
----
-
-## Deprecations
-
-### `serializers.NullBooleanField`
-
-`serializers.NullBooleanField` is now pending deprecation, and will be removed in 3.14.
-
-Instead use `serializers.BooleanField` field and set `allow_null=True` which does the same thing.
-
----
-
-## Funding
-
-REST framework is a *collaboratively funded project*. If you use
-REST framework commercially we strongly encourage you to invest in its
-continued development by **[signing up for a paid plan][funding]**.
-
-*Every single sign-up helps us make REST framework long-term financially sustainable.*
-
-<ul class="premium-promo promo">
-    <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
-    <li><a href="https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
-    <li><a href="https://software.esg-usa.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/esg-new-logo.png)">ESG</a></li>
-    <li><a href="https://rollbar.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li>
-    <li><a href="https://cadre.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cadre.png)">Cadre</a></li>
-    <li><a href="https://hubs.ly/H0f30Lf0" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/kloudless-plus-text.png)">Kloudless</a></li>
-    <li><a href="https://lightsonsoftware.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/lightson-dark.png)">Lights On Software</a></li>
-    <li><a href="https://retool.com/?utm_source=djangorest&utm_medium=sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/retool-sidebar.png)">Retool</a></li>
-</ul>
-<div style="clear: both; padding-bottom: 20px;"></div>
-
-*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), [Lights On Software](https://lightsonsoftware.com), and [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship).*
-
-[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
-[funding]: funding.md

docs/community/3.13-announcement.md

@@ -1,55 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.13
-
-## Django 4.0 support
-
-The latest release now fully supports Django 4.0.
-
-Our requirements are now:
-
-* Python 3.6+
-* Django 4.0, 3.2, 3.1, 2.2 (LTS)
-
-## Fields arguments are now keyword-only
-
-When instantiating fields on serializers, you should always use keyword arguments,
-such as `serializers.CharField(max_length=200)`. This has always been the case,
-and all the examples that we have in the documentation use keyword arguments,
-rather than positional arguments.
-
-From REST framework 3.13 onwards, this is now *explicitly enforced*.
-
-The most feasible cases where users might be accidentally omitting the keyword arguments
-are likely in the composite fields, `ListField` and `DictField`. For instance...
-
-```python
-aliases = serializers.ListField(serializers.CharField())
-```
-
-They must now use the more explicit keyword argument style...
-
-```python
-aliases = serializers.ListField(child=serializers.CharField())
-```
-
-This change has been made because using positional arguments here *does not* result in the expected behaviour.
-
-See Pull Request [#7632](https://github.com/encode/django-rest-framework/pull/7632) for more details.

docs/community/3.14-announcement.md

@@ -1,72 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.14
-
-## Django 4.1 support
-
-The latest release now fully supports Django 4.1, and drops support for Django 2.2.
-
-Our requirements are now:
-
-* Python 3.6+
-* Django 4.1, 4.0, 3.2, 3.1, 3.0
-
-## `raise_exception` argument for `is_valid` is now keyword-only.
-
-Calling `serializer_instance.is_valid(True)` is no longer acceptable syntax.
-If you'd like to use the `raise_exception` argument, you must use it as a
-keyword argument.
-
-See Pull Request [#7952](https://github.com/encode/django-rest-framework/pull/7952) for more details.
-
-## `ManyRelatedField` supports returning the default when the source attribute doesn't exist.
-
-Previously, if you used a serializer field with `many=True` with a dot notated source field
-that didn't exist, it would raise an `AttributeError`. Now it will return the default or be
-skipped depending on the other arguments.
-
-See Pull Request [#7574](https://github.com/encode/django-rest-framework/pull/7574) for more details.
-
-
-## Make Open API `get_reference` public.
-
-Returns a reference to the serializer component. This may be useful if you override `get_schema()`.
-
-## Change semantic of OR of two permission classes.
-
-When OR-ing two permissions, the request has to pass either class's `has_permission() and has_object_permission()`.
-
-Previously, both class's `has_permission()` was ignored when OR-ing two permissions together.
-
-See Pull Request [#7522](https://github.com/encode/django-rest-framework/pull/7522) for more details.
-
-## Minor fixes and improvements
-
-There are a number of minor fixes and improvements in this release. See the [release notes](release-notes.md) page for a complete listing.
-
----
-
-## Deprecations
-
-### `serializers.NullBooleanField`
-
-`serializers.NullBooleanField` was moved to pending deprecation in 3.12, and deprecated in 3.13. It has now been removed from the core framework.
-
-Instead use `serializers.BooleanField` field and set `allow_null=True` which does the same thing.

docs/community/3.15-announcement.md

@@ -1,50 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.15
-
-At the Internet, on March 15th, 2024, with 176 commits by 138 authors, we are happy to announce the release of Django REST framework 3.15.
-
-## Django 5.0 and Python 3.12 support
-
-The latest release now fully supports Django 5.0 and Python 3.12.
-
-The current minimum versions of Django still is 3.0 and Python 3.6.
-
-## Primary Support of UniqueConstraint
-
-`ModelSerializer` generates validators for [UniqueConstraint](https://docs.djangoproject.com/en/4.0/ref/models/constraints/#uniqueconstraint) (both UniqueValidator and UniqueTogetherValidator)
-
-## SimpleRouter non-regex matching support
-
-By default the URLs created by `SimpleRouter` use regular expressions. This behavior can be modified by setting the `use_regex_path` argument to `False` when instantiating the router.
-
-## ZoneInfo as the primary source of timezone data
-
-Dependency on pytz has been removed and deprecation warnings have been added, Django will provide ZoneInfo instances as long as USE_DEPRECATED_PYTZ is not enabled. More info on the migration can be found [in this guide](https://pytz-deprecation-shim.readthedocs.io/en/latest/migration.html).
-
-##  Align `SearchFilter` behaviour to `django.contrib.admin` search
-
-Searches now may contain _quoted phrases_ with spaces, each phrase is considered as a single search term, and it will raise a validation error if any null-character is provided in search. See the [Filtering API guide](../api-guide/filtering.md) for more information.
-
-## Other fixes and improvements
-
-There are a number of fixes and minor improvements in this release, ranging from documentation, internal infrastructure (typing, testing, requirements, deprecation, etc.), security and overall behaviour.
-
-See the [release notes](release-notes.md) page for a complete listing.

docs/community/3.16-announcement.md

@@ -1,42 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.16
-
-At the Internet, on March 28th, 2025, we are happy to announce the release of Django REST framework 3.16.
-
-## Updated Django and Python support
-
-The latest release now fully supports Django 5.1 and the upcoming 5.2 LTS as well as Python 3.13.
-
-The current minimum versions of Django is now 4.2 and Python 3.9.
-
-## Django LoginRequiredMiddleware
-
-The new `LoginRequiredMiddleware` introduced by Django 5.1 can now be used alongside Django REST Framework, however it is not honored for API views as an equivalent behaviour can be configured via `DEFAULT_AUTHENTICATION_CLASSES`. See [our dedicated section](../api-guide/authentication.md#django-51-loginrequiredmiddleware) in the docs for more information.
-
-## Improved support for UniqueConstraint
-
-The generation of validators for [UniqueConstraint](https://docs.djangoproject.com/en/stable/ref/models/constraints/#uniqueconstraint) has been improved to support better nullable fields and constraints with conditions.
-
-## Other fixes and improvements
-
-There are a number of fixes and minor improvements in this release, ranging from documentation, internal infrastructure (typing, testing, requirements, deprecation, etc.), security and overall behaviour.
-
-See the [release notes](release-notes.md) page for a complete listing.

docs/community/3.9-announcement.md

@@ -1,210 +0,0 @@
-<style>
-.promo li a {
-    float: left;
-    width: 130px;
-    height: 20px;
-    text-align: center;
-    margin: 10px 30px;
-    padding: 150px 0 0 0;
-    background-position: 0 50%;
-    background-size: 130px auto;
-    background-repeat: no-repeat;
-    font-size: 120%;
-    color: black;
-}
-.promo li {
-    list-style: none;
-}
-</style>
-
-# Django REST framework 3.9
-
-The 3.9 release gives access to _extra actions_ in the Browsable API, introduces composable permissions and built-in [OpenAPI][openapi] schema support. (Formerly known as Swagger)
-
----
-
-## Funding
-
-If you use REST framework commercially and would like to see this work continue, we strongly encourage you to invest in its continued development by
-**[signing up for a paid&nbsp;plan][funding]**.
-
-
-<ul class="premium-promo promo">
-    <li><a href="https://www.rover.com/careers/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
-    <li><a href="https://sentry.io/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
-    <li><a href="https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
-    <li><a href="https://auklet.io" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/auklet-new.png)">Auklet</a></li>
-    <li><a href="https://rollbar.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li>
-    <li><a href="https://cadre.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cadre.png)">Cadre</a></li>
-    <li><a href="https://loadimpact.com/?utm_campaign=Sponsorship%20links&utm_source=drf&utm_medium=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/load-impact.png)">Load Impact</a></li>
-    <li><a href="https://hubs.ly/H0f30Lf0" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/kloudless.png)">Kloudless</a></li>
-</ul>
-<div style="clear: both; padding-bottom: 20px;"></div>
-
-*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Rover](https://www.rover.com/careers/), [Sentry](https://sentry.io/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [Auklet](https://auklet.io/), [Rollbar](https://rollbar.com), [Cadre](https://cadre.com), [Load Impact](https://loadimpact.com/?utm_campaign=Sponsorship%20links&utm_source=drf&utm_medium=drf), and [Kloudless](https://hubs.ly/H0f30Lf0).*
-
----
-
-## Built-in OpenAPI schema support
-
-REST framework now has a first-pass at directly including OpenAPI schema support. (Formerly known as Swagger)
-
-Specifically:
-
-* There are now `OpenAPIRenderer`, and `JSONOpenAPIRenderer` classes that deal with encoding `coreapi.Document` instances into OpenAPI YAML or OpenAPI JSON.
-* The `get_schema_view(...)` method now defaults to OpenAPI YAML, with CoreJSON as a secondary
-option if it is selected via HTTP content negotiation.
-* There is a new management command `generateschema`, which you can use to dump
-the schema into your repository.
-
-Here's an example of adding an OpenAPI schema to the URL conf:
-
-```python
-from rest_framework.schemas import get_schema_view
-from rest_framework.renderers import JSONOpenAPIRenderer
-from django.urls import path
-
-schema_view = get_schema_view(
-    title="Server Monitoring API",
-    url="https://www.example.org/api/",
-    renderer_classes=[JSONOpenAPIRenderer],
-)
-
-urlpatterns = [path("schema.json", schema_view), ...]
-```
-
-And here's how you can use the `generateschema` management command:
-
-```shell
-$ python manage.py generateschema --format openapi > schema.yml
-```
-
-There's lots of different tooling that you can use for working with OpenAPI
-schemas. One option that we're working on is the [API Star](https://docs.apistar.com/)
-command line tool.
-
-You can use `apistar` to validate your API schema:
-
-```shell
-$ apistar validate --path schema.json --format openapi
-✓ Valid OpenAPI schema.
-```
-
-Or to build API documentation:
-
-```shell
-$ apistar docs --path schema.json --format openapi
-✓ Documentation built at "build/index.html".
-```
-
-API Star also includes a [dynamic client library](https://docs.apistar.com/client-library/)
-that uses an API schema to automatically provide a client library interface for making requests.
-
-## Composable permission classes
-
-You can now compose permission classes using the and/or operators, `&` and `|`.
-
-For example...
-
-```python
-permission_classes = [IsAuthenticated & (ReadOnly | IsAdminUser)]
-```
-
-If you're using custom permission classes then make sure that you are subclassing
-from `BasePermission` in order to enable this support.
-
-## ViewSet _Extra Actions_ available in the Browsable API
-
-Following the introduction of the `action` decorator in v3.8, _extra actions_ defined on a ViewSet are now available
-from the Browsable API.
-
-![Extra Actions displayed in the Browsable API](https://user-images.githubusercontent.com/2370209/32976956-1ca9ab7e-cbf1-11e7-981a-a20cb1e83d63.png)
-
-When defined, a dropdown of "Extra Actions", appropriately filtered to detail/non-detail actions, is displayed.
-
----
-
-## Supported Versions
-
-REST framework 3.9 supports Django versions 1.11, 2.0, and 2.1.
-
----
-
-## Deprecations
-
-### `DjangoObjectPermissionsFilter` moved to third-party package.
-
-The `DjangoObjectPermissionsFilter` class is pending deprecation, will be deprecated in 3.10 and removed entirely in 3.11.
-
-It has been moved to the third-party [`djangorestframework-guardian`](https://github.com/rpkilby/django-rest-framework-guardian)
-package. Please use this instead.
-
-### Router argument/method renamed to use `basename` for consistency.
-
-* The `Router.register` `base_name` argument has been renamed in favor of `basename`.
-* The `Router.get_default_base_name` method has been renamed in favor of `Router.get_default_basename`. [#5990][gh5990]
-
-See [#5990][gh5990].
-
-[gh5990]: https://github.com/encode/django-rest-framework/pull/5990
-
-`base_name` and `get_default_base_name()` are pending deprecation. They will be deprecated in 3.10 and removed entirely in 3.11.
-
-### `action` decorator replaces `list_route` and `detail_route`
-
-Both `list_route` and `detail_route` are now deprecated in favour of the single `action` decorator.
-They will be removed entirely in 3.10.
-
-The `action` decorator takes a boolean `detail` argument.
-
-* Replace `detail_route` uses with `@action(detail=True)`.
-* Replace `list_route` uses with `@action(detail=False)`.
-
-### `exclude_from_schema`
-
-Both `APIView.exclude_from_schema` and the `exclude_from_schema` argument to the `@api_view` have now been removed.
-
-For `APIView` you should instead set a `schema = None` attribute on the view class.
-
-For function-based views the `@schema` decorator can be used to exclude the view from the schema, by using `@schema(None)`.
-
----
-
-## Minor fixes and improvements
-
-There are a large number of minor fixes and improvements in this release. See the [release notes](release-notes.md) page for a complete listing.
-
-
-## What's next
-
-We're planning to iteratively work towards OpenAPI becoming the standard schema
-representation. This will mean that the `coreapi` dependency will gradually become
-removed, and we'll instead generate the schema directly, rather than building
-a CoreAPI `Document` object.
-
-OpenAPI has clearly become the standard for specifying Web APIs, so there's not
-much value any more in our schema-agnostic document model. Making this change
-will mean that we'll more easily be able to take advantage of the full set of
-OpenAPI functionality.
-
-This will also make a wider range of tooling available.
-
-We'll focus on continuing to develop the [API Star](https://docs.apistar.com/)
-library and client tool into a recommended option for generating API docs,
-validating API schemas, and providing a dynamic client library.
-
-There's also a huge amount of ongoing work on maturing the ASGI landscape,
-with the possibility that some of this work will eventually [feed back into
-Django](https://www.aeracode.org/2018/06/04/django-async-roadmap/).
-
-There will be further work on the [Uvicorn](https://www.uvicorn.org/)
-web server, as well as lots of functionality planned for the [Starlette](https://www.starlette.io/)
-web framework, which is building a foundational set of tooling for working with
-ASGI.
-
-
-[funding]: funding.md
-[gh5886]: https://github.com/encode/django-rest-framework/issues/5886
-[gh5705]: https://github.com/encode/django-rest-framework/issues/5705
-[openapi]: https://www.openapis.org/
-[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors

docs/index.md

@@ -20,17 +20,21 @@
 <p class="badges" height=20px>
     <iframe src="https://ghbtns.com/github-btn.html?user=encode&amp;repo=django-rest-framework&amp;type=watch&amp;count=true" class="github-star-button" allowtransparency="true" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
 
-    <a href="https://github.com/encode/django-rest-framework/actions/workflows/main.yml">
-        <img src="https://github.com/encode/django-rest-framework/actions/workflows/main.yml/badge.svg" class="status-badge">
+    <a href="https://travis-ci.org/encode/django-rest-framework?branch=master">
+        <img src="https://secure.travis-ci.org/encode/django-rest-framework.svg?branch=master" class="status-badge">
     </a>
 
-    <a href="https://pypi.org/project/djangorestframework/">
+    <a href="https://pypi.python.org/pypi/djangorestframework">
         <img src="https://img.shields.io/pypi/v/djangorestframework.svg" class="status-badge">
     </a>
 </p>
 
 ---
 
+**Note**: This is the documentation for the **version 3** of REST framework. Documentation for [version 2](https://tomchristie.github.io/rest-framework-2-docs/) is also available.
+
+---
+
 <p>
 <h1 style="position: absolute;
     width: 1px;
@@ -48,11 +52,11 @@ Django REST framework is a powerful and flexible toolkit for building Web APIs.
 
 Some reasons you might want to use REST framework:
 
-* The Web browsable API is a huge usability win for your developers.
+* The [Web browsable API][sandbox] is a huge usability win for your developers.
 * [Authentication policies][authentication] including packages for [OAuth1a][oauth1-section] and [OAuth2][oauth2-section].
 * [Serialization][serializers] that supports both [ORM][modelserializer-section] and [non-ORM][serializer-section] data sources.
 * Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views] [powerful][viewsets] [features][routers].
-* Extensive documentation, and [great community support][group].
+* [Extensive documentation][index], and [great community support][group].
 * Used and trusted by internationally recognised companies including [Mozilla][mozilla], [Red Hat][redhat], [Heroku][heroku], and [Eventbrite][eventbrite].
 
 ---
@@ -66,20 +70,15 @@ continued development by **[signing up for a paid plan][funding]**.
 *Every single sign-up helps us make REST framework long-term financially sustainable.*
 
 <ul class="premium-promo promo">
+    <li><a href="http://jobs.rover.com/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
     <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
-    <li><a href="https://getstream.io/?utm_source=DjangoRESTFramework&utm_medium=Webpage_Logo_Ad&utm_content=Developer&utm_campaign=DjangoRESTFramework_Jan2022_HomePage" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
-    <li><a href="https://www.spacinov.com/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/spacinov.png)">Spacinov</a></li>
-    <li><a href="https://retool.com/?utm_source=djangorest&utm_medium=sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/retool-sidebar.png)">Retool</a></li>
-    <li><a href="https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/bitio_logo_gold_background.png)">bit.io</a></li>
-    <li><a href="https://posthog.com?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/135996800-d49fe024-32d9-441a-98d9-4c7596287a67.png)">PostHog</a></li>
-    <li><a href="https://cryptapi.io" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cryptapi.png)">CryptAPI</a></li>
-    <li><a href="https://www.fezto.xyz/?utm_source=DjangoRESTFramework" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/fezto.png)">FEZTO</a></li>
-    <li><a href="https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/svix.png)">Svix</a></li>
-    <li><a href="https://zuplo.link/django-web" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/zuplo.png)">Zuplo</a></li>
+    <li><a href="https://getstream.io/try-the-api/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
+    <li><a href="https://hello.machinalis.co.uk/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/Machinalis130.png)">Machinalis</a></li>
+    <li><a href="https://rollbar.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li>
 </ul>
 <div style="clear: both; padding-bottom: 20px;"></div>
 
-*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=DjangoRESTFramework&utm_medium=Webpage_Logo_Ad&utm_content=Developer&utm_campaign=DjangoRESTFramework_Jan2022_HomePage), [Spacinov](https://www.spacinov.com/), [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship), [bit.io](https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [PostHog](https://posthog.com?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [CryptAPI](https://cryptapi.io), [FEZTO](https://www.fezto.xyz/?utm_source=DjangoRESTFramework), [Svix](https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship), , and [Zuplo](https://zuplo.link/django-web).*
+*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Rover](http://jobs.rover.com/), [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [Machinalis](https://hello.machinalis.co.uk/), and [Rollbar](https://rollbar.com).*
 
 ---
 
@@ -87,18 +86,15 @@ continued development by **[signing up for a paid plan][funding]**.
 
 REST framework requires the following:
 
-* Django (4.2, 5.0, 5.1, 5.2)
-* Python (3.9, 3.10, 3.11, 3.12, 3.13)
-
-We **highly recommend** and only officially support the latest patch release of
-each Python and Django series.
+* Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
+* Django (1.10, 1.11, 2.0)
 
 The following packages are optional:
 
-* [PyYAML][pyyaml], [uritemplate][uriteemplate] (5.1+, 3.0.0+) - Schema generation support.
-* [Markdown][markdown] (3.3.0+) - Markdown support for the browsable API.
-* [Pygments][pygments] (2.7.0+) - Add syntax highlighting to Markdown processing.
+* [coreapi][coreapi] (1.32.0+) - Schema generation support.
+* [Markdown][markdown] (2.1.0+) - Markdown support for the browsable API.
 * [django-filter][django-filter] (1.0.1+) - Filtering support.
+* [django-crispy-forms][django-crispy-forms] - Improved HTML display for filtering.
 * [django-guardian][django-guardian] (1.1.1+) - Object level permissions support.
 
 ## Installation
@@ -111,20 +107,20 @@ Install using `pip`, including any optional packages you want...
 
 ...or clone the project from github.
 
-    git clone https://github.com/encode/django-rest-framework
+    git clone git@github.com:encode/django-rest-framework.git
 
 Add `'rest_framework'` to your `INSTALLED_APPS` setting.
 
-    INSTALLED_APPS = [
+    INSTALLED_APPS = (
         ...
         'rest_framework',
-    ]
+    )
 
 If you're intending to use the browsable API you'll probably also want to add REST framework's login and logout views.  Add the following to your root `urls.py` file.
 
     urlpatterns = [
         ...
-        path('api-auth/', include('rest_framework.urls'))
+        url(r'^api-auth/', include('rest_framework.urls'))
     ]
 
 Note that the URL path can be whatever you want.
@@ -150,15 +146,15 @@ Don't forget to make sure you've also added `rest_framework` to your `INSTALLED_
 We're ready to create our API now.
 Here's our project's root `urls.py` module:
 
-    from django.urls import path, include
+    from django.conf.urls import url, include
     from django.contrib.auth.models import User
     from rest_framework import routers, serializers, viewsets
 
-    # Serializers define the API representation.
-    class UserSerializer(serializers.HyperlinkedModelSerializer):
-        class Meta:
-            model = User
-            fields = ['url', 'username', 'email', 'is_staff']
+	# Serializers define the API representation.
+	class UserSerializer(serializers.HyperlinkedModelSerializer):
+	    class Meta:
+	        model = User
+	        fields = ('url', 'username', 'email', 'is_staff')
 
     # ViewSets define the view behavior.
     class UserViewSet(viewsets.ModelViewSet):
@@ -172,8 +168,8 @@ Here's our project's root `urls.py` module:
     # Wire up our API using automatic URL routing.
     # Additionally, we include login URLs for the browsable API.
     urlpatterns = [
-        path('', include(router.urls)),
-        path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
+        url(r'^', include(router.urls)),
+        url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
     ]
 
 You can now open the API in your browser at [http://127.0.0.1:8000/](http://127.0.0.1:8000/), and view your new 'users' API. If you use the login control in the top right corner you'll also be able to add, create and delete users from the system.
@@ -182,42 +178,118 @@ You can now open the API in your browser at [http://127.0.0.1:8000/](http://127.
 
 Can't wait to get started? The [quickstart guide][quickstart] is the fastest way to get up and running, and building APIs with REST framework.
 
+## Tutorial
+
+The tutorial will walk you through the building blocks that make up REST framework.   It'll take a little while to get through, but it'll give you a comprehensive understanding of how everything fits together, and is highly recommended reading.
+
+* [1 - Serialization][tut-1]
+* [2 - Requests & Responses][tut-2]
+* [3 - Class-based views][tut-3]
+* [4 - Authentication & permissions][tut-4]
+* [5 - Relationships & hyperlinked APIs][tut-5]
+* [6 - Viewsets & routers][tut-6]
+* [7 - Schemas & client libraries][tut-7]
+
+There is a live example API of the finished tutorial API for testing purposes, [available here][sandbox].
+
+## API Guide
+
+The API guide is your complete reference manual to all the functionality provided by REST framework.
+
+* [Requests][request]
+* [Responses][response]
+* [Views][views]
+* [Generic views][generic-views]
+* [Viewsets][viewsets]
+* [Routers][routers]
+* [Parsers][parsers]
+* [Renderers][renderers]
+* [Serializers][serializers]
+* [Serializer fields][fields]
+* [Serializer relations][relations]
+* [Validators][validators]
+* [Authentication][authentication]
+* [Permissions][permissions]
+* [Throttling][throttling]
+* [Filtering][filtering]
+* [Pagination][pagination]
+* [Versioning][versioning]
+* [Content negotiation][contentnegotiation]
+* [Metadata][metadata]
+* [Schemas][schemas]
+* [Format suffixes][formatsuffixes]
+* [Returning URLs][reverse]
+* [Exceptions][exceptions]
+* [Status codes][status]
+* [Testing][testing]
+* [Settings][settings]
+
+## Topics
+
+General guides to using REST framework.
+
+* [Documenting your API][documenting-your-api]
+* [API Clients][api-clients]
+* [Internationalization][internationalization]
+* [AJAX, CSRF & CORS][ajax-csrf-cors]
+* [HTML & Forms][html-and-forms]
+* [Browser enhancements][browser-enhancements]
+* [The Browsable API][browsableapi]
+* [REST, Hypermedia & HATEOAS][rest-hypermedia-hateoas]
+* [Third Party Packages][third-party-packages]
+* [Tutorials and Resources][tutorials-and-resources]
+* [Contributing to REST framework][contributing]
+* [Project management][project-management]
+* [3.0 Announcement][3.0-announcement]
+* [3.1 Announcement][3.1-announcement]
+* [3.2 Announcement][3.2-announcement]
+* [3.3 Announcement][3.3-announcement]
+* [3.4 Announcement][3.4-announcement]
+* [3.5 Announcement][3.5-announcement]
+* [3.6 Announcement][3.6-announcement]
+* [3.7 Announcement][3.7-announcement]
+* [Kickstarter Announcement][kickstarter-announcement]
+* [Mozilla Grant][mozilla-grant]
+* [Funding][funding]
+* [Release Notes][release-notes]
+* [Jobs][jobs]
+
 ## Development
 
 See the [Contribution guidelines][contributing] for information on how to clone
-the repository, run the test suite and help maintain the code base of REST
+the repository, run the test suite and contribute changes back to REST
 Framework.
 
 ## Support
 
-For support please see the [REST framework discussion group][group], try the `#restframework` channel on `irc.libera.chat`, or raise a question on [Stack Overflow][stack-overflow], making sure to include the ['django-rest-framework'][django-rest-framework-tag] tag.
+For support please see the [REST framework discussion group][group], try the  `#restframework` channel on `irc.freenode.net`, search [the IRC archives][botbot], or raise a  question on [Stack Overflow][stack-overflow], making sure to include the ['django-rest-framework'][django-rest-framework-tag] tag.
 
 For priority support please sign up for a [professional or premium sponsorship plan](https://fund.django-rest-framework.org/topics/funding/).
 
+For updates on REST framework development, you may also want to follow [the author][twitter] on Twitter.
+
+<a style="padding-top: 10px" href="https://twitter.com/_tomchristie" class="twitter-follow-button" data-show-count="false">Follow @_tomchristie</a>
+<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
 ## Security
 
-**Please report security issues by emailing security@encode.io**.
+If you believe you’ve found something in Django REST framework which has security implications, please **do not raise the issue in a public forum**.
 
-The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.
+Send a description of the issue via email to [rest-framework-security@googlegroups.com][security-mail].  The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.
 
 ## License
 
-Copyright © 2011-present, [Encode OSS Ltd](https://www.encode.io/).
+Copyright (c) 2011-2017, Tom Christie
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
@@ -234,11 +306,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 [redhat]: https://www.redhat.com/
 [heroku]: https://www.heroku.com/
 [eventbrite]: https://www.eventbrite.co.uk/about/
-[pyyaml]: https://pypi.org/project/PyYAML/
-[uriteemplate]: https://pypi.org/project/uritemplate/
-[markdown]: https://pypi.org/project/Markdown/
-[pygments]: https://pypi.org/project/Pygments/
-[django-filter]: https://pypi.org/project/django-filter/
+[coreapi]: https://pypi.python.org/pypi/coreapi/
+[markdown]: https://pypi.python.org/pypi/Markdown/
+[django-filter]: https://pypi.python.org/pypi/django-filter
+[django-crispy-forms]: https://github.com/maraujop/django-crispy-forms
 [django-guardian]: https://github.com/django-guardian/django-guardian
 [index]: .
 [oauth1-section]: api-guide/authentication/#django-rest-framework-oauth
@@ -246,20 +317,74 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 [serializer-section]: api-guide/serializers#serializers
 [modelserializer-section]: api-guide/serializers#modelserializer
 [functionview-section]: api-guide/views#function-based-views
+[sandbox]: https://restframework.herokuapp.com/
 [sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
 
 [quickstart]: tutorial/quickstart.md
+[tut-1]: tutorial/1-serialization.md
+[tut-2]: tutorial/2-requests-and-responses.md
+[tut-3]: tutorial/3-class-based-views.md
+[tut-4]: tutorial/4-authentication-and-permissions.md
+[tut-5]: tutorial/5-relationships-and-hyperlinked-apis.md
+[tut-6]: tutorial/6-viewsets-and-routers.md
+[tut-7]: tutorial/7-schemas-and-client-libraries.md
 
+[request]: api-guide/requests.md
+[response]: api-guide/responses.md
+[views]: api-guide/views.md
 [generic-views]: api-guide/generic-views.md
 [viewsets]: api-guide/viewsets.md
 [routers]: api-guide/routers.md
+[parsers]: api-guide/parsers.md
+[renderers]: api-guide/renderers.md
 [serializers]: api-guide/serializers.md
+[fields]: api-guide/fields.md
+[relations]: api-guide/relations.md
+[validators]: api-guide/validators.md
 [authentication]: api-guide/authentication.md
+[permissions]: api-guide/permissions.md
+[throttling]: api-guide/throttling.md
+[filtering]: api-guide/filtering.md
+[pagination]: api-guide/pagination.md
+[versioning]: api-guide/versioning.md
+[contentnegotiation]: api-guide/content-negotiation.md
+[metadata]: api-guide/metadata.md
+[schemas]: api-guide/schemas.md
+[formatsuffixes]: api-guide/format-suffixes.md
+[reverse]: api-guide/reverse.md
+[exceptions]: api-guide/exceptions.md
+[status]: api-guide/status-codes.md
+[testing]: api-guide/testing.md
+[settings]: api-guide/settings.md
 
-[contributing]: community/contributing.md
-[funding]: community/funding.md
+[documenting-your-api]: topics/documenting-your-api.md
+[api-clients]: topics/api-clients.md
+[internationalization]: topics/internationalization.md
+[ajax-csrf-cors]: topics/ajax-csrf-cors.md
+[html-and-forms]: topics/html-and-forms.md
+[browser-enhancements]: topics/browser-enhancements.md
+[browsableapi]: topics/browsable-api.md
+[rest-hypermedia-hateoas]: topics/rest-hypermedia-hateoas.md
+[contributing]: topics/contributing.md
+[project-management]: topics/project-management.md
+[third-party-packages]: topics/third-party-packages.md
+[tutorials-and-resources]: topics/tutorials-and-resources.md
+[3.0-announcement]: topics/3.0-announcement.md
+[3.1-announcement]: topics/3.1-announcement.md
+[3.2-announcement]: topics/3.2-announcement.md
+[3.3-announcement]: topics/3.3-announcement.md
+[3.4-announcement]: topics/3.4-announcement.md
+[3.5-announcement]: topics/3.5-announcement.md
+[3.6-announcement]: topics/3.6-announcement.md
+[3.7-announcement]: topics/3.7-announcement.md
+[kickstarter-announcement]: topics/kickstarter-announcement.md
+[mozilla-grant]: topics/mozilla-grant.md
+[funding]: topics/funding.md
+[release-notes]: topics/release-notes.md
+[jobs]: topics/jobs.md
 
 [group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
+[botbot]: https://botbot.me/freenode/restframework/
 [stack-overflow]: https://stackoverflow.com/
 [django-rest-framework-tag]: https://stackoverflow.com/questions/tagged/django-rest-framework
 [security-mail]: mailto:rest-framework-security@googlegroups.com

docs/topics/2.2-announcement.md

@@ -0,0 +1,158 @@
+# Django REST framework 2.2
+
+The 2.2 release represents an important point for REST framework, with the addition of Python 3 support, and the introduction of an official deprecation policy.
+
+## Python 3 support
+
+Thanks to some fantastic work from [Xavier Ordoquy][xordoquy], Django REST framework 2.2 now supports Python 3.  You'll need to be running Django 1.5, and it's worth keeping in mind that Django's Python 3 support is currently [considered experimental][django-python-3].
+
+Django 1.6's Python 3 support is expected to be officially labeled as 'production-ready'.
+
+If you want to start ensuring that your own projects are Python 3 ready, we can highly recommend Django's [Porting to Python 3][porting-python-3] documentation.
+
+Django REST framework's Python 2.6 support now requires 2.6.5 or above, in line with [Django 1.5's Python compatibility][python-compat].
+
+## Deprecation policy
+
+We've now introduced an official deprecation policy, which is in line with [Django's deprecation policy][django-deprecation-policy].  This policy will make it easy for you to continue to track the latest, greatest version of REST framework.
+
+The timeline for deprecation works as follows:
+
+* Version 2.2 introduces some API changes as detailed in the release notes.  It remains fully backwards compatible with 2.1, but will raise `PendingDeprecationWarning` warnings if you use bits of API that are due to be deprecated.  These warnings are silent by default, but can be explicitly enabled when you're ready to start migrating any required changes.  For example if you start running your tests using `python -Wd manage.py test`, you'll be warned of any API changes you need to make.
+
+* Version 2.3 will escalate these warnings to `DeprecationWarning`, which is loud by default.
+
+* Version 2.4 will remove the deprecated bits of API entirely.
+
+Note that in line with Django's policy, any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.
+
+## Community
+
+As of the 2.2 merge, we've also hit an impressive milestone.  The number of committers listed in [the credits][credits], is now at over **one hundred individuals**.  Each name on that list represents at least one merged pull request, however large or small.
+
+Our [mailing list][mailing-list] and #restframework IRC channel are also very active, and we've got a really impressive rate of development both on REST framework itself, and on third party packages such as the great [django-rest-framework-docs][django-rest-framework-docs] package from [Marc Gibbons][marcgibbons].
+
+---
+
+## API changes
+
+The 2.2 release makes a few changes to the API, in order to make it more consistent, simple, and easier to use.
+
+### Cleaner to-many related fields
+
+The `ManyRelatedField()` style is being deprecated in favor of a new `RelatedField(many=True)` syntax.
+
+For example, if a user is associated with multiple questions, which we want to represent using a primary key relationship, we might use something like the following:
+
+    class UserSerializer(serializers.HyperlinkedModelSerializer):
+        questions = serializers.PrimaryKeyRelatedField(many=True)
+
+        class Meta:
+            fields = ('username', 'questions')
+
+The new syntax is cleaner and more obvious, and the change will also make the documentation cleaner, simplify the internal API, and make writing custom relational fields easier.
+
+The change also applies to serializers.  If you have a nested serializer, you should start using `many=True` for to-many relationships.  For example, a serializer representation of an Album that can contain many Tracks might look something like this:
+
+    class TrackSerializer(serializer.ModelSerializer):
+        class Meta:
+            model = Track
+            fields = ('name', 'duration')
+
+    class AlbumSerializer(serializer.ModelSerializer):
+        tracks = TrackSerializer(many=True)
+
+        class Meta:
+            model = Album
+            fields = ('album_name', 'artist', 'tracks')
+
+Additionally, the change also applies when serializing or deserializing data.  For example to serialize a queryset of models you should now use the `many=True` flag.
+
+    serializer = SnippetSerializer(Snippet.objects.all(), many=True)
+    serializer.data
+
+This more explicit behavior on serializing and deserializing data [makes integration with non-ORM backends such as MongoDB easier][564], as instances to be serialized can include the `__iter__` method, without incorrectly triggering list-based serialization, or requiring workarounds.
+
+The implicit to-many behavior on serializers, and the `ManyRelatedField` style classes will continue to function, but will raise a `PendingDeprecationWarning`, which can be made visible using the `-Wd` flag.
+
+**Note**: If you need to forcibly turn off the implicit "`many=True` for `__iter__` objects" behavior, you can now do so by specifying `many=False`.  This will become the default (instead of the current default of `None`) once the deprecation of the implicit behavior is finalised in version 2.4.
+
+### Cleaner optional relationships
+
+Serializer relationships for nullable Foreign Keys will change from using the current `null=True` flag, to instead using `required=False`.
+
+For example, is a user account has an optional foreign key to a company, that you want to express using a hyperlink, you might use the following field in a `Serializer` class:
+
+    current_company = serializers.HyperlinkedRelatedField(required=False)
+
+This is in line both with the rest of the serializer fields API, and with Django's `Form` and `ModelForm` API.
+
+Using `required` throughout the serializers API means you won't need to consider if a particular field should take `blank` or `null` arguments instead of `required`, and also means there will be more consistent behavior for how fields are treated when they are not present in the incoming data.
+
+The `null=True` argument will continue to function, and will imply `required=False`, but will raise a `PendingDeprecationWarning`.
+
+### Cleaner CharField syntax
+
+The `CharField` API previously took an optional `blank=True` argument, which was intended to differentiate between null CharField input, and blank CharField input.
+
+In keeping with Django's CharField API, REST framework's `CharField` will only ever return the empty string, for missing or `None` inputs.  The `blank` flag will no longer be in use, and you should instead just use the `required=<bool>` flag.  For example:
+
+    extra_details = CharField(required=False)
+
+The `blank` keyword argument will continue to function, but will raise a `PendingDeprecationWarning`.
+
+### Simpler object-level permissions
+
+Custom permissions classes previously used the signature `.has_permission(self, request, view, obj=None)`.  This method would be called twice, firstly for the global permissions check, with the `obj` parameter set to `None`, and again for the object-level permissions check when appropriate, with the `obj` parameter set to the relevant model instance.
+
+The global permissions check and object-level permissions check are now separated into two separate methods, which gives a cleaner, more obvious API.
+
+* Global permission checks now use the `.has_permission(self, request, view)` signature.
+* Object-level permission checks use a new method `.has_object_permission(self, request, view, obj)`.
+
+For example, the following custom permission class:
+
+    class IsOwner(permissions.BasePermission):
+        """
+        Custom permission to only allow owners of an object to view or edit it.
+        Model instances are expected to include an `owner` attribute.
+        """
+
+        def has_permission(self, request, view, obj=None):
+            if obj is None:
+                # Ignore global permissions check
+                return True
+
+            return obj.owner == request.user
+
+Now becomes:
+
+    class IsOwner(permissions.BasePermission):
+        """
+        Custom permission to only allow owners of an object to view or edit it.
+        Model instances are expected to include an `owner` attribute.
+        """
+
+        def has_object_permission(self, request, view, obj):
+            return obj.owner == request.user
+
+If you're overriding the `BasePermission` class, the old-style signature will continue to function, and will correctly handle both global and object-level permissions checks, but its use will raise a `PendingDeprecationWarning`.
+
+Note also that the usage of the internal APIs for permission checking on the `View` class has been cleaned up slightly, and is now documented and subject to the deprecation policy in all future versions.
+
+### More explicit hyperlink relations behavior
+
+When using a serializer with a `HyperlinkedRelatedField` or `HyperlinkedIdentityField`, the hyperlinks would previously use absolute URLs if the serializer context included a `'request'` key, and fall back to using relative URLs otherwise.  This could lead to non-obvious behavior, as it might not be clear why some serializers generated absolute URLs, and others do not.
+
+From version 2.2 onwards, serializers with hyperlinked relationships *always* require a `'request'` key to be supplied in the context dictionary.  The implicit behavior will continue to function, but its use will raise a `PendingDeprecationWarning`.
+
+[xordoquy]: https://github.com/xordoquy
+[django-python-3]: https://docs.djangoproject.com/en/stable/faq/install/#can-i-use-django-with-python-3
+[porting-python-3]: https://docs.djangoproject.com/en/stable/topics/python3/
+[python-compat]: https://docs.djangoproject.com/en/stable/releases/1.5/#python-compatibility
+[django-deprecation-policy]: https://docs.djangoproject.com/en/stable/internals/release-process/#internal-release-deprecation-policy
+[credits]: http://www.django-rest-framework.org/topics/credits
+[mailing-list]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
+[django-rest-framework-docs]: https://github.com/marcgibbons/django-rest-framework-docs
+[marcgibbons]: https://github.com/marcgibbons/
+[564]: https://github.com/encode/django-rest-framework/issues/564

docs/topics/2.3-announcement.md

@@ -0,0 +1,264 @@
+# Django REST framework 2.3
+
+REST framework 2.3 makes it even quicker and easier to build your Web APIs.
+
+## ViewSets and Routers
+
+The 2.3 release introduces the [ViewSet][viewset] and [Router][router] classes.
+
+A viewset is simply a type of class-based view that allows you to group multiple views into a single common class.
+
+Routers allow you to automatically determine the URLconf for your viewset classes.
+
+As an example of just how simple REST framework APIs can now be, here's an API written in a single `urls.py` module:
+
+    """
+    A REST framework API for viewing and editing users and groups.
+    """
+    from django.conf.urls.defaults import url, include
+    from django.contrib.auth.models import User, Group
+    from rest_framework import viewsets, routers
+
+
+    # ViewSets define the view behavior.
+    class UserViewSet(viewsets.ModelViewSet):
+        model = User
+
+    class GroupViewSet(viewsets.ModelViewSet):
+        model = Group
+
+
+    # Routers provide an easy way of automatically determining the URL conf
+    router = routers.DefaultRouter()
+    router.register(r'users', UserViewSet)
+    router.register(r'groups', GroupViewSet)
+
+
+    # Wire up our API using automatic URL routing.
+    # Additionally, we include login URLs for the browsable API.
+    urlpatterns = [
+        url(r'^', include(router.urls)),
+        url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
+    ]
+
+The best place to get started with ViewSets and Routers is to take a look at the [newest section in the tutorial][part-6], which demonstrates their usage.
+
+## Simpler views
+
+This release rationalises the API and implementation of the generic views, dropping the dependency on Django's `SingleObjectMixin` and `MultipleObjectMixin` classes, removing a number of unneeded attributes, and generally making the implementation more obvious and easy to work with.
+
+This improvement is reflected in improved documentation for the `GenericAPIView` base class, and should make it easier to determine how to override methods on the base class if you need to write customized subclasses.
+
+## Easier Serializers
+
+REST framework lets you be totally explicit regarding how you want to represent relationships, allowing you to choose between styles such as hyperlinking or primary key relationships.
+
+The ability to specify exactly how you want to represent relationships is powerful, but it also introduces complexity.  In order to keep things more simple, REST framework now allows you to include reverse relationships simply by including the field name in the `fields` metadata of the serializer class.
+
+For example, in REST framework 2.2, reverse relationships needed to be included explicitly on a serializer class.
+
+    class BlogSerializer(serializers.ModelSerializer):
+        comments = serializers.PrimaryKeyRelatedField(many=True)
+
+        class Meta:
+            model = Blog
+            fields = ('id', 'title', 'created', 'comments')
+
+As of 2.3, you can simply include the field name, and the appropriate serializer field will automatically be used for the relationship.
+
+    class BlogSerializer(serializers.ModelSerializer):
+        """
+        Don't need to specify the 'comments' field explicitly anymore.
+        """
+        class Meta:
+            model = Blog
+            fields = ('id', 'title', 'created', 'comments')
+
+Similarly, you can now easily include the primary key in hyperlinked relationships, simply by adding the field name to the metadata.
+
+    class BlogSerializer(serializers.HyperlinkedModelSerializer):
+        """
+        This is a hyperlinked serializer, which default to using
+        a field named 'url' as the primary identifier.
+        Note that we can now easily also add in the 'id' field.
+        """
+        class Meta:
+            model = Blog
+            fields = ('url', 'id', 'title', 'created', 'comments')
+
+## More flexible filtering
+
+The `FILTER_BACKEND` setting has moved to pending deprecation, in favor of a `DEFAULT_FILTER_BACKENDS` setting that takes a *list* of filter backend classes, instead of a single filter backend class.
+
+The generic view `filter_backend` attribute has also been moved to pending deprecation in favor of a `filter_backends` setting.
+
+Being able to specify multiple filters will allow for more flexible, powerful behavior.  New filter classes to handle searching and ordering of results are planned to be released shortly.
+
+---
+
+# API Changes
+
+## Simplified generic view classes
+
+The functionality provided by `SingleObjectAPIView` and `MultipleObjectAPIView` base classes has now been moved into the base class `GenericAPIView`.  The implementation of this base class is simple enough that providing subclasses for the base classes of detail and list views is somewhat unnecessary.
+
+Additionally the base generic view no longer inherits from Django's `SingleObjectMixin` or `MultipleObjectMixin` classes, simplifying the implementation, and meaning you don't need to cross-reference across to Django's codebase.
+
+Using the `SingleObjectAPIView` and `MultipleObjectAPIView` base classes continues to be supported, but will raise a `PendingDeprecationWarning`.  You should instead simply use `GenericAPIView` as the base for any generic view subclasses.
+
+### Removed attributes
+
+The following attributes and methods, were previously present as part of Django's generic view implementations, but were unneeded and unused and have now been entirely removed.
+
+* context_object_name
+* get_context_data()
+* get_context_object_name()
+
+The following attributes and methods, which were previously present as part of Django's generic view implementations have also been entirely removed.
+
+* paginator_class
+* get_paginator()
+* get_allow_empty()
+* get_slug_field()
+
+There may be cases when removing these bits of API might mean you need to write a little more code if your view has highly customized behavior, but generally we believe that providing a coarser-grained API will make the views easier to work with, and is the right trade-off to make for the vast majority of cases.
+
+Note that the listed attributes and methods have never been a documented part of the REST framework API, and as such are not covered by the deprecation policy.
+
+### Simplified methods
+
+The `get_object` and `get_paginate_by` methods no longer take an optional queryset argument.  This makes overridden these methods more obvious, and a little more simple.
+
+Using an optional queryset with these methods continues to be supported, but will raise a `PendingDeprecationWarning`.
+
+The `paginate_queryset` method no longer takes a `page_size` argument, or returns a four-tuple of pagination information.  Instead it simply takes a queryset argument, and either returns a `page` object with an appropriate page size, or returns `None`, if pagination is not configured for the view.
+
+Using the `page_size` argument is still supported and will trigger the old-style return type, but will raise a `PendingDeprecationWarning`.
+
+### Deprecated attributes
+
+The following attributes are used to control queryset lookup, and have all been moved into a pending deprecation state.
+
+* pk_url_kwarg = 'pk'
+* slug_url_kwarg = 'slug'
+* slug_field = 'slug'
+
+Their usage is replaced with a single attribute:
+
+* lookup_field = 'pk'
+
+This attribute is used both as the regex keyword argument in the URL conf, and as the model field to filter against when looking up a model instance.  To use non-pk based lookup, simply set the `lookup_field` argument to an alternative field, and ensure that the keyword argument in the url conf matches the field name.
+
+For example, a view with 'username' based lookup might look like this:
+
+    class UserDetail(generics.RetrieveAPIView):
+        lookup_field = 'username'
+        queryset = User.objects.all()
+        serializer_class = UserSerializer
+
+And would have the following entry in the urlconf:
+
+     url(r'^users/(?P<username>\w+)/$', UserDetail.as_view()),
+
+Usage of the old-style attributes continues to be supported, but will raise a `PendingDeprecationWarning`.
+
+The `allow_empty` attribute is also deprecated.  To use `allow_empty=False` style behavior you should explicitly override `get_queryset` and raise an `Http404` on empty querysets.
+
+For example:
+
+    class DisallowEmptyQuerysetMixin(object):
+        def get_queryset(self):
+            queryset = super(DisallowEmptyQuerysetMixin, self).get_queryset()
+            if not queryset.exists():
+                raise Http404
+            return queryset
+
+In our opinion removing lesser-used attributes like `allow_empty` helps us move towards simpler generic view implementations, making them more obvious to use and override, and re-enforcing the preferred style of developers writing their own base classes and mixins for custom behavior rather than relying on the configurability of the generic views.
+
+## Simpler URL lookups
+
+The `HyperlinkedRelatedField` class now takes a single optional `lookup_field` argument, that replaces the `pk_url_kwarg`, `slug_url_kwarg`, and `slug_field` arguments.
+
+For example, you might have a field that references it's relationship by a hyperlink based on a slug field:
+
+        account = HyperlinkedRelatedField(read_only=True,
+                                          lookup_field='slug',
+                                          view_name='account-detail')
+
+Usage of the old-style attributes continues to be supported, but will raise a `PendingDeprecationWarning`.
+
+## FileUploadParser
+
+2.3 adds a `FileUploadParser` parser class, that supports raw file uploads, in addition to the existing multipart upload support.
+
+## DecimalField
+
+2.3 introduces a `DecimalField` serializer field, which returns `Decimal` instances.
+
+For most cases APIs using model fields will behave as previously, however if you are using a custom renderer, not provided by REST framework, then you may now need to add support for rendering `Decimal` instances to your renderer implementation.
+
+## ModelSerializers and reverse relationships
+
+The support for adding reverse relationships to the `fields` option on a `ModelSerializer` class means that the `get_related_field` and `get_nested_field` method signatures have now changed.
+
+In the unlikely event that you're providing a custom serializer class, and implementing these methods you should note the new call signature for both methods is now `(self, model_field, related_model, to_many)`.  For reverse relationships `model_field` will be `None`.
+
+The old-style signature will continue to function but will raise a `PendingDeprecationWarning`.
+
+## View names and descriptions
+
+The mechanics of how the names and descriptions used in the browsable API are generated has been modified and cleaned up somewhat.
+
+If you've been customizing this behavior, for example perhaps to use `rst` markup for the browsable API, then you'll need to take a look at the implementation to see what updates you need to make.
+
+Note that the relevant methods have always been private APIs, and the docstrings called them out as intended to be deprecated.
+
+---
+
+# Other notes
+
+## More explicit style
+
+The usage of `model` attribute in generic Views is still supported, but it's usage is generally being discouraged throughout the documentation, in favour of the setting the more explicit `queryset` and `serializer_class` attributes.
+
+For example, the following is now the recommended style for using generic views:
+
+    class AccountListView(generics.RetrieveAPIView):
+        queryset = MyModel.objects.all()
+        serializer_class = MyModelSerializer
+
+Using an explicit `queryset` and `serializer_class` attributes makes the functioning of the view more clear than using the shortcut `model` attribute.
+
+It also makes the usage of the `get_queryset()` or `get_serializer_class()` methods more obvious.
+
+    class AccountListView(generics.RetrieveAPIView):
+        serializer_class = MyModelSerializer
+
+        def get_queryset(self):
+            """
+            Determine the queryset dynamically, depending on the
+            user making the request.
+
+            Note that overriding this method follows on more obviously now
+            that an explicit `queryset` attribute is the usual view style.
+            """
+            return self.user.accounts
+
+## Django 1.3 support
+
+The 2.3.x release series will be the last series to provide compatibility with Django 1.3.
+
+## Version 2.2 API changes
+
+All API changes in 2.2 that previously raised `PendingDeprecationWarning` will now raise a `DeprecationWarning`, which is loud by default.
+
+## What comes next?
+
+* Support for read-write nested serializers is almost complete, and due to be released in the next few weeks.
+* Extra filter backends for searching and ordering of results are planned to be added shortly.
+
+The next few months should see a renewed focus on addressing outstanding tickets.  The 2.4 release is currently planned for around August-September.
+
+[viewset]: ../api-guide/viewsets.md
+[router]: ../api-guide/routers.md
+[part-6]: ../tutorial/6-viewsets-and-routers.md

docs/topics/2.4-announcement.md

@@ -0,0 +1,172 @@
+# Django REST framework 2.4
+
+The 2.4 release is largely an intermediate step, tying up some outstanding issues prior to the 3.x series.
+
+## Version requirements
+
+Support for Django 1.3 has been dropped.
+The lowest supported version of Django is now 1.4.2.
+
+The current plan is for REST framework to remain in lockstep with [Django's long-term support policy][lts-releases].
+
+## Django 1.7 support
+
+The optional authtoken application now includes support for *both* Django 1.7 schema migrations, *and* for old-style `south` migrations.
+
+**If you are using authtoken, and you want to continue using `south`, you must upgrade your `south` package to version 1.0.**
+
+## Deprecation of `.model` view attribute
+
+The `.model` attribute on view classes is an optional shortcut for either or both of `.serializer_class` and `.queryset`. Its usage results in more implicit, less obvious behavior.
+
+The documentation has previously stated that usage of the more explicit style is prefered, and we're now taking that one step further and deprecating the usage of the `.model` shortcut.
+
+Doing so will mean that there are cases of API code where you'll now need to include a serializer class where you previously were just using the `.model` shortcut. However we firmly believe that it is the right trade-off to make.
+
+Removing the shortcut takes away an unnecessary layer of abstraction, and makes your codebase more explicit without any significant extra complexity. It also results in better consistency, as there's now only one way to set the serializer class and queryset attributes for the view, instead of two.
+
+The `DEFAULT_MODEL_SERIALIZER_CLASS` API setting is now also deprecated.
+
+## Updated test runner
+
+We now have a new test runner for developing against the project,, that uses the excellent [py.test](https://docs.pytest.org/) library.
+
+To use it make sure you have first installed the test requirements.
+
+    pip install -r requirements-test.txt
+
+Then run the `runtests.py` script.
+
+    ./runtests.py
+
+The new test runner also includes [flake8](https://flake8.readthedocs.io) code linting, which should help keep our coding style consistent.
+
+#### Test runner flags
+
+Run using a more concise output style.
+
+    ./runtests -q
+
+Run the tests using a more concise output style, no coverage, no flake8.
+
+    ./runtests --fast
+
+Don't run the flake8 code linting.
+
+    ./runtests --nolint
+
+Only run the flake8 code linting, don't run the tests.
+
+    ./runtests --lintonly
+
+Run the tests for a given test case.
+
+    ./runtests MyTestCase
+
+Run the tests for a given test method.
+
+    ./runtests MyTestCase.test_this_method
+
+Shorter form to run the tests for a given test method.
+
+    ./runtests test_this_method
+
+Note: The test case and test method matching is fuzzy and will sometimes run other tests that contain a partial string match to the given  command line input.
+
+## Improved viewset routing
+
+The `@action` and `@link` decorators were inflexible in that they only allowed additional routes to be added against instance style URLs, not against list style URLs.
+
+The `@action` and `@link` decorators have now been moved to pending deprecation, and the `@list_route` and `@detail_route` decorators have been introduced.
+
+Here's an example of using the new decorators. Firstly we have a detail-type route named "set_password" that acts on a single instance, and takes a `pk` argument in the URL. Secondly we have a list-type route named "recent_users" that acts on a queryset, and does not take any arguments in the URL.
+
+    class UserViewSet(viewsets.ModelViewSet):
+        """
+        A viewset that provides the standard actions
+        """
+        queryset = User.objects.all()
+        serializer_class = UserSerializer
+
+        @detail_route(methods=['post'])
+        def set_password(self, request, pk=None):
+            user = self.get_object()
+            serializer = PasswordSerializer(data=request.DATA)
+            if serializer.is_valid():
+                user.set_password(serializer.data['password'])
+                user.save()
+                return Response({'status': 'password set'})
+            else:
+                return Response(serializer.errors,
+                                status=status.HTTP_400_BAD_REQUEST)
+
+        @list_route()
+        def recent_users(self, request):
+            recent_users = User.objects.all().order('-last_login')
+            page = self.paginate_queryset(recent_users)
+            serializer = self.get_pagination_serializer(page)
+            return Response(serializer.data)
+
+For more details, see the [viewsets documentation](../api-guide/viewsets.md).
+
+## Throttle behavior
+
+There's one bugfix in 2.4 that's worth calling out, as it will *invalidate existing throttle caches* when you upgrade.
+
+We've now fixed a typo on the `cache_format` attribute. Previously this was named `"throtte_%(scope)s_%(ident)s"`, it is now `"throttle_%(scope)s_%(ident)s"`.
+
+If you're concerned about the invalidation you have two options.
+
+* Manually pre-populate your cache with the fixed version.
+* Set the `cache_format` attribute on your throttle class in order to retain the previous incorrect spelling.
+
+## Other features
+
+There are also a number of other features and bugfixes as [listed in the release notes][2-4-release-notes]. In particular these include:
+
+[Customizable view name and description functions][view-name-and-description-settings] for use with the browsable API, by using the `VIEW_NAME_FUNCTION` and `VIEW_DESCRIPTION_FUNCTION` settings.
+
+Smarter [client IP identification for throttling][client-ip-identification], with the addition of the `NUM_PROXIES` setting.
+
+Added the standardized `Retry-After` header to throttled responses, as per [RFC 6585](https://tools.ietf.org/html/rfc6585). This should now be used in preference to the custom `X-Throttle-Wait-Seconds` header which will be fully deprecated in 3.0.
+
+## Deprecations
+
+All API changes in 2.3 that previously raised `PendingDeprecationWarning` will now raise a `DeprecationWarning`, which is loud by default.
+
+All API changes in 2.3 that previously raised `DeprecationWarning` have now been removed entirely.
+
+Furter details on these deprecations is available in the [2.3 announcement][2-3-announcement].
+
+## Labels and milestones
+
+Although not strictly part of the 2.4 release it's also worth noting here that we've been working hard towards improving our triage process.
+
+The [labels that we use in GitHub][github-labels] have been cleaned up, and all existing tickets triaged. Any given ticket should have one and only one label, indicating its current state.
+
+We've also [started using milestones][github-milestones] in order to track tickets against particular releases.
+
+---
+
+![Labels and milestones](../img/labels-and-milestones.png)
+
+**Above**: *Overview of our current use of labels and milestones in GitHub.*
+
+---
+
+We hope both of these changes will help make the management process more clear and obvious and help keep tickets well-organised and relevant.
+
+## Next steps
+
+The next planned release will be 3.0, featuring an improved and simplified serializer implementation.
+
+Once again, many thanks to all the generous [backers and sponsors][kickstarter-sponsors] who've helped make this possible!
+
+[lts-releases]: https://docs.djangoproject.com/en/stable/internals/release-process/#long-term-support-lts-releases
+[2-4-release-notes]: release-notes#240
+[view-name-and-description-settings]: ../api-guide/settings#view-names-and-descriptions
+[client-ip-identification]: ../api-guide/throttling#how-clients-are-identified
+[2-3-announcement]: 2.3-announcement
+[github-labels]: https://github.com/encode/django-rest-framework/issues
+[github-milestones]: https://github.com/encode/django-rest-framework/milestones
+[kickstarter-sponsors]: kickstarter-announcement#sponsors

docs/topics/3.0-announcement.md

@@ -24,7 +24,7 @@ Notable features of this new release include:
 * Support for overriding how validation errors are handled by your API.
 * A metadata API that allows you to customize how `OPTIONS` requests are handled by your API.
 * A more compact JSON output with unicode style encoding turned on by default.
-* Templated based HTML form rendering for serializers. This will be finalized as public API in the upcoming 3.1 release.
+* Templated based HTML form rendering for serializers. This will be finalized as  public API in the upcoming 3.1 release.
 
 Significant new functionality continues to be planned for the 3.1 and 3.2 releases. These releases will correspond to the two [Kickstarter stretch goals](https://www.kickstarter.com/projects/tomchristie/django-rest-framework-3) - "Feature improvements" and "Admin interface". Further 3.x releases will present simple upgrades, without the same level of fundamental API changes necessary for the 3.0 release.
 
@@ -119,7 +119,7 @@ This would now be split out into two separate methods.
         instance.save()
         return instance
 
-    def create(self, validated_data):
+	def create(self, validated_data):
         return Snippet.objects.create(**validated_data)
 
 Note that these methods should return the newly created object instance.
@@ -258,13 +258,13 @@ If you try to use a writable nested serializer without writing a custom `create(
     >>> class ProfileSerializer(serializers.ModelSerializer):
     >>>     class Meta:
     >>>         model = Profile
-    >>>         fields = ['address', 'phone']
+    >>>         fields = ('address', 'phone')
     >>>
     >>> class UserSerializer(serializers.ModelSerializer):
     >>>     profile = ProfileSerializer()
     >>>     class Meta:
     >>>         model = User
-    >>>         fields = ['username', 'email', 'profile']
+    >>>         fields = ('username', 'email', 'profile')
     >>>
     >>> data = {
     >>>     'username': 'lizzy',
@@ -283,7 +283,7 @@ To use writable nested serialization you'll want to declare a nested field on th
 
         class Meta:
             model = User
-            fields = ['username', 'email', 'profile']
+            fields = ('username', 'email', 'profile')
 
         def create(self, validated_data):
             profile_data = validated_data.pop('profile')
@@ -327,9 +327,9 @@ The `write_only_fields` option on `ModelSerializer` has been moved to `PendingDe
     class MySerializer(serializer.ModelSerializer):
         class Meta:
             model = MyModel
-            fields = ['id', 'email', 'notes', 'is_admin']
+            fields = ('id', 'email', 'notes', 'is_admin')
             extra_kwargs = {
-                    'is_admin': {'write_only': True}
+            	    'is_admin': {'write_only': True}
             }
 
 Alternatively, specify the field explicitly on the serializer class:
@@ -339,7 +339,7 @@ Alternatively, specify the field explicitly on the serializer class:
 
         class Meta:
             model = MyModel
-            fields = ['id', 'email', 'notes', 'is_admin']
+            fields = ('id', 'email', 'notes', 'is_admin')
 
 The `read_only_fields` option remains as a convenient shortcut for the more common case.
 
@@ -350,7 +350,7 @@ The `view_name` and `lookup_field` options have been moved to `PendingDeprecatio
     class MySerializer(serializer.HyperlinkedModelSerializer):
         class Meta:
             model = MyModel
-            fields = ['url', 'email', 'notes', 'is_admin']
+            fields = ('url', 'email', 'notes', 'is_admin')
             extra_kwargs = {
                 'url': {'lookup_field': 'uuid'}
             }
@@ -365,7 +365,7 @@ Alternatively, specify the field explicitly on the serializer class:
 
         class Meta:
             model = MyModel
-            fields = ['url', 'email', 'notes', 'is_admin']
+            fields = ('url', 'email', 'notes', 'is_admin')
 
 #### Fields for model methods and properties.
 
@@ -384,12 +384,12 @@ You can include `expiry_date` as a field option on a `ModelSerializer` class.
     class InvitationSerializer(serializers.ModelSerializer):
         class Meta:
             model = Invitation
-            fields = ['to_email', 'message', 'expiry_date']
+            fields = ('to_email', 'message', 'expiry_date')
 
 These fields will be mapped to `serializers.ReadOnlyField()` instances.
 
     >>> serializer = InvitationSerializer()
-    >>> print(repr(serializer))
+    >>> print repr(serializer)
     InvitationSerializer():
         to_email = EmailField(max_length=75)
         message = CharField(max_length=1000)
@@ -454,7 +454,7 @@ We can now use this class to serialize single `HighScore` instances:
     def high_score(request, pk):
         instance = HighScore.objects.get(pk=pk)
         serializer = HighScoreSerializer(instance)
-        return Response(serializer.data)
+	    return Response(serializer.data)
 
 Or use it to serialize multiple instances:
 
@@ -462,7 +462,7 @@ Or use it to serialize multiple instances:
     def all_high_scores(request):
         queryset = HighScore.objects.order_by('-score')
         serializer = HighScoreSerializer(queryset, many=True)
-        return Response(serializer.data)
+	    return Response(serializer.data)
 
 ##### Read-write `BaseSerializer` classes.
 
@@ -493,8 +493,8 @@ Here's a complete example of our previous `HighScoreSerializer`, that's been upd
                     'player_name': 'May not be more than 10 characters.'
                 })
 
-            # Return the validated values. This will be available as
-            # the `.validated_data` property.
+			# Return the validated values. This will be available as
+			# the `.validated_data` property.
             return {
                 'score': int(score),
                 'player_name': player_name
@@ -523,7 +523,7 @@ The following class is an example of a generic serializer that can handle coerci
         def to_representation(self, obj):
             for attribute_name in dir(obj):
                 attribute = getattr(obj, attribute_name)
-                if attribute_name.startswith('_'):
+                if attribute_name('_'):
                     # Ignore private attributes.
                     pass
                 elif hasattr(attribute, '__call__'):
@@ -632,7 +632,7 @@ The `MultipleChoiceField` class has been added. This field acts like `ChoiceFiel
 
 The `from_native(self, value)` and `to_native(self, data)` method names have been replaced with the more obviously named `to_internal_value(self, data)` and `to_representation(self, value)`.
 
-The `field_from_native()` and `field_to_native()` methods are removed. Previously you could use these methods if you wanted to customise the behavior in a way that did not simply lookup the field value from the object. For example...
+The `field_from_native()` and `field_to_native()` methods are removed. Previously you could use these methods if you wanted to customise the behaviour in a way that did not simply lookup the field value from the object. For example...
 
     def field_to_native(self, obj, field_name):
         """A custom read-only field that returns the class name."""
@@ -738,7 +738,7 @@ The `UniqueTogetherValidator` should be applied to a serializer, and takes a `qu
         class Meta:
             validators = [UniqueTogetherValidator(
                 queryset=RaceResult.objects.all(),
-                fields=['category', 'position']
+                fields=('category', 'position')
             )]
 
 #### The `UniqueForDateValidator` classes.
@@ -960,6 +960,6 @@ The 3.2 release is planned to introduce an alternative admin-style interface to
 You can follow development on the GitHub site, where we use [milestones to indicate planning timescales](https://github.com/encode/django-rest-framework/milestones).
 
 [kickstarter]: https://www.kickstarter.com/projects/tomchristie/django-rest-framework-3
-[sponsors]: https://www.django-rest-framework.org/community/kickstarter-announcement/#sponsors
+[sponsors]: http://www.django-rest-framework.org/topics/kickstarter-announcement/#sponsors
 [mixins.py]: https://github.com/encode/django-rest-framework/blob/master/rest_framework/mixins.py
 [django-localization]: https://docs.djangoproject.com/en/stable/topics/i18n/translation/#localization-how-to-create-language-files

docs/topics/3.1-announcement.md

@@ -30,7 +30,7 @@ Note that as a result of this work a number of settings keys and generic view at
 
 Until now, there has only been a single built-in pagination style in REST framework. We now have page, limit/offset and cursor based schemes included by default.
 
-The cursor based pagination scheme is particularly smart, and is a better approach for clients iterating through large or frequently changing result sets. The scheme supports paging against non-unique indexes, by using both cursor and limit/offset information. It also allows for both forward and reverse cursor pagination. Much credit goes to David Cramer for [this blog post](https://cra.mr/2011/03/08/building-cursors-for-the-disqus-api) on the subject.
+The cursor based pagination scheme is particularly smart, and is a better approach for clients iterating through large or frequently changing result sets. The scheme supports paging against non-unique indexes, by using both cursor and limit/offset information. It also allows for both forward and reverse cursor pagination. Much credit goes to David Cramer for [this blog post](http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api) on the subject.
 
 #### Pagination controls in the browsable API.
 
@@ -61,7 +61,7 @@ For example, when using `NamespaceVersioning`, and the following hyperlinked ser
     class AccountsSerializer(serializer.HyperlinkedModelSerializer):
         class Meta:
             model = Accounts
-            fields = ['account_name', 'users']
+            fields = ('account_name', 'users')
 
 The output representation would match the version used on the incoming request. Like so:
 
@@ -114,7 +114,7 @@ Note that the structure of the error responses is still the same. We still have
 
 We include built-in translations both for standard exception cases, and for serializer validation errors.
 
-The full list of supported languages can be found on our [Transifex project page](https://www.transifex.com/django-rest-framework-1/django-rest-framework/).
+The full list of supported languages can be found on our [Transifex project page](https://www.transifex.com/projects/p/django-rest-framework/).
 
 If you only wish to support a subset of the supported languages, use Django's standard `LANGUAGES` setting:
 
@@ -123,7 +123,7 @@ If you only wish to support a subset of the supported languages, use Django's st
         ('en', _('English')),
     ]
 
-For more details, see the [internationalization documentation][internationalization].
+For more details, see the [internationalization documentation](internationalization.md).
 
 Many thanks to [Craig Blaszczyk](https://github.com/jakul) for helping push this through.
 
@@ -155,14 +155,14 @@ We've now moved a number of packages out of the core of REST framework, and into
 
 We're making this change in order to help distribute the maintenance workload, and keep better focus of the core essentials of the framework.
 
-The change also means we can be more flexible with which external packages we recommend. For example, the excellently maintained [Django OAuth toolkit](https://github.com/jazzband/django-oauth-toolkit) has now been promoted as our recommended option for integrating OAuth support.
+The change also means we can be more flexible with which external packages we recommend. For example, the excellently maintained [Django OAuth toolkit](https://github.com/evonove/django-oauth-toolkit) has now been promoted as our recommended option for integrating OAuth support.
 
 The following packages are now moved out of core and should be separately installed:
 
 * OAuth - [djangorestframework-oauth](https://jpadilla.github.io/django-rest-framework-oauth/)
-* XML - [djangorestframework-xml](https://jpadilla.github.io/django-rest-framework-xml/)
-* YAML - [djangorestframework-yaml](https://jpadilla.github.io/django-rest-framework-yaml/)
-* JSONP - [djangorestframework-jsonp](https://jpadilla.github.io/django-rest-framework-jsonp/)
+* XML - [djangorestframework-xml](https://jpadilla.github.io/django-rest-framework-xml)
+* YAML - [djangorestframework-yaml](https://jpadilla.github.io/django-rest-framework-yaml)
+* JSONP - [djangorestframework-jsonp](https://jpadilla.github.io/django-rest-framework-jsonp)
 
 It's worth reiterating that this change in policy shouldn't mean any work in your codebase other than adding a new requirement and modifying some import paths. For example to install XML rendering, you would now do:
 
@@ -205,5 +205,5 @@ This will either be made as a single 3.2 release, or split across two separate r
 [custom-exception-handler]: ../api-guide/exceptions.md#custom-exception-handling
 [pagination]: ../api-guide/pagination.md
 [versioning]: ../api-guide/versioning.md
-[internationalization]: ../topics/internationalization.md
+[internationalization]: internationalization.md
 [customizing-field-mappings]: ../api-guide/serializers.md#customizing-field-mappings

docs/topics/3.2-announcement.md

@@ -10,7 +10,7 @@ We've also fixed a huge number of issues, and made numerous cleanups and improve
 
 Over the course of the 3.1.x series we've [resolved nearly 600 tickets](https://github.com/encode/django-rest-framework/issues?utf8=%E2%9C%93&q=closed%3A%3E2015-03-05) on our GitHub issue tracker. This means we're currently running at a rate of **closing around 100 issues or pull requests per month**.
 
-None of this would have been possible without the support of our wonderful Kickstarter backers. If you're looking for a job in Django development we'd strongly recommend taking [a look through our sponsors](https://www.django-rest-framework.org/community/kickstarter-announcement/#sponsors) and finding out who's hiring.
+None of this would have been possible without the support of our wonderful Kickstarter backers. If you're looking for a job in Django development we'd strongly recommend taking [a look through our sponsors](http://www.django-rest-framework.org/topics/kickstarter-announcement/#sponsors) and finding out who's hiring.
 
 ## AdminRenderer
 
@@ -64,7 +64,7 @@ These are a little subtle and probably won't affect most users, but are worth un
 
 ### ManyToMany fields and blank=True
 
-We've now added an `allow_empty` argument, which can be used with `ListSerializer`, or with `many=True` relationships. This is `True` by default, but can be set to `False` if you want to disallow empty lists as valid input.
+We've now added an `allow_empty` argument, which can be used with `ListSerializer`, or with  `many=True` relationships. This is `True` by default, but can be set to `False` if you want to disallow empty lists as valid input.
 
 As a follow-up to this we are now able to properly mirror the behavior of Django's `ModelForm` with respect to how many-to-many fields are validated.
 
@@ -83,7 +83,7 @@ When using `allow_null` with `ListField` or a nested `many=True` serializer the
 
 For example, take the following field:
 
-    NestedSerializer(many=True, allow_null=True)
+    NestedSerializer(many=True, allow_null=True)
 
 Previously the validation behavior would be:
 
@@ -110,4 +110,4 @@ This release is planned to include:
 * Improvements and public API for our templated HTML forms and fields.
 * Nested object and list support in HTML forms.
 
-Thanks once again to all our sponsors and supporters.
+Thanks once again to all our sponsors and supporters.

docs/topics/3.3-announcement.md

@@ -37,8 +37,8 @@ This brings our supported versions into line with Django's [currently supported
 The AJAX based support for the browsable API means that there are a number of internal cleanups in the `request` class. For the vast majority of developers this should largely remain transparent:
 
 * To support form based `PUT` and `DELETE`, or to support form content types such as JSON, you should now use the [AJAX forms][ajax-form] javascript library. This replaces the previous 'method and content type overloading' that required significant internal complexity to the request class.
-* The `accept` query parameter is no longer supported by the default content negotiation class. If you require it then you'll need to [use a custom content negotiation class][accept-headers].
-* The custom `HTTP_X_HTTP_METHOD_OVERRIDE` header is no longer supported by default. If you require it then you'll need to [use custom middleware][method-override].
+* The `accept` query parameter is no longer supported by the default content negotiation class. If you require it then you'll need to [use a custom content negotiation class](browser-enhancements.md#url-based-accept-headers).
+*  The custom `HTTP_X_HTTP_METHOD_OVERRIDE` header is no longer supported by default. If you require it then you'll need to [use custom middleware](browser-enhancements.md#http-header-based-method-overriding).
 
 The following pagination view attributes and settings have been moved into attributes on the pagination class since 3.1. Their usage was formerly deprecated, and has now been removed entirely, in line with the deprecation policy.
 
@@ -52,9 +52,7 @@ The following pagination view attributes and settings have been moved into attri
 
 The `ModelSerializer` and `HyperlinkedModelSerializer` classes should now include either a `fields` or `exclude` option, although the `fields = '__all__'` shortcut may be used. Failing to include either of these two options is currently pending deprecation, and will be removed entirely in the 3.5 release. This behavior brings `ModelSerializer` more closely in line with Django's `ModelForm` behavior.
 
-[forms-api]: ../topics/html-and-forms.md
+[forms-api]: html-and-forms.md
 [ajax-form]: https://github.com/encode/ajax-form
-[jsonfield]: ../api-guide/fields#jsonfield
-[accept-headers]: ../topics/browser-enhancements.md#url-based-accept-headers
-[method-override]: ../topics/browser-enhancements.md#http-header-based-method-overriding
-[django-supported-versions]: https://www.djangoproject.com/download/#supported-versions
+[jsonfield]: ../../api-guide/fields#jsonfield
+[django-supported-versions]: https://www.djangoproject.com/download/#supported-versions

docs/topics/3.4-announcement.md

@@ -36,13 +36,13 @@ Right now we're over 60% of the way towards achieving that.
 *Every single sign-up makes a significant impact.*
 
 <ul class="premium-promo promo">
-    <li><a href="https://www.rover.com/careers/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
-    <li><a href="https://sentry.io/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
+    <li><a href="http://jobs.rover.com/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
+    <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
     <li><a href="https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
 </ul>
 <div style="clear: both; padding-bottom: 20px;"></div>
 
-*Many thanks to all our [awesome sponsors][sponsors], and in particular to our premium backers, [Rover](https://www.rover.com/careers/), [Sentry](https://sentry.io/welcome/), and [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf).*
+*Many thanks to all our [awesome sponsors][sponsors], and in particular to our premium backers, [Rover](http://jobs.rover.com/), [Sentry](https://getsentry.com/welcome/), and [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf).*
 
 ---
 
@@ -89,7 +89,7 @@ Name                             | Support                             | PyPI pa
 ---------------------------------|-------------------------------------|--------------------------------
 [Core JSON][core-json]           | Schema generation & client support. | Built-in support in `coreapi`.
 [Swagger / OpenAPI][swagger]     | Schema generation & client support. | The `openapi-codec` package.
-[JSON Hyper-Schema][hyperschema] | Currently client support only.      | The `hyperschema-codec` package.
+[JSON Hyper-Schema][hyperschema] | Currently client support only.     | The `hyperschema-codec` package.
 [API Blueprint][api-blueprint]   | Not yet available.                  | Not yet available.
 
 ---
@@ -178,17 +178,17 @@ The full set of itemized release notes [are available here][release-notes].
 [sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
 [moss]: mozilla-grant.md
 [funding]: funding.md
-[core-api]: https://www.coreapi.org/
+[core-api]: http://www.coreapi.org/
 [command-line-client]: api-clients#command-line-client
 [client-library]: api-clients#python-client-library
-[core-json]: https://www.coreapi.org/specification/encoding/#core-json-encoding
+[core-json]: http://www.coreapi.org/specification/encoding/#core-json-encoding
 [swagger]: https://openapis.org/specification
-[hyperschema]: https://json-schema.org/latest/json-schema-hypermedia.html
+[hyperschema]: http://json-schema.org/latest/json-schema-hypermedia.html
 [api-blueprint]: https://apiblueprint.org/
-[tut-7]: ../tutorial/7-schemas-and-client-libraries/
-[schema-generation]: ../api-guide/schemas/
-[api-clients]: https://github.com/encode/django-rest-framework/blob/3.14.0/docs/topics/api-clients.md
+[tut-7]: ../../tutorial/7-schemas-and-client-libraries/
+[schema-generation]: ../../api-guide/schemas/
+[api-clients]: api-clients.md
 [milestone]: https://github.com/encode/django-rest-framework/milestone/35
 [release-notes]: release-notes#34
-[metadata]: ../api-guide/metadata/#custom-metadata-classes
+[metadata]: ../../api-guide/metadata/#custom-metadata-classes
 [gh3751]: https://github.com/encode/django-rest-framework/issues/3751