Skip to content

docs: document external HTTP GET schema example#3387

Open
zmstone wants to merge 2 commits intoemqx:release-6.2from
zmstone:260311-external-http-get-doc-add-GET
Open

docs: document external HTTP GET schema example#3387
zmstone wants to merge 2 commits intoemqx:release-6.2from
zmstone:260311-external-http-get-doc-add-GET

Conversation

@zmstone
Copy link
Member

@zmstone zmstone commented Mar 11, 2026

No description provided.

@Meggielqk Meggielqk added this to the 6.2.0 milestone Mar 13, 2026
Copy link
Contributor

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

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 GET request 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 POST and GET, and decode URL-safe Base64 for GET.

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** 标签页中,点击**创建**。
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants