chore: hide `enable` fields from docgen

Fixes https://emqx.atlassian.net/browse/EMQX-12730

apps/emqx/src/emqx_schema.erl

@@ -351,6 +351,7 @@ fields("authz_cache") ->
                 #{
                     default => true,
                     required => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(fields_cache_enable)
                 }
             )},
@@ -387,6 +388,7 @@ fields("flapping_detect") ->
                 boolean(),
                 #{
                     default => false,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(flapping_detect_enable)
                 }
             )},
@@ -423,6 +425,7 @@ fields("force_shutdown") ->
                 boolean(),
                 #{
                     default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(force_shutdown_enable)
                 }
             )},
@@ -452,6 +455,7 @@ fields("overload_protection") ->
                 boolean(),
                 #{
                     desc => ?DESC(overload_protection_enable),
+                    importance => ?IMPORTANCE_NO_DOC,
                     default => false
                 }
             )},
@@ -512,7 +516,11 @@ fields("force_gc") ->
         {"enable",
             sc(
                 boolean(),
-                #{default => true, desc => ?DESC(force_gc_enable)}
+                #{
+                    default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
+                    desc => ?DESC(force_gc_enable)
+                }
             )},
         {"count",
             sc(
@@ -1665,6 +1673,7 @@ fields("durable_sessions") ->
             sc(
                 boolean(), #{
                     desc => ?DESC(durable_sessions_enable),
+                    importance => ?IMPORTANCE_NO_DOC,
                     default => false
                 }
             )},
@@ -1888,6 +1897,7 @@ base_listener(Bind) ->
                 #{
                     default => true,
                     aliases => [enabled],
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(fields_listener_enabled)
                 }
             )},
@@ -2416,6 +2426,7 @@ client_ssl_opts_schema(Defaults) ->
                     boolean(),
                     #{
                         default => false,
+                        importance => ?IMPORTANCE_NO_DOC,
                         desc => ?DESC(client_ssl_opts_schema_enable)
                     }
                 )},

apps/emqx_auth/src/emqx_authn/emqx_authn_schema.erl

@@ -203,6 +203,7 @@ common_fields() ->
 
 enable(type) -> boolean();
 enable(default) -> true;
+enable(importance) -> ?IMPORTANCE_NO_DOC;
 enable(desc) -> ?DESC(?FUNCTION_NAME);
 enable(_) -> undefined.
 

apps/emqx_auth/src/emqx_authz/emqx_authz_schema.erl

@@ -170,7 +170,12 @@ api_authz_refs() ->
 authz_common_fields(Type) ->
     [
         {type, ?HOCON(Type, #{required => true, desc => ?DESC(type)})},
-        {enable, ?HOCON(boolean(), #{default => true, desc => ?DESC(enable)})}
+        {enable,
+            ?HOCON(boolean(), #{
+                default => true,
+                importance => ?IMPORTANCE_NO_DOC,
+                desc => ?DESC(enable)
+            })}
     ].
 
 source_types() ->

apps/emqx_bridge/src/schema/emqx_bridge_schema.erl

@@ -123,6 +123,7 @@ common_bridge_fields() ->
                 boolean(),
                 #{
                     desc => ?DESC("desc_enable"),
+                    importance => ?IMPORTANCE_NO_DOC,
                     default => true
                 }
             )},

apps/emqx_bridge/src/schema/emqx_bridge_v2_schema.erl

@@ -65,6 +65,7 @@
 -export([
     make_producer_action_schema/1, make_producer_action_schema/2,
     make_consumer_action_schema/1, make_consumer_action_schema/2,
+    common_fields/0,
     top_level_common_action_keys/0,
     top_level_common_source_keys/0,
     project_to_actions_resource_opts/1,
@@ -507,16 +508,26 @@ make_consumer_action_schema(ParametersRef, Opts) ->
                 })}
         ].
 
-common_schema(ParametersRef, _Opts) ->
+common_fields() ->
     [
-        {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
+        {enable,
+            mk(boolean(), #{
+                desc => ?DESC("config_enable"),
+                importance => ?IMPORTANCE_NO_DOC,
+                default => true
+            })},
         {connector,
             mk(binary(), #{
                 desc => ?DESC(emqx_connector_schema, "connector_field"), required => true
             })},
         {tags, emqx_schema:tags_schema()},
-        {description, emqx_schema:description_schema()},
+        {description, emqx_schema:description_schema()}
+    ].
+
+common_schema(ParametersRef, _Opts) ->
+    [
         {parameters, ParametersRef}
+        | common_fields()
     ].
 
 project_to_actions_resource_opts(OldResourceOpts) ->

apps/emqx_bridge_azure_event_hub/src/emqx_bridge_azure_event_hub.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_azure_event_hub, [
     {description, "EMQX Enterprise Azure Event Hub Bridge"},
-    {vsn, "0.1.7"},
+    {vsn, "0.1.8"},
     {registered, []},
     {applications, [
         kernel,

apps/emqx_bridge_azure_event_hub/src/emqx_bridge_azure_event_hub.erl

@@ -129,16 +129,7 @@ fields(actions) ->
         override(
             emqx_bridge_kafka:producer_opts(action),
             bridge_v2_overrides()
-        ) ++
+        ) ++ emqx_bridge_v2_schema:common_fields(),
-            [
-                {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
-                {connector,
-                    mk(binary(), #{
-                        desc => ?DESC(emqx_connector_schema, "connector_field"), required => true
-                    })},
-                {tags, emqx_schema:tags_schema()},
-                {description, emqx_schema:description_schema()}
-            ],
     override_documentations(Fields);
 fields(Method) ->
     Fields = emqx_bridge_kafka:fields(Method),

apps/emqx_bridge_confluent/src/emqx_bridge_confluent.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_confluent, [
     {description, "EMQX Enterprise Confluent Connector and Action"},
-    {vsn, "0.1.2"},
+    {vsn, "0.1.3"},
     {registered, []},
     {applications, [
         kernel,

apps/emqx_bridge_confluent/src/emqx_bridge_confluent_producer.erl

@@ -116,16 +116,7 @@ fields(actions) ->
         override(
             emqx_bridge_kafka:producer_opts(action),
             bridge_v2_overrides()
-        ) ++
+        ) ++ emqx_bridge_v2_schema:common_fields(),
-            [
-                {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
-                {connector,
-                    mk(binary(), #{
-                        desc => ?DESC(emqx_connector_schema, "connector_field"), required => true
-                    })},
-                {tags, emqx_schema:tags_schema()},
-                {description, emqx_schema:description_schema()}
-            ],
     override_documentations(Fields);
 fields(Method) ->
     Fields = emqx_bridge_kafka:fields(Method),

apps/emqx_bridge_http/src/emqx_bridge_http_schema.erl

@@ -72,35 +72,29 @@ fields(action) ->
             }
         )};
 fields("http_action") ->
-    [
+    emqx_bridge_v2_schema:common_fields() ++
-        {enable, mk(boolean(), #{desc => ?DESC("config_enable_bridge"), default => true})},
+        [
-        {connector,
+            %% Note: there's an implicit convention in `emqx_bridge' that,
-            mk(binary(), #{
+            %% for egress bridges with this config, the published messages
-                desc => ?DESC(emqx_connector_schema, "connector_field"), required => true
+            %% will be forwarded to such bridges.
-            })},
+            {local_topic,
-        {tags, emqx_schema:tags_schema()},
+                mk(
-        {description, emqx_schema:description_schema()},
+                    binary(),
-        %% Note: there's an implicit convention in `emqx_bridge' that,
+                    #{
-        %% for egress bridges with this config, the published messages
+                        required => false,
-        %% will be forwarded to such bridges.
+                        desc => ?DESC("config_local_topic"),
-        {local_topic,
+                        importance => ?IMPORTANCE_HIDDEN
-            mk(
+                    }
-                binary(),
+                )},
-                #{
+            %% Since e5.3.2, we split the http bridge to two parts: a) connector. b) actions.
-                    required => false,
+            %% some fields are moved to connector, some fields are moved to actions and composed into the
-                    desc => ?DESC("config_local_topic"),
+            %% `parameters` field.
-                    importance => ?IMPORTANCE_HIDDEN
+            {parameters,
-                }
+                mk(ref("parameters_opts"), #{
-            )},
+                    required => true,
-        %% Since e5.3.2, we split the http bridge to two parts: a) connector. b) actions.
+                    desc => ?DESC("config_parameters_opts")
-        %% some fields are moved to connector, some fields are moved to actions and composed into the
+                })}
-        %% `parameters` field.
+        ] ++
-        {parameters,
-            mk(ref("parameters_opts"), #{
-                required => true,
-                desc => ?DESC("config_parameters_opts")
-            })}
-    ] ++
         emqx_connector_schema:resource_opts_ref(
             ?MODULE, action_resource_opts, fun legacy_action_resource_opts_converter/2
         );

apps/emqx_bridge_kafka/src/emqx_bridge_kafka.erl

@@ -297,15 +297,7 @@ fields("config_consumer") ->
 fields(kafka_producer) ->
     connector_config_fields() ++ producer_opts(v1);
 fields(kafka_producer_action) ->
-    [
+    emqx_bridge_v2_schema:common_fields() ++ producer_opts(action);
-        {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
-        {connector,
-            mk(binary(), #{
-                desc => ?DESC(emqx_connector_schema, "connector_field"), required => true
-            })},
-        {tags, emqx_schema:tags_schema()},
-        {description, emqx_schema:description_schema()}
-    ] ++ producer_opts(action);
 fields(kafka_consumer) ->
     connector_config_fields() ++ fields(consumer_opts);
 fields(ssl_client_opts) ->

apps/emqx_bridge_syskeeper/src/emqx_bridge_syskeeper.app.src

@@ -1,6 +1,6 @@
 {application, emqx_bridge_syskeeper, [
     {description, "EMQX Enterprise Data bridge for Syskeeper"},
-    {vsn, "0.1.3"},
+    {vsn, "0.1.4"},
     {registered, []},
     {applications, [
         kernel,

apps/emqx_bridge_syskeeper/src/emqx_bridge_syskeeper.erl

@@ -84,30 +84,16 @@ fields(action) ->
             }
         )};
 fields(config) ->
-    [
+    emqx_bridge_v2_schema:make_producer_action_schema(
-        {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
+        mk(
-        {tags, emqx_schema:tags_schema()},
+            ref(?MODULE, "parameters"),
-        {description, emqx_schema:description_schema()},
+            #{
-        {connector,
+                required => true,
-            mk(binary(), #{
+                desc => ?DESC("parameters")
-                desc => ?DESC(emqx_connector_schema, "connector_field"), required => true
+            }
-            })},
+        ),
-        {parameters,
+        #{resource_opts_ref => ref(?MODULE, "creation_opts")}
-            mk(
+    );
-                ref(?MODULE, "parameters"),
-                #{required => true, desc => ?DESC("parameters")}
-            )},
-        {local_topic, mk(binary(), #{required => false, desc => ?DESC(mqtt_topic)})},
-        {resource_opts,
-            mk(
-                ref(?MODULE, "creation_opts"),
-                #{
-                    required => false,
-                    default => #{},
-                    desc => ?DESC(emqx_resource_schema, <<"resource_opts">>)
-                }
-            )}
-    ];
 fields("parameters") ->
     [
         {target_topic,

apps/emqx_cluster_link/src/emqx_cluster_link_schema.erl

@@ -39,7 +39,12 @@ links_schema(Meta) ->
 
 fields("link") ->
     [
-        {enable, ?HOCON(boolean(), #{default => true, desc => ?DESC(enable)})},
+        {enable,
+            ?HOCON(boolean(), #{
+                default => true,
+                importance => ?IMPORTANCE_NO_DOC,
+                desc => ?DESC(enable)
+            })},
         {name, ?HOCON(binary(), #{required => true, desc => ?DESC(link_name)})},
         {server,
             emqx_schema:servers_sc(#{required => true, desc => ?DESC(server)}, ?MQTT_HOST_OPTS)},

apps/emqx_conf/src/emqx_conf_schema.erl

@@ -997,6 +997,7 @@ fields("log_overload_kill") ->
                 boolean(),
                 #{
                     default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC("log_overload_kill_enable")
                 }
             )},
@@ -1032,6 +1033,7 @@ fields("log_burst_limit") ->
                 boolean(),
                 #{
                     default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC("log_burst_limit_enable")
                 }
             )},
@@ -1285,7 +1287,7 @@ log_handler_common_confs(Handler, Default) ->
                 #{
                     default => Enable,
                     desc => ?DESC("common_handler_enable"),
-                    importance => ?IMPORTANCE_MEDIUM
+                    importance => ?IMPORTANCE_NO_DOC
                 }
             )},
         {"formatter",

apps/emqx_connector/src/schema/emqx_connector_schema.erl

@@ -489,7 +489,12 @@ api_fields("put_connector", _Type, Fields) ->
 
 common_fields() ->
     [
-        {enable, mk(boolean(), #{desc => ?DESC("config_enable"), default => true})},
+        {enable,
+            mk(boolean(), #{
+                desc => ?DESC("config_enable"),
+                importance => ?IMPORTANCE_NO_DOC,
+                default => true
+            })},
         {tags, emqx_schema:tags_schema()},
         {description, emqx_schema:description_schema()}
     ].

apps/emqx_dashboard/src/emqx_dashboard_swagger.erl

@@ -1008,7 +1008,7 @@ parse_object_loop([{Name, Hocon} | Rest], Module, Options, Props, Required, Refs
 
 %% return true if the field has 'importance' set to 'hidden'
 is_hidden(Hocon) ->
-    hocon_schema:is_hidden(Hocon, #{include_importance_up_from => ?IMPORTANCE_LOW}).
+    hocon_schema:is_hidden(Hocon, #{include_importance_up_from => ?IMPORTANCE_NO_DOC}).
 
 is_required(Hocon) ->
     hocon_schema:field_schema(Hocon, required) =:= true.

apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl

@@ -47,6 +47,7 @@ common_backend_schema(Backend) ->
             mk(
                 boolean(), #{
                     desc => ?DESC(backend_enable),
+                    importance => ?IMPORTANCE_NO_DOC,
                     required => false,
                     default => false
                 }

apps/emqx_enterprise/src/emqx_enterprise_schema.erl

@@ -53,7 +53,6 @@ fields("log_audit_handler") ->
                     importance => ?IMPORTANCE_HIDDEN
                 }
             )},
-
         {"path",
             hoconsc:mk(
                 string(),

apps/emqx_exhook/src/emqx_exhook.app.src

@@ -1,7 +1,7 @@
 %% -*- mode: erlang -*-
 {application, emqx_exhook, [
     {description, "EMQX Extension for Hook"},
-    {vsn, "5.0.17"},
+    {vsn, "5.0.18"},
     {modules, []},
     {registered, []},
     {mod, {emqx_exhook_app, []}},

apps/emqx_exhook/src/emqx_exhook_schema.erl

@@ -54,6 +54,7 @@ fields(server) ->
         {enable,
             ?HOCON(boolean(), #{
                 default => true,
+                importance => ?IMPORTANCE_NO_DOC,
                 desc => ?DESC(enable)
             })},
         {url,

apps/emqx_ft/src/emqx_ft_schema.erl

@@ -66,6 +66,7 @@ fields(file_transfer) ->
                 boolean(),
                 #{
                     desc => ?DESC("enable"),
+                    importance => ?IMPORTANCE_NO_DOC,
                     required => false,
                     default => false
                 }
@@ -242,6 +243,7 @@ common_backend_fields() ->
             mk(
                 boolean(), #{
                     desc => ?DESC("backend_enable"),
+                    importance => ?IMPORTANCE_NO_DOC,
                     required => false,
                     default => true
                 }

apps/emqx_gateway/src/emqx_gateway_schema.erl

@@ -240,6 +240,7 @@ gateway_common_options() ->
                 boolean(),
                 #{
                     default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(gateway_common_enable)
                 }
             )},
@@ -413,6 +414,7 @@ common_listener_opts() ->
                 boolean(),
                 #{
                     default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(gateway_common_listener_enable)
                 }
             )},

apps/emqx_modules/src/emqx_modules_schema.erl

@@ -79,7 +79,12 @@ rewrite_validator(Rules) ->
 
 fields("delayed") ->
     [
-        {enable, ?HOCON(boolean(), #{default => true, desc => ?DESC(enable)})},
+        {enable,
+            ?HOCON(boolean(), #{
+                default => true,
+                importance => ?IMPORTANCE_NO_DOC,
+                desc => ?DESC(enable)
+            })},
         {max_delayed_messages,
             ?HOCON(integer(), #{desc => ?DESC(max_delayed_messages), default => 0})}
     ];

apps/emqx_opentelemetry/src/emqx_opentelemetry.app.src

@@ -1,6 +1,6 @@
 {application, emqx_opentelemetry, [
     {description, "OpenTelemetry for EMQX Broker"},
-    {vsn, "0.2.6"},
+    {vsn, "0.2.7"},
     {registered, []},
     {mod, {emqx_otel_app, []}},
     {applications, [

apps/emqx_opentelemetry/src/emqx_otel_schema.erl

@@ -72,6 +72,7 @@ fields("otel_metrics") ->
                 boolean(),
                 #{
                     default => false,
+                    importance => ?IMPORTANCE_NO_DOC,
                     required => true,
                     desc => ?DESC(enable)
                 }
@@ -104,7 +105,7 @@ fields("otel_logs") ->
                 #{
                     default => false,
                     desc => ?DESC(enable),
-                    importance => ?IMPORTANCE_HIGH
+                    importance => ?IMPORTANCE_NO_DOC
                 }
             )},
         {max_queue_size,
@@ -143,7 +144,7 @@ fields("otel_traces") ->
                 #{
                     default => false,
                     desc => ?DESC(enable),
-                    importance => ?IMPORTANCE_HIGH
+                    importance => ?IMPORTANCE_NO_DOC
                 }
             )},
         {max_queue_size,

apps/emqx_plugins/src/emqx_plugins_schema.erl

@@ -56,6 +56,8 @@ state_fields() ->
             ?HOCON(
                 boolean(),
                 #{
+                    default => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(enable),
                     required => true
                 }

apps/emqx_prometheus/src/emqx_prometheus_schema.erl

@@ -78,6 +78,7 @@ fields(push_gateway) ->
                 #{
                     default => false,
                     required => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(push_gateway_enable)
                 }
             )},
@@ -229,6 +230,7 @@ fields(legacy_deprecated_setting) ->
                 #{
                     default => false,
                     required => true,
+                    importance => ?IMPORTANCE_NO_DOC,
                     desc => ?DESC(legacy_enable)
                 }
             )},

apps/emqx_psk/src/emqx_psk.app.src

@@ -2,7 +2,7 @@
 {application, emqx_psk, [
     {description, "EMQX PSK"},
     % strict semver, bump manually!
-    {vsn, "5.0.6"},
+    {vsn, "5.0.7"},
     {modules, []},
     {registered, [emqx_psk_sup]},
     {applications, [kernel, stdlib]},

apps/emqx_psk/src/emqx_psk_schema.erl

@@ -42,6 +42,7 @@ fields() ->
     [
         {enable,
             ?HOCON(boolean(), #{
+                importance => ?IMPORTANCE_NO_DOC,
                 default => false,
                 require => true,
                 desc => ?DESC(enable)

apps/emqx_retainer/src/emqx_retainer_schema.erl

@@ -43,7 +43,7 @@ roots() ->
 
 fields("retainer") ->
     [
-        {enable, sc(boolean(), enable, true)},
+        {enable, sc(boolean(), enable, true, ?IMPORTANCE_NO_DOC)},
         {msg_expiry_interval,
             sc(
                 %% not used in a `receive ... after' block, just timestamp comparison
@@ -126,6 +126,7 @@ fields(mnesia_config) ->
         {enable,
             ?HOCON(boolean(), #{
                 desc => ?DESC(mnesia_enable),
+                importance => ?IMPORTANCE_NO_DOC,
                 required => false,
                 default => true
             })}

apps/emqx_slow_subs/src/emqx_slow_subs.app.src

@@ -1,7 +1,7 @@
 {application, emqx_slow_subs, [
     {description, "EMQX Slow Subscribers Statistics"},
     % strict semver, bump manually!
-    {vsn, "1.0.7"},
+    {vsn, "1.0.8"},
     {modules, []},
     {registered, [emqx_slow_subs_sup]},
     {applications, [kernel, stdlib, emqx]},

apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl

@@ -27,7 +27,7 @@ roots() ->
 
 fields("slow_subs") ->
     [
-        {enable, sc(boolean(), false, enable)},
+        {enable, sc(boolean(), false, enable, ?IMPORTANCE_NO_DOC)},
         {threshold,
             sc(
                 %% not used in a `receive ... after' block, just timestamp comparison
@@ -66,3 +66,6 @@ desc(_) ->
 %%--------------------------------------------------------------------
 sc(Type, Default, Desc) ->
     ?HOCON(Type, #{default => Default, desc => ?DESC(Desc)}).
+
+sc(Type, Default, Desc, Importance) ->
+    ?HOCON(Type, #{default => Default, desc => ?DESC(Desc), importance => Importance}).