fix: fix bad swagger format

This commit is contained in:
Zhongwen Deng 2022-07-20 16:56:07 +08:00
parent 53f9b59805
commit a12478225a
5 changed files with 76 additions and 88 deletions

View File

@ -66,15 +66,7 @@ schema("/authentication/:id/import_users") ->
tags => ?API_TAGS_GLOBAL, tags => ?API_TAGS_GLOBAL,
description => ?DESC(authentication_id_import_users_post), description => ?DESC(authentication_id_import_users_post),
parameters => [emqx_authn_api:param_auth_id()], parameters => [emqx_authn_api:param_auth_id()],
'requestBody' => #{ 'requestBody' => emqx_dashboard_swagger:file_schema(filename),
content => #{
'multipart/form-data' => #{
schema => #{
filename => file
}
}
}
},
responses => #{ responses => #{
204 => <<"Users imported">>, 204 => <<"Users imported">>,
400 => error_codes([?BAD_REQUEST], <<"Bad Request">>), 400 => error_codes([?BAD_REQUEST], <<"Bad Request">>),
@ -89,15 +81,7 @@ schema("/listeners/:listener_id/authentication/:id/import_users") ->
tags => ?API_TAGS_SINGLE, tags => ?API_TAGS_SINGLE,
description => ?DESC(listeners_listener_id_authentication_id_import_users_post), description => ?DESC(listeners_listener_id_authentication_id_import_users_post),
parameters => [emqx_authn_api:param_listener_id(), emqx_authn_api:param_auth_id()], parameters => [emqx_authn_api:param_listener_id(), emqx_authn_api:param_auth_id()],
'requestBody' => #{ 'requestBody' => emqx_dashboard_swagger:file_schema(filename),
content => #{
'multipart/form-data' => #{
schema => #{
filename => file
}
}
}
},
responses => #{ responses => #{
204 => <<"Users imported">>, 204 => <<"Users imported">>,
400 => error_codes([?BAD_REQUEST], <<"Bad Request">>), 400 => error_codes([?BAD_REQUEST], <<"Bad Request">>),

View File

@ -564,6 +564,10 @@ authz_sources_type_refs() ->
bin(Term) -> erlang:iolist_to_binary(io_lib:format("~p", [Term])). bin(Term) -> erlang:iolist_to_binary(io_lib:format("~p", [Term])).
status_metrics_example() -> status_metrics_example() ->
#{
'metrics_example' => #{
summary => <<"Showing a typical metrics example">>,
value =>
#{ #{
resource_metrics => #{ resource_metrics => #{
matched => 0, matched => 0,
@ -617,6 +621,8 @@ status_metrics_example() ->
status => connected status => connected
} }
] ]
}
}
}. }.
create_authz_file(Body) -> create_authz_file(Body) ->

View File

@ -180,7 +180,6 @@ field(username_in_path) ->
{username, {username,
mk(binary(), #{ mk(binary(), #{
desc => ?DESC(username), desc => ?DESC(username),
'maxLength' => 100,
example => <<"admin">>, example => <<"admin">>,
in => path, in => path,
required => true required => true

View File

@ -24,6 +24,7 @@
-export([namespace/0, namespace/1, fields/1]). -export([namespace/0, namespace/1, fields/1]).
-export([schema_with_example/2, schema_with_examples/2]). -export([schema_with_example/2, schema_with_examples/2]).
-export([error_codes/1, error_codes/2]). -export([error_codes/1, error_codes/2]).
-export([file_schema/1]).
-export([filter_check_request/2, filter_check_request_and_translate_body/2]). -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 %% Private functions
%%------------------------------------------------------------------------------ %%------------------------------------------------------------------------------

View File

@ -124,15 +124,7 @@ schema("/gateway/:name/authentication/import_users") ->
#{ #{
desc => ?DESC(emqx_gateway_api_authn, import_users), desc => ?DESC(emqx_gateway_api_authn, import_users),
parameters => params_gateway_name_in_path(), parameters => params_gateway_name_in_path(),
'requestBody' => #{ 'requestBody' => emqx_dashboard_swagger:file_schema(filename),
content => #{
'multipart/form-data' => #{
schema => #{
filename => file
}
}
}
},
responses => responses =>
?STANDARD_RESP(#{204 => <<"Imported">>}) ?STANDARD_RESP(#{204 => <<"Imported">>})
} }
@ -145,15 +137,7 @@ schema("/gateway/:name/listeners/:id/authentication/import_users") ->
desc => ?DESC(emqx_gateway_api_listeners, import_users), desc => ?DESC(emqx_gateway_api_listeners, 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' => #{ 'requestBody' => emqx_dashboard_swagger:file_schema(filename),
content => #{
'multipart/form-data' => #{
schema => #{
filename => file
}
}
}
},
responses => responses =>
?STANDARD_RESP(#{204 => <<"Imported">>}) ?STANDARD_RESP(#{204 => <<"Imported">>})
} }