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

fix(api): mention spec override in "request metadata" type

This commit is contained in:
Andrew Mayorov 2024-05-27 16:57:45 +02:00
parent 5c2a68076f
commit ed7c29ec26
No known key found for this signature in database
GPG Key ID: 2837C62ACFBFED5D
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
apps/emqx_dashboard/src/emqx_dashboard_swagger.erl
View File

@ -91,7 +91,14 @@
-define(DEFAULT_ROW, 100). -define(DEFAULT_ROW, 100).
-type request() :: #{bindings => map(), query_string => map(), body => map()}. -type request() :: #{bindings => map(), query_string => map(), body => map()}.
-type request_meta() :: #{module => module(), path => string(), method => atom()}. -type request_meta() :: #{
module := module(),
path := string(),
method := atom(),
%% API Operation specification override.
%% Takes precedence over the API specification defined in the module.
apispec => map()
}.
%% More exact types are defined in minirest.hrl, but we don't want to include it %% More exact types are defined in minirest.hrl, but we don't want to include it
%% because it defines a lot of types and they may clash with the types declared locally. %% because it defines a lot of types and they may clash with the types declared locally.