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

docs: fix config doc, avoid using <text> in doc body

This commit is contained in:
Zaiming (Stone) Shi 2021-11-30 17:09:13 +01:00
parent e6e28f9002
commit d9a980c7e1
4 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_bridge/src/emqx_bridge_api.erl
View File

@ -33,7 +33,7 @@
catch catch
error:{invalid_bridge_id, Id0} -> error:{invalid_bridge_id, Id0} ->
{400, #{code => 'INVALID_ID', message => <<"invalid_bridge_id: ", Id0/binary, {400, #{code => 'INVALID_ID', message => <<"invalid_bridge_id: ", Id0/binary,
". Bridge Ids must be of format <bridge_type>:<name>">>}} ". Bridge ID must be of format 'bridge_type:name'">>}}
end). end).
-define(METRICS(MATCH, SUCC, FAILED, RATE, RATE_5, RATE_MAX), -define(METRICS(MATCH, SUCC, FAILED, RATE, RATE_5, RATE_MAX),

3
apps/emqx_bridge/src/emqx_bridge_schema.erl
View File

@ -108,7 +108,8 @@ connector_name() ->
#{ nullable => false #{ nullable => false
, desc =>""" , desc =>"""
The connector name to be used for this bridge. The connector name to be used for this bridge.
Connectors are configured by 'connectors.<type>.<name> Connectors are configured as 'connectors.type.name',
for example 'connectors.http.mybridge'.
""" """
})}. })}.

6
apps/emqx_connector/src/emqx_connector_api.erl
View File

@ -38,7 +38,7 @@
catch catch
error:{invalid_bridge_id, Id0} -> error:{invalid_bridge_id, Id0} ->
{400, #{code => 'INVALID_ID', message => <<"invalid_bridge_id: ", Id0/binary, {400, #{code => 'INVALID_ID', message => <<"invalid_bridge_id: ", Id0/binary,
". Bridge Ids must be of format <bridge_type>:<name>">>}} ". Bridge ID must be of format 'bridge_type:name'">>}}
end). end).
namespace() -> "connector". namespace() -> "connector".
@ -74,7 +74,7 @@ schema("/connectors_test") ->
post => #{ post => #{
tags => [<<"connectors">>], tags => [<<"connectors">>],
description => <<"Test creating a new connector by given Id <br>" description => <<"Test creating a new connector by given Id <br>"
"The Id must be of format <type>:<name>">>, "The ID must be of format 'type:name'">>,
summary => <<"Test creating connector">>, summary => <<"Test creating connector">>,
requestBody => connector_test_info(), requestBody => connector_test_info(),
responses => #{ responses => #{
@ -98,7 +98,7 @@ schema("/connectors") ->
post => #{ post => #{
tags => [<<"connectors">>], tags => [<<"connectors">>],
description => <<"Create a new connector by given Id <br>" description => <<"Create a new connector by given Id <br>"
"The Id must be of format <type>:<name>">>, "The ID must be of format 'type:name'">>,
summary => <<"Create connector">>, summary => <<"Create connector">>,
requestBody => connector_info(), requestBody => connector_info(),
responses => #{ responses => #{

2
apps/emqx_rule_engine/src/emqx_rule_engine_schema.erl
View File

@ -56,7 +56,7 @@ A list of outputs of the rule.<br>
An output can be a string that refers to the channel Id of a emqx bridge, or a object An output can be a string that refers to the channel Id of a emqx bridge, or a object
that refers to a function.<br> that refers to a function.<br>
There a some built-in functions like \"republish\" and \"console\", and we also support user There a some built-in functions like \"republish\" and \"console\", and we also support user
provided functions like \"<SomeModule>:<SomeFunction>\".<br> provided functions like \"ModuleName:FunctionName\".<br>
The outputs in the list is executed one by one in order. The outputs in the list is executed one by one in order.
This means that if one of the output is executing slowly, all of the outputs comes after it will not This means that if one of the output is executing slowly, all of the outputs comes after it will not
be executed until it returns.<br> be executed until it returns.<br>