Skip to content

docs(ai-rate-limiting): re-port with Admin API, ADC, and Ingress Controller tabs#13209

Open
Yilialinn wants to merge 6 commits intoapache:masterfrom
Yilialinn:docs/update-ai-rate-limiting
Open

docs(ai-rate-limiting): re-port with Admin API, ADC, and Ingress Controller tabs#13209
Yilialinn wants to merge 6 commits intoapache:masterfrom
Yilialinn:docs/update-ai-rate-limiting

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

@Yilialinn Yilialinn commented Apr 13, 2026

Summary

  • Re-port ai-rate-limiting plugin documentation from API7 docs with all three configuration tabs (Admin API, ADC, Ingress Controller)
  • Include nested Gateway API / APISIX Ingress Controller sub-tabs within the Ingress Controller tab
  • 6 example sections covering single instance, multi-instance, shared quota, instance priority, consumer-level, and rule-based rate limiting
  • Update both English and Chinese documentation

@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. doc Documentation things labels Apr 13, 2026
…xamples

limit_strategy is a top-level attribute, not a per-instance attribute.
Fixed in all 4 config variants (Admin API, ADC, Gateway API, Ingress Controller)
for the 'Rate Limit One Instance Among Multiple' example.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR re-ports the ai-rate-limiting plugin documentation from API7 Docs, adding multi-tab configuration instructions (Admin API, ADC, Ingress Controller with nested Gateway API / APISIX Ingress Controller) and expanding examples, for both English and Chinese docs.

Changes:

  • Added MDX tabbed configuration blocks (Admin API / ADC / Ingress Controller, with nested Kubernetes API tabs) across multiple examples.
  • Updated/expanded Attributes tables (including expression limit_strategy and cost_expr) and added a new “rate limit by rules” example section.
  • Updated both docs/en and docs/zh versions to keep content aligned.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/zh/latest/plugins/ai-rate-limiting.md Re-ported/expanded Chinese docs with MDX tabs and additional scenarios/examples.
docs/en/latest/plugins/ai-rate-limiting.md Re-ported/expanded English docs with MDX tabs and additional scenarios/examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/zh/latest/plugins/ai-rate-limiting.md Outdated
Comment thread docs/zh/latest/plugins/ai-rate-limiting.md Outdated
Comment thread docs/zh/latest/plugins/ai-rate-limiting.md Outdated
Comment thread docs/zh/latest/plugins/ai-rate-limiting.md Outdated
Yilialinn and others added 4 commits April 14, 2026 12:02
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
curl "http://127.0.0.1:9180/apisix/admin/routes/1" -X PUT \
-H "X-API-KEY: ${admin_key}" \
-d '{
"id": "ai-rate-limiting-route",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the style of resource creation consistent across plugin docs. Other plugin docs are adopting the style where the ID of the resource is placed in the PUT body, with a meaningful ID. It seems that this writing style is being reverted in this doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants