fix: alias listeners.Type.Name.enabled as listeners.Type.Name.enable

apps/emqx/src/emqx_listeners.erl

@@ -368,7 +368,7 @@ console_print(_Fmt, _Args) -> ok.
 %% Start MQTT/TCP listener
 -spec do_start_listener(atom(), atom(), map()) ->
     {ok, pid() | {skipped, atom()}} | {error, term()}.
-do_start_listener(_Type, _ListenerName, #{enabled := false}) ->
+do_start_listener(_Type, _ListenerName, #{enable := false}) ->
     {ok, {skipped, listener_disabled}};
 do_start_listener(Type, ListenerName, #{bind := ListenOn} = Opts) when
     Type == tcp; Type == ssl
@@ -499,8 +499,8 @@ post_config_update([?ROOT_KEY, Type, Name], {update, _Request}, NewConf, OldConf
 post_config_update([?ROOT_KEY, Type, Name], ?MARK_DEL, _, OldConf = #{}, _AppEnvs) ->
     remove_listener(Type, Name, OldConf);
 post_config_update([?ROOT_KEY, Type, Name], {action, _Action, _}, NewConf, OldConf, _AppEnvs) ->
-    #{enabled := NewEnabled} = NewConf,
-    #{enabled := OldEnabled} = OldConf,
+    #{enable := NewEnabled} = NewConf,
+    #{enable := OldEnabled} = OldConf,
     case {NewEnabled, OldEnabled} of
         {true, true} ->
             ok = maybe_unregister_ocsp_stapling_refresh(Type, Name, NewConf),
@@ -810,7 +810,7 @@ has_enabled_listener_conf_by_type(Type) ->
     lists:any(
         fun({Id, LConf}) when is_map(LConf) ->
             {ok, #{type := Type0}} = parse_listener_id(Id),
-            Type =:= Type0 andalso maps:get(enabled, LConf, true)
+            Type =:= Type0 andalso maps:get(enable, LConf, true)
         end,
         list()
     ).

apps/emqx/src/emqx_schema.erl

@@ -1750,13 +1750,12 @@ mqtt_listener(Bind) ->
 
 base_listener(Bind) ->
     [
-        {"enabled",
+        {"enable",
             sc(
                 boolean(),
                 #{
                     default => true,
-                    %% TODO(5.2): change field name to 'enable' and keep 'enabled' as an alias
-                    aliases => [enable],
+                    aliases => [enabled],
                     desc => ?DESC(fields_listener_enabled)
                 }
             )},

apps/emqx_management/src/emqx_mgmt_api_listeners.erl

@@ -510,9 +510,9 @@ action_listeners_by_id(post, #{bindings := #{id := Id, action := Action}}) ->
 
 %%%==============================================================================================
 
-enabled(start) -> #{<<"enabled">> => true};
-enabled(stop) -> #{<<"enabled">> => false};
-enabled(restart) -> #{<<"enabled">> => true}.
+enabled(start) -> #{<<"enable">> => true};
+enabled(stop) -> #{<<"enable">> => false};
+enabled(restart) -> #{<<"enable">> => true}.
 
 err_msg(Atom) when is_atom(Atom) -> atom_to_binary(Atom);
 err_msg(Reason) -> list_to_binary(err_msg_str(Reason)).
@@ -594,7 +594,7 @@ format_status(Key, Node, Listener, Acc) ->
     #{
         <<"id">> := Id,
         <<"type">> := Type,
-        <<"enabled">> := Enabled,
+        <<"enable">> := Enable,
         <<"running">> := Running,
         <<"max_connections">> := MaxConnections,
         <<"current_connections">> := CurrentConnections,
@@ -609,7 +609,7 @@ format_status(Key, Node, Listener, Acc) ->
                 GroupKey => #{
                     name => Name,
                     type => Type,
-                    enable => Enabled,
+                    enable => Enable,
                     ids => [Id],
                     acceptors => Acceptors,
                     bind => iolist_to_binary(emqx_listeners:format_bind(Bind)),