diff --git a/apps/emqx_gateway/src/emqx_gateway_api.erl b/apps/emqx_gateway/src/emqx_gateway_api.erl index 5036286b4..7bf52b4ec 100644 --- a/apps/emqx_gateway/src/emqx_gateway_api.erl +++ b/apps/emqx_gateway/src/emqx_gateway_api.erl @@ -210,6 +210,7 @@ params_gateway_name_in_path() -> mk(binary(), #{ in => path , desc => <<"Gateway Name">> + , example => <<"">> })} ]. @@ -220,6 +221,7 @@ params_gateway_status_in_qs() -> #{ in => query , nullable => true , desc => <<"Gateway Status">> + , example => <<"">> })} ]. diff --git a/apps/emqx_gateway/src/emqx_gateway_api_authn.erl b/apps/emqx_gateway/src/emqx_gateway_api_authn.erl index d9bdf4d7c..701890633 100644 --- a/apps/emqx_gateway/src/emqx_gateway_api_authn.erl +++ b/apps/emqx_gateway/src/emqx_gateway_api_authn.erl @@ -272,6 +272,7 @@ params_gateway_name_in_path() -> mk(binary(), #{ in => path , desc => <<"Gateway Name">> + , example => <<"">> })} ]. @@ -279,6 +280,7 @@ params_userid_in_path() -> [{uid, mk(binary(), #{ in => path , desc => <<"User ID">> + , example => <<"">> })} ]. @@ -287,11 +289,13 @@ params_paging_in_qs() -> #{ in => query , nullable => true , desc => <<"Page Index">> + , example => 1 })}, {limit, mk(integer(), #{ in => query , nullable => true , desc => <<"Page Limit">> + , example => 100 })} ]. diff --git a/apps/emqx_gateway/src/emqx_gateway_api_clients.erl b/apps/emqx_gateway/src/emqx_gateway_api_clients.erl index b67961e12..9fe36d25e 100644 --- a/apps/emqx_gateway/src/emqx_gateway_api_clients.erl +++ b/apps/emqx_gateway/src/emqx_gateway_api_clients.erl @@ -475,7 +475,7 @@ params_client_insta() -> ++ params_gateway_name_in_path(). params_client_searching_in_qs() -> - M = #{in => query, nullable => true}, + M = #{in => query, nullable => true, example => <<"">>}, [ {node, mk(binary(), M#{desc => <<"Match the client's node name">>})} @@ -526,12 +526,16 @@ params_paging() -> mk(integer(), #{ in => query , nullable => true - , desc => <<"Page Index">>})} - , {limit, - mk(integer(), - #{ in => query - , desc => <<"Page Limit">> - , nullable => true})} + , desc => <<"Page Index">> + , example => 1 + })} + , {limit, + mk(integer(), + #{ in => query + , desc => <<"Page Limit">> + , nullable => true + , example => 100 + })} ]. params_gateway_name_in_path() -> diff --git a/apps/emqx_gateway/src/emqx_gateway_api_listeners.erl b/apps/emqx_gateway/src/emqx_gateway_api_listeners.erl index 142469313..fbf923700 100644 --- a/apps/emqx_gateway/src/emqx_gateway_api_listeners.erl +++ b/apps/emqx_gateway/src/emqx_gateway_api_listeners.erl @@ -410,6 +410,7 @@ params_gateway_name_in_path() -> mk(binary(), #{ in => path , desc => <<"Gateway Name">> + , example => <<"">> })} ]. @@ -418,6 +419,7 @@ params_listener_id_in_path() -> mk(binary(), #{ in => path , desc => <<"Listener ID">> + , example => <<"">> })} ]. @@ -425,6 +427,7 @@ params_userid_in_path() -> [{uid, mk(binary(), #{ in => path , desc => <<"User ID">> + , example => <<"">> })} ]. @@ -433,11 +436,13 @@ params_paging_in_qs() -> #{ in => query , nullable => true , desc => <<"Page Index">> + , example => 1 })}, {limit, mk(integer(), #{ in => query , nullable => true , desc => <<"Page Limit">> + , example => 100 })} ].