docs: improve desc for filter field

This commit is contained in:
zhouzb 2022-04-27 09:58:22 +08:00
parent fa9bd74595
commit 7ddd020dd2
3 changed files with 26 additions and 24 deletions

View File

@ -34,14 +34,14 @@ emqx_authn_mongodb {
filter { filter {
desc { desc {
en: """ en: """
Statement that is executed during the authentication process. Conditional expression that defines the filter condition in the query.
Commands can support following wildcards: Filter supports the following placeholders:
- <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting - <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 - <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting
""" """
zh: """ zh: """
认证过程中所使用的查询命令 在查询中定义过滤条件的条件表达式
查询命令支持如下占位符: 过滤器支持如下占位符:
- <code>${username}</code>: 将在运行时被替换为客户端连接时使用的用户名 - <code>${username}</code>: 将在运行时被替换为客户端连接时使用的用户名
- <code>${clientid}</code>: 将在运行时被替换为客户端连接时使用的客户端标识符 - <code>${clientid}</code>: 将在运行时被替换为客户端连接时使用的客户端标识符
""" """

View File

@ -122,20 +122,21 @@ emqx_authz_api_schema {
filter { filter {
desc { desc {
en: """ en: """
Statement that is executed during the authorize process. Conditional expression that defines the filter condition in the query.
Commands can support following wildcards:\n Filter supports the following placeholders:
- `${username}`: substituted with client's username\n - <code>${username}</code>: Will be replaced at runtime with <code>Username</code> used by the client when connecting
- `${clientid}`: substituted with the clientid - <code>${clientid}</code>: Will be replaced at runtime with <code>Client ID</code> used by the client when connecting
""" """
zh: """ zh: """
鉴权过程中所使用的查询命令。 在查询中定义过滤条件的条件表达式。
查询命令支持如下占位符: 过滤器支持如下占位符:
- `${username}`: 代替客户端的用户名 - <code>${username}</code>: 将在运行时被替换为客户端连接时使用的用户名
- `${clientid}`: 代替客户端的客户端标识符""" - <code>${clientid}</code>: 将在运行时被替换为客户端连接时使用的客户端标识符
"""
} }
label { label {
en: """filter""" en: """Filter"""
zh: """filter""" zh: """过滤器"""
} }
} }

View File

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