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

chore: fix schema desc and README.md typo

This commit is contained in:
JimMoen 2023-11-01 15:59:09 +08:00
parent 523bb17fc8
commit 25e277bdc6
No known key found for this signature in database
GPG Key ID: 87A520B4F76BA86D
4 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_gateway_coap/README.md
View File

@ -5,7 +5,7 @@ with [Publish-Subscribe Broker for the CoAP](https://datatracker.ietf.org/doc/ht
## Quick Start ## Quick Start
In EMQX 5.0, CoAP gateways can be configured and enabled through the Dashboard. In EMQX 5.0, CoAP gateway can be configured and enabled through the Dashboard.
It can also be enabled via the HTTP API or emqx.conf, e.g. In emqx.conf: It can also be enabled via the HTTP API or emqx.conf, e.g. In emqx.conf:

5
apps/emqx_gateway_lwm2m/README.md
View File

@ -5,7 +5,7 @@ is a protocol designed for IoT devices and machine-to-machine communication.
It is a lightweight protocol that supports devices with limited processing power and memory. It is a lightweight protocol that supports devices with limited processing power and memory.
The **LwM2M Gateway** in EMQX can accept LwM2M clients and translate theirevents The **LwM2M Gateway** in EMQX can accept LwM2M clients and translate their events
and messages into MQTT Publish messages. and messages into MQTT Publish messages.
In the current implementation, it has the following limitations: In the current implementation, it has the following limitations:
@ -15,7 +15,7 @@ In the current implementation, it has the following limitations:
## Quick Start ## Quick Start
In EMQX 5.0, LwM2M gateways can be configured and enabled through the Dashboard. In EMQX 5.0, LwM2M gateway can be configured and enabled through the Dashboard.
It can also be enabled via the HTTP API, and emqx.conf e.g, In emqx.conf: It can also be enabled via the HTTP API, and emqx.conf e.g, In emqx.conf:
@ -52,7 +52,6 @@ gateway.lwm2m {
> Note: > Note:
> Configuring the gateway via emqx.conf requires changes on a per-node basis, > Configuring the gateway via emqx.conf requires changes on a per-node basis,
> but configuring it via Dashboard or the HTTP API will take effect across the cluster. > but configuring it via Dashboard or the HTTP API will take effect across the cluster.
:::
## Object definations ## Object definations

4
apps/emqx_gateway_stomp/src/emqx_stomp_schema.erl
View File

@ -35,7 +35,7 @@ fields(stomp_frame) ->
non_neg_integer(), non_neg_integer(),
#{ #{
default => 10, default => 10,
desc => ?DESC(stom_frame_max_headers) desc => ?DESC(stomp_frame_max_headers)
} }
)}, )},
{max_headers_length, {max_headers_length,
@ -51,7 +51,7 @@ fields(stomp_frame) ->
integer(), integer(),
#{ #{
default => 65536, default => 65536,
desc => ?DESC(stom_frame_max_body_length) desc => ?DESC(stomp_frame_max_body_length)
} }
)} )}
]. ].

12
rel/i18n/emqx_stomp_schema.hocon
View File

@ -1,16 +1,16 @@
emqx_stomp_schema { emqx_stomp_schema {
stom_frame_max_body_length.desc:
"""Maximum number of bytes of Body allowed per Stomp packet"""
stom_frame_max_headers.desc:
"""The maximum number of Header"""
stomp.desc: stomp.desc:
"""The Stomp Gateway configuration. """The Stomp Gateway configuration.
This gateway supports v1.2/1.1/1.0""" This gateway supports v1.2/1.1/1.0"""
stomp_frame_max_headers.desc:
"""The maximum number of Header"""
stomp_frame_max_headers_length.desc: stomp_frame_max_headers_length.desc:
"""The maximum string length of the Header Value""" """The maximum string length of the Header Value"""
stomp_frame_max_body_length.desc:
"""Maximum number of bytes of Body allowed per Stomp packet"""
} }