From bcb7fe96d52805811f5fb03485a2b440cbe519e7 Mon Sep 17 00:00:00 2001
From: Thales Macedo Garitezi <thalesmg@gmail.com>
Date: Mon, 18 Mar 2024 13:20:05 -0300
Subject: [PATCH] refactor: remove ambiguity from api

In preparation for the "reorder" API
---
 .../src/emqx_message_validation_http_api.erl  | 22 +++++++++----------
 ...emqx_message_validation_http_api_SUITE.erl | 13 ++++++++---
 2 files changed, 21 insertions(+), 14 deletions(-)

diff --git a/apps/emqx_message_validation/src/emqx_message_validation_http_api.erl b/apps/emqx_message_validation/src/emqx_message_validation_http_api.erl
index 5cbb911df..69d63f2ed 100644
--- a/apps/emqx_message_validation/src/emqx_message_validation_http_api.erl
+++ b/apps/emqx_message_validation/src/emqx_message_validation_http_api.erl
@@ -22,8 +22,8 @@
 %% `minirest' handlers
 -export([
     '/message_validations'/2,
-    '/message_validations/:name'/2,
-    '/message_validations/:name/move'/2
+    '/message_validations/validation/:name'/2,
+    '/message_validations/validation/:name/move'/2
 ]).
 
 %%-------------------------------------------------------------------------------------------------
@@ -44,8 +44,8 @@ api_spec() ->
 paths() ->
     [
         "/message_validations",
-        "/message_validations/:name",
-        "/message_validations/:name/move"
+        "/message_validations/validation/:name",
+        "/message_validations/validation/:name/move"
     ].
 
 schema("/message_validations") ->
@@ -107,9 +107,9 @@ schema("/message_validations") ->
                 }
         }
     };
-schema("/message_validations/:name") ->
+schema("/message_validations/validation/:name") ->
     #{
-        'operationId' => '/message_validations/:name',
+        'operationId' => '/message_validations/validation/:name',
         get => #{
             tags => ?TAGS,
             summary => <<"Lookup a validation">>,
@@ -142,9 +142,9 @@ schema("/message_validations/:name") ->
                 }
         }
     };
-schema("/message_validations/:name/move") ->
+schema("/message_validations/validation/:name/move") ->
     #{
-        'operationId' => '/message_validations/:name/move',
+        'operationId' => '/message_validations/validation/:name/move',
         post => #{
             tags => ?TAGS,
             summary => <<"Change the order of a validation">>,
@@ -226,13 +226,13 @@ fields(before) ->
         not_found()
     ).
 
-'/message_validations/:name'(get, #{bindings := #{name := Name}}) ->
+'/message_validations/validation/:name'(get, #{bindings := #{name := Name}}) ->
     with_validation(
         Name,
         fun(Validation) -> ?OK(Validation) end,
         not_found()
     );
-'/message_validations/:name'(delete, #{bindings := #{name := Name}}) ->
+'/message_validations/validation/:name'(delete, #{bindings := #{name := Name}}) ->
     with_validation(
         Name,
         fun() ->
@@ -246,7 +246,7 @@ fields(before) ->
         not_found()
     ).
 
-'/message_validations/:name/move'(post, #{bindings := #{name := Name}, body := Body}) ->
+'/message_validations/validation/:name/move'(post, #{bindings := #{name := Name}, body := Body}) ->
     with_validation(
         Name,
         fun() ->
diff --git a/apps/emqx_message_validation/test/emqx_message_validation_http_api_SUITE.erl b/apps/emqx_message_validation/test/emqx_message_validation_http_api_SUITE.erl
index 9c1289e88..22b58cd4f 100644
--- a/apps/emqx_message_validation/test/emqx_message_validation_http_api_SUITE.erl
+++ b/apps/emqx_message_validation/test/emqx_message_validation_http_api_SUITE.erl
@@ -151,7 +151,7 @@ list() ->
     simplify_result(Res).
 
 lookup(Name) ->
-    Path = emqx_mgmt_api_test_util:api_path([api_root(), Name]),
+    Path = emqx_mgmt_api_test_util:api_path([api_root(), "validation", Name]),
     Res = request(get, Path, _Params = []),
     ct:pal("lookup ~s result:\n  ~p", [Name, Res]),
     simplify_result(Res).
@@ -169,17 +169,23 @@ update(Params) ->
     simplify_result(Res).
 
 delete(Name) ->
-    Path = emqx_mgmt_api_test_util:api_path([api_root(), Name]),
+    Path = emqx_mgmt_api_test_util:api_path([api_root(), "validation", Name]),
     Res = request(delete, Path, _Params = []),
     ct:pal("delete result:\n  ~p", [Res]),
     simplify_result(Res).
 
 move(Name, Pos) ->
-    Path = emqx_mgmt_api_test_util:api_path([api_root(), Name, "move"]),
+    Path = emqx_mgmt_api_test_util:api_path([api_root(), "validation", Name, "move"]),
     Res = request(post, Path, Pos),
     ct:pal("move result:\n  ~p", [Res]),
     simplify_result(Res).
 
+reorder(Order) ->
+    Path = emqx_mgmt_api_test_util:api_path([api_root(), "reorder"]),
+    Res = request(post, Path, Order),
+    ct:pal("reorder result:\n  ~p", [Res]),
+    simplify_result(Res).
+
 connect(ClientId) ->
     connect(ClientId, _IsPersistent = false).
 
@@ -410,6 +416,7 @@ t_crud(_Config) ->
 
     ok.
 
+%% test the "move" API
 t_move(_Config) ->
     lists:foreach(
         fun(Pos) ->