Summary

Add a developer guide for Rate Limiting.

Review Request #14758 — Created Jan. 5, 2026 and updated Jan. 6, 2026, 8:53 a.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This adds a guide to the docs for using the new general rate limiting
support. It covers the new functions and best practices for constructing
rate limit keys.

Testing Done

Built the docs. Checked for any obvious errors, and for bad links and
build errors.

Commits

Summary	ID
Add a developer guide for Rate Limiting. This adds a guide to the docs for using the new general rate limiting support. It covers the new functions and best practices for constructing rate limit keys.	8a62dac0f10915ee2057af28fbf84c4e7ab1fa60

Issues

Description	From	Last Updated
Typo: let's -> lets	david	Jan. 5, 2026, 2:43 p.m.
The arg names in the code are total_limit and period_secs	david	Jan. 5, 2026, 2:44 p.m.
The default is to not increment. We should fix this paragraph and maybe also provide an example of check+increment.	david	Jan. 5, 2026, 2:46 p.m.
Let's remove "by default" from this sentence.	david	Jan. 6, 2026, 8:53 a.m.
We should import RateLimit in here too.	david	Jan. 5, 2026, 2:46 p.m.
We mention get_user_id_or_ip in the above section, but we probably should include its usage here (and perhaps also in the …	david	Jan. 5, 2026, 2:46 p.m.
Let's add the from djblets.auth.ratelimit import get_user_id_or_ip line to this example too.	david	Jan. 6, 2026, 8:53 a.m.

flake8 passed.

JSHint passed.

docs/djblets/guides/protect/ratelimit.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: let's -> lets
```
docs/djblets/guides/protect/ratelimit.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
The arg names in the code are total_limit and period_secs
```

docs/djblets/guides/protect/ratelimit.rst (Diff revision 1)

The issue has been resolved. Show all issues

The default is to not increment. We should fix this paragraph and maybe also provide an example of check+increment.

docs/djblets/guides/protect/ratelimit.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
We should import RateLimit in here too.
```

docs/djblets/guides/protect/ratelimit.rst (Diff revision 1)

The issue has been resolved. Show all issues

We mention get_user_id_or_ip in the above section, but we probably should include its usage here (and perhaps also in the examples below)

Change Summary:

Fixed a number of issues with invoking the rate limit functions.

Commits:

	Summary	ID
	Add a developer guide for Rate Limiting. This adds a guide to the docs for using the new general rate limiting support. It covers the new functions and best practices for constructing rate limit keys.	ff3230519b7138d9a29263a812b01309d4a7a6ee
	Add a developer guide for Rate Limiting. This adds a guide to the docs for using the new general rate limiting support. It covers the new functions and best practices for constructing rate limit keys.	8a62dac0f10915ee2057af28fbf84c4e7ab1fa60

Diff:

Revision 2 (+468)

Show changes

	docs/djblets/guides/index.rst
	docs/djblets/guides/protect/index.rst
	docs/djblets/guides/protect/ratelimit.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Fix it!

docs/djblets/guides/protect/ratelimit.rst (Diff revisions 1 - 2)
An issue was opened. Show all issues
```
Let's remove "by default" from this sentence.
```

docs/djblets/guides/protect/ratelimit.rst (Diff revisions 1 - 2)

An issue was opened. Show all issues

Let's add the from djblets.auth.ratelimit import get_user_id_or_ip line to this example too.