yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(schema): Document fields for HTTP auth

This commit is contained in:
ieQu1 2022-03-30 12:52:01 +02:00
parent d23a88d0a9
commit b6d93e91e6
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
apps/emqx_authz/src/emqx_authz_schema.erl
View File

@ -145,8 +145,8 @@ fields(redis_cluster) ->
http_common_fields() -> http_common_fields() ->
[ {url, fun url/1} [ {url, fun url/1}
, {request_timeout, mk_duration("Request timeout", #{default => "30s"})} , {request_timeout, mk_duration("Request timeout", #{default => "30s", desc => "Request timeout."})}
, {body, #{type => map(), required => false}} , {body, #{type => map(), required => false, desc => "HTTP request body."}}
] ++ maps:to_list(maps:without([ base_url ] ++ maps:to_list(maps:without([ base_url
, pool_type], , pool_type],
maps:from_list(connector_fields(http)))). maps:from_list(connector_fields(http)))).
@ -166,6 +166,7 @@ validations() ->
]. ].
headers(type) -> list({binary(), binary()}); headers(type) -> list({binary(), binary()});
headers(desc) -> "List of HTTP headers.";
headers(converter) -> headers(converter) ->
fun(Headers) -> fun(Headers) ->
maps:to_list(maps:merge(default_headers(), transform_header_name(Headers))) maps:to_list(maps:merge(default_headers(), transform_header_name(Headers)))
@ -174,6 +175,7 @@ headers(default) -> default_headers();
headers(_) -> undefined. headers(_) -> undefined.
headers_no_content_type(type) -> list({binary(), binary()}); headers_no_content_type(type) -> list({binary(), binary()});
headers_no_content_type(desc) -> "List of HTTP headers.";
headers_no_content_type(converter) -> headers_no_content_type(converter) ->
fun(Headers) -> fun(Headers) ->
maps:to_list(maps:merge(default_headers_no_content_type(), transform_header_name(Headers))) maps:to_list(maps:merge(default_headers_no_content_type(), transform_header_name(Headers)))
@ -182,6 +184,7 @@ headers_no_content_type(default) -> default_headers_no_content_type();
headers_no_content_type(_) -> undefined. headers_no_content_type(_) -> undefined.
url(type) -> binary(); url(type) -> binary();
url(desc) -> "URL of the auth server.";
url(validator) -> [?NOT_EMPTY("the value of the field 'url' cannot be empty")]; url(validator) -> [?NOT_EMPTY("the value of the field 'url' cannot be empty")];
url(required) -> true; url(required) -> true;
url(_) -> undefined. url(_) -> undefined.