Skip to content

Commit 566c6cd

Browse files
authored
Clarifies docs for jsonCompare analyzer (#623)
Adds a little bit to the explanation of the `value` parameter to the JSON Compare analyzer to avoid an issue that tripped up a vendor team, @sgalsaleh , and I. This could probably be explained more clearly, but I wanted to get something out there.
1 parent 81de7e0 commit 566c6cd

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/source/analyze/json-compare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The JSON compare analyzer is used to compare a JSON snippet with part or all of
1111

1212
**value**: (Required) JSON value to compare.
1313
If the value matches the collected file, the outcome that has `when` set to `"true"` will be executed.
14-
If a `when` expression is not specified, the `pass` outcome defaults to `"true"`.
14+
If a `when` expression is not specified, the `pass` outcome defaults to `"true"`. This value _must_ be specified as a multi-line YAML string and any string values must be in double quotes (see the examples).
1515

1616
**path**: (Optional) Portion of the collected JSON file to compare against.
1717
The default behavior is to compare against the entire collected file.

0 commit comments

Comments
 (0)