provided a different example status for a profile in an exec_json since 'loaded' is different from the other usual possibilities and also is going to be the presumably most common status

Signed-off-by: Amndeep Singh Mann <amann@mitre.org>
This commit is contained in:
Amndeep Singh Mann 2021-12-20 12:31:26 -05:00
parent 9f98ea0ecd
commit 2c01ffb754

View file

@ -102,7 +102,7 @@ module Inspec
# These are generated at runtime, and all except status_message and skip_message are guaranteed # These are generated at runtime, and all except status_message and skip_message are guaranteed
"sha256" => Primitives.desc(Primitives::STRING, "The checksum of the profile."), "sha256" => Primitives.desc(Primitives::STRING, "The checksum of the profile."),
"status" => Primitives.desc(Primitives::STRING, "The status. Example: skipped."), "status" => Primitives.desc(Primitives::STRING, "The status. Example: loaded."), # enum? loaded, failed, skipped
"status_message" => Primitives.desc(Primitives::STRING, "The reason for the status. Example: why it was skipped or failed to load."), "status_message" => Primitives.desc(Primitives::STRING, "The reason for the status. Example: why it was skipped or failed to load."),
"skip_message" => Primitives.desc(Primitives::STRING, "The reason for skipping if it was skipped."), # Deprecated field - status_message should be used instead. "skip_message" => Primitives.desc(Primitives::STRING, "The reason for skipping if it was skipped."), # Deprecated field - status_message should be used instead.
"controls" => Primitives.desc(Primitives.array(CONTROL.ref), "The set of controls including any findings."), "controls" => Primitives.desc(Primitives.array(CONTROL.ref), "The set of controls including any findings."),