Skip to content

Commit

Permalink
Clarify path for a simple body_text event. (#1705)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
bobbysteel authored and cantino committed Sep 23, 2016
1 parent e0fa7f0 commit 1497712
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion app/models/agents/trigger_agent.rb
Expand Up @@ -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)`.
Expand Down

0 comments on commit 1497712

Please sign in to comment.