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

docs(gw): add gateway comment

This commit is contained in:
JianBo He 2021-10-26 09:40:48 +08:00 committed by JianBo He
parent 1f067d6f3b
commit 5a08fa6a03
1 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
apps/emqx_gateway/src/emqx_gateway_schema.erl
View File

@ -53,23 +53,37 @@ namespace() -> gateway.
roots() -> [gateway]. roots() -> [gateway].
fields(gateway) -> fields(gateway) ->
[{stomp, sc(ref(stomp), [{stomp,
sc(ref(stomp),
#{ nullable => {true, recursively} #{ nullable => {true, recursively}
, desc => "The Stomp Gateway configuration." , desc =>
"The Stomp Gateway configuration.<br>
This gateway supports v1.2/1.1/1.0"
})}, })},
{mqttsn, sc(ref(mqttsn), {mqttsn,
sc(ref(mqttsn),
#{ nullable => {true, recursively} #{ nullable => {true, recursively}
, desc => "The MQTT-SN Gateway configuration" , desc =>
"The MQTT-SN Gateway configuration.<br>
This gateway only supports the v1.2 protocol"
})}, })},
{coap, sc(ref(coap), {coap,
sc(ref(coap),
#{ nullable => {true, recursively} #{ nullable => {true, recursively}
, desc => "The CoAP Gateway configuration" , desc =>
"The CoAP Gateway configuration.<br>
This gateway is implemented based on RFC-7252 and
https://core-wg.github.io/coap-pubsub/draft-ietf-core-pubsub.html"
})}, })},
{lwm2m, sc(ref(lwm2m), {lwm2m,
sc(ref(lwm2m),
#{ nullable => {true, recursively} #{ nullable => {true, recursively}
, desc => "The LwM2M Gateway configuration" , desc =>
"The LwM2M Gateway configuration.<br>
This gateway only supports the v1.0.1 protocol"
})}, })},
{exproto, sc(ref(exproto), {exproto,
sc(ref(exproto),
#{ nullable => {true, recursively} #{ nullable => {true, recursively}
, desc => "The Extension Protocol configuration" , desc => "The Extension Protocol configuration"
})} })}