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

Merge pull request #11088 from fix/EMQX-10068/nicer-doc-tags 

fix(ft-api): make schema tags look nicer in the docs
This commit is contained in:
Andrew Mayorov 2023-06-19 16:00:04 +02:00 committed by GitHub
parent 7f1e8baa76 ae5846be29
commit af7b7ebf7c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
apps/emqx_ft/src/emqx_ft_api.erl
View File

@ -19,6 +19,7 @@
-include_lib("typerefl/include/types.hrl"). -include_lib("typerefl/include/types.hrl").
-include_lib("hocon/include/hoconsc.hrl"). -include_lib("hocon/include/hoconsc.hrl").
-include("emqx_ft_api.hrl").
%% Swagger specs from hocon schema %% Swagger specs from hocon schema
-export([ -export([
@ -61,7 +62,7 @@ schema("/file_transfer/files") ->
#{ #{
'operationId' => '/file_transfer/files', 'operationId' => '/file_transfer/files',
get => #{ get => #{
tags => [<<"file_transfer">>], tags => ?TAGS,
summary => <<"List all uploaded files">>, summary => <<"List all uploaded files">>,
description => ?DESC("file_list"), description => ?DESC("file_list"),
parameters => [ parameters => [
@ -83,7 +84,7 @@ schema("/file_transfer/files/:clientid/:fileid") ->
#{ #{
'operationId' => '/file_transfer/files/:clientid/:fileid', 'operationId' => '/file_transfer/files/:clientid/:fileid',
get => #{ get => #{
tags => [<<"file_transfer">>], tags => ?TAGS,
summary => <<"List files uploaded in a specific transfer">>, summary => <<"List files uploaded in a specific transfer">>,
description => ?DESC("file_list_transfer"), description => ?DESC("file_list_transfer"),
parameters => [ parameters => [

10
apps/emqx_ft/src/emqx_ft_api.hrl Normal file
View File

@ -0,0 +1,10 @@
%%--------------------------------------------------------------------
%% Copyright (c) 2023 EMQ Technologies Co., Ltd. All Rights Reserved.
%%--------------------------------------------------------------------
-ifndef(__EMQX_FT_API__).
-define(__EMQX_FT_API__, 42).
-define(TAGS, [<<"File Transfer">>]).
-endif.

3
apps/emqx_ft/src/emqx_ft_storage_exporter_fs_api.erl
View File

@ -21,6 +21,7 @@
-include_lib("typerefl/include/types.hrl"). -include_lib("typerefl/include/types.hrl").
-include_lib("hocon/include/hoconsc.hrl"). -include_lib("hocon/include/hoconsc.hrl").
-include_lib("emqx/include/logger.hrl"). -include_lib("emqx/include/logger.hrl").
-include("emqx_ft_api.hrl").
%% Swagger specs from hocon schema %% Swagger specs from hocon schema
-export([ -export([
@ -60,7 +61,7 @@ schema("/file_transfer/file") ->
#{ #{
'operationId' => '/file_transfer/file', 'operationId' => '/file_transfer/file',
get => #{ get => #{
tags => [<<"file_transfer">>], tags => ?TAGS,
summary => <<"Download a particular file">>, summary => <<"Download a particular file">>,
description => ?DESC("file_get"), description => ?DESC("file_get"),
parameters => [ parameters => [