fix: all missing descriptions
This commit is contained in:
parent
c5e281b84b
commit
3dca83c854
|
@ -3,6 +3,8 @@
|
||||||
%%--------------------------------------------------------------------
|
%%--------------------------------------------------------------------
|
||||||
-module(emqx_bridge_matrix).
|
-module(emqx_bridge_matrix).
|
||||||
|
|
||||||
|
-include_lib("hocon/include/hoconsc.hrl").
|
||||||
|
|
||||||
-export([
|
-export([
|
||||||
conn_bridge_examples/1
|
conn_bridge_examples/1
|
||||||
]).
|
]).
|
||||||
|
@ -67,6 +69,8 @@ fields("post_connector") ->
|
||||||
fields(Method) ->
|
fields(Method) ->
|
||||||
emqx_bridge_pgsql:fields(Method).
|
emqx_bridge_pgsql:fields(Method).
|
||||||
|
|
||||||
|
desc("config_connector") ->
|
||||||
|
?DESC(emqx_postgresql_connector_schema, "config_connector");
|
||||||
desc(_) ->
|
desc(_) ->
|
||||||
undefined.
|
undefined.
|
||||||
|
|
||||||
|
|
|
@ -112,6 +112,12 @@ desc("config") ->
|
||||||
?DESC("desc_config");
|
?DESC("desc_config");
|
||||||
desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
|
desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
|
||||||
["Configuration for PostgreSQL using `", string:to_upper(Method), "` method."];
|
["Configuration for PostgreSQL using `", string:to_upper(Method), "` method."];
|
||||||
|
desc(pgsql_action) ->
|
||||||
|
?DESC("pgsql_action");
|
||||||
|
desc(action_parameters) ->
|
||||||
|
?DESC("action_parameters");
|
||||||
|
desc("config_connector") ->
|
||||||
|
?DESC(emqx_postgresql_connector_schema, "config_connector");
|
||||||
desc(_) ->
|
desc(_) ->
|
||||||
undefined.
|
undefined.
|
||||||
|
|
||||||
|
|
|
@ -3,6 +3,8 @@
|
||||||
%%--------------------------------------------------------------------
|
%%--------------------------------------------------------------------
|
||||||
-module(emqx_bridge_timescale).
|
-module(emqx_bridge_timescale).
|
||||||
|
|
||||||
|
-include_lib("hocon/include/hoconsc.hrl").
|
||||||
|
|
||||||
-export([
|
-export([
|
||||||
conn_bridge_examples/1
|
conn_bridge_examples/1
|
||||||
]).
|
]).
|
||||||
|
@ -67,6 +69,8 @@ fields("post_connector") ->
|
||||||
fields(Method) ->
|
fields(Method) ->
|
||||||
emqx_bridge_pgsql:fields(Method).
|
emqx_bridge_pgsql:fields(Method).
|
||||||
|
|
||||||
|
desc("config_connector") ->
|
||||||
|
?DESC(emqx_postgresql_connector_schema, "config_connector");
|
||||||
desc(_) ->
|
desc(_) ->
|
||||||
undefined.
|
undefined.
|
||||||
|
|
||||||
|
|
|
@ -117,7 +117,7 @@ connector_structs() ->
|
||||||
)},
|
)},
|
||||||
{pgsql,
|
{pgsql,
|
||||||
mk(
|
mk(
|
||||||
hoconsc:map(name, ref(emqx_postgresql_connector_schema, "config_connector")),
|
hoconsc:map(name, ref(emqx_bridge_pgsql, "config_connector")),
|
||||||
#{
|
#{
|
||||||
desc => <<"PostgreSQL Connector Config">>,
|
desc => <<"PostgreSQL Connector Config">>,
|
||||||
required => false
|
required => false
|
||||||
|
|
|
@ -25,7 +25,8 @@
|
||||||
|
|
||||||
-export([
|
-export([
|
||||||
roots/0,
|
roots/0,
|
||||||
fields/1
|
fields/1,
|
||||||
|
desc/1
|
||||||
]).
|
]).
|
||||||
|
|
||||||
%% Examples
|
%% Examples
|
||||||
|
@ -35,7 +36,7 @@
|
||||||
]).
|
]).
|
||||||
|
|
||||||
roots() ->
|
roots() ->
|
||||||
[{config, #{type => hoconsc:ref(?MODULE, config)}}].
|
[].
|
||||||
|
|
||||||
fields("config_connector") ->
|
fields("config_connector") ->
|
||||||
[{server, server()}] ++
|
[{server, server()}] ++
|
||||||
|
@ -199,3 +200,8 @@ values(producer) ->
|
||||||
},
|
},
|
||||||
local_topic => <<"mqtt/local/topic">>
|
local_topic => <<"mqtt/local/topic">>
|
||||||
}.
|
}.
|
||||||
|
|
||||||
|
desc("config_connector") ->
|
||||||
|
?DESC("config_connector");
|
||||||
|
desc(_) ->
|
||||||
|
undefined.
|
||||||
|
|
|
@ -40,4 +40,17 @@ sql_template.desc:
|
||||||
sql_template.label:
|
sql_template.label:
|
||||||
"""SQL Template"""
|
"""SQL Template"""
|
||||||
|
|
||||||
|
pgsql_action.desc:
|
||||||
|
"""Configuration for PostgreSQL Action"""
|
||||||
|
|
||||||
|
pgsql_action.label:
|
||||||
|
"""PostgreSQL Action Configuration"""
|
||||||
|
|
||||||
|
|
||||||
|
action_parameters.desc:
|
||||||
|
"""Configuration Parameters Specific to the PostgreSQL Action"""
|
||||||
|
|
||||||
|
action_parameters.label:
|
||||||
|
"""Action Parameters"""
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -8,4 +8,10 @@ The PostgreSQL default port 5432 is used if `[:Port]` is not specified."""
|
||||||
server.label:
|
server.label:
|
||||||
"""Server Host"""
|
"""Server Host"""
|
||||||
|
|
||||||
|
config_connector.desc:
|
||||||
|
"""The configuration for the PostgreSQL connector."""
|
||||||
|
|
||||||
|
config_connector.label:
|
||||||
|
"""PostgreSQL Connector Config"""
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,18 @@
|
||||||
|
|
||||||
|
emqx_postgresql_connector_schema {
|
||||||
|
|
||||||
|
server.desc:
|
||||||
|
"""The IPv4 or IPv6 address or the hostname to connect to.<br/>
|
||||||
|
A host entry has the following form: `Host[:Port]`.<br/>
|
||||||
|
The PostgreSQL default port 5432 is used if `[:Port]` is not specified."""
|
||||||
|
|
||||||
|
server.label:
|
||||||
|
"""Server Host"""
|
||||||
|
|
||||||
|
config_connector.desc:
|
||||||
|
"""The configuration for the PostgreSQL connector."""
|
||||||
|
|
||||||
|
config_connector.label:
|
||||||
|
"""PostgreSQL Connector Config"""
|
||||||
|
|
||||||
|
}
|
Loading…
Reference in New Issue