Merging to release-5.7: New IA - Rate Limit Page (#5908)

[buger]

User description

New IA - Rate Limit Page (#5908)

---

PR Type

Documentation

---

Description

• Introduced a comprehensive "Rate Limiting" documentation page.

• Updated references and links to the new rate-limiting page.

• Enhanced descriptions for rate-limiting features and configurations.

• Added aliases for backward compatibility with previous rate-limiting links.

---

Changes walkthrough 📝

	Relevant files
Documentation	16 files rate-limit.md Added a detailed "Rate Limiting" documentation page.          +895/-0  gateway.md Updated rate-limiting references in Gateway release notes. +12/-12  security-best-practices.md Updated security best practices to reference new rate-limiting page. +5/-5      dashboard.md Updated rate-limiting references in Dashboard release notes. +4/-4      plan-your-api-integration.md Updated rate-limiting references in API integration planning guide. +2/-2      create-security-policy-include.md Updated rate-limiting references in shared security policy documentation. +4/-4      archived.md Updated archived release notes with new rate-limiting references. +2/-2      event-types.md Updated event types documentation with new rate-limiting references. +2/-2      endpoint-designer.md Updated endpoint designer documentation with new rate-limiting references. +1/-1      configure-first-api.md Updated first API configuration guide with new rate-limiting references. +1/-1      troubleshooting-debugging.md Updated troubleshooting guide with new rate-limiting references. +1/-1      api-def-rate-and-quotas.md Updated shared API definition documentation with new rate-limiting references. +1/-1      rate-limits.md Updated API definition rate-limits documentation with new references. +1/-1      security.md Updated UDG security documentation with new rate-limiting references. +1/-1      http-client.md Updated streaming input configuration with new rate-limiting references. +1/-1      http-client.md Updated streaming output configuration with new rate-limiting references. +1/-1
Configuration changes	2 files menu.yaml Added "Rate Limiting" to the API Management menu.                +4/-44    alias.json Added aliases for backward compatibility with old rate-limiting links. +11/-0
Additional files	12 files automations.md +1/-1      basic-config-and-security.md +0/-1      control-limit-traffic.md +0/-14    rate-limiting.md +0/-151  request-quotas.md +0/-66    request-throttling.md +0/-45    rate-limiting.md +0/-294  api-versioning.md +1/-1      endpoint-rate-limit-classic.md +0/-87    endpoint-rate-limit-oas.md +0/-211  local.md +0/-33    overview.md +0/-49

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[netlify]

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	627b072
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/678f8d95a5f7c600085a3e93
😎 Deploy Preview	https://deploy-preview-5910--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 5908 - Fully compliant Fully compliant requirements: Introduce a comprehensive "Rate Limiting" documentation page. Update links and references to the new rate-limiting documentation. Enhance descriptions for rate-limiting features and configurations. Add aliases for backward compatibility with previous rate-limiting links. Not compliant requirements:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Possible Redundancy The extensive use of repetitive keywords in the tags and keywords fields might lead to redundancy and could be optimized for better readability and search engine performance. tags: ["Rate Limit", "Rate Limiting", "Rate Limit Algorithms", "Distributed Rate Limiter", "Redis Rate Limiter", "Fixed Window", "Spike Arrest", "Rate Limit Scope", "Local", "Local rate Limits", "Request Throttling", "Quotas", "Tyk Classic", "Tyk Classic API", "Tyk OAS", "Tyk OAS API", "Rate Limiting", "Global limits", "Per API limits", "Request Throttling", "Request Quotas"] description: Overview of Rate Limiting with the Tyk Gateway keywords: ["Rate Limit", "Rate Limiting", "Rate Limit Algorithms", "Distributed Rate Limiter", "Redis Rate Limiter", "Fixed Window", "Spike Arrest", "Rate Limit Scope", "Local", "Local rate Limits", "Request Throttling", "Quotas", "Tyk Classic", "Tyk Classic API", "Tyk OAS", "Tyk OAS API", "Rate Limiting", "Global limits", "Per API limits", "Request Throttling", "Request Quotas"] Clarity in Examples Some examples, such as the "Rate Limit Smoothing" configuration, could benefit from additional clarity or simplification to ensure they are easily understandable by all users. ##### Configuring rate limit smoothing When Redis Rate Limiter is in use, rate limit smoothing is configured with the following options within the `smoothing` object alongside the standard `rate` and `per` parameters: - `enabled` (boolean) to enable or disable rate limit smoothing - `threshold` is the initial rate limit (*current allowance*) beyond which smoothing will be applied - `step` is the increment by which the *current allowance* will be increased or decreased each time a smoothing event is emitted - `trigger` is a fraction (typically in the range 0.1-1.0) of the `step` at which point a smoothing event will be emitted as the request rate approaches the *current allowance* - `delay` is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds). Rate Limit Smoothing is configured using the `smoothing` object within access keys and policies. For API-level rate limiting, this configuration is within the `access_rights[*].limit` object. An example configuration would be as follows: ```yaml "smoothing": { "enabled": true, "threshold": 5, "trigger": 0.5, "step": 5, "delay": 30 } </details> </td></tr> </table>

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.