Merge pull request #361 from StackStorm/trigger_validation_changes

Documentation for trigger validation changes

Author: Kami

docs/source/_includes/internal_trigger_types.rst

@@ -3,15 +3,15 @@
 Action
 ~~~~~~
 
-+---------------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------+
-| Reference                 | Description                                                  | Properties                                                                               |
-+===========================+==============================================================+==========================================================================================+
-| st2.generic.actiontrigger | Trigger encapsulating the completion of an action execution. | status, start_timestamp, parameters, action_name, result, execution_id                   |
-+---------------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------+
-| st2.generic.notifytrigger | Notification trigger.                                        | status, start_timestamp, channel, action_ref, data, message, execution_id, end_timestamp |
-+---------------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------+
-| st2.action.file_writen    | Trigger encapsulating action file being written on disk.     | content, host_info, ref, file_path                                                       |
-+---------------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------+
++---------------------------+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Reference                 | Description                                                  | Properties                                                                                                  |
++===========================+==============================================================+=============================================================================================================+
+| st2.generic.actiontrigger | Trigger encapsulating the completion of an action execution. | status, start_timestamp, result, parameters, action_ref, runner_ref, execution_id, action_name              |
++---------------------------+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+| st2.generic.notifytrigger | Notification trigger.                                        | status, data, start_timestamp, channel, route, action_ref, message, runner_ref, execution_id, end_timestamp |
++---------------------------+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+| st2.action.file_writen    | Trigger encapsulating action file being written on disk.     | host_info, ref, file_path                                                                                   |
++---------------------------+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
 
 Key Value Pair
 ~~~~~~~~~~~~~~

docs/source/upgrade_notes.rst

@@ -3,6 +3,28 @@
 Upgrade Notes
 =============
 
+|st2| in development
+--------------------
+
+* Additional validation has been introduced for triggers.
+
+    1. Trigger payload is now validated against the trigger ``payload_schema`` schema when
+       dispatching a trigger inside the sensor.
+
+      Validation is only performed if ``system.validate_trigger_parameters`` config option is
+      enabled (it's disabled by default) and if trigger object defines ``parameters_schema``
+      attribute.
+
+    2. Trigger parameters are now validated for non-system (user-defined) triggers when creating
+       a rule.
+
+      Validation is only performed if ``system.validate_trigger_parameters`` config option is
+      enabled (it's disabled by default) and if trigger object defines ``parameters_schema``
+      attribute.
+
+  Both of those configuration options are disabled by default for now, but they will be enabled
+  by default (with an option to opt-out) in a future major |st2| release.
+
 |st2| v2.1
 ----------