From 1497712e04778ce411430b8c979bc0a8009bc9fc Mon Sep 17 00:00:00 2001 From: bobbysteel Date: Fri, 23 Sep 2016 20:36:18 +0100 Subject: [PATCH] Clarify path for a simple body_text event. (#1705) * Clarify path for a simple body_text event. It's not really clear with regard to a normal agent that this is simply the name of the field. * updated text --- app/models/agents/trigger_agent.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/models/agents/trigger_agent.rb b/app/models/agents/trigger_agent.rb index 20b1b402a1..2cac4dd995 100644 --- a/app/models/agents/trigger_agent.rb +++ b/app/models/agents/trigger_agent.rb @@ -8,7 +8,7 @@ class TriggerAgent < Agent description <<-MD The Trigger Agent will watch for a specific value in an Event payload. - The `rules` array contains hashes of `path`, `value`, and `type`. The `path` value is a dotted path through a hash in [JSONPaths](http://goessner.net/articles/JsonPath/) syntax. + The `rules` array contains hashes of `path`, `value`, and `type`. The `path` value is a dotted path through a hash in [JSONPaths](http://goessner.net/articles/JsonPath/) syntax. For simple events, this is usually just the name of the field you want, like 'text' for the text key of the event. The `type` can be one of #{VALID_COMPARISON_TYPES.map { |t| "`#{t}`" }.to_sentence} and compares with the `value`. Note that regex patterns are matched case insensitively. If you want case sensitive matching, prefix your pattern with `(?-i)`.