Skip to content

docs(key-auth): re-port with Admin API, ADC, and Ingress Controller tabs#13241

Merged
Baoyuantop merged 13 commits intoapache:masterfrom
Yilialinn:docs/update-key-auth
Apr 23, 2026
Merged

docs(key-auth): re-port with Admin API, ADC, and Ingress Controller tabs#13241
Baoyuantop merged 13 commits intoapache:masterfrom
Yilialinn:docs/update-key-auth

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

Re-ports the key-auth plugin documentation with Admin API, ADC, and Ingress Controller tab structure, updated attribute table, and canonical link.

@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. doc Documentation things labels Apr 17, 2026
@Yilialinn Yilialinn requested a review from Copilot April 17, 2026 09:18
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

Re-ports the key-auth plugin documentation to the newer tabbed structure (Admin API / ADC / Ingress Controller) and refreshes the attribute tables/examples to match current configuration patterns.

Changes:

  • Add Docusaurus Tabs/TabItem structure across examples for Admin API, ADC, and Ingress Controller.
  • Update Consumer/Credential and Route attribute tables (including anonymous_consumer and realm).
  • Adjust example snippets (e.g., hide credentials flows, query/header priority examples, rate-limit + anonymous consumer example).

Reviewed changes

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

File Description
docs/zh/latest/plugins/key-auth.md Reworked Chinese docs with tabs, updated attribute tables, and expanded examples for multiple configuration surfaces.
docs/en/latest/plugins/key-auth.md Reworked English docs with tabs, updated attribute tables, and expanded examples for multiple configuration surfaces.

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

Comment thread docs/zh/latest/plugins/key-auth.md Outdated
Comment thread docs/en/latest/plugins/key-auth.md Outdated
Comment thread docs/en/latest/plugins/key-auth.md Outdated
Comment thread docs/en/latest/plugins/key-auth.md Outdated
Comment thread docs/en/latest/plugins/key-auth.md Outdated
Comment thread docs/zh/latest/plugins/key-auth.md Outdated
Comment thread docs/zh/latest/plugins/key-auth.md Outdated
Yilialinn and others added 6 commits April 20, 2026 10:15
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>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Yilialinn Yilialinn requested a review from kayx23 April 20, 2026 02:28
Comment thread docs/en/latest/plugins/key-auth.md Outdated
- Fix header name Consumer-Custom-Id -> X-Consumer-Custom-Id in prose (EN & ZH)
- Add dollar sign prefix to $env:// and $secret:// references (EN & ZH)
- Fix grammar: additional logics -> additional logic (EN)
@Yilialinn Yilialinn requested a review from kayx23 April 21, 2026 10:10
kayx23
kayx23 previously approved these changes Apr 21, 2026
moonming
moonming previously approved these changes Apr 22, 2026
@Yilialinn Yilialinn dismissed stale reviews from moonming and kayx23 via f545cf9 April 22, 2026 06:34
kayx23
kayx23 previously approved these changes Apr 22, 2026
@Yilialinn Yilialinn dismissed stale reviews from shreemaan-abhishek and kayx23 via 0947c62 April 22, 2026 06:48
@Baoyuantop Baoyuantop merged commit 46773fe into apache:master Apr 23, 2026
7 checks passed
@Yilialinn Yilialinn deleted the docs/update-key-auth branch April 23, 2026 08: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.

6 participants