emqx/apps/emqx_connector/src/emqx_connector_examples.erl

23 lines
1.1 KiB
Erlang

%%--------------------------------------------------------------------
%% Copyright (c) 2023-2024 EMQ Technologies Co., Ltd. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%--------------------------------------------------------------------
-module(emqx_connector_examples).
%% Should return examples for the connector HTTP API. One can use the helper
%% function emqx_connector_schema:connector_values/3 to generate these
%% examples. See emqx_bridge_oracle:connector_examples/1 for an example.
-callback connector_examples(Method :: get | post | put) -> [map()].