yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'update-api-docs' of github.com:HJianBo/emqx into update-api-docs

This commit is contained in:
JianBo He 2022-09-30 23:05:07 +08:00
parent a84c6f938c 9c6c13789e
commit 6589a66710
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/emqx_gateway/i18n/emqx_gateway_api_authn_i18n.conf
View File

@ -20,7 +20,7 @@ Returns 404 when gateway or authentication is not enabled."""
desc {
en: """Enables the authenticator for client authentication for the specified gateway. <\br>
When the authenticator is not configured or turned off, all client connections are assumed to be allowed. <\br>
Note: Adding only one authenticator is supported in the gateway, rather than allowing multiple authenticators to be configured to form an authentication chain as in MQTT."""
Note: Only one authenticator is allowed to be enabled at a time in the gateway, rather than allowing multiple authenticators to be configured to form an authentication chain as in MQTT."""
zh: """为指定网关开启认证器实现客户端认证的功能。<\br>
当未配置认证器或关闭认证器时，则认为允许所有客户端的连接。<\br>
注：在网关中仅支持添加一个认证器，而不是像 MQTT 一样允许配置多个认证器构成认证链。"""
@ -36,7 +36,7 @@ Note: Adding only one authenticator is supported in the gateway, rather than all
list_users {
desc {
en: """Get the users for the authenticator (only supports built_in_database)."""
en: """Get the users for the authenticator (only supported by <code>built_in_database</code>)."""
zh: """获取用户列表（仅支持 built_in_database 类型的认证器）"""
}
}

4
apps/emqx_gateway/i18n/emqx_gateway_api_listeners_i18n.conf
View File

@ -47,7 +47,7 @@ Note: For listener types not supported by a gateway, this API returns `400: BAD_
add_listener_authn {
desc {
en: """Enable authenticator for specified listener for client authentication.</br>
When authenticator is enabled for a listener, all clients connected to that listener will use that authenticator for authentication."""
When authenticator is enabled for a listener, all clients connecting to that listener will use that authenticator for authentication."""
zh: """为指定监听器开启认证器以实现客户端认证的能力。</br>
当某一监听器开启认证后，所有连接到该监听器的客户端会使用该认证器进行认证。"""
}
@ -69,7 +69,7 @@ When authenticator is enabled for a listener, all clients connected to that list
list_users {
desc {
en: """Get the users for the authenticator (only supports built_in_database)"""
en: """Get the users for the authenticator (only supported by <code>built_in_database</code>)"""
zh: """获取用户列表（仅支持 built_in_database 类型的认证器）"""
}
}

2
apps/emqx_gateway/src/emqx_gateway_api_listeners.erl
View File

@ -360,7 +360,7 @@ schema("/gateways/:name/listeners") ->
#{
tags => [<<"Gateways">>],
desc => ?DESC(list_listeners),
summary => <<"List All Listener">>,
summary => <<"List All Listeners">>,
parameters => params_gateway_name_in_path(),
responses =>
?STANDARD_RESP(

6
apps/emqx_management/i18n/emqx_mgmt_api_banned_i18n.conf
View File

@ -67,11 +67,11 @@ emqx_mgmt_api_banned {
}
reason {
desc {
en: """Banned reason, record the reason why the current object was banned."""
en: """Ban reason, record the reason why the current object was banned."""
zh: """封禁原因，记录当前对象被封禁的原因。"""
}
label {
en: """Banned Reason"""
en: """Ban Reason"""
zh: """封禁原因"""
}
}
@ -87,7 +87,7 @@ emqx_mgmt_api_banned {
}
until {
desc {
en: """The end time of the ban, the formula is rfc3339, the default is the time when the operation was initiated + 5 minutes."""
en: """The end time of the ban, the format is rfc3339, the default is the time when the operation was initiated + 5 minutes."""
zh: """封禁的结束时间，式为 rfc3339，默认为发起操作的时间 + 5 分钟。"""
}
label {