Skip to content

docs(ai-prompt-guard): re-port with Admin API, ADC, and Ingress Controller tabs#13207

Merged
Yilialinn merged 8 commits intoapache:masterfrom
Yilialinn:docs/update-ai-prompt-guard
Apr 17, 2026
Merged

docs(ai-prompt-guard): re-port with Admin API, ADC, and Ingress Controller tabs#13207
Yilialinn merged 8 commits intoapache:masterfrom
Yilialinn:docs/update-ai-prompt-guard

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

@Yilialinn Yilialinn commented Apr 13, 2026

Summary

  • Re-port ai-prompt-guard 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
  • 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
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-prompt-guard plugin documentation (EN + ZH) to include full configuration examples across Admin API, ADC, and Ingress Controller (with nested Gateway API / APISIX Ingress Controller tabs), aligned with the API7 Docs structure.

Changes:

  • Added canonical links and Docusaurus Tabs/TabItem-based multi-configuration examples (Admin API / ADC / Ingress Controller).
  • Expanded examples to demonstrate allow/deny patterns and full-history/all-roles validation behavior.
  • Updated both English and Chinese plugin docs with the new structure and examples.

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-prompt-guard.md Adds canonical + tabbed configuration examples; expands usage guidance and scenarios in Chinese.
docs/en/latest/plugins/ai-prompt-guard.md Adds canonical + tabbed configuration examples; expands usage guidance and scenarios in English.

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

Comment thread docs/en/latest/plugins/ai-prompt-guard.md Outdated
Comment thread docs/en/latest/plugins/ai-prompt-guard.md Outdated
Comment thread docs/zh/latest/plugins/ai-prompt-guard.md Outdated
Comment thread docs/zh/latest/plugins/ai-prompt-guard.md Outdated
Yilialinn and others added 6 commits April 14, 2026 14:07
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>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…rmat

Convert attribute table from 4-column to 6-column format (Name, Type,
Required, Default, Valid values, Description) for consistency across
plugin docs. Extract default values to Default column.
@kayx23 kayx23 requested review from Baoyuantop and moonming April 15, 2026 06:39
@Yilialinn Yilialinn merged commit 611c319 into apache:master Apr 17, 2026
7 checks passed
@Yilialinn Yilialinn deleted the docs/update-ai-prompt-guard branch April 17, 2026 01:41
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.

5 participants