docs(hmac-auth): re-port with Admin API, ADC, and Ingress Controller tabs#13242
Merged
Yilialinn merged 9 commits intoapache:masterfrom Apr 22, 2026
Merged
docs(hmac-auth): re-port with Admin API, ADC, and Ingress Controller tabs#13242Yilialinn merged 9 commits intoapache:masterfrom
Yilialinn merged 9 commits intoapache:masterfrom
Conversation
dosubot
Bot
added
size:XXL
There was a problem hiding this comment.
Pull request overview
This PR re-ports and modernizes the hmac-auth plugin documentation (EN/ZH) to align with current APISIX usage patterns, adding canonical links and expanding examples to cover Admin API, ADC, and Ingress Controller flows.
Changes:
- Added canonical link and Docusaurus tabbed examples (Admin API / ADC / Ingress Controller, incl. Gateway API + APISIX CRD).
- Updated Consumer/Credential attribute tables (e.g.,
key_id/secret_key) and fixed theX-Credential-Identifierheader typo. - Added an “Implementation/实现原理” section and refreshed multiple examples (e.g.,
admin_keyretrieval path, removed enterprise-only content).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/en/latest/plugins/hmac-auth.md | Canonical link + tabs for multi-API examples; updated attribute tables and added Implementation section. |
| docs/zh/latest/plugins/hmac-auth.md | Chinese parity update with canonical link + full tab structure; updated attribute tables and added 实现原理 section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
kayx23
reviewed
Apr 20, 2026
kayx23
approved these changes
Apr 21, 2026
moonming
approved these changes
Apr 22, 2026
shreemaan-abhishek
approved these changes
Apr 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-ports the
hmac-authplugin documentation with the following updates:<head>pointing to API7 docskey_idfield (replacing incorrectaccess_key)X-Credential-Identifierheader name typo (Indentifier→Identifier)/usr/local/apisix/conf/config.yaml