Pārlūkot izejas kodu

chore: add comments to explain`/status` cant be found in swagger docs

JianBo He 3 gadi atpakaļ
vecāks
revīzija
d43b680f14
1 mainītis faili ar 7 papildinājumiem un 0 dzēšanām
  1. 7 0
      apps/emqx_management/src/emqx_mgmt_api_status.erl

+ 7 - 0
apps/emqx_management/src/emqx_mgmt_api_status.erl

@@ -20,6 +20,13 @@
     path/0
     path/0
 ]).
 ]).
 
 
+%% Note: Because swagger now requires an HTTP prefix (e.g. /api/v5),
+%% but the `/status` does not require this fixed prefix.
+%%
+%% Changing the swagger framework was too big, so we implemented the `/status`
+%% in a simple way first
+%%
+%% XXX: So the HTTP API docs generated by swagger can not find this API now
 path() ->
 path() ->
     "/status".
     "/status".