docs: update mqtt-proxy plugin docs#13310
Open
Yilialinn wants to merge 4 commits intoapache:masterfrom
Open
Conversation
- Full port from API7 docs with 2 structured examples: * Proxy to a MQTT Broker * Load Balance MQTT Traffic - Add attributes table Default column with 'MQTT' for protocol_name - Fix description to describe L4 plugin with stream Route requirement - Rewrite examples to use PUT /stream_routes with id in body and admin_key - Consolidate config.yaml snippet into examples preamble - Keep existing mTLS section (APISIX-specific content) - Remove Delete Plugin section - Add canonical link
dosubot
Bot
added
size:L
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the mqtt-proxy plugin documentation to align with API7 content and provide clearer, more structured stream proxy examples (proxying + load balancing), while keeping APISIX-specific mTLS guidance.
Changes:
- Reworked plugin description and examples, including L4 enabling steps and Mosquitto-based verification flows.
- Expanded the attributes table to include a
Defaultcolumn forprotocol_name. - Updated Admin API example requests and removed the “Delete Plugin” section; added a canonical link.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/zh/latest/plugins/mqtt-proxy.md | Ports/restructures the Chinese plugin doc: adds canonical link, updates attributes, consolidates L4 setup, and refreshes examples + mTLS section. |
| docs/en/latest/plugins/mqtt-proxy.md | Ports/restructures the English plugin doc similarly: canonical link, new examples + L4 config preamble, attribute defaults, and updated mTLS section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Yilialinn
force-pushed
the
docs/update-mqtt-proxy
branch
from
4205596 to
b3852d4
Compare
Add comprehensive configuration examples for different deployment methods: - Add ADC (API7 Declarative Config) configuration examples - Add Ingress Controller examples with Gateway API and APISIX CRD - Organize examples using multi-tab interface for better usability - Include both simple proxy and load balancing scenarios These examples help users configure mqtt-proxy in different deployment environments including standalone APISIX, ADC-managed deployments, and Kubernetes with Ingress Controller. Related: api7/docs#1554
dosubot
Bot
added
size:XL
…ples Update Chinese documentation for mqtt-proxy plugin to match the English version updates: - Add ADC (API7 Declarative Config) configuration examples - Add Ingress Controller (Gateway API and APISIX CRD) examples - Add multi-tab interface for different configuration methods - Translate new example descriptions and instructions to Chinese - Keep code blocks and YAML configurations in English This ensures Chinese-speaking users have access to the same comprehensive configuration examples as English-speaking users.
kayx23
approved these changes
May 7, 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
Defaultcolumn to attributes table showing"MQTT"default forprotocol_name.PUT /apisix/admin/stream_routeswithidin the request body and${admin_key}variable.