diff --git a/apps/emqx_exhook/src/emqx_exhook_api.erl b/apps/emqx_exhook/src/emqx_exhook_api.erl index 2df2176d3..d0680e715 100644 --- a/apps/emqx_exhook/src/emqx_exhook_api.erl +++ b/apps/emqx_exhook/src/emqx_exhook_api.erl @@ -55,7 +55,7 @@ schema(("/exhooks")) -> 'operationId' => exhooks, get => #{tags => ?TAGS, description => <<"List all servers">>, - responses => #{200 => mk(array(ref(list_server_info)), #{})} + responses => #{200 => mk(array(ref(detail_server_info)), #{})} }, post => #{tags => ?TAGS, description => <<"Add a servers">>, @@ -88,7 +88,8 @@ schema("/exhooks/:name") -> description => <<"Delete the server">>, parameters => params_server_name_in_path(), responses => #{204 => <<>>, - 500 => error_codes([?BAD_RPC], <<"Bad RPC">>) } + 500 => error_codes([?BAD_RPC], <<"Bad RPC">>) + } } }; @@ -124,13 +125,6 @@ fields(move_req) -> })} ]; -fields(list_server_info) -> - [ {metrics, mk(ref(metrics), #{})} - , {node_metrics, mk(array(ref(node_metrics)), #{})} - , {node_status, mk(array(ref(node_status)), #{})} - , {hooks, mk(array(ref(hook_info)), #{})} - ] ++ emqx_exhook_schema:server_config(); - fields(detail_server_info) -> [ {metrics, mk(ref(metrics), #{})} , {node_metrics, mk(array(ref(node_metrics)), #{})} @@ -139,8 +133,9 @@ fields(detail_server_info) -> ] ++ emqx_exhook_schema:server_config(); fields(list_hook_info) -> - [ {name, mk(binary(), #{})} - , {params, mk(map(name, binary()), #{})} + [ {name, mk(binary(), #{desc => <<"The hook's name">>})} + , {params, mk(map(name, binary()), + #{desc => <<"The parameters used when the hook is registered">>})} , {metrics, mk(ref(metrics), #{})} , {node_metrics, mk(array(ref(node_metrics)), #{})} ]; @@ -156,8 +151,9 @@ fields(node_status) -> ]; fields(hook_info) -> - [ {name, mk(binary(), #{})} - , {params, mk(map(name, binary()), #{})} + [ {name, mk(binary(), #{desc => <<"The hook's name">>})} + , {params, mk(map(name, binary()), + #{desc => <<"The parameters used when the hook is registered">>})} ]; fields(metrics) -> diff --git a/apps/emqx_exhook/src/emqx_exhook_metrics.erl b/apps/emqx_exhook/src/emqx_exhook_metrics.erl index abe592a97..7d63d31f8 100644 --- a/apps/emqx_exhook/src/emqx_exhook_metrics.erl +++ b/apps/emqx_exhook/src/emqx_exhook_metrics.erl @@ -71,17 +71,17 @@ new_metric_info() -> -spec succeed(server_name(), hookpoint()) -> ok. succeed(Server, Hook) -> inc(Server, Hook, #metrics.succeed, - #metrics{index = {Server, Hook} - ,window_rate = 1 - ,succeed = 1 + #metrics{ index = {Server, Hook} + , window_rate = 1 + , succeed = 1 }). -spec failed(server_name(), hookpoint()) -> ok. failed(Server, Hook) -> inc(Server, Hook, #metrics.failed, - #metrics{index = {Server, Hook} - ,window_rate = 1 - ,failed = 1 + #metrics{ index = {Server, Hook} + , window_rate = 1 + , failed = 1 }). -spec update(pos_integer()) -> true.