Release Notes
Release Early, Release Often
— Eric S. Raymond, The Cathedral and the Bazaar.
Versioning
Minor version numbers (0.0.x) are used for changes that are API compatible. You should be able to upgrade between minor point releases without any other code changes.
Medium version numbers (0.x.0) may include API changes, in line with the deprecation policy. You should read the release notes carefully before upgrading between medium point releases.
Major version numbers (x.0.0) are reserved for substantial project milestones.
Deprecation policy
REST framework releases follow a formal deprecation policy, which is in line with Django's deprecation policy.
The timeline for deprecation of a feature present in version 1.0 would work as follows:
-
Version 1.1 would remain fully backwards compatible with 1.0, but would raise
PendingDeprecationWarningwarnings if you use the feature 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 usingpython -Wd manage.py test, you'll be warned of any API changes you need to make. -
Version 1.2 would escalate these warnings to
DeprecationWarning, which is loud by default. -
Version 1.3 would 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.
Upgrading
To upgrade Django REST framework to the latest version, use pip:
pip install -U djangorestframework
You can determine your currently installed version using pip freeze:
pip freeze | grep djangorestframework
3.2.x series
3.2.3
Date: 24th August 2015.
- Added
html_cutoffandhtml_cutoff_textfor limiting select dropdowns. (#3313) - Added regex style to
SearchFilter. (#3316) - Resolve issues with setting blank HTML fields. (#3318) (#3321)
- Correctly display existing 'select multiple' values in browsable API forms. (#3290)
- Resolve duplicated validation message for
IPAddressField. ([#3249[gh3249]) (#3250) - Fix to ensure admin renderer continues to work when pagination is disabled. (#3275)
- Resolve error with
LimitOffsetPaginationwhen count=0, offset=0. (#3303)
3.2.2
Date: 13th August 2015.
- Add
display_value()method for use when displaying relational field select inputs. (#3254) - Fix issue with
BooleanFieldcheckboxes incorrectly displaying as checked. (#3258) - Ensure empty checkboxes properly set
BooleanFieldtoFalsein all cases. (#2776) - Allow
WSGIRequest.FILESproperty without raising incorrect deprecated error. (#3261) - Resolve issue with rendering nested serializers in forms. (#3260)
- Raise an error if user accidentally pass a serializer instance to a response, rather than data. (#3241)
3.2.1
Date: 7th August 2015.
- Fix for relational select widgets rendering without any choices. (#3237)
- Fix for
1,0rendering astrue,falsein the admin interface. #3227) - Fix for ListFields with single value in HTML form input. (#3238)
- Allow
request.FILESfor compat with Django'sHTTPRequestclass. (#3239)
3.2.0
Date: 6th August 2015.
- Add
AdminRenderer. (#2926) - Add
FilePathField. (#1854) - Add
allow_emptytoListField. (#2250) - Support django-guardian 1.3. (#3165)
- Support grouped choices. (#3225)
- Support error forms in browsable API. (#3024)
- Allow permission classes to customize the error message. (#2539)
- Support
source=<method>on hyperlinked fields. (#2690) ListField(allow_null=True)now allows null as the list value, not null items in the list. (#2766)ManyToMany()maps toallow_empty=False,ManyToMany(blank=True)maps toallow_empty=True. (#2804)- Support custom serialization styles for primary key fields. (#2789)
OPTIONSrequests support nested representations. (#2915)- Set
view.action == "metadata"for viewsets withOPTIONSrequests. (#3115) - Support
allow_blankonUUIDField. ([#3130][gh#3130]) - Do not display view docstrings with 401 or 403 response codes. (#3216)
- Resolve Django 1.8 deprecation warnings. (#2886)
- Fix for
DecimalFieldvalidation. (#3139) - Fix behavior of
allow_blank=Falsewhen used withtrim_whitespace=True. (#2712) - Fix issue with some field combinations incorrectly mapping to an invalid
allow_blankargument. (#3011) - Fix for output representations with prefetches and modified querysets. (#2704, #2727)
- Fix assertion error when CursorPagination is provided with certains invalid query parameters. (#2920)gh2920.
- Fix
UnicodeDecodeErrorwhen invalid characters included in header withTokenAuthentication. (#2928) - Fix transaction rollbacks with
@non_atomic_requestsdecorator. (#3016) - Fix duplicate results issue with Oracle databases using
SearchFilter. (#2935) - Fix checkbox alignment and rendering in browsable API forms. (#2783)
- Fix for unsaved file objects which should use
"url": nullin the representation. (#2759) - Fix field value rendering in browsable API. (#2416)
- Fix
HStoreFieldto includeallow_blank=TrueinDictFieldmapping. (#2659) - Numerous other cleanups, improvements to error messaging, private API & minor fixes.
3.1.x series
3.1.3
Date: 4th June 2015.
- Add
DurationField. (#2481, #2989) - Add
formatargument toUUIDField. (#2788, #3000) MultipleChoiceFieldempties incorrectly on a partial update using multipart/form-data (#2993, #2894)- Fix a bug in options related to read-only
RelatedField. (#2981, #2811) - Fix nested serializers with
unique_togetherrelations. (#2975) - Allow unexpected values for
ChoiceField/MultipleChoiceFieldrepresentations. (#2839, #2940) - Rollback the transaction on error if
ATOMIC_REQUESTSis set. (#2887, #2034) - Set the action on a view when override_method regardless of its None-ness. (#2933)
DecimalFieldaccepts2E+2as 200 and validates decimal place correctly. (#2948, #2947)- Support basic authentication with custom
UserModelthat changeusername. (#2952) IPAddressFieldimprovements. (#2747, #2618, #3008)- Improve
DecimalFieldfor easier subclassing. (#2695)
3.1.2
Date: 13rd May 2015.
DateField.to_representationcan handle str and empty values. (#2656, #2687, #2869)- Use default reason phrases from HTTP standard. (#2764, #2763)
- Raise error when
ModelSerializerused with abstract model. (#2757, #2630) - Handle reversal of non-API view_name in
HyperLinkedRelatedField(#2724, #2711) - Dont require pk strictly for related fields. (#2745, #2754)
- Metadata detects null boolean field type. (#2762)
- Proper handling of depth in nested serializers. (#2798)
- Display viewset without paginator. (#2807)
- Don't check for deprecated
.modelattribute in permissions (#2818) - Restrict integer field to integers and strings. (#2835, #2836)
- Improve
IntegerFieldto use compiled decimal regex. (#2853) - Prevent empty
querysetto raise AssertionError. (#2862) DjangoModelPermissionsrely onget_queryset. (#2863)- Check
AcceptHeaderVersioningwith content negotiation in place. (#2868) - Allow
DjangoObjectPermissionsto use views that defineget_queryset. (#2905)
3.1.1
Date: 23rd March 2015.
- Security fix: Escape tab switching cookie name in browsable API.
- Display input forms in browsable API if
serializer_classis used, even whenget_serializermethod does not exist on the view. (#2743) - Use a password input for the AuthTokenSerializer. (#2741)
- Fix missing anchor closing tag after next button. (#2691)
- Fix
lookup_url_kwarghandling in viewsets. (#2685, #2591) - Fix problem with importing
rest_framework.viewsinapps.py(#2678) - LimitOffsetPagination raises
TypeErrorif PAGE_SIZE not set (#2667, #2700) - German translation for
min_valuefield error message referencesmax_value. (#2645) - Remove
MergeDict. (#2640) - Support serializing unsaved models with related fields. (#2637, #2641)
- Allow blank/null on radio.html choices. (#2631)
3.1.0
Date: 5th March 2015.
For full details see the 3.1 release announcement.
3.0.x series
3.0.5
Date: 10th February 2015.
- Fix a bug where
_closable_objectsbreaks pickling. (#1850, #2492) - Allow non-standard
Usermodels withThrottling. (#2524) - Support custom
User.db_tablein TokenAuthentication migration. (#2479) - Fix misleading
AttributeErrortracebacks onRequestobjects. (#2530, #2108) ManyRelatedField.get_valueclearing field on partial update. (#2475)- Removed '.model' shortcut from code. (#2486)
- Fix
detail_routeandlist_routemutable argument. (#2518) - Prefetching the user object when getting the token in
TokenAuthentication. (#2519)
3.0.4
Date: 28th January 2015.
- Django 1.8a1 support. (#2425, #2446, #2441)
- Add
DictFieldand support Django 1.8HStoreField. (#2451, #2106) - Add
UUIDFieldand support Django 1.8UUIDField. (#2448, #2433, #2432) BaseRenderer.rendernow raisesNotImplementedError. (#2434)- Fix timedelta JSON serialization on Python 2.6. (#2430)
ResultDictandResultListnow appear as standard dict/list. (#2421)- Fix visible
HiddenFieldin the HTML form of the web browsable API page. (#2410) - Use
OrderedDictforRelatedField.choices. (#2408) - Fix ident format when using
HTTP_X_FORWARDED_FOR. (#2401) - Fix invalid key with memcached while using throttling. (#2400)
- Fix
FileUploadParserwith version 3.x. (#2399) - Fix the serializer inheritance. (#2388)
- Fix caching issues with
ReturnDict. (#2360)
3.0.3
Date: 8th January 2015.
- Fix
MinValueValidatoronmodels.DateField. (#2369) - Fix serializer missing context when pagination is used. (#2355)
- Namespaced router URLs are now supported by the
DefaultRouter. (#2351) required=Falseallows omission of value for output. (#2342)- Use textarea input for
models.TextField. (#2340) - Use custom
ListSerializerfor pagination if required. (#2331, #2327) - Better behavior with null and '' for blank HTML fields. (#2330)
- Ensure fields in
excludeare model fields. (#2319) - Fix
IntegerFieldandmax_lengthargument incompatibility. (#2317) - Fix the YAML encoder for 3.0 serializers. (#2315, #2283)
- Fix the behavior of empty HTML fields. (#2311, #1101)
- Fix Metaclass attribute depth ignoring fields attribute. (#2287)
- Fix
format_suffix_patternsto work with Django'si18n_patterns. (#2278) - Ability to customize router URLs for custom actions, using
url_path. (#2010) - Don't install Django REST Framework as egg. (#2386)
3.0.2
Date: 17th December 2014.
- Ensure
request.useris made available to response middleware. (#2155) Client.logout()also cancels any existingforce_authenticate. (#2218, #2259)- Extra assertions and better checks to preventing incorrect serializer API use. (#2228, #2234, #2262, #2263, #2266, #2267, #2289, #2291)
- Fixed
min_lengthmessage forCharField. (#2255) - Fix
UnicodeDecodeError, which can occur on serializerrepr. (#2270, #2279) - Fix empty HTML values when a default is provided. (#2280, #2294)
- Fix
SlugRelatedFieldraisingUnicodeEncodeErrorwhen used as a multiple choice input. (#2290)
3.0.1
Date: 11th December 2014.
- More helpful error message when the default Serializer
create()fails. (#2013) - Raise error when attempting to save serializer if data is not valid. (#2098)
- Fix
FileUploadParserbreaks with empty file names and multiple upload handlers. (#2109) - Improve
BindingDictto support standard dict-functions. (#2135, #2163) - Add
validate()toListSerializer. (#2168, #2225, #2232) - Fix JSONP renderer failing to escape some characters. (#2169, #2195)
- Add missing default style for
FileField. (#2172) - Actions are required when calling
ViewSet.as_view(). (#2175) - Add
allow_blanktoChoiceField. (#2184, #2239) - Cosmetic fixes in the HTML renderer. (#2187)
- Raise error if
fieldson serializer is not a list of strings. (#2193, #2213) - Improve checks for nested creates and updates. (#2194, #2196)
validated_attrsargument renamed tovalidated_datainSerializercreate()/update(). (#2197)- Remove deprecated code to reflect the dropped Django versions. (#2200)
- Better serializer errors for nested writes. (#2202, #2215)
- Fix pagination and custom permissions incompatibility. (#2205)
- Raise error if
fieldson serializer is not a list of strings. (#2213) - Add missing translation markers for relational fields. (#2231)
- Improve field lookup behavior for dicts/mappings. (#2244, #2243)
- Optimized hyperlinked PK. (#2242)
3.0.0
Date: 1st December 2014
For full details see the 3.0 release announcement.
For older release notes, please see the version 2.x documentation.