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

fix: listener api doc (#5627)

This commit is contained in:
DDDHuang 2021-09-02 15:30:53 +08:00 committed by GitHub
parent 0fd18a2795
commit 516f2fd06e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
apps/emqx_management/src/emqx_mgmt_api_listeners.erl
View File

@ -111,7 +111,7 @@ api_list_listeners_on_node() ->
description => <<"List listeners in one node">>, description => <<"List listeners in one node">>,
parameters => [param_path_node()], parameters => [param_path_node()],
responses => #{ responses => #{
<<"200">> => emqx_mgmt_util:object_schema(resp_schema(), <<"List listeners successfully">>)}}}, <<"200">> => emqx_mgmt_util:schema(resp_schema(), <<"List listeners successfully">>)}}},
{"/nodes/:node/listeners", Metadata, list_listeners_on_node}. {"/nodes/:node/listeners", Metadata, list_listeners_on_node}.
api_get_update_listener_by_id_on_node() -> api_get_update_listener_by_id_on_node() ->
@ -124,7 +124,7 @@ api_get_update_listener_by_id_on_node() ->
emqx_mgmt_util:error_schema(?NODE_LISTENER_NOT_FOUND, emqx_mgmt_util:error_schema(?NODE_LISTENER_NOT_FOUND,
['BAD_NODE_NAME', 'BAD_LISTENER_ID']), ['BAD_NODE_NAME', 'BAD_LISTENER_ID']),
<<"200">> => <<"200">> =>
emqx_mgmt_util:object_schema(resp_schema(), <<"Get listener successfully">>)}}, emqx_mgmt_util:schema(resp_schema(), <<"Get listener successfully">>)}},
put => #{ put => #{
description => <<"Create or update a listener by a given Id on a specific node">>, description => <<"Create or update a listener by a given Id on a specific node">>,
parameters => [param_path_node(), param_path_id()], parameters => [param_path_node(), param_path_id()],
@ -134,7 +134,7 @@ api_get_update_listener_by_id_on_node() ->
emqx_mgmt_util:error_schema(?NODE_LISTENER_NOT_FOUND, emqx_mgmt_util:error_schema(?NODE_LISTENER_NOT_FOUND,
['BAD_NODE_NAME', 'BAD_LISTENER_ID']), ['BAD_NODE_NAME', 'BAD_LISTENER_ID']),
<<"200">> => <<"200">> =>
emqx_mgmt_util:object_schema(resp_schema(), <<"Get listener successfully">>)}}, emqx_mgmt_util:schema(resp_schema(), <<"Get listener successfully">>)}},
delete => #{ delete => #{
description => <<"Delete a listener by a given Id to all nodes in the cluster">>, description => <<"Delete a listener by a given Id to all nodes in the cluster">>,
parameters => [param_path_node(), param_path_id()], parameters => [param_path_node(), param_path_id()],