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

fix(api): config api on sepcific node (#6100) 

* fix(api): config api on sepcific node

* chore(style):  code style for elvis checking
This commit is contained in:
JimMoen 2021-11-10 09:38:45 +08:00 committed by GitHub
parent c911876511
commit ac23214447
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
apps/emqx_management/src/emqx_mgmt_api_configs.erl
View File

@ -40,14 +40,16 @@ paths() ->
schema("/configs") -> schema("/configs") ->
#{ #{
operationId => configs, 'operationId' => configs,
get => #{ get => #{
tags => [conf], tags => [conf],
description => <<"Get all the configurations of the specified node, including hot and non-hot updatable items.">>, description =>
<<"Get all the configurations of the specified node, including hot and non-hot updatable items.">>,
parameters => [ parameters => [
{node, hoconsc:mk(typerefl:atom(), {node, hoconsc:mk(typerefl:atom(),
#{in => query, required => false, example => <<"emqx@127.0.0.1">>, #{in => query, required => false, example => <<"emqx@127.0.0.1">>,
desc => <<"Node's name: If you do not fill in the fields, this node will be used by default.">>})}], desc =>
<<"Node's name: If you do not fill in the fields, this node will be used by default.">>})}],
responses => #{ responses => #{
200 => config_list([]) 200 => config_list([])
} }
@ -56,17 +58,19 @@ schema("/configs") ->
schema("/configs_reset/:rootname") -> schema("/configs_reset/:rootname") ->
Paths = lists:map(fun({Path, _}) -> Path end, config_list(?EXCLUDES)), Paths = lists:map(fun({Path, _}) -> Path end, config_list(?EXCLUDES)),
#{ #{
operationId => config_reset, 'operationId' => config_reset,
post => #{ post => #{
tags => [conf], tags => [conf],
description => <<"Reset the config entry specified by the query string parameter `conf_path`.<br/> description =>
<<"Reset the config entry specified by the query string parameter `conf_path`.<br/>
- For a config entry that has default value, this resets it to the default value; - For a config entry that has default value, this resets it to the default value;
- For a config entry that has no default value, an error 400 will be returned">>, - For a config entry that has no default value, an error 400 will be returned">>,
%% We only return "200" rather than the new configs that has been changed, as %% We only return "200" rather than the new configs that has been changed, as
%% the schema of the changed configs is depends on the request parameter %% the schema of the changed configs is depends on the request parameter
%% `conf_path`, it cannot be defined here. %% `conf_path`, it cannot be defined here.
parameters => [ parameters => [
{rootname, hoconsc:mk(hoconsc:enum(Paths), #{in => path, example => <<"authorization">>})}, {rootname, hoconsc:mk( hoconsc:enum(Paths)
, #{in => path, example => <<"authorization">>})},
{conf_path, hoconsc:mk(typerefl:binary(), {conf_path, hoconsc:mk(typerefl:binary(),
#{in => query, required => false, example => <<"cache.enable">>, #{in => query, required => false, example => <<"cache.enable">>,
desc => <<"The config path separated by '.' character">>})}], desc => <<"The config path separated by '.' character">>})}],
@ -79,10 +83,12 @@ schema("/configs_reset/:rootname") ->
schema(Path) -> schema(Path) ->
{Root, Schema} = find_schema(Path), {Root, Schema} = find_schema(Path),
#{ #{
operationId => config, 'operationId' => config,
get => #{ get => #{
tags => [conf], tags => [conf],
description => iolist_to_binary([<<"Get the sub-configurations under *">>, Root, <<"*">>]), description => iolist_to_binary([ <<"Get the sub-configurations under *">>
, Root
, <<"*">>]),
responses => #{ responses => #{
200 => Schema, 200 => Schema,
404 => emqx_dashboard_swagger:error_codes(['NOT_FOUND'], <<"config not found">>) 404 => emqx_dashboard_swagger:error_codes(['NOT_FOUND'], <<"config not found">>)
@ -90,8 +96,10 @@ schema(Path) ->
}, },
put => #{ put => #{
tags => [conf], tags => [conf],
description => iolist_to_binary([<<"Update the sub-configurations under *">>, Root, <<"*">>]), description => iolist_to_binary([ <<"Update the sub-configurations under *">>
requestBody => Schema, , Root
, <<"*">>]),
'requestBody' => Schema,
responses => #{ responses => #{
200 => Schema, 200 => Schema,
400 => emqx_dashboard_swagger:error_codes(['UPDATE_FAILED']) 400 => emqx_dashboard_swagger:error_codes(['UPDATE_FAILED'])
@ -147,7 +155,7 @@ config_reset(post, _Params, Req) ->
configs(get, Params, _Req) -> configs(get, Params, _Req) ->
Node = maps:get(node, Params, node()), Node = maps:get(node, Params, node()),
Res = rpc:call(Node, ?MODULE, get_full_config, [[]]), Res = rpc:call(Node, ?MODULE, get_full_config, []),
{200, Res}. {200, Res}.
conf_path_reset(Req) -> conf_path_reset(Req) ->