Skip to content

Commit 809a003

Browse files
committed
Update upgrade notes for trigger validation changes.
1 parent 6eb0bb6 commit 809a003

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/source/upgrade_notes.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,28 @@
33
Upgrade Notes
44
=============
55

6+
|st2| in development
7+
--------------------
8+
9+
* Additional validation has been introduced for triggers.
10+
11+
1. Trigger payload is now validated against the trigger ``payload_schema`` schema when
12+
dispatching a trigger inside the sensor.
13+
14+
Validation is only performed if ``system.validate_trigger_parameters`` config option is
15+
enabled (it's disabled by default) and if trigger object defines ``parameters_schema``
16+
attribute.
17+
18+
2. Trigger parameters are now validated for non-system (user-defined) triggers when creating
19+
a rule.
20+
21+
Validation is only performed if ``system.validate_trigger_parameters`` config option is
22+
enabled (it's disabled by default) and if trigger object defines ``parameters_schema``
23+
attribute.
24+
25+
Both of those configuration options are disabled by default for now, but they will be enabled
26+
by default (with an option to opt-out) in a future major |st2| release.
27+
628
|st2| v2.1
729
----------
830

0 commit comments

Comments
 (0)