Skip to content

Commit 88e5b15

Browse files
committed
docs(api-server): update rate limiting documentation
- Clarify how rate limiting works for both authenticated and unauthenticated requests - Update error code from 'forbidden' to 'tooManyRequests' for more accurate representation
1 parent f41b798 commit 88e5b15

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/content/docs/api-server/features/rate-limiting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This is crucial for preventing abuse, such as brute-force attacks on the authent
1111

1212
### How It Works
1313

14-
The rate-limiting mechanism is implemented as a middleware that runs on specific routes. It uses the client's IP address as the primary identifier for tracking requests.
14+
The rate-limiting mechanism is implemented as a middleware that runs on specific routes. It uses the client's IP address to identify unauthenticated requests and the user's ID for authenticated requests.
1515

1616
There are two distinct rate-limiting configurations applied to different parts of the API:
1717

@@ -40,7 +40,7 @@ When a client exceeds a rate limit, the API will respond with an HTTP `429 Too M
4040
```json
4141
{
4242
"error": {
43-
"code": "forbidden",
43+
"code": "tooManyRequests",
4444
"message": "You have made too many requests. Please try again later."
4545
}
4646
}

0 commit comments

Comments
 (0)