Skip to content

docs(ua-restriction): re-port with Admin API, ADC, and Ingress Controller tabs#13260

Merged
Yilialinn merged 6 commits into
apache:masterfrom
Yilialinn:docs/update-ua-restriction
Apr 22, 2026
Merged

docs(ua-restriction): re-port with Admin API, ADC, and Ingress Controller tabs#13260
Yilialinn merged 6 commits into
apache:masterfrom
Yilialinn:docs/update-ua-restriction

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

Summary

Re-ports the ua-restriction plugin documentation with the following updates:

  • Adds three-tab structure (Admin API / ADC / Ingress Controller) for all examples, with nested Gateway API / APISIX Ingress Controller tabs under the Ingress Controller tab
  • Updates attribute table: adds [1, 1024] chars valid values for message, and clarifies that exactly one of allowlist or denylist must be configured
  • Updates admin_key fetch command to use /usr/local/apisix/conf/config.yaml
  • Adds canonical link to API7 docs
  • Updates both English and Chinese documentation

@dosubot dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. doc Documentation things labels Apr 20, 2026
@Yilialinn Yilialinn requested a review from Copilot April 20, 2026 08:57
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.

Re-ports the ua-restriction plugin docs to a tabbed (Admin API / ADC / Ingress Controller) structure and updates option semantics to better reflect current behavior.

Changes:

  • Added MDX tabbed examples (including nested Gateway API / APISIX Ingress Controller tabs) across both EN/ZH docs.
  • Updated attributes table to document message length constraints and “exactly one of allowlist/denylist” rule.
  • Updated admin_key fetch command path and added a canonical link.

Reviewed changes

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

File Description
docs/zh/latest/plugins/ua-restriction.md Adds tabbed examples + updates attributes table and admin key fetch path in Chinese docs.
docs/en/latest/plugins/ua-restriction.md Mirrors tabbed examples + attributes/admin-key updates in English docs.

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

Comment thread docs/en/latest/plugins/ua-restriction.md
Comment thread docs/zh/latest/plugins/ua-restriction.md
Comment thread docs/en/latest/plugins/ua-restriction.md
Comment thread docs/zh/latest/plugins/ua-restriction.md
Yilialinn and others added 5 commits April 21, 2026 10:30
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Yilialinn Yilialinn requested a review from kayx23 April 21, 2026 03:23
kayx23
kayx23 approved these changes Apr 21, 2026
@Yilialinn Yilialinn requested a review from Baoyuantop April 21, 2026 09:53
@Yilialinn Yilialinn merged commit 5205abf into apache:master Apr 22, 2026
7 checks passed
@Yilialinn Yilialinn deleted the docs/update-ua-restriction branch April 22, 2026 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants