docs: improve desc for filter field
This commit is contained in:
parent
fa9bd74595
commit
7ddd020dd2
|
@ -34,14 +34,14 @@ emqx_authn_mongodb {
|
|||
filter {
|
||||
desc {
|
||||
en: """
|
||||
Statement that is executed during the authentication process.
|
||||
Commands can support following wildcards:
|
||||
Conditional expression that defines the filter condition in the query.
|
||||
Filter supports the following placeholders:
|
||||
- <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting
|
||||
- <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting
|
||||
"""
|
||||
zh: """
|
||||
认证过程中所使用的查询命令。
|
||||
查询命令支持如下占位符:
|
||||
在查询中定义过滤条件的条件表达式。
|
||||
过滤器支持如下占位符:
|
||||
- <code>${username}</code>: 将在运行时被替换为客户端连接时使用的用户名
|
||||
- <code>${clientid}</code>: 将在运行时被替换为客户端连接时使用的客户端标识符
|
||||
"""
|
||||
|
|
|
@ -122,20 +122,21 @@ emqx_authz_api_schema {
|
|||
filter {
|
||||
desc {
|
||||
en: """
|
||||
Statement that is executed during the authorize process.
|
||||
Commands can support following wildcards:\n
|
||||
- `${username}`: substituted with client's username\n
|
||||
- `${clientid}`: substituted with the clientid
|
||||
Conditional expression that defines the filter condition in the query.
|
||||
Filter supports the following placeholders:
|
||||
- <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting
|
||||
- <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting
|
||||
"""
|
||||
zh: """
|
||||
鉴权过程中所使用的查询命令。
|
||||
查询命令支持如下占位符:
|
||||
- `${username}`: 代替客户端的用户名
|
||||
- `${clientid}`: 代替客户端的客户端标识符"""
|
||||
在查询中定义过滤条件的条件表达式。
|
||||
过滤器支持如下占位符:
|
||||
- <code>${username}</code>: 将在运行时被替换为客户端连接时使用的用户名
|
||||
- <code>${clientid}</code>: 将在运行时被替换为客户端连接时使用的客户端标识符
|
||||
"""
|
||||
}
|
||||
label {
|
||||
en: """filter"""
|
||||
zh: """filter"""
|
||||
en: """Filter"""
|
||||
zh: """过滤器"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
@ -269,20 +269,21 @@ and the new rules will override all rules from the old config file.
|
|||
filter {
|
||||
desc {
|
||||
en: """
|
||||
Statement that is executed during the authorize process.
|
||||
Commands can support following wildcards:\n
|
||||
- `${username}`: substituted with client's username\n
|
||||
- `${clientid}`: substituted with the clientid
|
||||
Conditional expression that defines the filter condition in the query.
|
||||
Filter supports the following placeholders:
|
||||
- <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting
|
||||
- <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting
|
||||
"""
|
||||
zh: """
|
||||
鉴权过程中所使用的查询命令。
|
||||
查询命令支持如下占位符:
|
||||
- `${username}`: 代替客户端的用户名
|
||||
- `${clientid}`: 代替客户端的客户端标识符"""
|
||||
在查询中定义过滤条件的条件表达式。
|
||||
过滤器支持如下占位符:
|
||||
- <code>${username}</code>: 将在运行时被替换为客户端连接时使用的用户名
|
||||
- <code>${clientid}</code>: 将在运行时被替换为客户端连接时使用的客户端标识符
|
||||
"""
|
||||
}
|
||||
label {
|
||||
en: """filter"""
|
||||
zh: """filter"""
|
||||
en: """Filter"""
|
||||
zh: """过滤器"""
|
||||
}
|
||||
}
|
||||
|
||||
|
|
Loading…
Reference in New Issue