docs: remove impl details from user doc

This commit is contained in:
Zaiming (Stone) Shi 2023-02-01 09:30:10 +01:00
parent bc7feeed0b
commit 6ca816f7a4
1 changed files with 4 additions and 10 deletions

View File

@ -4,12 +4,12 @@ emqx_connector_http {
en: """ en: """
The base URL is the URL includes only the scheme, host and port.<br/> The base URL is the URL includes only the scheme, host and port.<br/>
When send an HTTP request, the real URL to be used is the concatenation of the base URL and the When send an HTTP request, the real URL to be used is the concatenation of the base URL and the
path parameter (passed by the emqx_resource:query/2,3 or provided by the request parameter).<br/> path parameter<br/>
For example: `http://localhost:9901/` For example: `http://localhost:9901/`
""" """
zh: """ zh: """
base URL 只包含host和port。<br/> base URL 只包含host和port。<br/>
发送HTTP请求时真实的URL是由base URL 和 path parameter连接而成通过emqx_resource:query/2,3传递或者通过请求参数提供。<br/> 发送HTTP请求时真实的URL是由base URL 和 path parameter连接而成。<br/>
示例:`http://localhost:9901/` 示例:`http://localhost:9901/`
""" """
} }
@ -76,14 +76,8 @@ base URL 只包含host和port。<br/>
request { request {
desc { desc {
en: """ en: """Configure HTTP request parameters."""
If the request is provided, the caller can send HTTP requests via zh: """设置 HTTP 请求的参数。"""
<code>emqx_resource:query(ResourceId, {send_message, BridgeId, Message})</code>
"""
zh: """
如果提供了请求,调用者可以通过以下方式发送 HTTP 请求
<code>emqx_resource:query(ResourceId, {send_message, BridgeId, Message})</code>
"""
} }
label: { label: {
en: "Request" en: "Request"