33 lines
1.4 KiB
JSON
33 lines
1.4 KiB
JSON
{
|
|
"_comment": "Template for error message when rate limits are exceeded",
|
|
"error": {
|
|
"code": 429,
|
|
"_comment": "HTTP status code for Too Many Requests",
|
|
"message": "Too Many Requests",
|
|
"_comment": "General error message",
|
|
"details": {
|
|
"reason": "Rate limit exceeded",
|
|
"_comment": "Specific reason for the error",
|
|
"limit": 100,
|
|
"_comment": "The allowed request limit",
|
|
"remaining": 0,
|
|
"_comment": "Requests remaining in the current window",
|
|
"reset_at": "2024-01-24T12:00:00Z",
|
|
"_comment": "ISO 8601 timestamp for when the limit resets",
|
|
"policy": "100 requests per minute",
|
|
"_comment": "Human-readable policy description",
|
|
"algorithm": "token_bucket",
|
|
"_comment": "Rate limiting algorithm used (token_bucket, sliding_window, fixed_window)",
|
|
"scope": "user",
|
|
"_comment": "Scope of the rate limit (user, ip, global)",
|
|
"key": "user_id:123",
|
|
"_comment": "Key used for rate limiting (e.g., user ID, IP address)",
|
|
"retry_after": 60,
|
|
"_comment": "Seconds to wait before retrying the request (for Retry-After header)",
|
|
"documentation_url": "https://example.com/api/rate-limiting",
|
|
"_comment": "URL to documentation about rate limiting",
|
|
"support_email": "support@example.com"
|
|
"_comment": "Support email for questions about rate limits"
|
|
}
|
|
}
|
|
} |