Merge pull request #6428 from zmstone/refactor-better-config-doc

docs: better config doc
This commit is contained in:
Zaiming (Stone) Shi 2021-12-12 19:09:05 +01:00 committed by GitHub
commit e5b11d48a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 3 deletions

View File

@ -50,8 +50,7 @@ config_refs(Modules) ->
%% in emqx_schema, 'authentication' is a map() type which is to allow %% in emqx_schema, 'authentication' is a map() type which is to allow
%% EMQ X more plugable. %% EMQ X more plugable.
root_type() -> root_type() ->
T = authenticator_type(), hoconsc:array(authenticator_type()).
hoconsc:union([T, hoconsc:array(T)]).
mechanism(Name) -> mechanism(Name) ->
hoconsc:mk(hoconsc:enum([Name]), hoconsc:mk(hoconsc:enum([Name]),

View File

@ -36,7 +36,9 @@
-export([ roots/0 -export([ roots/0
, fields/1 , fields/1
, validations/0]). , validations/0
, namespace/0
]).
-export([ check_ssl_opts/2 -export([ check_ssl_opts/2
]). ]).
@ -50,6 +52,9 @@
%%===================================================================== %%=====================================================================
%% Hocon schema %% Hocon schema
namespace() -> "connector-http".
roots() -> roots() ->
fields(config). fields(config).