mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-15 06:07:41 +03:00
644 lines
44 KiB
HTML
644 lines
44 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta charset="utf-8">
|
|
<title>Release Notes - Django REST framework</title>
|
|
<link href="../../img/favicon.ico" rel="icon" type="image/x-icon">
|
|
<link rel="canonical" href="http://www.django-rest-framework.org/topics/release-notes/" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="Django, API, REST, Release Notes">
|
|
<meta name="author" content="Tom Christie">
|
|
|
|
<!-- Le styles -->
|
|
<link href="../../css/prettify.css" rel="stylesheet">
|
|
<link href="../../css/bootstrap.css" rel="stylesheet">
|
|
<link href="../../css/bootstrap-responsive.css" rel="stylesheet">
|
|
<link href="../../css/default.css" rel="stylesheet">
|
|
|
|
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
|
|
<!--[if lt IE 9]>
|
|
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
|
|
<script type="text/javascript">
|
|
var _gaq = _gaq || [];
|
|
_gaq.push(['_setAccount', 'UA-18852272-2']);
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
(function() {
|
|
var ga = document.createElement('script');
|
|
ga.type = 'text/javascript';
|
|
ga.async = true;
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
var s = document.getElementsByTagName('script')[0];
|
|
s.parentNode.insertBefore(ga, s);
|
|
})();
|
|
</script>
|
|
|
|
<style>
|
|
span.fusion-wrap a {
|
|
display: block;
|
|
margin-top: 10px;
|
|
color: black;
|
|
}
|
|
a.fusion-poweredby {
|
|
display: block;
|
|
margin-top: 10px;
|
|
}
|
|
@media (max-width: 767px) {
|
|
div.promo {
|
|
display: none;
|
|
}
|
|
}
|
|
</style>
|
|
</head>
|
|
<body onload="prettyPrint()" class="-page">
|
|
|
|
<div class="wrapper">
|
|
<div class="navbar navbar-inverse navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container-fluid">
|
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
|
<a class="repo-link btn btn-inverse btn-small disabled" rel="prev" >
|
|
Next <i class="icon-arrow-right icon-white"></i>
|
|
</a>
|
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../kickstarter-announcement/">
|
|
<i class="icon-arrow-left icon-white"></i> Previous
|
|
</a>
|
|
<a id="search_modal_show" class="repo-link btn btn-inverse btn-small" href="#mkdocs_search_modal" data-toggle="modal" data-target="#mkdocs_search_modal"><i class="icon-search icon-white"></i> Search</a>
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</a>
|
|
<a class="brand" href="http://www.django-rest-framework.org">Django REST framework</a>
|
|
<div class="nav-collapse collapse">
|
|
|
|
<!-- Main navigation -->
|
|
<ul class="nav navbar-nav">
|
|
|
|
<li >
|
|
<a href="../..">Home</a>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li >
|
|
<a href="../../tutorial/quickstart/">Quickstart</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../tutorial/1-serialization/">1 - Serialization</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../tutorial/2-requests-and-responses/">2 - Requests and responses</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../tutorial/3-class-based-views/">3 - Class based views</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../tutorial/4-authentication-and-permissions/">4 - Authentication and permissions</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../tutorial/5-relationships-and-hyperlinked-apis/">5 - Relationships and hyperlinked APIs</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../tutorial/6-viewsets-and-routers/">6 - Viewsets and routers</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li >
|
|
<a href="../../api-guide/requests/">Requests</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/responses/">Responses</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/views/">Views</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/generic-views/">Generic views</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/viewsets/">Viewsets</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/routers/">Routers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/parsers/">Parsers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/renderers/">Renderers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/serializers/">Serializers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/fields/">Serializer fields</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/relations/">Serializer relations</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/validators/">Validators</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/authentication/">Authentication</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/permissions/">Permissions</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/throttling/">Throttling</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/filtering/">Filtering</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/pagination/">Pagination</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/versioning/">Versioning</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/content-negotiation/">Content negotiation</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/metadata/">Metadata</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/reverse/">Returning URLs</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/exceptions/">Exceptions</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/status-codes/">Status codes</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/testing/">Testing</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../../api-guide/settings/">Settings</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown active">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li >
|
|
<a href="../documenting-your-api/">Documenting your API</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../internationalization/">Internationalization</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../ajax-csrf-cors/">AJAX, CSRF & CORS</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../browser-enhancements/">Browser Enhancements</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../browsable-api/">The Browsable API</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../rest-hypermedia-hateoas/">REST, Hypermedia & HATEOAS</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../third-party-resources/">Third Party Resources</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../contributing/">Contributing to REST framework</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../project-management/">Project management</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../3.0-announcement/">3.0 Announcement</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../3.1-announcement/">3.1 Announcement</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../3.2-announcement/">3.2 Announcement</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="../kickstarter-announcement/">Kickstarter Announcement</a>
|
|
</li>
|
|
|
|
<li class="active" >
|
|
<a href="./">Release Notes</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<!--/.nav-collapse -->
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="body-content">
|
|
<div class="container-fluid">
|
|
<!-- Search Modal -->
|
|
<div id="mkdocs_search_modal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h3 id="myModalLabel">Documentation search</h3>
|
|
</div>
|
|
|
|
<div class="modal-body">
|
|
<form role="form" autocomplete="off">
|
|
<div class="form-group">
|
|
<input type="text" name="q" class="form-control" placeholder="Search..." id="mkdocs-search-query">
|
|
</div>
|
|
</form>
|
|
<div id="mkdocs-search-results"></div>
|
|
</div>
|
|
|
|
<div class="modal-footer">
|
|
<button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
<div class="span3">
|
|
<div id="table-of-contents">
|
|
<ul class="nav nav-list side-nav well sidebar-nav-fixed">
|
|
|
|
|
|
|
|
<li class="main">
|
|
<a href="#release-notes">Release Notes</a>
|
|
</li>
|
|
|
|
|
|
<li>
|
|
<a href="#versioning">Versioning</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#deprecation-policy">Deprecation policy</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#upgrading">Upgrading</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#32x-series">3.2.x series</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#31x-series">3.1.x series</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#30x-series">3.0.x series</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="main-content" class="span9">
|
|
|
|
|
|
|
|
<h1 id="release-notes">Release Notes</h1>
|
|
<blockquote>
|
|
<p>Release Early, Release Often</p>
|
|
<p>— Eric S. Raymond, <a href="http://www.catb.org/~esr/writings/cathedral-bazaar/cathedral-bazaar/ar01s04.html">The Cathedral and the Bazaar</a>.</p>
|
|
</blockquote>
|
|
<h2 id="versioning">Versioning</h2>
|
|
<p>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.</p>
|
|
<p>Medium version numbers (0.x.0) may include API changes, in line with the <a href="#deprecation-policy">deprecation policy</a>. You should read the release notes carefully before upgrading between medium point releases.</p>
|
|
<p>Major version numbers (x.0.0) are reserved for substantial project milestones.</p>
|
|
<h2 id="deprecation-policy">Deprecation policy</h2>
|
|
<p>REST framework releases follow a formal deprecation policy, which is in line with <a href="https://docs.djangoproject.com/en/dev/internals/release-process/#internal-release-deprecation-policy">Django's deprecation policy</a>.</p>
|
|
<p>The timeline for deprecation of a feature present in version 1.0 would work as follows:</p>
|
|
<ul>
|
|
<li>
|
|
<p>Version 1.1 would remain <strong>fully backwards compatible</strong> with 1.0, but would raise <code>PendingDeprecationWarning</code> warnings if you use the feature that are due to be deprecated. These warnings are <strong>silent by default</strong>, but can be explicitly enabled when you're ready to start migrating any required changes. For example if you start running your tests using <code>python -Wd manage.py test</code>, you'll be warned of any API changes you need to make.</p>
|
|
</li>
|
|
<li>
|
|
<p>Version 1.2 would escalate these warnings to <code>DeprecationWarning</code>, which is loud by default.</p>
|
|
</li>
|
|
<li>
|
|
<p>Version 1.3 would remove the deprecated bits of API entirely.</p>
|
|
</li>
|
|
</ul>
|
|
<p>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.</p>
|
|
<h2 id="upgrading">Upgrading</h2>
|
|
<p>To upgrade Django REST framework to the latest version, use pip:</p>
|
|
<pre><code>pip install -U djangorestframework
|
|
</code></pre>
|
|
<p>You can determine your currently installed version using <code>pip freeze</code>:</p>
|
|
<pre><code>pip freeze | grep djangorestframework
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="32x-series">3.2.x series</h2>
|
|
<h3 id="320">3.2.0</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.0+Release%22">6th August 2015</a>.</p>
|
|
<ul>
|
|
<li>Add <code>AdminRenderer</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2926">#2926</a>)</li>
|
|
<li>Add <code>FilePathField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/1854">#1854</a>)</li>
|
|
<li>Add <code>allow_empty</code> to <code>ListField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2250">#2250</a>)</li>
|
|
<li>Support django-guardian 1.3. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3165">#3165</a>)</li>
|
|
<li>Support grouped choices. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3225">#3225</a>)</li>
|
|
<li>Support error forms in browsable API. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3024">#3024</a>)</li>
|
|
<li>Allow permission classes to customize the error message. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2539">#2539</a>)</li>
|
|
<li>Support <code>source=<method></code> on hyperlinked fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2690">#2690</a>)</li>
|
|
<li><code>ListField(allow_null=True)</code> now allows null as the list value, not null items in the list. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2766">#2766</a>)</li>
|
|
<li><code>ManyToMany()</code> maps to <code>allow_empty=False</code>, <code>ManyToMany(blank=True)</code> maps to <code>allow_empty=True</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2804">#2804</a>)</li>
|
|
<li>Support custom serialization styles for primary key fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2789">#2789</a>)</li>
|
|
<li><code>OPTIONS</code> requests support nested representations. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2915">#2915</a>)</li>
|
|
<li>Set <code>view.action == "metadata"</code> for viewsets with <code>OPTIONS</code> requests. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3115">#3115</a>)</li>
|
|
<li>Support <code>allow_blank</code> on <code>UUIDField</code>. ([#3130][gh#3130])</li>
|
|
<li>Do not display view docstrings with 401 or 403 response codes. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3216">#3216</a>)</li>
|
|
<li>Resolve Django 1.8 deprecation warnings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2886">#2886</a>)</li>
|
|
<li>Fix for <code>DecimalField</code> validation. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3139">#3139</a>)</li>
|
|
<li>Fix behavior of <code>allow_blank=False</code> when used with <code>trim_whitespace=True</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2712">#2712</a>)</li>
|
|
<li>Fix issue with some field combinations incorrectly mapping to an invalid <code>allow_blank</code> argument. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3011">#3011</a>)</li>
|
|
<li>Fix for output representations with prefetches and modified querysets. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2704">#2704</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2727">#2727</a>)</li>
|
|
<li>Fix assertion error when CursorPagination is provided with certains invalid query parameters. (#2920)<a href="https://github.com/tomchristie/django-rest-framework/issues/2920">gh2920</a>.</li>
|
|
<li>Fix <code>UnicodeDecodeError</code> when invalid characters included in header with <code>TokenAuthentication</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2928">#2928</a>)</li>
|
|
<li>Fix transaction rollbacks with <code>@non_atomic_requests</code> decorator. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3016">#3016</a>)</li>
|
|
<li>Fix duplicate results issue with Oracle databases using <code>SearchFilter</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2935">#2935</a>)</li>
|
|
<li>Fix checkbox alignment and rendering in browsable API forms. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2783">#2783</a>)</li>
|
|
<li>Fix for unsaved file objects which should use <code>"url": null</code> in the representation. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2759">#2759</a>)</li>
|
|
<li>Fix field value rendering in browsable API. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2416">#2416</a>)</li>
|
|
<li>Fix <code>HStoreField</code> to include <code>allow_blank=True</code> in <code>DictField</code> mapping. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2659">#2659</a>)</li>
|
|
<li>Numerous other cleanups, improvements to error messaging, private API & minor fixes.</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="31x-series">3.1.x series</h2>
|
|
<h3 id="313">3.1.3</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.1.3+Release%22">4th June 2015</a>.</p>
|
|
<ul>
|
|
<li>Add <code>DurationField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2481">#2481</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2989">#2989</a>)</li>
|
|
<li>Add <code>format</code> argument to <code>UUIDField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2788">#2788</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/3000">#3000</a>)</li>
|
|
<li><code>MultipleChoiceField</code> empties incorrectly on a partial update using multipart/form-data (<a href="https://github.com/tomchristie/django-rest-framework/issues/2993">#2993</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2894">#2894</a>)</li>
|
|
<li>Fix a bug in options related to read-only <code>RelatedField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2981">#2981</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2811">#2811</a>)</li>
|
|
<li>Fix nested serializers with <code>unique_together</code> relations. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2975">#2975</a>)</li>
|
|
<li>Allow unexpected values for <code>ChoiceField</code>/<code>MultipleChoiceField</code> representations. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2839">#2839</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2940">#2940</a>)</li>
|
|
<li>Rollback the transaction on error if <code>ATOMIC_REQUESTS</code> is set. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2887">#2887</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2034">#2034</a>)</li>
|
|
<li>Set the action on a view when override_method regardless of its None-ness. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2933">#2933</a>)</li>
|
|
<li><code>DecimalField</code> accepts <code>2E+2</code> as 200 and validates decimal place correctly. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2948">#2948</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2947">#2947</a>)</li>
|
|
<li>Support basic authentication with custom <code>UserModel</code> that change <code>username</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2952">#2952</a>)</li>
|
|
<li><code>IPAddressField</code> improvements. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2747">#2747</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2618">#2618</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/3008">#3008</a>)</li>
|
|
<li>Improve <code>DecimalField</code> for easier subclassing. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2695">#2695</a>)</li>
|
|
</ul>
|
|
<h3 id="312">3.1.2</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.1.2+Release%22">13rd May 2015</a>.</p>
|
|
<ul>
|
|
<li><code>DateField.to_representation</code> can handle str and empty values. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2656">#2656</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2687">#2687</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2869">#2869</a>)</li>
|
|
<li>Use default reason phrases from HTTP standard. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2764">#2764</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2763">#2763</a>)</li>
|
|
<li>Raise error when <code>ModelSerializer</code> used with abstract model. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2757">#2757</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2630">#2630</a>)</li>
|
|
<li>Handle reversal of non-API view_name in <code>HyperLinkedRelatedField</code> (<a href="https://github.com/tomchristie/django-rest-framework/issues/2724">#2724</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2711">#2711</a>)</li>
|
|
<li>Dont require pk strictly for related fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2745">#2745</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2754">#2754</a>)</li>
|
|
<li>Metadata detects null boolean field type. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2762">#2762</a>)</li>
|
|
<li>Proper handling of depth in nested serializers. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2798">#2798</a>)</li>
|
|
<li>Display viewset without paginator. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2807">#2807</a>)</li>
|
|
<li>Don't check for deprecated <code>.model</code> attribute in permissions (<a href="https://github.com/tomchristie/django-rest-framework/issues/2818">#2818</a>)</li>
|
|
<li>Restrict integer field to integers and strings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2835">#2835</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2836">#2836</a>)</li>
|
|
<li>Improve <code>IntegerField</code> to use compiled decimal regex. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2853">#2853</a>)</li>
|
|
<li>Prevent empty <code>queryset</code> to raise AssertionError. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2862">#2862</a>)</li>
|
|
<li><code>DjangoModelPermissions</code> rely on <code>get_queryset</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2863">#2863</a>)</li>
|
|
<li>Check <code>AcceptHeaderVersioning</code> with content negotiation in place. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2868">#2868</a>)</li>
|
|
<li>Allow <code>DjangoObjectPermissions</code> to use views that define <code>get_queryset</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2905">#2905</a>)</li>
|
|
</ul>
|
|
<h3 id="311">3.1.1</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.1.1+Release%22">23rd March 2015</a>.</p>
|
|
<ul>
|
|
<li><strong>Security fix</strong>: Escape tab switching cookie name in browsable API.</li>
|
|
<li>Display input forms in browsable API if <code>serializer_class</code> is used, even when <code>get_serializer</code> method does not exist on the view. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2643">#2743</a>)</li>
|
|
<li>Use a password input for the AuthTokenSerializer. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2641">#2741</a>)</li>
|
|
<li>Fix missing anchor closing tag after next button. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2691">#2691</a>)</li>
|
|
<li>Fix <code>lookup_url_kwarg</code> handling in viewsets. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2685">#2685</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2591">#2591</a>)</li>
|
|
<li>Fix problem with importing <code>rest_framework.views</code> in <code>apps.py</code> (<a href="https://github.com/tomchristie/django-rest-framework/issues/2678">#2678</a>)</li>
|
|
<li>LimitOffsetPagination raises <code>TypeError</code> if PAGE_SIZE not set (<a href="https://github.com/tomchristie/django-rest-framework/issues/2667">#2667</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2700">#2700</a>)</li>
|
|
<li>German translation for <code>min_value</code> field error message references <code>max_value</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2645">#2645</a>)</li>
|
|
<li>Remove <code>MergeDict</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2640">#2640</a>)</li>
|
|
<li>Support serializing unsaved models with related fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2637">#2637</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2641">#2641</a>)</li>
|
|
<li>Allow blank/null on radio.html choices. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2631">#2631</a>)</li>
|
|
</ul>
|
|
<h3 id="310">3.1.0</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.1.0+Release%22">5th March 2015</a>.</p>
|
|
<p>For full details see the <a href="../3.1-announcement/">3.1 release announcement</a>.</p>
|
|
<hr />
|
|
<h2 id="30x-series">3.0.x series</h2>
|
|
<h3 id="305">3.0.5</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.0.5+Release%22">10th February 2015</a>.</p>
|
|
<ul>
|
|
<li>Fix a bug where <code>_closable_objects</code> breaks pickling. (<a href="https://github.com/tomchristie/django-rest-framework/issues/1850">#1850</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2492">#2492</a>)</li>
|
|
<li>Allow non-standard <code>User</code> models with <code>Throttling</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2524">#2524</a>)</li>
|
|
<li>Support custom <code>User.db_table</code> in TokenAuthentication migration. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2479">#2479</a>)</li>
|
|
<li>Fix misleading <code>AttributeError</code> tracebacks on <code>Request</code> objects. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2530">#2530</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2108">#2108</a>)</li>
|
|
<li><code>ManyRelatedField.get_value</code> clearing field on partial update. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2475">#2475</a>)</li>
|
|
<li>Removed '.model' shortcut from code. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2486">#2486</a>)</li>
|
|
<li>Fix <code>detail_route</code> and <code>list_route</code> mutable argument. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2518">#2518</a>)</li>
|
|
<li>Prefetching the user object when getting the token in <code>TokenAuthentication</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2519">#2519</a>)</li>
|
|
</ul>
|
|
<h3 id="304">3.0.4</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.0.4+Release%22">28th January 2015</a>.</p>
|
|
<ul>
|
|
<li>Django 1.8a1 support. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2425">#2425</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2446">#2446</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2441">#2441</a>)</li>
|
|
<li>Add <code>DictField</code> and support Django 1.8 <code>HStoreField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2451">#2451</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2106">#2106</a>)</li>
|
|
<li>Add <code>UUIDField</code> and support Django 1.8 <code>UUIDField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2448">#2448</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2433">#2433</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2432">#2432</a>)</li>
|
|
<li><code>BaseRenderer.render</code> now raises <code>NotImplementedError</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2434">#2434</a>)</li>
|
|
<li>Fix timedelta JSON serialization on Python 2.6. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2430">#2430</a>)</li>
|
|
<li><code>ResultDict</code> and <code>ResultList</code> now appear as standard dict/list. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2421">#2421</a>)</li>
|
|
<li>Fix visible <code>HiddenField</code> in the HTML form of the web browsable API page. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2410">#2410</a>)</li>
|
|
<li>Use <code>OrderedDict</code> for <code>RelatedField.choices</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2408">#2408</a>)</li>
|
|
<li>Fix ident format when using <code>HTTP_X_FORWARDED_FOR</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2401">#2401</a>)</li>
|
|
<li>Fix invalid key with memcached while using throttling. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2400">#2400</a>)</li>
|
|
<li>Fix <code>FileUploadParser</code> with version 3.x. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2399">#2399</a>)</li>
|
|
<li>Fix the serializer inheritance. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2388">#2388</a>)</li>
|
|
<li>Fix caching issues with <code>ReturnDict</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2360">#2360</a>)</li>
|
|
</ul>
|
|
<h3 id="303">3.0.3</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.0.3+Release%22">8th January 2015</a>.</p>
|
|
<ul>
|
|
<li>Fix <code>MinValueValidator</code> on <code>models.DateField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2369">#2369</a>)</li>
|
|
<li>Fix serializer missing context when pagination is used. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2355">#2355</a>)</li>
|
|
<li>Namespaced router URLs are now supported by the <code>DefaultRouter</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2351">#2351</a>)</li>
|
|
<li><code>required=False</code> allows omission of value for output. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2342">#2342</a>)</li>
|
|
<li>Use textarea input for <code>models.TextField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2340">#2340</a>)</li>
|
|
<li>Use custom <code>ListSerializer</code> for pagination if required. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2331">#2331</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2327">#2327</a>)</li>
|
|
<li>Better behavior with null and '' for blank HTML fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2330">#2330</a>)</li>
|
|
<li>Ensure fields in <code>exclude</code> are model fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2319">#2319</a>)</li>
|
|
<li>Fix <code>IntegerField</code> and <code>max_length</code> argument incompatibility. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2317">#2317</a>)</li>
|
|
<li>Fix the YAML encoder for 3.0 serializers. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2315">#2315</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2283">#2283</a>)</li>
|
|
<li>Fix the behavior of empty HTML fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2311">#2311</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/1101">#1101</a>)</li>
|
|
<li>Fix Metaclass attribute depth ignoring fields attribute. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2287">#2287</a>)</li>
|
|
<li>Fix <code>format_suffix_patterns</code> to work with Django's <code>i18n_patterns</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2278">#2278</a>)</li>
|
|
<li>Ability to customize router URLs for custom actions, using <code>url_path</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2010">#2010</a>)</li>
|
|
<li>Don't install Django REST Framework as egg. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2386">#2386</a>)</li>
|
|
</ul>
|
|
<h3 id="302">3.0.2</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.0.2+Release%22">17th December 2014</a>.</p>
|
|
<ul>
|
|
<li>Ensure <code>request.user</code> is made available to response middleware. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2155">#2155</a>)</li>
|
|
<li><code>Client.logout()</code> also cancels any existing <code>force_authenticate</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2218">#2218</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2259">#2259</a>)</li>
|
|
<li>Extra assertions and better checks to preventing incorrect serializer API use. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2228">#2228</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2234">#2234</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2262">#2262</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2263">#2263</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2266">#2266</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2267">#2267</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2289">#2289</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2291">#2291</a>)</li>
|
|
<li>Fixed <code>min_length</code> message for <code>CharField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2255">#2255</a>)</li>
|
|
<li>Fix <code>UnicodeDecodeError</code>, which can occur on serializer <code>repr</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2270">#2270</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2279">#2279</a>)</li>
|
|
<li>Fix empty HTML values when a default is provided. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2280">#2280</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2294">#2294</a>)</li>
|
|
<li>Fix <code>SlugRelatedField</code> raising <code>UnicodeEncodeError</code> when used as a multiple choice input. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2290">#2290</a>)</li>
|
|
</ul>
|
|
<h3 id="301">3.0.1</h3>
|
|
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.0.1+Release%22">11th December 2014</a>.</p>
|
|
<ul>
|
|
<li>More helpful error message when the default Serializer <code>create()</code> fails. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2013">#2013</a>)</li>
|
|
<li>Raise error when attempting to save serializer if data is not valid. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2098">#2098</a>)</li>
|
|
<li>Fix <code>FileUploadParser</code> breaks with empty file names and multiple upload handlers. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2109">#2109</a>)</li>
|
|
<li>Improve <code>BindingDict</code> to support standard dict-functions. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2135">#2135</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2163">#2163</a>)</li>
|
|
<li>Add <code>validate()</code> to <code>ListSerializer</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2168">#2168</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2225">#2225</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2232">#2232</a>)</li>
|
|
<li>Fix JSONP renderer failing to escape some characters. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2169">#2169</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2195">#2195</a>)</li>
|
|
<li>Add missing default style for <code>FileField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2172">#2172</a>)</li>
|
|
<li>Actions are required when calling <code>ViewSet.as_view()</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2175">#2175</a>)</li>
|
|
<li>Add <code>allow_blank</code> to <code>ChoiceField</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2184">#2184</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2239">#2239</a>)</li>
|
|
<li>Cosmetic fixes in the HTML renderer. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2187">#2187</a>)</li>
|
|
<li>Raise error if <code>fields</code> on serializer is not a list of strings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2193">#2193</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2213">#2213</a>)</li>
|
|
<li>Improve checks for nested creates and updates. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2194">#2194</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2196">#2196</a>)</li>
|
|
<li><code>validated_attrs</code> argument renamed to <code>validated_data</code> in <code>Serializer</code> <code>create()</code>/<code>update()</code>. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2197">#2197</a>)</li>
|
|
<li>Remove deprecated code to reflect the dropped Django versions. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2200">#2200</a>)</li>
|
|
<li>Better serializer errors for nested writes. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2202">#2202</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2215">#2215</a>)</li>
|
|
<li>Fix pagination and custom permissions incompatibility. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2205">#2205</a>)</li>
|
|
<li>Raise error if <code>fields</code> on serializer is not a list of strings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2213">#2213</a>)</li>
|
|
<li>Add missing translation markers for relational fields. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2231">#2231</a>)</li>
|
|
<li>Improve field lookup behavior for dicts/mappings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2244">#2244</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/2243">#2243</a>)</li>
|
|
<li>Optimized hyperlinked PK. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2242">#2242</a>)</li>
|
|
</ul>
|
|
<h3 id="300">3.0.0</h3>
|
|
<p><strong>Date</strong>: 1st December 2014</p>
|
|
<p>For full details see the <a href="../3.0-announcement/">3.0 release announcement</a>.</p>
|
|
<hr />
|
|
<p>For older release notes, <a href="https://github.com/tomchristie/django-rest-framework/blob/version-2.4.x/docs/topics/release-notes.md">please see the version 2.x documentation</a>.</p>
|
|
<!-- 3.0.1 -->
|
|
|
|
<p><!-- 3.0.2 -->
|
|
<!-- 3.0.3 -->
|
|
<!-- 3.0.4 -->
|
|
<!-- 3.0.5 -->
|
|
<!-- 3.1.1 -->
|
|
<!-- 3.1.2 -->
|
|
<!-- 3.1.3 --></p>
|
|
<!-- 3.2.0 -->
|
|
|
|
|
|
</div> <!--/span-->
|
|
</div> <!--/row-->
|
|
</div> <!--/.fluid-container-->
|
|
</div> <!--/.body content-->
|
|
<div id="push"></div>
|
|
</div> <!--/.wrapper -->
|
|
|
|
<footer class="span12">
|
|
<p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</a>
|
|
</p>
|
|
</footer>
|
|
|
|
<!-- Le javascript
|
|
================================================== -->
|
|
<!-- Placed at the end of the document so the pages load faster -->
|
|
<script src="../../js/jquery-1.8.1-min.js"></script>
|
|
<script src="../../js/prettify-1.0.js"></script>
|
|
<script src="../../js/bootstrap-2.1.1-min.js"></script>
|
|
<script>var base_url = '../..';</script>
|
|
<script src="../../mkdocs/js/require.js"></script>
|
|
<script src="../../js/theme.js"></script>
|
|
|
|
<script>
|
|
var shiftWindow = function() {
|
|
scrollBy(0, -50)
|
|
};
|
|
|
|
if (location.hash) shiftWindow();
|
|
window.addEventListener("hashchange", shiftWindow);
|
|
|
|
$('.dropdown-menu').on('click touchstart', function(event) {
|
|
event.stopPropagation();
|
|
});
|
|
|
|
// Dynamically force sidenav/dropdown to no higher than browser window
|
|
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
|
|
|
|
$(function() {
|
|
$(window).resize(function() {
|
|
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
|
|
});
|
|
});
|
|
</script>
|
|
</body>
|
|
|
|
</html> |