From 929d043677ccb0753084d5158b6f91b4d41409a2 Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Mon, 18 Apr 2022 21:29:55 +0800 Subject: [PATCH] chore: fix elvis warning atom_naming_convention. --- .../i18n/emqx_auto_subscribe_i18n.conf | 2 +- apps/emqx_dashboard/src/emqx_dashboard_swagger.erl | 3 ++- .../i18n/emqx_mgmt_api_alarms_i18n.conf | 2 +- .../i18n/emqx_mgmt_api_banned_i18n.conf | 13 +++---------- apps/emqx_management/src/emqx_mgmt_api_alarms.erl | 2 +- apps/emqx_management/src/emqx_mgmt_api_banned.erl | 4 ++-- 6 files changed, 10 insertions(+), 16 deletions(-) diff --git a/apps/emqx_auto_subscribe/i18n/emqx_auto_subscribe_i18n.conf b/apps/emqx_auto_subscribe/i18n/emqx_auto_subscribe_i18n.conf index ce417ea50..b93a186b1 100644 --- a/apps/emqx_auto_subscribe/i18n/emqx_auto_subscribe_i18n.conf +++ b/apps/emqx_auto_subscribe/i18n/emqx_auto_subscribe_i18n.conf @@ -36,7 +36,7 @@ QoS 2:消息仅传送一次。""" } label { en: """Quality of Service""" - zh: """Quality of Service""" + zh: """服务质量""" } } diff --git a/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl b/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl index 9c89d8637..a6a2d1bc4 100644 --- a/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl +++ b/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl @@ -149,7 +149,8 @@ schema_with_examples(Type, Examples) -> error_codes(Codes) -> error_codes(Codes, <<"Error code to troubleshoot problems.">>). --spec error_codes(nonempty_list(atom()), binary()) -> hocon_schema:fields(). +-spec error_codes(nonempty_list(atom()), binary() | {desc, module(), term()}) -> + hocon_schema:fields(). error_codes(Codes = [_ | _], MsgDesc) -> [ {code, hoconsc:mk(hoconsc:enum(Codes))}, diff --git a/apps/emqx_management/i18n/emqx_mgmt_api_alarms_i18n.conf b/apps/emqx_management/i18n/emqx_mgmt_api_alarms_i18n.conf index 43ad85029..c6f518c86 100644 --- a/apps/emqx_management/i18n/emqx_mgmt_api_alarms_i18n.conf +++ b/apps/emqx_management/i18n/emqx_mgmt_api_alarms_i18n.conf @@ -14,7 +14,7 @@ emqx_mgmt_api_alarms { } } - delete_alarms_api_response_200 { + delete_alarms_api_response204 { desc { en: """Remove all deactivated alarms ok""" zh: """删除所有历史告警(非活跃告警)成功""" diff --git a/apps/emqx_management/i18n/emqx_mgmt_api_banned_i18n.conf b/apps/emqx_management/i18n/emqx_mgmt_api_banned_i18n.conf index 5ab1a24d4..686293d0b 100644 --- a/apps/emqx_management/i18n/emqx_mgmt_api_banned_i18n.conf +++ b/apps/emqx_management/i18n/emqx_mgmt_api_banned_i18n.conf @@ -18,17 +18,10 @@ emqx_mgmt_api_banned { } } - create_banned_api_response_400 { + create_banned_api_response400 { desc { en: """Banned already existed, or bad args.""" - zh: """黑名单已存在,或错误的参数""" - } - } - - create_banned_api_response_404 { - desc { - en: """Banned not existed.""" - zh: """黑名单不存在""" + zh: """黑名单已存在,或参数格式有错误""" } } @@ -39,7 +32,7 @@ emqx_mgmt_api_banned { } } - delete_banned_api_response_400 { + delete_banned_api_response404 { desc { en: """Banned not found. May be the banned time has been exceeded""" zh: """黑名单未找到,可能为已经超期失效""" diff --git a/apps/emqx_management/src/emqx_mgmt_api_alarms.erl b/apps/emqx_management/src/emqx_mgmt_api_alarms.erl index e9acc9cd7..d6b2280de 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_alarms.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_alarms.erl @@ -57,7 +57,7 @@ schema("/alarms") -> delete => #{ description => ?DESC(delete_alarms_api), responses => #{ - 204 => ?DESC(delete_alarms_api_response_200) + 204 => ?DESC(delete_alarms_api_response204) } } }. diff --git a/apps/emqx_management/src/emqx_mgmt_api_banned.erl b/apps/emqx_management/src/emqx_mgmt_api_banned.erl index 4c17de1f2..52fb64b75 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_banned.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_banned.erl @@ -70,7 +70,7 @@ schema("/banned") -> 200 => [{data, hoconsc:mk(hoconsc:array(hoconsc:ref(ban)), #{})}], 400 => emqx_dashboard_swagger:error_codes( ['ALREADY_EXISTS', 'BAD_REQUEST'], - ?DESC(create_banned_api_response_400)) + ?DESC(create_banned_api_response400)) } } }; @@ -93,7 +93,7 @@ schema("/banned/:as/:who") -> 204 => <<"Delete banned success">>, 404 => emqx_dashboard_swagger:error_codes( ['NOT_FOUND'], - ?DESC(create_banned_api_response_404)) + ?DESC(delete_banned_api_response404)) } } }.