fix(api): banned api error code format

This commit is contained in:
DDDHuang 2022-02-18 10:57:04 +08:00
parent 98a11f3c15
commit a5d8f2ce3b
2 changed files with 12 additions and 8 deletions

View File

@ -127,7 +127,9 @@ parse(Params) ->
until = Until until = Until
}; };
false -> false ->
{error, "already_expired"} ErrorReason =
io_lib:format("Cannot create expired banned, ~p to ~p", [At, Until]),
{error, ErrorReason}
end end
end. end.
pares_who(#{as := As, who := Who}) -> pares_who(#{as := As, who := Who}) ->

View File

@ -67,8 +67,9 @@ schema("/banned") ->
'requestBody' => hoconsc:mk(hoconsc:ref(ban)), 'requestBody' => hoconsc:mk(hoconsc:ref(ban)),
responses => #{ responses => #{
200 => [{data, hoconsc:mk(hoconsc:array(hoconsc:ref(ban)), #{})}], 200 => [{data, hoconsc:mk(hoconsc:array(hoconsc:ref(ban)), #{})}],
400 => emqx_dashboard_swagger:error_codes(['ALREADY_EXISTED'], 400 => emqx_dashboard_swagger:error_codes(
<<"Banned already existed">>) ['ALREADY_EXISTED', 'BAD_REQUEST'],
<<"Banned already existed, or bad args">>)
} }
} }
}; };
@ -89,8 +90,9 @@ schema("/banned/:as/:who") ->
], ],
responses => #{ responses => #{
204 => <<"Delete banned success">>, 204 => <<"Delete banned success">>,
404 => emqx_dashboard_swagger:error_codes(['RESOURCE_NOT_FOUND'], 404 => emqx_dashboard_swagger:error_codes(
<<"Banned not found">>) ['NOT_FOUND'],
<<"Banned not found. May be the banned time has been exceeded">>)
} }
} }
}. }.
@ -134,12 +136,12 @@ banned(get, #{query_string := Params}) ->
banned(post, #{body := Body}) -> banned(post, #{body := Body}) ->
case emqx_banned:parse(Body) of case emqx_banned:parse(Body) of
{error, Reason} -> {error, Reason} ->
{400, #{code => 'PARAMS_ERROR', message => list_to_binary(Reason)}}; {400, 'BAD_REQUEST', list_to_binary(Reason)};
Ban -> Ban ->
case emqx_banned:create(Ban) of case emqx_banned:create(Ban) of
{ok, Banned} -> {200, format(Banned)}; {ok, Banned} -> {200, format(Banned)};
{error, {already_exist, Old}} -> {error, {already_exist, Old}} ->
{400, #{code => 'ALREADY_EXISTED', message => format(Old)}} {400, 'ALREADY_EXISTED', format(Old)}
end end
end. end.
@ -148,7 +150,7 @@ delete_banned(delete, #{bindings := Params}) ->
[] -> [] ->
#{as := As0, who := Who0} = Params, #{as := As0, who := Who0} = Params,
Message = list_to_binary(io_lib:format("~p: ~s not found", [As0, Who0])), Message = list_to_binary(io_lib:format("~p: ~s not found", [As0, Who0])),
{404, #{code => 'RESOURCE_NOT_FOUND', message => Message}}; {404, 'NOT_FOUND', Message};
_ -> _ ->
ok = emqx_banned:delete(Params), ok = emqx_banned:delete(Params),
{204} {204}