From 21a0a826bba3df01e72ea8b0390e05d50cf9a854 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 20 Aug 2014 17:34:51 +0100 Subject: [PATCH] Add Retry-After to release notes. Refs #1508. --- docs/topics/2.4-accouncement.md | 2 ++ docs/topics/release-notes.md | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/topics/2.4-accouncement.md b/docs/topics/2.4-accouncement.md index 64dcca610..d8e264ff8 100644 --- a/docs/topics/2.4-accouncement.md +++ b/docs/topics/2.4-accouncement.md @@ -116,6 +116,8 @@ There are also a number of other features and bugfixes as [listed in the release Smarter [client IP identification for throttling][client-ip-identification], with the addition of the `NUM_PROXIES` setting. +Added the standardized `Retry-After` header to throttled responses, as per [RFC 6585](http://tools.ietf.org/html/rfc6585). This should now be used in preference to the custom `X-Trottle-Wait-Seconds` header which will be fully deprecated in 3.0. + ## Deprecations All API changes in 2.3 that previously raised `PendingDeprecationWarning` will now raise a `DeprecationWarning`, which is loud by default. diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md index 0a74a27d3..a2b4782f3 100644 --- a/docs/topics/release-notes.md +++ b/docs/topics/release-notes.md @@ -52,6 +52,7 @@ You can determine your currently installed version using `pip freeze`: * Support customizable view name and description functions, using the `VIEW_NAME_FUNCTION` and `VIEW_DESCRIPTION_FUNCTION` settings. * Added `NUM_PROXIES` setting for smarter client IP identification. * Added `MAX_PAGINATE_BY` setting and `max_paginate_by` generic view attribute. +* Added `Retry-After` header to throttled responses, as per [RFC 6585](http://tools.ietf.org/html/rfc6585). This should now be used in preference to the custom `X-Trottle-Wait-Seconds` header which will be fully deprecated in 3.0. * Added `cache` attribute to throttles to allow overriding of default cache. * Added `lookup_value_regex` attribute to routers, to allow the URL argument matching to be constrainted by the user. * Added `allow_none` option to `CharField`.