fix(connector): some desc for connector APIs
This commit is contained in:
parent
b2e7a6a249
commit
20091f8d2a
|
@ -48,10 +48,10 @@ common_bridge_fields() ->
|
||||||
, {connector,
|
, {connector,
|
||||||
mk(binary(),
|
mk(binary(),
|
||||||
#{ nullable => false
|
#{ nullable => false
|
||||||
|
, example => <<"mqtt:my_mqtt_connector">>
|
||||||
, desc =>"""
|
, desc =>"""
|
||||||
The connector name to be used for this bridge.
|
The connector Id to be used for this bridge. Connector Ids must be of format: '{type}:{name}'.<br>
|
||||||
Connectors are configured as 'connectors.{type}.{name}',
|
In config files, you can find the corresponding config entry for a connector by such path: 'connectors.{type}.{name}'.<br>
|
||||||
for example 'connectors.http.mybridge'.
|
|
||||||
"""
|
"""
|
||||||
})}
|
})}
|
||||||
].
|
].
|
||||||
|
|
|
@ -38,9 +38,9 @@
|
||||||
_ = ConnName,
|
_ = ConnName,
|
||||||
EXPR
|
EXPR
|
||||||
catch
|
catch
|
||||||
error:{invalid_bridge_id, Id0} ->
|
error:{invalid_connector_id, Id0} ->
|
||||||
{400, #{code => 'INVALID_ID', message => <<"invalid_bridge_id: ", Id0/binary,
|
{400, #{code => 'INVALID_ID', message => <<"invalid_connector_id: ", Id0/binary,
|
||||||
". Bridge Ids must be of format {type}:{name}">>}}
|
". Connector Ids must be of format {type}:{name}">>}}
|
||||||
end).
|
end).
|
||||||
|
|
||||||
namespace() -> "connector".
|
namespace() -> "connector".
|
||||||
|
|
Loading…
Reference in New Issue