Expected Behavior

A user should intuitively be able to specify a body parameter to point to a piece of data in their HTTP request JSON body.

Actual Behavior

Currently, the Triggers project is using the gjson library because it makes it easy for us to search the JSON for a specified path. However, gjson does not use the conventional JSONPath syntax, instead it has its own GJSON path syntax. Since the gjson path syntax is different from the JSONPath syntax, it can be unintuitive, and Triggers does not have any documentation linking to an explanation of this syntax.

Furthermore, the bodyPathVarRegex limits the user to a subset of the gjson syntax.

Additional Info

This concern originated in our Slack channel here.

I hope that the following work will come from this issue:

Decide whether to keep the gjson path syntax, or switch to JSONPath

1. If we decide to keep the gjson library and the gjson path syntax

• add Triggers documentation linking to the gjson path syntax page
• update the bodyPathVarRegex to accept all valid gjson path syntax
• update/add tests for examples using gjson path syntax

1. If we decide to use JSONPath syntax

• find a library that we can substitute for gjson (or use with gjson?)
• update code & tests to use the JSONPath syntax
• add Triggers documentation linking to an explanation of the JSONPath syntax