feat(ft): add schema descriptions

This commit is contained in:
Ilya Averyanov 2023-02-16 12:28:40 +02:00
parent bc0a15afd7
commit c6b3f2c2ca
2 changed files with 21 additions and 4 deletions

View File

@ -1,6 +1,17 @@
emqx_ft_schema {
local {
storage {
desc {
en: "Storage settings for file transfer."
zh: "文件传输的存储设置。"
}
label: {
en: "Storage settings"
zh: "存储设置"
}
}
local_type {
desc {
en: "Use local file system to store uploaded files and temporary data."
zh: "使用本地文件系统来存储上传的文件和临时数据。"

View File

@ -21,7 +21,7 @@
-include_lib("hocon/include/hoconsc.hrl").
-include_lib("typerefl/include/types.hrl").
-export([namespace/0, roots/0, fields/1, tags/0]).
-export([namespace/0, roots/0, fields/1, tags/0, desc/1]).
-export([schema/1]).
@ -49,7 +49,8 @@ fields(file_transfer) ->
{storage, #{
type => hoconsc:union([
hoconsc:ref(?MODULE, local_storage)
])
]),
desc => ?DESC("storage")
}}
];
fields(local_storage) ->
@ -58,7 +59,7 @@ fields(local_storage) ->
type => local,
default => local,
required => false,
desc => ?DESC("local")
desc => ?DESC("local_type")
}},
{root, #{
type => binary(),
@ -67,6 +68,11 @@ fields(local_storage) ->
}}
].
desc(file_transfer) ->
"File transfer settings";
desc(local_storage) ->
"File transfer local storage settings".
schema(filemeta) ->
#{
roots => [