Repository navigation
docs: add Hosted rate-limit operator guide (#37) - #152
Merged
CodewithJha merged 1 commit intoNov 16, 2026
Merged
Conversation
|
@BasilZafar11 is attempting to deploy a commit to the priyanshu's projects Team on Vercel. A member of the Team first needs to authorize it. |
4 tasks
11 tasks done
CodewithJha
approved these changes
Nov 16, 2026
CodewithJha
left a comment
Owner
There was a problem hiding this comment.
MERGE READY for #37.
What I verified
docs/RATE_LIMITS.mdlists all 11 env vars with defaults that matchrate_limit.pyconstants (health/normal/expensive/ingest RPM+burst, max keys, idle seconds). Documents process-local buckets, identity keying, middleware order, and 429 semantics without overselling distributed limits.- SECURITY.md and docs index link in. Docs-only against live code. Closes #37.
Owner
|
Merged — thank you @BasilZafar11. Operators finally have a single field guide for the in-process limiter defaults, identity keys, and Retry-After behavior. Related open work:
No pressure. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #37
Add docs/RATE_LIMITS.md as the Hosted operator field guide: all 11 environment variables and their defaults/types, auth-dependent enablement, endpoint categories, token-bucket refill/burst semantics, per-identity/category keys, proxy identity implications, idle/LRU cleanup, and process-local reset/replica limitations.
Document middleware order, the structured 429 response, integer-second Retry-After rounding, and safe bounded client retry expectations. Distinguish the HTTP contract from automatic client retry support, and link the existing ingestion/pending-file contract. Explain public health/meta rate limiting and the metadata flags for checking enablement.
Link the guide from the docs hub and SECURITY.md. Correct the security summary's type wording: idle cleanup accepts fractional seconds; RPM/burst/key counts require positive integers. No runtime behavior changes.
Type of change
Checklist
Test plan
rate_limit.py/load_rate_limit_config({}).uv run --locked pytest tests/unit/test_rate_limit.py tests/integration/test_api_hosted_rate_limit.py -q --tb=short: 27 passed.uv run --locked ruff check: passed.git diff --check: passed.No new tests were added for this documentation-only change. Full backend/web/container/package and CLI smoke gates are left to existing CI. Branch starts at current upstream main
99ed9ad, matching fork main at fetch.CI results
All seven jobs passed: Python 3.11/3.12 backend tests, Python lint, package build, CLI smoke, web build, and container smoke.
CI run: https://github.com/CodewithJha/mutiny/actions/runs/43666468336