From e6c2da540e5e65120b68f0aaab270e732e8bd622 Mon Sep 17 00:00:00 2001 From: ssube Date: Mon, 17 Jun 2019 07:19:02 -0500 Subject: [PATCH] docs: add links to syntax and meta-rules --- docs/rules.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/rules.md b/docs/rules.md index a6dd56c..850d3fc 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -2,6 +2,8 @@ Rules apply a schema fragment to a set of nodes selected from the original data. +This is a descriptive standard for rules. The enforced meta-rules for rules [are located here](../rules/salty-dog.yml). + - [Rules](#rules) - [Metadata](#metadata) - [Name](#name) @@ -37,14 +39,20 @@ A list of tags for the rule. Used for inclusion and exclusion. JSON path used to select nodes from the data. +Uses [jsonpath-plus syntax](https://www.npmjs.com/package/jsonpath-plus#syntax-through-examples) in a string. + ### 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. +Uses [ajv syntax](https://ajv.js.org/keywords.html) in an object. + ### Check Schema fragment used to check selected nodes. This is the real rule. + +Uses [ajv syntax](https://ajv.js.org/keywords.html) in an object.