chore: improve swagger tags

This commit is contained in:
Zhongwen Deng 2022-08-17 23:32:19 +08:00
parent b08991cb44
commit 49b95b0aa8
4 changed files with 15 additions and 14 deletions

View File

@ -48,7 +48,7 @@ schema(?PREFIX ++ "/request") ->
#{ #{
operationId => request, operationId => request,
post => #{ post => #{
tags => [<<"CoAP gateway">>], tags => [<<"CoAP">>],
desc => ?DESC(send_coap_request), desc => ?DESC(send_coap_request),
parameters => request_parameters(), parameters => request_parameters(),
requestBody => request_body(), requestBody => request_body(),

View File

@ -43,7 +43,7 @@ schema(?PATH("/lookup")) ->
#{ #{
'operationId' => lookup, 'operationId' => lookup,
get => #{ get => #{
tags => [<<"lwm2m">>], tags => [<<"LwM2M">>],
desc => ?DESC(lookup_resource), desc => ?DESC(lookup_resource),
parameters => [ parameters => [
{clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})}, {clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})},
@ -67,7 +67,7 @@ schema(?PATH("/observe")) ->
#{ #{
'operationId' => observe, 'operationId' => observe,
post => #{ post => #{
tags => [<<"lwm2m">>], tags => [<<"LwM2M">>],
desc => ?DESC(observe_resource), desc => ?DESC(observe_resource),
parameters => [ parameters => [
{clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})}, {clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})},
@ -85,7 +85,7 @@ schema(?PATH("/read")) ->
#{ #{
'operationId' => read, 'operationId' => read,
post => #{ post => #{
tags => [<<"lwm2m">>], tags => [<<"LwM2M">>],
desc => ?DESC(read_resource), desc => ?DESC(read_resource),
parameters => [ parameters => [
{clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})}, {clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})},
@ -102,7 +102,7 @@ schema(?PATH("/write")) ->
'operationId' => write, 'operationId' => write,
post => #{ post => #{
desc => ?DESC(write_resource), desc => ?DESC(write_resource),
tags => [<<"lwm2m">>], tags => [<<"LwM2M">>],
parameters => [ parameters => [
{clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})}, {clientid, mk(binary(), #{in => path, example => "urn:oma:lwm2m:oma:2"})},
{path, mk(binary(), #{in => query, required => true, example => "/3/0/7"})}, {path, mk(binary(), #{in => query, required => true, example => "/3/0/7"})},

View File

@ -37,6 +37,7 @@
-define(PREFIX_RESET, "/configs_reset/"). -define(PREFIX_RESET, "/configs_reset/").
-define(ERR_MSG(MSG), list_to_binary(io_lib:format("~p", [MSG]))). -define(ERR_MSG(MSG), list_to_binary(io_lib:format("~p", [MSG]))).
-define(OPTS, #{rawconf_with_defaults => true, override_to => cluster}). -define(OPTS, #{rawconf_with_defaults => true, override_to => cluster}).
-define(TAGS, ["Configs"]).
-define(EXCLUDES, -define(EXCLUDES,
[ [
@ -85,7 +86,7 @@ schema("/configs") ->
#{ #{
'operationId' => configs, 'operationId' => configs,
get => #{ get => #{
tags => [conf], tags => ?TAGS,
description => description =>
<<"Get all the configurations of the specified node, including hot and non-hot updatable items.">>, <<"Get all the configurations of the specified node, including hot and non-hot updatable items.">>,
parameters => [ parameters => [
@ -111,7 +112,7 @@ schema("/configs_reset/:rootname") ->
#{ #{
'operationId' => config_reset, 'operationId' => config_reset,
post => #{ post => #{
tags => [conf], tags => ?TAGS,
description => description =>
<< <<
"Reset the config entry specified by the query string parameter `conf_path`.</br>\n" "Reset the config entry specified by the query string parameter `conf_path`.</br>\n"
@ -149,12 +150,12 @@ schema("/configs/global_zone") ->
#{ #{
'operationId' => global_zone_configs, 'operationId' => global_zone_configs,
get => #{ get => #{
tags => [conf], tags => ?TAGS,
description => <<"Get the global zone configs">>, description => <<"Get the global zone configs">>,
responses => #{200 => Schema} responses => #{200 => Schema}
}, },
put => #{ put => #{
tags => [conf], tags => ?TAGS,
description => <<"Update globbal zone configs">>, description => <<"Update globbal zone configs">>,
'requestBody' => Schema, 'requestBody' => Schema,
responses => #{ responses => #{
@ -180,7 +181,7 @@ schema("/configs/global_zone") ->
%% #{ %% #{
%% 'operationId' => config, %% 'operationId' => config,
%% get => #{ %% get => #{
%% tags => [conf], %% tags => ?TAGS,
%% description => <<"Get config of this limiter">>, %% description => <<"Get config of this limiter">>,
%% parameters => Parameters, %% parameters => Parameters,
%% responses => #{ %% responses => #{
@ -189,7 +190,7 @@ schema("/configs/global_zone") ->
%% } %% }
%% }, %% },
%% put => #{ %% put => #{
%% tags => [conf], %% tags => ?TAGS,
%% description => <<"Update config of this limiter">>, %% description => <<"Update config of this limiter">>,
%% parameters => Parameters, %% parameters => Parameters,
%% 'requestBody' => Schema, %% 'requestBody' => Schema,
@ -204,7 +205,7 @@ schema(Path) ->
#{ #{
'operationId' => config, 'operationId' => config,
get => #{ get => #{
tags => [conf], tags => ?TAGS,
description => iolist_to_binary([ description => iolist_to_binary([
<<"Get the sub-configurations under *">>, <<"Get the sub-configurations under *">>,
RootKey, RootKey,
@ -216,7 +217,7 @@ schema(Path) ->
} }
}, },
put => #{ put => #{
tags => [conf], tags => ?TAGS,
description => iolist_to_binary([ description => iolist_to_binary([
<<"Update the sub-configurations under *">>, <<"Update the sub-configurations under *">>,
RootKey, RootKey,

View File

@ -20,5 +20,5 @@
%% Interval for reporting telemetry data, Default: 7d %% Interval for reporting telemetry data, Default: 7d
-define(REPORT_INTERVAL, 604800). -define(REPORT_INTERVAL, 604800).
-define(API_TAG_MQTT, [<<"mqtt">>]). -define(API_TAG_MQTT, [<<"MQTT">>]).
-define(API_SCHEMA_MODULE, emqx_modules_schema). -define(API_SCHEMA_MODULE, emqx_modules_schema).