Merge pull request #12951 from zmstone/0429-fix-description-schema

fix(schema): description should be in binary() type
emqx · Apr 30, 2024 · a88862e · a88862e
2 parents 7e7ae92 + 9917293
commit a88862e
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
@@ -1876,7 +1876,7 @@ base_listener(Bind) ->
             )}
     ] ++ emqx_limiter_schema:short_paths_fields().
 
-%% @hidden Starting from 5.7, listenrs.{TYPE}.{NAME}.zone is no longer hidden
+%% @hidden Starting from 5.7, listeners.{TYPE}.{NAME}.zone is no longer hidden
 %% However, the root key 'zones' is still hidden because the fields' schema
 %% just repeat other root field's schema, which makes the dumped schema doc
 %% unnecessarily bloated.
@@ -3721,7 +3721,7 @@ default_mem_check_interval() ->
 
 description_schema() ->
     sc(
-        string(),
+        binary(),
         #{
             default => <<"">>,
             desc => ?DESC(description),