aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/throttling.md
diff options
context:
space:
mode:
authorTom Christie2014-09-11 20:43:44 +0100
committerTom Christie2014-09-11 20:43:44 +0100
commit19b8f779de82fa4737b37fb4359145af0b07a56c (patch)
tree09e3d8201501db7af2a01d30e476979a59bac4aa /docs/api-guide/throttling.md
parentbf52d04f4c370d6917599d26c84b73124d5ef366 (diff)
downloaddjango-rest-framework-19b8f779de82fa4737b37fb4359145af0b07a56c.tar.bz2
Throttles now use Retry-After header and no longer support the custom style
Diffstat (limited to 'docs/api-guide/throttling.md')
-rw-r--r--docs/api-guide/throttling.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md
index 832304f1..16a7457b 100644
--- a/docs/api-guide/throttling.md
+++ b/docs/api-guide/throttling.md
@@ -178,6 +178,8 @@ To create a custom throttle, override `BaseThrottle` and implement `.allow_reque
Optionally you may also override the `.wait()` method. If implemented, `.wait()` should return a recommended number of seconds to wait before attempting the next request, or `None`. The `.wait()` method will only be called if `.allow_request()` has previously returned `False`.
+If the `.wait()` method is implemented and the request is throttled, then a `Retry-After` header will be included in the response.
+
## Example
The following is an example of a rate throttle, that will randomly throttle 1 in every 10 requests.