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

Merge pull request #10196 from sstrigler/EMQX-9201-the-case-is-not-correct-for-some-of-menu 

Emqx 9201 the case is not correct for some of menu
This commit is contained in:
Stefan Strigler 2023-03-21 19:42:10 +01:00 committed by GitHub
parent 4bbbaf8b13 394a455903
commit 6c24b3a77d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 84 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
apps/emqx_bridge/src/emqx_bridge_api.erl
View File

@ -316,7 +316,7 @@ schema("/bridges") ->
'operationId' => '/bridges', 'operationId' => '/bridges',
get => #{ get => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"List Bridges">>, summary => <<"List bridges">>,
description => ?DESC("desc_api1"), description => ?DESC("desc_api1"),
responses => #{ responses => #{
200 => emqx_dashboard_swagger:schema_with_example( 200 => emqx_dashboard_swagger:schema_with_example(
@ -327,7 +327,7 @@ schema("/bridges") ->
}, },
post => #{ post => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Create Bridge">>, summary => <<"Create bridge">>,
description => ?DESC("desc_api2"), description => ?DESC("desc_api2"),
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
emqx_bridge_schema:post_request(), emqx_bridge_schema:post_request(),
@ -344,7 +344,7 @@ schema("/bridges/:id") ->
'operationId' => '/bridges/:id', 'operationId' => '/bridges/:id',
get => #{ get => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Get Bridge">>, summary => <<"Get bridge">>,
description => ?DESC("desc_api3"), description => ?DESC("desc_api3"),
parameters => [param_path_id()], parameters => [param_path_id()],
responses => #{ responses => #{
@ -354,7 +354,7 @@ schema("/bridges/:id") ->
}, },
put => #{ put => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Update Bridge">>, summary => <<"Update bridge">>,
description => ?DESC("desc_api4"), description => ?DESC("desc_api4"),
parameters => [param_path_id()], parameters => [param_path_id()],
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
@ -369,7 +369,7 @@ schema("/bridges/:id") ->
}, },
delete => #{ delete => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Delete Bridge">>, summary => <<"Delete bridge">>,
description => ?DESC("desc_api5"), description => ?DESC("desc_api5"),
parameters => [param_path_id()], parameters => [param_path_id()],
responses => #{ responses => #{
@ -388,7 +388,7 @@ schema("/bridges/:id/metrics") ->
'operationId' => '/bridges/:id/metrics', 'operationId' => '/bridges/:id/metrics',
get => #{ get => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Get Bridge Metrics">>, summary => <<"Get bridge metrics">>,
description => ?DESC("desc_bridge_metrics"), description => ?DESC("desc_bridge_metrics"),
parameters => [param_path_id()], parameters => [param_path_id()],
responses => #{ responses => #{
@ -402,7 +402,7 @@ schema("/bridges/:id/metrics/reset") ->
'operationId' => '/bridges/:id/metrics/reset', 'operationId' => '/bridges/:id/metrics/reset',
put => #{ put => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Reset Bridge Metrics">>, summary => <<"Reset bridge metrics">>,
description => ?DESC("desc_api6"), description => ?DESC("desc_api6"),
parameters => [param_path_id()], parameters => [param_path_id()],
responses => #{ responses => #{
@ -417,7 +417,7 @@ schema("/bridges/:id/enable/:enable") ->
put => put =>
#{ #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Enable or Disable Bridge">>, summary => <<"Enable or disable bridge">>,
desc => ?DESC("desc_enable_bridge"), desc => ?DESC("desc_enable_bridge"),
parameters => [param_path_id(), param_path_enable()], parameters => [param_path_id(), param_path_enable()],
responses => responses =>
@ -433,7 +433,7 @@ schema("/bridges/:id/:operation") ->
'operationId' => '/bridges/:id/:operation', 'operationId' => '/bridges/:id/:operation',
post => #{ post => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Stop or Restart Bridge">>, summary => <<"Stop or restart bridge">>,
description => ?DESC("desc_api7"), description => ?DESC("desc_api7"),
parameters => [ parameters => [
param_path_id(), param_path_id(),
@ -455,7 +455,7 @@ schema("/nodes/:node/bridges/:id/:operation") ->
'operationId' => '/nodes/:node/bridges/:id/:operation', 'operationId' => '/nodes/:node/bridges/:id/:operation',
post => #{ post => #{
tags => [<<"bridges">>], tags => [<<"bridges">>],
summary => <<"Stop/Restart Bridge">>, summary => <<"Stop/Restart bridge">>,
description => ?DESC("desc_api8"), description => ?DESC("desc_api8"),
parameters => [ parameters => [
param_path_node(), param_path_node(),

2
apps/emqx_dashboard/src/emqx_dashboard_api.erl
View File

@ -74,7 +74,7 @@ schema("/login") ->
post => #{ post => #{
tags => [<<"dashboard">>], tags => [<<"dashboard">>],
desc => ?DESC(login_api), desc => ?DESC(login_api),
summary => <<"Dashboard Auth">>, summary => <<"Dashboard authentication">>,
'requestBody' => fields([username, password]), 'requestBody' => fields([username, password]),
responses => #{ responses => #{
200 => fields([token, version, license]), 200 => fields([token, version, license]),

24
apps/emqx_gateway/src/emqx_gateway_api.erl
View File

@ -180,7 +180,7 @@ schema("/gateways") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(list_gateway), desc => ?DESC(list_gateway),
summary => <<"List All Gateways">>, summary => <<"List all gateways">>,
parameters => params_gateway_status_in_qs(), parameters => params_gateway_status_in_qs(),
responses => responses =>
#{ #{
@ -201,7 +201,7 @@ schema("/gateways/:name") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_gateway), desc => ?DESC(get_gateway),
summary => <<"Get the Gateway">>, summary => <<"Get gateway">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
responses => responses =>
#{ #{
@ -608,7 +608,7 @@ examples_gateway_confs() ->
#{ #{
stomp_gateway => stomp_gateway =>
#{ #{
summary => <<"A simple STOMP gateway configs">>, summary => <<"A simple STOMP gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -636,7 +636,7 @@ examples_gateway_confs() ->
}, },
mqttsn_gateway => mqttsn_gateway =>
#{ #{
summary => <<"A simple MQTT-SN gateway configs">>, summary => <<"A simple MQTT-SN gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -672,7 +672,7 @@ examples_gateway_confs() ->
}, },
coap_gateway => coap_gateway =>
#{ #{
summary => <<"A simple CoAP gateway configs">>, summary => <<"A simple CoAP gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -699,7 +699,7 @@ examples_gateway_confs() ->
}, },
lwm2m_gateway => lwm2m_gateway =>
#{ #{
summary => <<"A simple LwM2M gateway configs">>, summary => <<"A simple LwM2M gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -735,7 +735,7 @@ examples_gateway_confs() ->
}, },
exproto_gateway => exproto_gateway =>
#{ #{
summary => <<"A simple ExProto gateway configs">>, summary => <<"A simple ExProto gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -765,7 +765,7 @@ examples_update_gateway_confs() ->
#{ #{
stomp_gateway => stomp_gateway =>
#{ #{
summary => <<"A simple STOMP gateway configs">>, summary => <<"A simple STOMP gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -782,7 +782,7 @@ examples_update_gateway_confs() ->
}, },
mqttsn_gateway => mqttsn_gateway =>
#{ #{
summary => <<"A simple MQTT-SN gateway configs">>, summary => <<"A simple MQTT-SN gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -803,7 +803,7 @@ examples_update_gateway_confs() ->
}, },
coap_gateway => coap_gateway =>
#{ #{
summary => <<"A simple CoAP gateway configs">>, summary => <<"A simple CoAP gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -819,7 +819,7 @@ examples_update_gateway_confs() ->
}, },
lwm2m_gateway => lwm2m_gateway =>
#{ #{
summary => <<"A simple LwM2M gateway configs">>, summary => <<"A simple LwM2M gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,
@ -844,7 +844,7 @@ examples_update_gateway_confs() ->
}, },
exproto_gateway => exproto_gateway =>
#{ #{
summary => <<"A simple ExProto gateway configs">>, summary => <<"A simple ExProto gateway config">>,
value => value =>
#{ #{
enable => true, enable => true,

20
apps/emqx_gateway/src/emqx_gateway_api_authn.erl
View File

@ -185,13 +185,13 @@ schema("/gateways/:name/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_authn), desc => ?DESC(get_authn),
summary => <<"Get Authenticator Configuration">>, summary => <<"Get authenticator configuration">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
responses => responses =>
?STANDARD_RESP( ?STANDARD_RESP(
#{ #{
200 => schema_authn(), 200 => schema_authn(),
204 => <<"Authenticator doesn't initiated">> 204 => <<"Authenticator not initialized">>
} }
) )
}, },
@ -199,7 +199,7 @@ schema("/gateways/:name/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(update_authn), desc => ?DESC(update_authn),
summary => <<"Update Authenticator Configuration">>, summary => <<"Update authenticator configuration">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
'requestBody' => schema_authn(), 'requestBody' => schema_authn(),
responses => responses =>
@ -209,7 +209,7 @@ schema("/gateways/:name/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(add_authn), desc => ?DESC(add_authn),
summary => <<"Create an Authenticator for a Gateway">>, summary => <<"Create authenticator for gateway">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
'requestBody' => schema_authn(), 'requestBody' => schema_authn(),
responses => responses =>
@ -219,7 +219,7 @@ schema("/gateways/:name/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(delete_authn), desc => ?DESC(delete_authn),
summary => <<"Delete the Gateway Authenticator">>, summary => <<"Delete gateway authenticator">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
responses => responses =>
?STANDARD_RESP(#{204 => <<"Deleted">>}) ?STANDARD_RESP(#{204 => <<"Deleted">>})
@ -232,7 +232,7 @@ schema("/gateways/:name/authentication/users") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(list_users), desc => ?DESC(list_users),
summary => <<"List users for a Gateway Authenticator">>, summary => <<"List users for gateway authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_paging_in_qs() ++ params_paging_in_qs() ++
params_fuzzy_in_qs(), params_fuzzy_in_qs(),
@ -250,7 +250,7 @@ schema("/gateways/:name/authentication/users") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(add_user), desc => ?DESC(add_user),
summary => <<"Add User for a Gateway Authenticator">>, summary => <<"Add user for gateway authenticator">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
ref(emqx_authn_api, request_user_create), ref(emqx_authn_api, request_user_create),
@ -274,7 +274,7 @@ schema("/gateways/:name/authentication/users/:uid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_user), desc => ?DESC(get_user),
summary => <<"Get User Info for a Gateway Authenticator">>, summary => <<"Get user info for gateway authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_userid_in_path(), params_userid_in_path(),
responses => responses =>
@ -291,7 +291,7 @@ schema("/gateways/:name/authentication/users/:uid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(update_user), desc => ?DESC(update_user),
summary => <<"Update User Info for a Gateway Authenticator">>, summary => <<"Update user info for gateway authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_userid_in_path(), params_userid_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
@ -312,7 +312,7 @@ schema("/gateways/:name/authentication/users/:uid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(delete_user), desc => ?DESC(delete_user),
summary => <<"Delete User for a Gateway Authenticator">>, summary => <<"Delete user for gateway authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_userid_in_path(), params_userid_in_path(),
responses => responses =>

4
apps/emqx_gateway/src/emqx_gateway_api_authn_user_import.erl
View File

@ -126,7 +126,7 @@ schema("/gateways/:name/authentication/import_users") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(emqx_gateway_api_authn, import_users), desc => ?DESC(emqx_gateway_api_authn, import_users),
summary => <<"Import Users">>, summary => <<"Import users">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
'requestBody' => emqx_dashboard_swagger:file_schema(filename), 'requestBody' => emqx_dashboard_swagger:file_schema(filename),
responses => responses =>
@ -140,7 +140,7 @@ schema("/gateways/:name/listeners/:id/authentication/import_users") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(emqx_gateway_api_listeners, import_users), desc => ?DESC(emqx_gateway_api_listeners, import_users),
summary => <<"Import Users">>, summary => <<"Import users">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
'requestBody' => emqx_dashboard_swagger:file_schema(filename), 'requestBody' => emqx_dashboard_swagger:file_schema(filename),

28
apps/emqx_gateway/src/emqx_gateway_api_clients.erl
View File

@ -460,7 +460,7 @@ schema("/gateways/:name/clients") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(list_clients), desc => ?DESC(list_clients),
summary => <<"List Gateway's Clients">>, summary => <<"List gateway's clients">>,
parameters => params_client_query(), parameters => params_client_query(),
responses => responses =>
?STANDARD_RESP(#{ ?STANDARD_RESP(#{
@ -478,7 +478,7 @@ schema("/gateways/:name/clients/:clientid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_client), desc => ?DESC(get_client),
summary => <<"Get Client Info">>, summary => <<"Get client info">>,
parameters => params_client_insta(), parameters => params_client_insta(),
responses => responses =>
?STANDARD_RESP(#{200 => schema_client()}) ?STANDARD_RESP(#{200 => schema_client()})
@ -487,7 +487,7 @@ schema("/gateways/:name/clients/:clientid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(kick_client), desc => ?DESC(kick_client),
summary => <<"Kick out Client">>, summary => <<"Kick out client">>,
parameters => params_client_insta(), parameters => params_client_insta(),
responses => responses =>
?STANDARD_RESP(#{204 => <<"Kicked">>}) ?STANDARD_RESP(#{204 => <<"Kicked">>})
@ -500,7 +500,7 @@ schema("/gateways/:name/clients/:clientid/subscriptions") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(list_subscriptions), desc => ?DESC(list_subscriptions),
summary => <<"List Client's Subscription">>, summary => <<"List client's subscription">>,
parameters => params_client_insta(), parameters => params_client_insta(),
responses => responses =>
?STANDARD_RESP( ?STANDARD_RESP(
@ -516,7 +516,7 @@ schema("/gateways/:name/clients/:clientid/subscriptions") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(add_subscription), desc => ?DESC(add_subscription),
summary => <<"Add Subscription for Client">>, summary => <<"Add subscription for client">>,
parameters => params_client_insta(), parameters => params_client_insta(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
ref(subscription), ref(subscription),
@ -540,7 +540,7 @@ schema("/gateways/:name/clients/:clientid/subscriptions/:topic") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(delete_subscription), desc => ?DESC(delete_subscription),
summary => <<"Delete Client's Subscription">>, summary => <<"Delete client's subscription">>,
parameters => params_topic_name_in_path() ++ params_client_insta(), parameters => params_topic_name_in_path() ++ params_client_insta(),
responses => responses =>
?STANDARD_RESP(#{204 => <<"Unsubscribed">>}) ?STANDARD_RESP(#{204 => <<"Unsubscribed">>})
@ -1020,12 +1020,12 @@ examples_client_list() ->
#{ #{
general_client_list => general_client_list =>
#{ #{
summary => <<"General Client List">>, summary => <<"General client list">>,
value => [example_general_client()] value => [example_general_client()]
}, },
lwm2m_client_list => lwm2m_client_list =>
#{ #{
summary => <<"LwM2M Client List">>, summary => <<"LwM2M client list">>,
value => [example_lwm2m_client()] value => [example_lwm2m_client()]
} }
}. }.
@ -1034,12 +1034,12 @@ examples_client() ->
#{ #{
general_client => general_client =>
#{ #{
summary => <<"General Client Info">>, summary => <<"General client info">>,
value => example_general_client() value => example_general_client()
}, },
lwm2m_client => lwm2m_client =>
#{ #{
summary => <<"LwM2M Client Info">>, summary => <<"LwM2M client info">>,
value => example_lwm2m_client() value => example_lwm2m_client()
} }
}. }.
@ -1048,12 +1048,12 @@ examples_subscription_list() ->
#{ #{
general_subscription_list => general_subscription_list =>
#{ #{
summary => <<"A General Subscription List">>, summary => <<"A general subscription list">>,
value => [example_general_subscription()] value => [example_general_subscription()]
}, },
stomp_subscription_list => stomp_subscription_list =>
#{ #{
summary => <<"The Stomp Subscription List">>, summary => <<"The STOMP subscription list">>,
value => [example_stomp_subscription] value => [example_stomp_subscription]
} }
}. }.
@ -1062,12 +1062,12 @@ examples_subscription() ->
#{ #{
general_subscription => general_subscription =>
#{ #{
summary => <<"A General Subscription">>, summary => <<"A general subscription">>,
value => example_general_subscription() value => example_general_subscription()
}, },
stomp_subscription => stomp_subscription =>
#{ #{
summary => <<"A Stomp Subscription">>, summary => <<"A STOMP subscription">>,
value => example_stomp_subscription() value => example_stomp_subscription()
} }
}. }.

40
apps/emqx_gateway/src/emqx_gateway_api_listeners.erl
View File

@ -362,7 +362,7 @@ schema("/gateways/:name/listeners") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(list_listeners), desc => ?DESC(list_listeners),
summary => <<"List All Listeners">>, summary => <<"List all listeners">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
responses => responses =>
?STANDARD_RESP( ?STANDARD_RESP(
@ -378,7 +378,7 @@ schema("/gateways/:name/listeners") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(add_listener), desc => ?DESC(add_listener),
summary => <<"Add a Listener">>, summary => <<"Add listener">>,
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
%% XXX: How to distinguish the different listener supported by %% XXX: How to distinguish the different listener supported by
%% different types of gateways? %% different types of gateways?
@ -404,7 +404,7 @@ schema("/gateways/:name/listeners/:id") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_listener), desc => ?DESC(get_listener),
summary => <<"Get the Listener Configs">>, summary => <<"Get listener config">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
responses => responses =>
@ -421,7 +421,7 @@ schema("/gateways/:name/listeners/:id") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(delete_listener), desc => ?DESC(delete_listener),
summary => <<"Delete the Listener">>, summary => <<"Delete listener">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
responses => responses =>
@ -431,7 +431,7 @@ schema("/gateways/:name/listeners/:id") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(update_listener), desc => ?DESC(update_listener),
summary => <<"Update the Listener Configs">>, summary => <<"Update listener config">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
@ -456,7 +456,7 @@ schema("/gateways/:name/listeners/:id/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_listener_authn), desc => ?DESC(get_listener_authn),
summary => <<"Get the Listener's Authenticator">>, summary => <<"Get the listener's authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
responses => responses =>
@ -471,7 +471,7 @@ schema("/gateways/:name/listeners/:id/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(add_listener_authn), desc => ?DESC(add_listener_authn),
summary => <<"Create an Authenticator for a Listener">>, summary => <<"Create authenticator for listener">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
'requestBody' => schema_authn(), 'requestBody' => schema_authn(),
@ -482,7 +482,7 @@ schema("/gateways/:name/listeners/:id/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(update_listener_authn), desc => ?DESC(update_listener_authn),
summary => <<"Update the Listener Authenticator configs">>, summary => <<"Update config of authenticator for listener">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
'requestBody' => schema_authn(), 'requestBody' => schema_authn(),
@ -493,7 +493,7 @@ schema("/gateways/:name/listeners/:id/authentication") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(delete_listener_authn), desc => ?DESC(delete_listener_authn),
summary => <<"Delete the Listener's Authenticator">>, summary => <<"Delete the listener's authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
responses => responses =>
@ -507,7 +507,7 @@ schema("/gateways/:name/listeners/:id/authentication/users") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(list_users), desc => ?DESC(list_users),
summary => <<"List Authenticator's Users">>, summary => <<"List authenticator's users">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path() ++ params_listener_id_in_path() ++
params_paging_in_qs(), params_paging_in_qs(),
@ -525,7 +525,7 @@ schema("/gateways/:name/listeners/:id/authentication/users") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(add_user), desc => ?DESC(add_user),
summary => <<"Add User for an Authenticator">>, summary => <<"Add user for an authenticator">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path(), params_listener_id_in_path(),
'requestBody' => emqx_dashboard_swagger:schema_with_examples( 'requestBody' => emqx_dashboard_swagger:schema_with_examples(
@ -550,7 +550,7 @@ schema("/gateways/:name/listeners/:id/authentication/users/:uid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(get_user), desc => ?DESC(get_user),
summary => <<"Get User Info">>, summary => <<"Get user info">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path() ++ params_listener_id_in_path() ++
params_userid_in_path(), params_userid_in_path(),
@ -568,7 +568,7 @@ schema("/gateways/:name/listeners/:id/authentication/users/:uid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(update_user), desc => ?DESC(update_user),
summary => <<"Update User Info">>, summary => <<"Update user info">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path() ++ params_listener_id_in_path() ++
params_userid_in_path(), params_userid_in_path(),
@ -590,7 +590,7 @@ schema("/gateways/:name/listeners/:id/authentication/users/:uid") ->
#{ #{
tags => ?TAGS, tags => ?TAGS,
desc => ?DESC(delete_user), desc => ?DESC(delete_user),
summary => <<"Delete User">>, summary => <<"Delete user">>,
parameters => params_gateway_name_in_path() ++ parameters => params_gateway_name_in_path() ++
params_listener_id_in_path() ++ params_listener_id_in_path() ++
params_userid_in_path(), params_userid_in_path(),
@ -712,7 +712,7 @@ examples_listener() ->
#{ #{
tcp_listener => tcp_listener =>
#{ #{
summary => <<"A simple tcp listener example">>, summary => <<"A simple TCP listener example">>,
value => value =>
#{ #{
name => <<"tcp-def">>, name => <<"tcp-def">>,
@ -738,7 +738,7 @@ examples_listener() ->
}, },
ssl_listener => ssl_listener =>
#{ #{
summary => <<"A simple ssl listener example">>, summary => <<"A simple SSL listener example">>,
value => value =>
#{ #{
name => <<"ssl-def">>, name => <<"ssl-def">>,
@ -771,7 +771,7 @@ examples_listener() ->
}, },
udp_listener => udp_listener =>
#{ #{
summary => <<"A simple udp listener example">>, summary => <<"A simple UDP listener example">>,
value => value =>
#{ #{
name => <<"udp-def">>, name => <<"udp-def">>,
@ -789,7 +789,7 @@ examples_listener() ->
}, },
dtls_listener => dtls_listener =>
#{ #{
summary => <<"A simple dtls listener example">>, summary => <<"A simple DTLS listener example">>,
value => value =>
#{ #{
name => <<"dtls-def">>, name => <<"dtls-def">>,
@ -817,7 +817,7 @@ examples_listener() ->
}, },
dtls_listener_with_psk_ciphers => dtls_listener_with_psk_ciphers =>
#{ #{
summary => <<"A dtls listener with PSK example">>, summary => <<"A DTLS listener with PSK example">>,
value => value =>
#{ #{
name => <<"dtls-psk">>, name => <<"dtls-psk">>,
@ -845,7 +845,7 @@ examples_listener() ->
}, },
lisetner_with_authn => lisetner_with_authn =>
#{ #{
summary => <<"A tcp listener with authentication example">>, summary => <<"A TCP listener with authentication example">>,
value => value =>
#{ #{
name => <<"tcp-with-authn">>, name => <<"tcp-with-authn">>,

10
apps/emqx_modules/i18n/emqx_topic_metrics_api_i18n.conf
View File

@ -1,7 +1,7 @@
emqx_topic_metrics_api { emqx_topic_metrics_api {
get_topic_metrics_api { get_topic_metrics_api {
desc { desc {
en: """List Topic metrics""" en: """List topic metrics"""
zh: """获取主题监控数据""" zh: """获取主题监控数据"""
} }
} }
@ -15,21 +15,21 @@ emqx_topic_metrics_api {
post_topic_metrics_api { post_topic_metrics_api {
desc { desc {
en: """Create Topic metrics""" en: """Create topic metrics"""
zh: """创建主题监控数据""" zh: """创建主题监控数据"""
} }
} }
gat_topic_metrics_data_api { gat_topic_metrics_data_api {
desc { desc {
en: """Get Topic metrics""" en: """Get topic metrics"""
zh: """获取主题监控数据""" zh: """获取主题监控数据"""
} }
} }
delete_topic_metrics_data_api { delete_topic_metrics_data_api {
desc { desc {
en: """Delete Topic metrics""" en: """Delete topic metrics"""
zh: """删除主题监控数据""" zh: """删除主题监控数据"""
} }
} }
@ -43,7 +43,7 @@ emqx_topic_metrics_api {
topic_metrics_api_response400 { topic_metrics_api_response400 {
desc { desc {
en: """Bad Request. Already exists or bad topic name""" en: """Bad request. Already exists or bad topic name"""
zh: """错误请求。已存在或错误的主题名称""" zh: """错误请求。已存在或错误的主题名称"""
} }
} }

18
apps/emqx_rule_engine/src/emqx_rule_engine_api.erl
View File

@ -180,7 +180,7 @@ schema("/rules") ->
ref(emqx_dashboard_swagger, page), ref(emqx_dashboard_swagger, page),
ref(emqx_dashboard_swagger, limit) ref(emqx_dashboard_swagger, limit)
], ],
summary => <<"List Rules">>, summary => <<"List rules">>,
responses => #{ responses => #{
200 => 200 =>
[ [
@ -193,7 +193,7 @@ schema("/rules") ->
post => #{ post => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api2"), description => ?DESC("api2"),
summary => <<"Create a Rule">>, summary => <<"Create a rule">>,
'requestBody' => rule_creation_schema(), 'requestBody' => rule_creation_schema(),
responses => #{ responses => #{
400 => error_schema('BAD_REQUEST', "Invalid Parameters"), 400 => error_schema('BAD_REQUEST', "Invalid Parameters"),
@ -207,7 +207,7 @@ schema("/rule_events") ->
get => #{ get => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api3"), description => ?DESC("api3"),
summary => <<"List Events">>, summary => <<"List rule events">>,
responses => #{ responses => #{
200 => mk(ref(emqx_rule_api_schema, "rule_events"), #{}) 200 => mk(ref(emqx_rule_api_schema, "rule_events"), #{})
} }
@ -219,7 +219,7 @@ schema("/rules/:id") ->
get => #{ get => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api4"), description => ?DESC("api4"),
summary => <<"Get a Rule">>, summary => <<"Get rule">>,
parameters => param_path_id(), parameters => param_path_id(),
responses => #{ responses => #{
404 => error_schema('NOT_FOUND', "Rule not found"), 404 => error_schema('NOT_FOUND', "Rule not found"),
@ -229,7 +229,7 @@ schema("/rules/:id") ->
put => #{ put => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api5"), description => ?DESC("api5"),
summary => <<"Update a Rule">>, summary => <<"Update rule">>,
parameters => param_path_id(), parameters => param_path_id(),
'requestBody' => rule_creation_schema(), 'requestBody' => rule_creation_schema(),
responses => #{ responses => #{
@ -240,7 +240,7 @@ schema("/rules/:id") ->
delete => #{ delete => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api6"), description => ?DESC("api6"),
summary => <<"Delete a Rule">>, summary => <<"Delete rule">>,
parameters => param_path_id(), parameters => param_path_id(),
responses => #{ responses => #{
204 => <<"Delete rule successfully">> 204 => <<"Delete rule successfully">>
@ -253,7 +253,7 @@ schema("/rules/:id/metrics") ->
get => #{ get => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api4_1"), description => ?DESC("api4_1"),
summary => <<"Get a Rule's Metrics">>, summary => <<"Get rule metrics">>,
parameters => param_path_id(), parameters => param_path_id(),
responses => #{ responses => #{
404 => error_schema('NOT_FOUND', "Rule not found"), 404 => error_schema('NOT_FOUND', "Rule not found"),
@ -267,7 +267,7 @@ schema("/rules/:id/metrics/reset") ->
put => #{ put => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api7"), description => ?DESC("api7"),
summary => <<"Reset a Rule Metrics">>, summary => <<"Reset rule metrics">>,
parameters => param_path_id(), parameters => param_path_id(),
responses => #{ responses => #{
404 => error_schema('NOT_FOUND', "Rule not found"), 404 => error_schema('NOT_FOUND', "Rule not found"),
@ -281,7 +281,7 @@ schema("/rule_test") ->
post => #{ post => #{
tags => [<<"rules">>], tags => [<<"rules">>],
description => ?DESC("api8"), description => ?DESC("api8"),
summary => <<"Test a Rule">>, summary => <<"Test a rule">>,
'requestBody' => rule_test_schema(), 'requestBody' => rule_test_schema(),
responses => #{ responses => #{
400 => error_schema('BAD_REQUEST', "Invalid Parameters"), 400 => error_schema('BAD_REQUEST', "Invalid Parameters"),

1
changes/ce/fix-10196.en.md Normal file
View File

@ -0,0 +1 @@
Use lower-case for schema summaries and descritptions to be used in menu of generated online documentation.