Преглед на файлове

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

Andrew Mayorov преди 1 година
родител
ревизия
ed7c29ec26
променени са 1 файла, в които са добавени 8 реда и са изтрити 1 реда
  1. 8 1
      apps/emqx_dashboard/src/emqx_dashboard_swagger.erl

+ 8 - 1
apps/emqx_dashboard/src/emqx_dashboard_swagger.erl

@@ -91,7 +91,14 @@
 -define(DEFAULT_ROW, 100).
 
 -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
 %% because it defines a lot of types and they may clash with the types declared locally.