docs: document external HTTP GET schema example#3387
Open
zmstone wants to merge 2 commits intoemqx:release-6.2from
Open
docs: document external HTTP GET schema example#3387zmstone wants to merge 2 commits intoemqx:release-6.2from
zmstone wants to merge 2 commits intoemqx:release-6.2from
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the External HTTP schema registry documentation to cover calling external schema endpoints via HTTP GET in addition to POST, including request/query parameter details and corresponding example/server updates.
Changes:
- Document
GETrequest format (query parameters, URL-safe Base64 without padding, and query-string appending behavior). - Add a “Schema Configuration Reference” section describing Dashboard fields (including the new Method selection guidance).
- Update the Flask example to accept both
POSTandGET, and decode URL-safe Base64 forGET.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| zh_CN/data-integration/schema-registry-example-external-http.md | Adds GET request spec, configuration reference table, and updates the Python example + Dashboard instructions (contains a small typo). |
| en_US/data-integration/schema-registry-example-external-http.md | Adds GET request spec, configuration reference table, and updates the Python example + adds Method guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## External HTTP API Specification | ||
|
|
||
| To implement a custom External HTTP API that integrates with EMQX's `schema_encode` and `schema_decode` functions, your External HTTP server must provide a single `POST` endpoint that handles the encoding or decoding requests from EMQX. | ||
| Your external HTTP server must expose a single endpoint that receives encoding and decoding requests from EMQX's `schema_encode` and `schema_decode` functions. EMQX can call this endpoint using either `POST` (default) or `GET` method. |
| 1. 进入 Dashboard,依次点击左侧导航栏的**数据智能中心** -> **Schema Registry**。 | ||
| 2. 在到 **内部 Schema** 标签页中,点击 **创建**。 | ||
| 1. 进入 Dashboard,点击左侧导航栏的**数据智能中心** -> **Schema Registry**。 | ||
| 2. 在到**内部 Schema** 标签页中,点击**创建**。 |
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.
No description provided.