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

docs: refine docs

This commit is contained in:
zmstone 2024-03-27 09:37:38 +01:00
parent b1c9bb63d7
commit 450ef2d591
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
rel/i18n/emqx_mgmt_api_trace.hocon
View File

@ -56,7 +56,7 @@ file_mtime.label:
"""file mtime""" """file mtime"""
trace_name.desc: trace_name.desc:
"""Unique name of the trace. Only ascii letters in a-z, A-Z, 0-9 and underscore '_' are allowed.""" """Unique name of the trace. Only ASCII letters in a-z, A-Z, 0-9 and underscore '_' are allowed."""
trace_name.label: trace_name.label:
"""Unique name of the trace""" """Unique name of the trace"""

13
rel/i18n/emqx_schema.hocon
View File

@ -1572,7 +1572,7 @@ durable_storage.desc: """~
EMQX uses durable storages to offload various data, such as MQTT messages, to disc.""" EMQX uses durable storages to offload various data, such as MQTT messages, to disc."""
client_attrs_init { client_attrs_init {
label: "Client attributes init" label: "Client Attributes Initialization"
desc: """~ desc: """~
Specify how to initialize client attributes. Specify how to initialize client attributes.
One initial client attribute can be initialized as `client_attrs.NAME`, One initial client attribute can be initialized as `client_attrs.NAME`,
@ -1584,7 +1584,7 @@ client_attrs_init {
} }
client_attrs_init_extract_from { client_attrs_init_extract_from {
label: "Client property to extract attribute from" label: "Client Property to Extract Attribute"
desc: """~ desc: """~
Specify from which client property the client attribute should be extracted. Specify from which client property the client attribute should be extracted.
@ -1594,23 +1594,24 @@ client_attrs_init_extract_from {
- `cn`: Extract from the Common Name (CN) field of the client certificate. - `cn`: Extract from the Common Name (CN) field of the client certificate.
- `dn`: Extract from the Distinguished Name (DN) field of the client certificate. - `dn`: Extract from the Distinguished Name (DN) field of the client certificate.
- `user_property`: Extract from the user property sent in the MQTT v5 `CONNECT` packet. - `user_property`: Extract from the user property sent in the MQTT v5 `CONNECT` packet.
In this case, `extract_regex` is not applicable, and `extract_as` should be the user property key. In this case, `extract_regexp` is not applicable, and `extract_as` should be the user property key.
NOTE: this extraction happens **after** `clientid` or `username` is initialized NOTE: this extraction happens **after** `clientid` or `username` is initialized
from `peer_cert_as_clientid` or `peer_cert_as_username` config.""" from `peer_cert_as_clientid` or `peer_cert_as_username` config."""
} }
client_attrs_init_extract_regexp { client_attrs_init_extract_regexp {
label: "Client attribute extract regex" label: "Client Attribute Extraction Regular Expression"
desc: """~ desc: """~
The regular expression to extract a client attribute from the client property specified by `client_attrs_init.extract_from` config. The regular expression to extract a client attribute from the client property specified by `client_attrs_init.extract_from` config.
The expression should match the entire client property value, and capturing groups are concatenated to make the client attribute. The expression should match the entire client property value, and capturing groups are concatenated to make the client attribute.
For example if the client attribute is the first part of the client ID delimited by a dash, the regular expression would be `^(.+?)-.*$`. For example if the client attribute is the first part of the client ID delimited by a dash, the regular expression would be `^(.+?)-.*$`.
Note that failure to match the regular expression will result in the client attribute being absent but not an empty string.""" Note that failure to match the regular expression will result in the client attribute being absent but not an empty string.
Note also that currently only printable ASCII characters are allowed as input for the regular expression extraction."""
} }
client_attrs_init_extract_as { client_attrs_init_extract_as {
label: "Name the extracted attribute" label: "Name The Extracted Attribute"
desc: """~ desc: """~
The name of the client attribute extracted from the client property specified by `client_attrs_init.extract_from` config. The name of the client attribute extracted from the client property specified by `client_attrs_init.extract_from` config.
The extracted attribute will be stored in the `client_attrs` property with this name. The extracted attribute will be stored in the `client_attrs` property with this name.