From 4d5125d8269b72a453f718f0de6bda6c4425a17d Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Fri, 1 Dec 2023 16:24:19 +0100 Subject: [PATCH] docs: refine some schema docs --- rel/i18n/emqx_connector_schema.hocon | 2 +- rel/i18n/emqx_limiter_schema.hocon | 2 +- rel/i18n/emqx_schema.hocon | 16 ++++++++-------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/rel/i18n/emqx_connector_schema.hocon b/rel/i18n/emqx_connector_schema.hocon index 8b9b2ccac..01bdb59e3 100644 --- a/rel/i18n/emqx_connector_schema.hocon +++ b/rel/i18n/emqx_connector_schema.hocon @@ -8,7 +8,7 @@ desc_connectors.label: connector_field.desc: -"""Name of connector used to connect to the resource where the action is to be performed.""" +"""Name of the connector specified by the action, used for external resource selection.""" connector_field.label: """Connector""" diff --git a/rel/i18n/emqx_limiter_schema.hocon b/rel/i18n/emqx_limiter_schema.hocon index 1a0ed5273..f4d5d6702 100644 --- a/rel/i18n/emqx_limiter_schema.hocon +++ b/rel/i18n/emqx_limiter_schema.hocon @@ -6,7 +6,7 @@ This is used to limit the connection rate for this node. Once the limit is reached, new connections will be deferred or refused.
For example:
- 1000/s :: Only accepts 1000 connections per second
-- 1000/10s :: Only accepts 1000 connections every 10 seconds""" +- 1000/10s :: Only accepts 1000 connections every 10 seconds.""" max_conn_rate.label: """Maximum Connection Rate""" diff --git a/rel/i18n/emqx_schema.hocon b/rel/i18n/emqx_schema.hocon index 3eb816f3b..e8ef878dd 100644 --- a/rel/i18n/emqx_schema.hocon +++ b/rel/i18n/emqx_schema.hocon @@ -573,7 +573,7 @@ fields_tcp_opts_buffer.label: """TCP user-space buffer""" server_ssl_opts_schema_honor_cipher_order.desc: -"""An important security setting, it forces the cipher to be set based +"""An important security setting. It forces the cipher to be set based on the server-specified order instead of the client-specified order, hence enforcing the (usually more properly configured) security ordering of the server administrator.""" @@ -1012,13 +1012,13 @@ fields_ws_opts_supported_subprotocols.label: broker_shared_subscription_strategy.desc: """Dispatch strategy for shared subscription. - - `random`: dispatch the message to a random selected subscriber - - `round_robin`: select the subscribers in a round-robin manner - - `round_robin_per_group`: select the subscribers in round-robin fashion within each shared subscriber group - - `local`: select random local subscriber otherwise select random cluster-wide - - `sticky`: always use the last selected subscriber to dispatch, until the subscriber disconnects. - - `hash_clientid`: select the subscribers by hashing the `clientIds` - - `hash_topic`: select the subscribers by hashing the source topic""" + - `random`: Randomly select a subscriber for dispatch; + - `round_robin`: Messages from a single publisher are dispatched to subscribers in turn; + - `round_robin_per_group`: All messages are dispatched to subscribers in turn; + - `local`: Randomly select a subscriber on the current node, if there are no subscribers on the current node, then randomly select within the cluster; + - `sticky`: Continuously dispatch messages to the initially selected subscriber until their session ends; + - `hash_clientid`: Hash the publisher's client ID to select a subscriber; + - `hash_topic`: Hash the publishing topic to select a subscriber.""" fields_deflate_opts_mem_level.desc: """Specifies the size of the compression state.