fix: config docs for banned api & auto sub

apps/emqx_auto_subscribe/src/emqx_auto_subscribe_schema.erl

@@ -17,6 +17,7 @@
 
 -behaviour(hocon_schema).
 
+-include_lib("hocon/include/hoconsc.hrl").
 -include_lib("typerefl/include/types.hrl").
 -include_lib("emqx/include/emqx_placeholder.hrl").
 
@@ -38,28 +39,24 @@ fields("auto_subscribe") ->
 fields("topic") ->
     [ {topic, sc(binary(), #{
         example => topic_example(),
-        desc => "Topic name, placeholders is supported. For example: "
-                ++ binary_to_list(topic_example())})}
+        desc => ?DESC("topic")})}
     , {qos, sc(emqx_schema:qos(), #{
         default => 0,
-        desc => "Quality of service. MQTT definition."})}
+        desc => ?DESC("qos")})}
     , {rh, sc(range(0,2), #{
         default => 0,
-        desc => "Retain handling. MQTT 5.0 definition."})}
+        desc => ?DESC("rh")})}
     , {rap, sc(range(0, 1), #{
         default => 0,
-        desc => "Retain as Published. MQTT 5.0 definition."})}
+        desc => ?DESC("rap")})}
     , {nl, sc(range(0, 1), #{
         default => 0,
-        desc => "Not local. MQTT 5.0 definition."})}
+        desc => ?DESC(nl)})}
     ].
 
-desc("auto_subscribe") ->
-    "Configuration for `auto_subscribe` feature.";
-desc("topic") ->
-    "";
-desc(_) ->
-    undefined.
+desc("auto_subscribe") -> ?DESC("auto_subscribe");
+desc("topic") -> ?DESC("topic");
+desc(_) -> undefined.
 
 topic_example() ->
     <<"/clientid/", ?PH_S_CLIENTID,

apps/emqx_management/i18n/emqx_management_i18n.conf

@@ -0,0 +1,54 @@
+emqx_management {
+    banned {
+        as {
+            desc {
+                en: """Banned type clientid, username, peerhost"""
+                zh: """黑名单类型，可选 clientid、username、peerhost"""
+            }
+            label {
+                en: """Banned Type"""
+                zh: """黑名单类型"""
+            }
+        }
+        who {
+            desc {
+                en: """Client info as banned type"""
+                zh: """设备信息"""
+            }
+            label {
+                en: """Banned Info"""
+                zh: """黑名单信息"""
+            }
+        }
+        by {
+            desc {
+                en: """Commander"""
+                zh: """黑名单创建者"""
+            }
+            label {
+                en: """Commander"""
+                zh: """黑名单创建者"""
+            }
+        }
+        at {
+            desc {
+                en: """Create banned time, rfc3339, now if not specified"""
+                zh: """黑名单创建时间，默认为当前"""
+            }
+            label {
+                en: """Create banned time"""
+                zh: """黑名单创建时间"""
+            }
+        }
+        until {
+            desc {
+                en: """Cancel banned time, rfc3339, now + 5 minute if not specified"""
+                zh: """黑名单结束时间，默认为创建时间 + 5 分钟"""
+            }
+            label {
+                en: """Cancel banned time"""
+                zh: """黑名单结束时间"""
+            }
+        }
+    }
+}