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

chore: make sure swagger's tags always titlecase 2

This commit is contained in:
Zhongwen Deng 2022-07-25 16:36:36 +08:00
parent cc63479e69
commit a3296078c3
10 changed files with 16 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apps/emqx_authn/src/emqx_authn_api.erl
View File

@ -33,8 +33,8 @@
% Swagger % Swagger
-define(API_TAGS_GLOBAL, [<<"authentication">>]). -define(API_TAGS_GLOBAL, [<<"Authentication">>]).
-define(API_TAGS_SINGLE, [<<"listener authentication">>]). -define(API_TAGS_SINGLE, [<<"Listener authentication">>]).
-export([ -export([
api_spec/0, api_spec/0,

11
apps/emqx_authn/src/emqx_authn_user_import_api.erl
View File

@ -29,15 +29,8 @@
-define(NOT_FOUND, 'NOT_FOUND'). -define(NOT_FOUND, 'NOT_FOUND').
% Swagger % Swagger
-define(API_TAGS_GLOBAL, [<<"authentication">>]).
-define(API_TAGS_GLOBAL, [ -define(API_TAGS_SINGLE, [<<"listener authentication">>]).
?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME_BINARY,
<<"authentication">>
]).
-define(API_TAGS_SINGLE, [
?EMQX_AUTHENTICATION_CONFIG_ROOT_NAME_BINARY,
<<"listener authentication">>
]).
-export([ -export([
api_spec/0, api_spec/0,

4
apps/emqx_dashboard/src/emqx_dashboard_error_code_api.erl
View File

@ -51,7 +51,7 @@ schema("/error_codes") ->
get => #{ get => #{
security => [], security => [],
description => <<"API Error Codes">>, description => <<"API Error Codes">>,
tags => [<<"Error Codes">>], tags => [<<"Error codes">>],
responses => #{ responses => #{
200 => hoconsc:array(hoconsc:ref(?MODULE, error_code)) 200 => hoconsc:array(hoconsc:ref(?MODULE, error_code))
} }
@ -63,7 +63,7 @@ schema("/error_codes/:code") ->
get => #{ get => #{
security => [], security => [],
description => <<"API Error Codes">>, description => <<"API Error Codes">>,
tags => [<<"Error Codes">>], tags => [<<"Error codes">>],
parameters => [ parameters => [
{code, {code,
hoconsc:mk(hoconsc:enum(emqx_dashboard_error_code:all()), #{ hoconsc:mk(hoconsc:enum(emqx_dashboard_error_code:all()), #{

8
apps/emqx_dashboard/src/emqx_dashboard_monitor_api.erl
View File

@ -37,7 +37,7 @@ schema("/monitor") ->
#{ #{
'operationId' => monitor, 'operationId' => monitor,
get => #{ get => #{
tags => [<<"metrics">>], tags => [<<"Metrics">>],
desc => <<"List monitor data.">>, desc => <<"List monitor data.">>,
parameters => [parameter_latest()], parameters => [parameter_latest()],
responses => #{ responses => #{
@ -50,7 +50,7 @@ schema("/monitor/nodes/:node") ->
#{ #{
'operationId' => monitor, 'operationId' => monitor,
get => #{ get => #{
tags => [<<"metrics">>], tags => [<<"Metrics">>],
desc => <<"List the monitor data on the node.">>, desc => <<"List the monitor data on the node.">>,
parameters => [parameter_node(), parameter_latest()], parameters => [parameter_node(), parameter_latest()],
responses => #{ responses => #{
@ -63,7 +63,7 @@ schema("/monitor_current") ->
#{ #{
'operationId' => monitor_current, 'operationId' => monitor_current,
get => #{ get => #{
tags => [<<"metrics">>], tags => [<<"Metrics">>],
desc => <<"Current status. Gauge and rate.">>, desc => <<"Current status. Gauge and rate.">>,
responses => #{ responses => #{
200 => hoconsc:mk(hoconsc:ref(sampler_current), #{}) 200 => hoconsc:mk(hoconsc:ref(sampler_current), #{})
@ -74,7 +74,7 @@ schema("/monitor_current/nodes/:node") ->
#{ #{
'operationId' => monitor_current, 'operationId' => monitor_current,
get => #{ get => #{
tags => [<<"metrics">>], tags => [<<"Metrics">>],
desc => <<"Node current status. Gauge and rate.">>, desc => <<"Node current status. Gauge and rate.">>,
parameters => [parameter_node()], parameters => [parameter_node()],
responses => #{ responses => #{

2
apps/emqx_gateway/src/coap/emqx_coap_api.erl
View File

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

2
apps/emqx_management/src/emqx_mgmt_api_alarms.erl
View File

@ -26,7 +26,7 @@
-export([alarms/2]). -export([alarms/2]).
-define(TAGS, [<<"alarms">>]). -define(TAGS, [<<"Alarms">>]).
%% internal export (for query) %% internal export (for query)
-export([query/4]). -export([query/4]).

2
apps/emqx_management/src/emqx_mgmt_api_stats.erl
View File

@ -50,7 +50,7 @@ schema("/stats") ->
get => get =>
#{ #{
description => <<"EMQX stats">>, description => <<"EMQX stats">>,
tags => [<<"metrics">>], tags => [<<"Metrics">>],
parameters => [ref(aggregate)], parameters => [ref(aggregate)],
responses => responses =>
#{ #{

2
apps/emqx_management/src/emqx_mgmt_api_sys.erl
View File

@ -31,7 +31,7 @@
-export([sys/2]). -export([sys/2]).
-define(TAGS, [<<"system topics">>]). -define(TAGS, [<<"System topics">>]).
namespace() -> "sys". namespace() -> "sys".

2
apps/emqx_prometheus/src/emqx_prometheus_api.erl
View File

@ -34,7 +34,7 @@
]). ]).
-define(SCHEMA_MODULE, emqx_prometheus_schema). -define(SCHEMA_MODULE, emqx_prometheus_schema).
-define(TAGS, [<<"monitor">>]). -define(TAGS, [<<"Monitor">>]).
api_spec() -> api_spec() ->
emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}). emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).

2
apps/emqx_statsd/src/emqx_statsd_api.erl
View File

@ -32,7 +32,7 @@
schema/1 schema/1
]). ]).
-define(API_TAG_STATSD, [<<"monitor">>]). -define(API_TAG_STATSD, [<<"Monitor">>]).
-define(SCHEMA_MODULE, emqx_statsd_schema). -define(SCHEMA_MODULE, emqx_statsd_schema).
-define(INTERNAL_ERROR, 'INTERNAL_ERROR'). -define(INTERNAL_ERROR, 'INTERNAL_ERROR').