diff options
| author | Tom Christie | 2015-02-04 23:32:25 +0000 | 
|---|---|---|
| committer | Tom Christie | 2015-02-04 23:32:25 +0000 | 
| commit | 41b213414df57d7e39f1bbf3aaa35a1b033e89a3 (patch) | |
| tree | 68c3d86e61b6825be691fa58746cb6612f912ba4 /docs/topics | |
| parent | a0374e44985172e4b8f6dc91fbc22897d2b06767 (diff) | |
| download | django-rest-framework-41b213414df57d7e39f1bbf3aaa35a1b033e89a3.tar.bz2 | |
Updating release notes
Diffstat (limited to 'docs/topics')
| -rw-r--r-- | docs/topics/3.1-announcement.md | 28 | 
1 files changed, 21 insertions, 7 deletions
| diff --git a/docs/topics/3.1-announcement.md b/docs/topics/3.1-announcement.md index 73cccb1c..d5986360 100644 --- a/docs/topics/3.1-announcement.md +++ b/docs/topics/3.1-announcement.md @@ -60,16 +60,30 @@ The serializer redesign in 3.0 did not include any public API for modifying how  We've now moved a number of packages out of the core of REST framework, and into separately installable packages. If you're currently using these you don't need to worry, you simply need to `pip install` the new packages, and change any import paths. -We're making this change in order to distribute the maintainance workload, and keep better focus of the core essentials of the framework. +We're making this change in order to help distribute the maintainance 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/evonove/django-oauth-toolkit) is now 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. -**TODO** Links and package names +The following packages are now moved out of core and should be separately installed: -* XML -* YAML -* JSONP -* OAuth +* OAuth - [djangorestframework-oauth](http://jpadilla.github.io/django-rest-framework-oauth/) +* XML - [djangorestframework-xml](http://jpadilla.github.io/django-rest-framework-xml) +* YAML - [djangorestframework-yaml](http://jpadilla.github.io/django-rest-framework-yaml) +* JSONP - [djangorestframework-jsonp](http://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: + +    pip install djangorestframework-xml + +And modify your settings, like so: + +    REST_FRAMEWORK = { +        'DEFAULT_RENDERER_CLASSES': [ +            'rest_framework.renderers.JSONRenderer', +            'rest_framework.renderers.BrowsableAPIRenderer', +            'rest_framework_xml.renderers.XMLRenderer' +        ] +    }  # What's next? | 
