Commit 312d3b8
committed
docs: add comprehensive rate limiting documentation and decorator usage notes
- Create complete rate limiting documentation (docs/usage/rate-limiting.md)
- Overview of rate limiting features and backends
- Configuration guide for in-memory and Redis backends
- Usage examples and best practices
- Security considerations and troubleshooting
- 541 lines of comprehensive documentation
- Add rate limiting feature to README.md and docs/index.md
- Describe conservative limits for auth endpoints
- Mention both in-memory and Redis backend support
- Note HTTP 429 responses with Retry-After header
- Highlight Prometheus metrics integration
- Add decorator ordering notes to both caching and rate limiting docs
- Document correct order when using both decorators
- Explain security rationale (rate limit before cache)
- Provide code examples with both decorators
- Cross-reference between documentation pages
- Update mkdocs.yml navigation
- Add "Rate Limiting and Security" before Metrics section
- Position logically in Usage section
All documentation follows existing style and format.1 parent 892b335 commit 312d3b8
File tree
5 files changed
+592
-0
lines changed- docs
- usage
5 files changed
+592
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
128 | 128 | | |
129 | 129 | | |
130 | 130 | | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
131 | 137 | | |
132 | 138 | | |
133 | 139 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
80 | 86 | | |
81 | 87 | | |
82 | 88 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
212 | 212 | | |
213 | 213 | | |
214 | 214 | | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
215 | 233 | | |
216 | 234 | | |
217 | 235 | | |
| |||
0 commit comments