From 9628a00a82295da6190dbe4dc4a6fac1e0de9357 Mon Sep 17 00:00:00 2001
From: Kjell Winblad <kjellwinblad@gmail.com>
Date: Mon, 8 Apr 2024 15:34:29 +0200
Subject: [PATCH] docs(emqx_rule_api apply rule): fix doc strings

---
 apps/emqx_rule_engine/src/emqx_rule_api_schema.erl   |  2 +-
 apps/emqx_rule_engine/src/emqx_rule_engine_api.erl   |  4 ++--
 apps/emqx_rule_engine/src/emqx_rule_sqltester.erl    |  2 +-
 .../test/emqx_rule_engine_api_rule_apply_SUITE.erl   |  5 +----
 rel/i18n/emqx_rule_api_schema.hocon                  | 12 ++++++++++++
 rel/i18n/emqx_rule_engine_api.hocon                  |  6 ++++++
 6 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/apps/emqx_rule_engine/src/emqx_rule_api_schema.erl b/apps/emqx_rule_engine/src/emqx_rule_api_schema.erl
index 862aea3b3..20363e726 100644
--- a/apps/emqx_rule_engine/src/emqx_rule_api_schema.erl
+++ b/apps/emqx_rule_engine/src/emqx_rule_api_schema.erl
@@ -117,7 +117,7 @@ fields("rule_apply_test") ->
                     default => #{}
                 }
             )},
-        {"stop_action_after_template_render",
+        {"stop_action_after_template_rendering",
             sc(
                 typerefl:boolean(),
                 #{
diff --git a/apps/emqx_rule_engine/src/emqx_rule_engine_api.erl b/apps/emqx_rule_engine/src/emqx_rule_engine_api.erl
index c0514b82b..d203dd915 100644
--- a/apps/emqx_rule_engine/src/emqx_rule_engine_api.erl
+++ b/apps/emqx_rule_engine/src/emqx_rule_engine_api.erl
@@ -268,8 +268,8 @@ schema("/rules/:id/test") ->
         'operationId' => '/rules/:id/test',
         post => #{
             tags => [<<"rules">>],
-            description => ?DESC("api8"),
-            summary => <<"Apply a rule with the given message and environment">>,
+            description => ?DESC("api11"),
+            summary => <<"Apply a rule for testing">>,
             'requestBody' => rule_apply_test_schema(),
             responses => #{
                 400 => error_schema('BAD_REQUEST', "Invalid Parameters"),
diff --git a/apps/emqx_rule_engine/src/emqx_rule_sqltester.erl b/apps/emqx_rule_engine/src/emqx_rule_sqltester.erl
index fc4d2614f..342a8d9f9 100644
--- a/apps/emqx_rule_engine/src/emqx_rule_sqltester.erl
+++ b/apps/emqx_rule_engine/src/emqx_rule_sqltester.erl
@@ -29,7 +29,7 @@ apply_rule(
     #{
         context := Context,
         environment := Env,
-        stop_action_after_template_render := StopAfterRender
+        stop_action_after_template_rendering := StopAfterRender
     }
 ) ->
     {ok, Rule} = emqx_rule_engine:get_rule(RuleId),
diff --git a/apps/emqx_rule_engine/test/emqx_rule_engine_api_rule_apply_SUITE.erl b/apps/emqx_rule_engine/test/emqx_rule_engine_api_rule_apply_SUITE.erl
index 31a462de3..2b77f9c3d 100644
--- a/apps/emqx_rule_engine/test/emqx_rule_engine_api_rule_apply_SUITE.erl
+++ b/apps/emqx_rule_engine/test/emqx_rule_engine_api_rule_apply_SUITE.erl
@@ -30,9 +30,6 @@ all() ->
 
 init_per_suite(Config) ->
     application:load(emqx_conf),
-    % ok = emqx_common_test_helpers:load_config(emqx_rule_engine_schema, ?CONF_DEFAULT),
-    % ok = emqx_common_test_helpers:start_apps([emqx_conf, emqx, emqx_rule_engine, emqx_bridge, emqx_bridge_http]),
-
     Apps = emqx_cth_suite:start(
         [
             emqx,
@@ -125,7 +122,7 @@ basic_apply_rule_test_helper(Config, TraceType, StopAfterRender) ->
     Params = #{
         % body => #{
         <<"context">> => Context,
-        <<"stop_action_after_template_render">> => StopAfterRender
+        <<"stop_action_after_template_rendering">> => StopAfterRender
         % }
     },
     emqx_trace:check(),
diff --git a/rel/i18n/emqx_rule_api_schema.hocon b/rel/i18n/emqx_rule_api_schema.hocon
index 0289f53ab..7f684e8ef 100644
--- a/rel/i18n/emqx_rule_api_schema.hocon
+++ b/rel/i18n/emqx_rule_api_schema.hocon
@@ -66,6 +66,18 @@ test_context.desc:
 test_context.label:
 """Event Conetxt"""
 
+test_rule_environment.desc:
+"""The environment that will be passed to the rule when it is applied. A default environment will be used if no environment is given."""
+
+test_rule_environment.label:
+"""Event Environment"""
+
+stop_action_after_template_render.desc:
+"""Set this to true if the action should be stopped after its template has been rendered."""
+
+stop_action_after_template_render.label:
+"""Stop Action After Template Rendering"""
+
 node_node.desc:
 """The node name"""
 
diff --git a/rel/i18n/emqx_rule_engine_api.hocon b/rel/i18n/emqx_rule_engine_api.hocon
index 385b71ddc..0745a108d 100644
--- a/rel/i18n/emqx_rule_engine_api.hocon
+++ b/rel/i18n/emqx_rule_engine_api.hocon
@@ -90,4 +90,10 @@ api9.desc:
 api9.label:
 """Get configuration"""
 
+api11.desc:
+"""Apply a rule with the given message and environment"""
+
+api11.label:
+"""Apply Rule"""
+
 }