2019-06-16 01:04:20 +00:00
|
|
|
# Rules
|
|
|
|
|
|
|
|
|
|
Rules apply a schema fragment to a set of nodes selected from the original data.
|
|
|
|
|
|
2019-06-17 12:19:02 +00:00
|
|
|
This is a descriptive standard for rules. The enforced meta-rules for rules [are located here](../rules/salty-dog.yml).
|
|
|
|
|
|
2019-06-16 01:04:20 +00:00
|
|
|
- [Rules](#rules)
|
|
|
|
|
- [Metadata](#metadata)
|
|
|
|
|
- [Name](#name)
|
|
|
|
|
- [Desc](#desc)
|
|
|
|
|
- [Level](#level)
|
|
|
|
|
- [Tags](#tags)
|
|
|
|
|
- [Data](#data)
|
|
|
|
|
- [Select](#select)
|
|
|
|
|
- [Filter](#filter)
|
|
|
|
|
- [Check](#check)
|
|
|
|
|
|
|
|
|
|
## Metadata
|
|
|
|
|
|
|
|
|
|
### Name
|
|
|
|
|
|
|
|
|
|
The rule name for running single rules.
|
|
|
|
|
|
|
|
|
|
### Desc
|
|
|
|
|
|
|
|
|
|
The rule description for error messaging.
|
|
|
|
|
|
|
|
|
|
### Level
|
|
|
|
|
|
|
|
|
|
The rule log level.
|
|
|
|
|
|
|
|
|
|
### Tags
|
|
|
|
|
|
|
|
|
|
A list of tags for the rule. Used for inclusion and exclusion.
|
|
|
|
|
|
|
|
|
|
## Data
|
|
|
|
|
|
|
|
|
|
### Select
|
|
|
|
|
|
|
|
|
|
JSON path used to select nodes from the data.
|
|
|
|
|
|
2019-06-17 12:19:02 +00:00
|
|
|
Uses [jsonpath-plus syntax](https://www.npmjs.com/package/jsonpath-plus#syntax-through-examples) in a string.
|
|
|
|
|
|
2019-06-16 01:04:20 +00:00
|
|
|
### Filter
|
|
|
|
|
|
|
|
|
|
Schema fragment used to filter selected nodes.
|
|
|
|
|
|
|
|
|
|
If a node matches the `select` path but does not match this schema, it will be skipped.
|
|
|
|
|
|
2019-06-17 12:19:02 +00:00
|
|
|
Uses [ajv syntax](https://ajv.js.org/keywords.html) in an object.
|
|
|
|
|
|
2019-06-16 01:04:20 +00:00
|
|
|
### Check
|
|
|
|
|
|
|
|
|
|
Schema fragment used to check selected nodes.
|
|
|
|
|
|
|
|
|
|
This is the real rule.
|
2019-06-17 12:19:02 +00:00
|
|
|
|
|
|
|
|
Uses [ajv syntax](https://ajv.js.org/keywords.html) in an object.
|
