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

docs: fix examples for PUT operations on bridge_v2 and connectors 

Examples would show `type` and `name` properties in the request body, which is
not accepted by the schema.

Also fixes some minor inconsistencies in the example names of connectors and
bridges.
This commit is contained in:
Stefan Strigler 2023-10-31 15:10:11 +01:00
parent 848f9c8dd6
commit 2a4eaf41ba
2 changed files with 53 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
apps/emqx_bridge_azure_event_hub/src/emqx_bridge_azure_event_hub.erl
View File

@ -205,20 +205,47 @@ values({post, bridge_v2}) ->
values(producer), values(producer),
#{ #{
enable => true, enable => true,
connector => <<"my_azure_event_hub_connector">>, connector => <<"my_azure_event_hub_producer_connector">>,
name => <<"my_azure_event_hub_bridge">>, name => <<"my_azure_event_hub_producer_bridge">>,
type => ?AEH_CONNECTOR_TYPE_BIN type => ?AEH_CONNECTOR_TYPE_BIN
} }
); );
values({post, AEHType}) -> values({post, connector}) ->
maps:merge(values(common_config), values(AEHType)); maps:merge(
values({put, AEHType}) -> values(common_config),
values({post, AEHType}); #{
name => <<"my_azure_event_hub_producer_connector">>,
type => ?AEH_CONNECTOR_TYPE_BIN
}
);
values({post, producer}) ->
maps:merge(
#{
name => <<"my_azure_event_hub_producer">>,
type => <<"azure_event_hub_producer">>
},
maps:merge(
values(common_config),
values(producer)
)
);
values({put, connector}) ->
values(common_config);
values({put, bridge_v2}) ->
maps:merge(
values(producer),
#{
enable => true,
connector => <<"my_azure_event_hub_producer_connector">>
}
);
values({put, producer}) ->
values({post, producer});
values(connector) -> values(connector) ->
maps:merge( maps:merge(
values(common_config), values(common_config),
#{ #{
name => <<"my_azure_event_hub_connector">>, name => <<"my_azure_event_hub_producer_connector">>,
type => ?AEH_CONNECTOR_TYPE_BIN type => ?AEH_CONNECTOR_TYPE_BIN
} }
); );
@ -232,14 +259,12 @@ values(common_config) ->
enable => true, enable => true,
metadata_request_timeout => <<"4s">>, metadata_request_timeout => <<"4s">>,
min_metadata_refresh_interval => <<"3s">>, min_metadata_refresh_interval => <<"3s">>,
name => <<"my_azure_event_hub_bridge">>,
socket_opts => #{ socket_opts => #{
sndbuf => <<"1024KB">>, sndbuf => <<"1024KB">>,
recbuf => <<"1024KB">>, recbuf => <<"1024KB">>,
nodelay => true, nodelay => true,
tcp_keepalive => <<"none">> tcp_keepalive => <<"none">>
}, }
type => <<"azure_event_hub_producer">>
}; };
values(producer) -> values(producer) ->
#{ #{

29
apps/emqx_bridge_kafka/src/emqx_bridge_kafka.erl
View File

@ -36,15 +36,12 @@
%% ------------------------------------------------------------------------------------------------- %% -------------------------------------------------------------------------------------------------
%% api %% api
connector_examples(_Method) -> connector_examples(Method) ->
[ [
#{ #{
<<"kafka_producer">> => #{ <<"kafka_producer">> => #{
summary => <<"Kafka Connector">>, summary => <<"Kafka Producer Connector">>,
value => maps:merge( value => values({Method, connector})
#{name => <<"my_connector">>, type => <<"kafka_producer">>},
values(common_config)
)
} }
} }
]. ].
@ -53,7 +50,7 @@ bridge_v2_examples(Method) ->
[ [
#{ #{
<<"kafka_producer">> => #{ <<"kafka_producer">> => #{
summary => <<"Kafka Bridge v2">>, summary => <<"Kafka Producer Bridge v2">>,
value => values({Method, bridge_v2_producer}) value => values({Method, bridge_v2_producer})
} }
} }
@ -88,23 +85,33 @@ values({get, KafkaType}) ->
}, },
values({post, KafkaType}) values({post, KafkaType})
); );
values({post, connector}) ->
maps:merge(
#{
name => <<"my_kafka_producer_connector">>,
type => <<"kafka_producer">>
},
values(common_config)
);
values({post, KafkaType}) -> values({post, KafkaType}) ->
maps:merge( maps:merge(
#{ #{
name => <<"my_kafka_bridge">>, name => <<"my_kafka_producer_bridge">>,
type => <<"kafka_producer">> type => <<"kafka_producer">>
}, },
values({put, KafkaType}) values({put, KafkaType})
); );
values({put, KafkaType}) when KafkaType =:= bridge_v2_producer -> values({put, bridge_v2_producer}) ->
values(KafkaType); values(bridge_v2_producer);
values({put, connector}) ->
values(common_config);
values({put, KafkaType}) -> values({put, KafkaType}) ->
maps:merge(values(common_config), values(KafkaType)); maps:merge(values(common_config), values(KafkaType));
values(bridge_v2_producer) -> values(bridge_v2_producer) ->
maps:merge( maps:merge(
#{ #{
enable => true, enable => true,
connector => <<"my_kafka_connector">>, connector => <<"my_kafka_producer_connector">>,
resource_opts => #{ resource_opts => #{
health_check_interval => "32s" health_check_interval => "32s"
} }