From b315e5a5f0785ad3906ac536b4d9ea5a45848d8c Mon Sep 17 00:00:00 2001 From: Alexander Stein Date: Mon, 15 Mar 2021 15:42:30 -0400 Subject: [PATCH] Add docs per PR feedback. Signed-off-by: Alexander Stein --- docs-chef-io/content/inspec/reporters.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs-chef-io/content/inspec/reporters.md b/docs-chef-io/content/inspec/reporters.md index 4a38daa6c..1218d479b 100644 --- a/docs-chef-io/content/inspec/reporters.md +++ b/docs-chef-io/content/inspec/reporters.md @@ -101,7 +101,23 @@ This is the basic text base report. It includes details about which tests passed ### json -This reporter includes all information about the profiles and test results in standard json format. +This reporter includes all information about the profiles and test results in standard json format. You may optionally allow pass through arbitrary structured JSON data via a json config with the `--config` parameter like the example below. + +Example config: + +```json +{ + "reporter": { + "json": { + "stdout": true, + "passthrough": { + "a": 1, + "b": false + } + } + } +} +``` ### json-min