fix: fix bad swagger format
This commit is contained in:
parent
53f9b59805
commit
a12478225a
|
@ -66,15 +66,7 @@ schema("/authentication/:id/import_users") ->
|
|||
tags => ?API_TAGS_GLOBAL,
|
||||
description => ?DESC(authentication_id_import_users_post),
|
||||
parameters => [emqx_authn_api:param_auth_id()],
|
||||
'requestBody' => #{
|
||||
content => #{
|
||||
'multipart/form-data' => #{
|
||||
schema => #{
|
||||
filename => file
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
'requestBody' => emqx_dashboard_swagger:file_schema(filename),
|
||||
responses => #{
|
||||
204 => <<"Users imported">>,
|
||||
400 => error_codes([?BAD_REQUEST], <<"Bad Request">>),
|
||||
|
@ -89,15 +81,7 @@ schema("/listeners/:listener_id/authentication/:id/import_users") ->
|
|||
tags => ?API_TAGS_SINGLE,
|
||||
description => ?DESC(listeners_listener_id_authentication_id_import_users_post),
|
||||
parameters => [emqx_authn_api:param_listener_id(), emqx_authn_api:param_auth_id()],
|
||||
'requestBody' => #{
|
||||
content => #{
|
||||
'multipart/form-data' => #{
|
||||
schema => #{
|
||||
filename => file
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
'requestBody' => emqx_dashboard_swagger:file_schema(filename),
|
||||
responses => #{
|
||||
204 => <<"Users imported">>,
|
||||
400 => error_codes([?BAD_REQUEST], <<"Bad Request">>),
|
||||
|
|
|
@ -565,58 +565,64 @@ bin(Term) -> erlang:iolist_to_binary(io_lib:format("~p", [Term])).
|
|||
|
||||
status_metrics_example() ->
|
||||
#{
|
||||
resource_metrics => #{
|
||||
matched => 0,
|
||||
success => 0,
|
||||
failed => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
},
|
||||
node_resource_metrics => [
|
||||
#{
|
||||
node => node(),
|
||||
metrics => #{
|
||||
matched => 0,
|
||||
success => 0,
|
||||
failed => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
}
|
||||
}
|
||||
],
|
||||
metrics => #{
|
||||
total => 0,
|
||||
allow => 0,
|
||||
deny => 0,
|
||||
nomatch => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
},
|
||||
node_metrics => [
|
||||
#{
|
||||
node => node(),
|
||||
metrics => #{
|
||||
total => 0,
|
||||
allow => 0,
|
||||
deny => 0,
|
||||
nomatch => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
}
|
||||
}
|
||||
],
|
||||
'metrics_example' => #{
|
||||
summary => <<"Showing a typical metrics example">>,
|
||||
value =>
|
||||
#{
|
||||
resource_metrics => #{
|
||||
matched => 0,
|
||||
success => 0,
|
||||
failed => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
},
|
||||
node_resource_metrics => [
|
||||
#{
|
||||
node => node(),
|
||||
metrics => #{
|
||||
matched => 0,
|
||||
success => 0,
|
||||
failed => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
}
|
||||
}
|
||||
],
|
||||
metrics => #{
|
||||
total => 0,
|
||||
allow => 0,
|
||||
deny => 0,
|
||||
nomatch => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
},
|
||||
node_metrics => [
|
||||
#{
|
||||
node => node(),
|
||||
metrics => #{
|
||||
total => 0,
|
||||
allow => 0,
|
||||
deny => 0,
|
||||
nomatch => 0,
|
||||
rate => 0.0,
|
||||
rate_last5m => 0.0,
|
||||
rate_max => 0.0
|
||||
}
|
||||
}
|
||||
],
|
||||
|
||||
status => connected,
|
||||
node_status => [
|
||||
#{
|
||||
node => node(),
|
||||
status => connected
|
||||
}
|
||||
]
|
||||
status => connected,
|
||||
node_status => [
|
||||
#{
|
||||
node => node(),
|
||||
status => connected
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}.
|
||||
|
||||
create_authz_file(Body) ->
|
||||
|
|
|
@ -180,7 +180,6 @@ field(username_in_path) ->
|
|||
{username,
|
||||
mk(binary(), #{
|
||||
desc => ?DESC(username),
|
||||
'maxLength' => 100,
|
||||
example => <<"admin">>,
|
||||
in => path,
|
||||
required => true
|
||||
|
|
|
@ -24,6 +24,7 @@
|
|||
-export([namespace/0, namespace/1, fields/1]).
|
||||
-export([schema_with_example/2, schema_with_examples/2]).
|
||||
-export([error_codes/1, error_codes/2]).
|
||||
-export([file_schema/1]).
|
||||
|
||||
-export([filter_check_request/2, filter_check_request_and_translate_body/2]).
|
||||
|
||||
|
@ -165,6 +166,20 @@ error_codes(Codes = [_ | _], MsgDesc) ->
|
|||
})}
|
||||
].
|
||||
|
||||
file_schema(FileName) ->
|
||||
#{
|
||||
content => #{
|
||||
'multipart/form-data' => #{
|
||||
schema => #{
|
||||
type => object,
|
||||
properties => #{
|
||||
FileName => #{type => string, format => binary}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}.
|
||||
|
||||
%%------------------------------------------------------------------------------
|
||||
%% Private functions
|
||||
%%------------------------------------------------------------------------------
|
||||
|
|
|
@ -124,15 +124,7 @@ schema("/gateway/:name/authentication/import_users") ->
|
|||
#{
|
||||
desc => ?DESC(emqx_gateway_api_authn, import_users),
|
||||
parameters => params_gateway_name_in_path(),
|
||||
'requestBody' => #{
|
||||
content => #{
|
||||
'multipart/form-data' => #{
|
||||
schema => #{
|
||||
filename => file
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
'requestBody' => emqx_dashboard_swagger:file_schema(filename),
|
||||
responses =>
|
||||
?STANDARD_RESP(#{204 => <<"Imported">>})
|
||||
}
|
||||
|
@ -145,15 +137,7 @@ schema("/gateway/:name/listeners/:id/authentication/import_users") ->
|
|||
desc => ?DESC(emqx_gateway_api_listeners, import_users),
|
||||
parameters => params_gateway_name_in_path() ++
|
||||
params_listener_id_in_path(),
|
||||
'requestBody' => #{
|
||||
content => #{
|
||||
'multipart/form-data' => #{
|
||||
schema => #{
|
||||
filename => file
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
'requestBody' => emqx_dashboard_swagger:file_schema(filename),
|
||||
responses =>
|
||||
?STANDARD_RESP(#{204 => <<"Imported">>})
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue