Skip to content

docs: fix broken paragraph and add custom headers example for limit-count#13171

Open
Yilialinn wants to merge 3 commits intoapache:masterfrom
Yilialinn:docs/update-limit-count
Open

docs: fix broken paragraph and add custom headers example for limit-count#13171
Yilialinn wants to merge 3 commits intoapache:masterfrom
Yilialinn:docs/update-limit-count

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

Summary

  • Fix the truncated opening paragraph in the "Rate Limit with Anonymous Consumer" section, which was missing the introductory sentence: "The following example demonstrates how you can configure different rate limiting policies for regular and anonymous Consumers, where the anonymous Consumer..."
  • Add the "Customize Rate Limiting Headers" example section, demonstrating how to use plugin metadata to customize rate limiting response header names (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
  • Apply the same changes to both English and Chinese documentation

Ref: https://github.com/api7/docs/issues/892#issuecomment-3881958092

…ount

Fix the truncated opening paragraph in the 'Rate Limit with Anonymous
Consumer' section, which was missing the introductory sentence.

Add the 'Customize Rate Limiting Headers' example section from the
API7 docs, demonstrating how to use plugin metadata to customize
rate limiting response header names.

Apply the same changes to both English and Chinese documentation.

Ref: api7/docs#892 (comment)
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. doc Documentation things labels Apr 7, 2026
@Yilialinn Yilialinn requested a review from Copilot April 9, 2026 08:41
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

Note

Copilot was unable to run its full agentic suite in this review.

Updates the limit-count plugin documentation to restore a truncated paragraph and add an example showing how to customize rate limiting response headers via plugin metadata.

Changes:

  • Fixes the missing introductory sentence in “Rate Limit with Anonymous Consumer” (English doc).
  • Adds a “Customize Rate Limiting Headers” / “自定义速率限制标头” section with Admin API examples (English + Chinese docs).

Reviewed changes

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

File Description
docs/en/latest/plugins/limit-count.md Restores the truncated anonymous consumer paragraph and adds a new header-customization example section.
docs/zh/latest/plugins/limit-count.md Adds the corresponding Chinese header-customization example section.

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

Yilialinn and others added 2 commits April 9, 2026 16:57
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants