From d43b680f142d4b496e80c4f8ad056c4863b43ae7 Mon Sep 17 00:00:00 2001
From: JianBo He <heeejianbo@gmail.com>
Date: Sat, 1 Oct 2022 09:40:27 +0800
Subject: [PATCH] chore: add comments to explain`/status` cant be found in
 swagger docs

---
 apps/emqx_management/src/emqx_mgmt_api_status.erl | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/apps/emqx_management/src/emqx_mgmt_api_status.erl b/apps/emqx_management/src/emqx_mgmt_api_status.erl
index e38ccfd69..68bad03e4 100644
--- a/apps/emqx_management/src/emqx_mgmt_api_status.erl
+++ b/apps/emqx_management/src/emqx_mgmt_api_status.erl
@@ -20,6 +20,13 @@
     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() ->
     "/status".