Skip to content

Commit

Permalink
Improved description of allowed throttling rates (#9640)
Browse files Browse the repository at this point in the history
  • Loading branch information
decadenza authored Jan 30, 2025
1 parent 038670a commit 8637b3d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api-guide/throttling.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The default throttling policy may be set globally, using the `DEFAULT_THROTTLE_C
}
}

The rate descriptions used in `DEFAULT_THROTTLE_RATES` may include `second`, `minute`, `hour` or `day` as the throttle period.
The rates used in `DEFAULT_THROTTLE_RATES` can be specified over a period of second, minute, hour or day. The period must be specified after the `/` separator using `s`, `m`, `h` or `d`, respectively. For increased clarity, extended units such as `second`, `minute`, `hour`, `day` or even abbreviations like `sec`, `min`, `hr` are allowed, as only the first character is relevant to identify the rate.

You can also set the throttling policy on a per-view or per-viewset basis,
using the `APIView` class-based views.
Expand Down

0 comments on commit 8637b3d

Please sign in to comment.