From ab2cdfeab1c9b15aab47ecb8928e0092027fe38e Mon Sep 17 00:00:00 2001
From: DDDHuang <44492639+DDDHuang@users.noreply.github.com>
Date: Wed, 22 Sep 2021 10:04:00 +0800
Subject: [PATCH] fix: delayed message format & message id parameter name
 (#5762)

---
 apps/emqx_modules/src/emqx_delayed.erl     |  2 +-
 apps/emqx_modules/src/emqx_delayed_api.erl | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/apps/emqx_modules/src/emqx_delayed.erl b/apps/emqx_modules/src/emqx_delayed.erl
index 0b1f00e14..823424c1f 100644
--- a/apps/emqx_modules/src/emqx_delayed.erl
+++ b/apps/emqx_modules/src/emqx_delayed.erl
@@ -143,7 +143,7 @@ format_delayed(#delayed_message{key = {ExpectTimeStamp, Id}, delayed = Delayed,
     ExpectTime = to_rfc3339(ExpectTimeStamp),
     RemainingTime = ExpectTimeStamp - erlang:system_time(second),
     Result = #{
-        id => emqx_guid:to_hexstr(Id),
+        msgid => emqx_guid:to_hexstr(Id),
         publish_at => PublishTime,
         delayed_interval => Delayed,
         delayed_remaining => RemainingTime,
diff --git a/apps/emqx_modules/src/emqx_delayed_api.erl b/apps/emqx_modules/src/emqx_delayed_api.erl
index d78b7ddcb..96589bf06 100644
--- a/apps/emqx_modules/src/emqx_delayed_api.erl
+++ b/apps/emqx_modules/src/emqx_delayed_api.erl
@@ -59,7 +59,7 @@ properties() ->
     PayloadDesc = io_lib:format("Payload, base64 encode. Payload will be ~p if length large than ~p",
             [?PAYLOAD_TOO_LARGE, ?MAX_PAYLOAD_LENGTH]),
     properties([
-        {id, integer, <<"Message Id (MQTT message id hash)">>},
+        {msgid, integer, <<"Message Id">>},
         {publish_at, string, <<"Client publish message time, rfc 3339">>},
         {delayed_interval, integer, <<"Delayed interval, second">>},
         {delayed_remaining, integer, <<"Delayed remaining, second">>},
@@ -73,7 +73,7 @@ properties() ->
 
 parameters() ->
     [#{
-        name => id,
+        name => msgid,
         in => path,
         schema => #{type => string},
         required => true
@@ -129,7 +129,7 @@ delayed_message_api() ->
             }
         }
     },
-    {"/mqtt/delayed/messages/:id", Metadata, delayed_message}.
+    {"/mqtt/delayed/messages/:msgid", Metadata, delayed_message}.
 
 %%--------------------------------------------------------------------
 %% HTTP API
@@ -143,7 +143,7 @@ status(put, #{body := Body}) ->
 delayed_messages(get, #{query_string := Qs}) ->
     {200, emqx_delayed:list(Qs)}.
 
-delayed_message(get, #{bindings := #{id := Id}}) ->
+delayed_message(get, #{bindings := #{msgid := Id}}) ->
     case emqx_delayed:get_delayed_message(Id) of
         {ok, Message} ->
             Payload = maps:get(payload, Message),
@@ -157,7 +157,7 @@ delayed_message(get, #{bindings := #{id := Id}}) ->
             Message = iolist_to_binary(io_lib:format("Message ID ~p not found", [Id])),
             {404, #{code => ?MESSAGE_ID_NOT_FOUND, message => Message}}
     end;
-delayed_message(delete, #{bindings := #{id := Id}}) ->
+delayed_message(delete, #{bindings := #{msgid := Id}}) ->
     _ = emqx_delayed:delete_delayed_message(Id),
     {200}.