aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/throttling.md
diff options
context:
space:
mode:
authorTom Christie2012-10-10 10:02:37 +0100
committerTom Christie2012-10-10 10:02:37 +0100
commitccd2b0117d9c26199b1862a302b1eb06dd2f07b2 (patch)
tree05e47209445303f2cda704d4ac50791551ddae5b /docs/api-guide/throttling.md
parent900c4b625b62a6c1f4a16bfe8d6b5d77480427ff (diff)
downloaddjango-rest-framework-ccd2b0117d9c26199b1862a302b1eb06dd2f07b2.tar.bz2
Permissions and throttles no longer have a view attribute on self. Explicitly passed to .has_permissions(request, view, obj=None) / .allow_request(request, view)
Diffstat (limited to 'docs/api-guide/throttling.md')
-rw-r--r--docs/api-guide/throttling.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md
index 7861e9ba..0e228905 100644
--- a/docs/api-guide/throttling.md
+++ b/docs/api-guide/throttling.md
@@ -144,8 +144,8 @@ User requests to either `ContactListView` or `ContactDetailView` would be restri
## Custom throttles
-To create a custom throttle, override `BaseThrottle` and implement `.allow_request(request)`. The method should return `True` if the request should be allowed, and `False` otherwise.
+To create a custom throttle, override `BaseThrottle` and implement `.allow_request(request, view)`. The method should return `True` if the request should be allowed, and `False` otherwise.
-Optionally you may also override the `.wait()` method. If implemented, `.wait()` should return a recomended number of seconds to wait before attempting the next request, or `None`. The `.wait()` method will only be called if `.check_throttle()` has previously returned `False`.
+Optionally you may also override the `.wait()` method. If implemented, `.wait()` should return a recomended 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`.
[permissions]: permissions.md