diff options
| author | Tom Christie | 2014-08-18 18:54:43 +0100 |
|---|---|---|
| committer | Tom Christie | 2014-08-18 18:54:43 +0100 |
| commit | 2aad8e4b35c3552a065347d7eccad8bd51938783 (patch) | |
| tree | bd84d5ccb907c6156749d4a80296bd0a8e8d7292 /docs | |
| parent | 4876bec9f529cac69aede8e51746d8a0fd6b0d88 (diff) | |
| parent | 556948661acc4bf038ecdd0cb17b1e19f2080061 (diff) | |
| download | django-rest-framework-2aad8e4b35c3552a065347d7eccad8bd51938783.tar.bz2 | |
Merge pull request #1654 from carltongibson/1559-take-2
Allow use of native migrations in 1.7 — Take 2
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/api-guide/authentication.md | 17 | ||||
| -rw-r--r-- | docs/topics/release-notes.md | 16 |
2 files changed, 25 insertions, 8 deletions
diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index 1cb37d67..343466ee 100755 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -126,7 +126,13 @@ To use the `TokenAuthentication` scheme you'll need to [configure the authentica 'rest_framework.authtoken' ) -Make sure to run `manage.py syncdb` after changing your settings. The `authtoken` database tables are managed by south (see [Schema migrations](#schema-migrations) below). + +--- + +**Note:** Make sure to run `manage.py syncdb` after changing your settings. The `rest_framework.authtoken` app provides both Django (from v1.7) and South database migrations. See [Schema migrations](#schema-migrations) below. + +--- + You'll also need to create tokens for your users. @@ -198,7 +204,14 @@ Note that the default `obtain_auth_token` view explicitly uses JSON requests and #### Schema migrations -The `rest_framework.authtoken` app includes a south migration that will create the authtoken table. +The `rest_framework.authtoken` app includes both Django native migrations (for Django versions >1.7) and South migrations (for Django versions <1.7) that will create the authtoken table. + +---- + +**Note**: From REST Framework v2.4.0 using South with Django <1.7 requires upgrading South v1.0+ + +---- + If you're using a [custom user model][custom-user-model] you'll need to make sure that any initial migration that creates the user table runs before the authtoken table is created. diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md index f6bbb815..b0e5b198 100644 --- a/docs/topics/release-notes.md +++ b/docs/topics/release-notes.md @@ -40,6 +40,11 @@ You can determine your currently installed version using `pip freeze`: ### 2.4.0 +* Added compatibility with Django 1.7's native migrations. + + **IMPORTANT**: In order to continue to use South with Django <1.7 you **must** upgrade to + South v1.0. + * Use py.test * `@detail_route` and `@list_route` decorators replace `@action` and `@link`. * `six` no longer bundled. For Django <= 1.4.1, install `six` package. @@ -52,6 +57,7 @@ You can determine your currently installed version using `pip freeze`: ## 2.3.x series + ### 2.3.14 **Date**: 12th June 2014 @@ -76,8 +82,6 @@ You can determine your currently installed version using `pip freeze`: * Support `blank_display_value` on `ChoiceField`. ### 2.3.13 -## 2.3.x series - **Date**: 6th March 2014 @@ -183,9 +187,9 @@ You can determine your currently installed version using `pip freeze`: * Added `trailing_slash` option to routers. * Include support for `HttpStreamingResponse`. * Support wider range of default serializer validation when used with custom model fields. -* UTF-8 Support for browsable API descriptions. +* UTF-8 Support for browsable API descriptions. * OAuth2 provider uses timezone aware datetimes when supported. -* Bugfix: Return error correctly when OAuth non-existent consumer occurs. +* Bugfix: Return error correctly when OAuth non-existent consumer occurs. * Bugfix: Allow `FileUploadParser` to correctly filename if provided as URL kwarg. * Bugfix: Fix `ScopedRateThrottle`. @@ -226,7 +230,7 @@ You can determine your currently installed version using `pip freeze`: * Added SearchFilter * Added OrderingFilter * Added GenericViewSet -* Bugfix: Multiple `@action` and `@link` methods now allowed on viewsets. +* Bugfix: Multiple `@action` and `@link` methods now allowed on viewsets. * Bugfix: Fix API Root view issue with DjangoModelPermissions ### 2.3.2 @@ -279,7 +283,7 @@ You can determine your currently installed version using `pip freeze`: * Long HTTP headers in browsable API are broken in multiple lines when possible. * Bugfix: Fix regression with DjangoFilterBackend not worthing correctly with single object views. * Bugfix: OAuth should fail hard when invalid token used. -* Bugfix: Fix serializer potentially returning `None` object for models that define `__bool__` or `__len__`. +* Bugfix: Fix serializer potentially returning `None` object for models that define `__bool__` or `__len__`. ### 2.2.5 |
