From a5d8f2ce3b77b31f45ed58f94b43cc1ac323e002 Mon Sep 17 00:00:00 2001
From: DDDHuang <44492639+DDDHuang@users.noreply.github.com>
Date: Fri, 18 Feb 2022 10:57:04 +0800
Subject: [PATCH] fix(api): banned api error code format

---
 apps/emqx/src/emqx_banned.erl                    |  4 +++-
 .../emqx_management/src/emqx_mgmt_api_banned.erl | 16 +++++++++-------
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/apps/emqx/src/emqx_banned.erl b/apps/emqx/src/emqx_banned.erl
index ddb81fee4..fce9b29cd 100644
--- a/apps/emqx/src/emqx_banned.erl
+++ b/apps/emqx/src/emqx_banned.erl
@@ -127,7 +127,9 @@ parse(Params) ->
                         until  = Until
                     };
                 false ->
-                    {error, "already_expired"}
+                    ErrorReason =
+                        io_lib:format("Cannot create expired banned, ~p to ~p", [At, Until]),
+                    {error, ErrorReason}
             end
     end.
 pares_who(#{as := As, who := Who}) ->
diff --git a/apps/emqx_management/src/emqx_mgmt_api_banned.erl b/apps/emqx_management/src/emqx_mgmt_api_banned.erl
index 2ecd894ee..8633ccfc2 100644
--- a/apps/emqx_management/src/emqx_mgmt_api_banned.erl
+++ b/apps/emqx_management/src/emqx_mgmt_api_banned.erl
@@ -67,8 +67,9 @@ schema("/banned") ->
             'requestBody' => hoconsc:mk(hoconsc:ref(ban)),
             responses => #{
                 200 => [{data, hoconsc:mk(hoconsc:array(hoconsc:ref(ban)), #{})}],
-                400 => emqx_dashboard_swagger:error_codes(['ALREADY_EXISTED'],
-                                                          <<"Banned already existed">>)
+                400 => emqx_dashboard_swagger:error_codes(
+                           ['ALREADY_EXISTED', 'BAD_REQUEST'],
+                            <<"Banned already existed, or bad args">>)
             }
         }
     };
@@ -89,8 +90,9 @@ schema("/banned/:as/:who") ->
                 ],
             responses => #{
                 204 => <<"Delete banned success">>,
-                404 => emqx_dashboard_swagger:error_codes(['RESOURCE_NOT_FOUND'],
-                                                          <<"Banned not found">>)
+                404 => emqx_dashboard_swagger:error_codes(
+                           ['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}) ->
     case emqx_banned:parse(Body) of
         {error, Reason} ->
-            {400, #{code => 'PARAMS_ERROR', message => list_to_binary(Reason)}};
+            {400, 'BAD_REQUEST', list_to_binary(Reason)};
         Ban ->
             case emqx_banned:create(Ban) of
                 {ok, Banned} -> {200, format(Banned)};
                 {error, {already_exist, Old}} ->
-                    {400, #{code => 'ALREADY_EXISTED', message => format(Old)}}
+                    {400, 'ALREADY_EXISTED', format(Old)}
             end
     end.
 
@@ -148,7 +150,7 @@ delete_banned(delete, #{bindings := Params}) ->
         [] ->
             #{as := As0, who := Who0} = Params,
             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),
             {204}