Skip to content

Structured query

Rule kinds in the Structured query family. Each rule below links to its own page with options, an example, and any auto-fix support.

RuleDescription
json_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
yaml_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
toml_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
xml_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
dotenv_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
properties_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
ini_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
hcl_path_equalsQuery a structured document with a JSONPath expression and assert every match deep-equals the supplied value.
json_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
yaml_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
toml_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
xml_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
dotenv_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
properties_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
ini_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
hcl_path_matchesSame shape as the *_equals variants, but the asserted value is a regex matched against string values.
json_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
yaml_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
toml_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
xml_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
dotenv_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
properties_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
ini_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
hcl_path_absentAssert a JSONPath query over the document matches nothing; one file-level violation if present.
json_schema_passesValidate every JSON / YAML / TOML / XML / dotenv / properties / INI / HCL file in paths against a JSON Schema document.