Skip to content

Commit 41b2134

Browse files
committed
Updating release notes
1 parent a0374e4 commit 41b2134

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

docs/topics/3.1-announcement.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,30 @@ The serializer redesign in 3.0 did not include any public API for modifying how
6060

6161
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.
6262

63-
We're making this change in order to distribute the maintainance workload, and keep better focus of the core essentials of the framework.
63+
We're making this change in order to help distribute the maintainance workload, and keep better focus of the core essentials of the framework.
6464

65-
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.
65+
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.
6666

67-
**TODO** Links and package names
67+
The following packages are now moved out of core and should be separately installed:
6868

69-
* XML
70-
* YAML
71-
* JSONP
72-
* OAuth
69+
* OAuth - [djangorestframework-oauth](http://jpadilla.github.io/django-rest-framework-oauth/)
70+
* XML - [djangorestframework-xml](http://jpadilla.github.io/django-rest-framework-xml)
71+
* YAML - [djangorestframework-yaml](http://jpadilla.github.io/django-rest-framework-yaml)
72+
* JSONP - [djangorestframework-jsonp](http://jpadilla.github.io/django-rest-framework-jsonp)
73+
74+
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:
75+
76+
pip install djangorestframework-xml
77+
78+
And modify your settings, like so:
79+
80+
REST_FRAMEWORK = {
81+
'DEFAULT_RENDERER_CLASSES': [
82+
'rest_framework.renderers.JSONRenderer',
83+
'rest_framework.renderers.BrowsableAPIRenderer',
84+
'rest_framework_xml.renderers.XMLRenderer'
85+
]
86+
}
7387

7488
# What's next?
7589

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy