From 1c27fb8be847b4b9d2dab6edd1893d6116b9e4cc Mon Sep 17 00:00:00 2001 From: Rakesh Date: Thu, 1 Jan 2026 18:25:34 -0500 Subject: [PATCH 1/4] Add documentation for executability --- resources/schema/CORE-base.json | 29 ++++++++++++++++++------- resources/schema/Executability.md | 35 +++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 7 deletions(-) create mode 100644 resources/schema/Executability.md diff --git a/resources/schema/CORE-base.json b/resources/schema/CORE-base.json index d6a660437..bdeb4f067 100644 --- a/resources/schema/CORE-base.json +++ b/resources/schema/CORE-base.json @@ -400,14 +400,29 @@ "type": "string" }, "Executability": { - "enum": [ - "Fully Executable", - "Not Executable", - "Partially Executable", - "Partially Executable - Possible Overreporting", - "Partially Executable - Possible Underreporting" + "anyOf": [ + { + "const": "Fully Executable", + "markdownDescription": "The rule can be fully executed and validated automatically by the rules engine" + }, + { + "const": "Not Executable", + "markdownDescription": "The rule cannot be executed automatically by the rules engine" + }, + { + "const": "Partially Executable", + "markdownDescription": "The rule can be partially executed, but may not capture all validation scenarios" + }, + { + "const": "Partially Executable - Possible Overreporting", + "markdownDescription": "The rule can be partially executed but may report more violations than actually exist" + }, + { + "const": "Partially Executable - Possible Underreporting", + "markdownDescription": "The rule can be partially executed but may miss some violations that should be reported" + } ], - "type": "string" + "markdownDescription": "Indicates the extent to which the rule can be automatically executed and validated by the rules engine" }, "Match Datasets": { "items": { diff --git a/resources/schema/Executability.md b/resources/schema/Executability.md new file mode 100644 index 000000000..fd52967e4 --- /dev/null +++ b/resources/schema/Executability.md @@ -0,0 +1,35 @@ +## Executability + +Indicates the extent to which the rule can be automatically executed and validated by the rules engine. This is informational metadata that describes the rule's execution capability. + +## Fully Executable + +The rule can be fully executed and validated automatically by the rules engine. + +## Not Executable + +The rule cannot be executed automatically by the rules engine. + +## Partially Executable + +The rule can be partially executed, but may not capture all validation scenarios. + +## Partially Executable - Possible Overreporting + +The rule can be partially executed but may report more violations than actually exist. + +## Partially Executable - Possible Underreporting + +The rule can be partially executed but may miss some violations that should be reported. + +### Example + +```yaml +Executability: Fully Executable +``` + +### Notes + +- Executability is informational metadata and does not control whether a rule executes +- All rules are executed by the engine regardless of their Executability value +- The Executability value is included in validation reports to inform users about the rule's execution capability From 6c1a30cbf69bd02f6346bcf7e8c5a939aba2b448 Mon Sep 17 00:00:00 2001 From: Rakesh Date: Wed, 21 Jan 2026 10:29:30 -0500 Subject: [PATCH 2/4] Fix Executability tooltip rendering by using title instead of markdownDescription for enum values --- resources/schema/CORE-base.json | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/resources/schema/CORE-base.json b/resources/schema/CORE-base.json index bdeb4f067..9d63a2fa2 100644 --- a/resources/schema/CORE-base.json +++ b/resources/schema/CORE-base.json @@ -403,23 +403,23 @@ "anyOf": [ { "const": "Fully Executable", - "markdownDescription": "The rule can be fully executed and validated automatically by the rules engine" + "title": "The rule can be fully executed and validated automatically by the rules engine" }, { "const": "Not Executable", - "markdownDescription": "The rule cannot be executed automatically by the rules engine" + "title": "The rule cannot be executed automatically by the rules engine" }, { "const": "Partially Executable", - "markdownDescription": "The rule can be partially executed, but may not capture all validation scenarios" + "title": "The rule can be partially executed, but may not capture all validation scenarios" }, { "const": "Partially Executable - Possible Overreporting", - "markdownDescription": "The rule can be partially executed but may report more violations than actually exist" + "title": "The rule can be partially executed but may report more violations than actually exist" }, { "const": "Partially Executable - Possible Underreporting", - "markdownDescription": "The rule can be partially executed but may miss some violations that should be reported" + "title": "The rule can be partially executed but may miss some violations that should be reported" } ], "markdownDescription": "Indicates the extent to which the rule can be automatically executed and validated by the rules engine" @@ -639,7 +639,9 @@ ], "if": { "properties": { - "Sensitivity": { "const": "Group" } + "Sensitivity": { + "const": "Group" + } } }, "then": { From 02b571cba20a76c3dfeabca9f197b5a49679388a Mon Sep 17 00:00:00 2001 From: Rakesh Date: Wed, 21 Jan 2026 10:32:44 -0500 Subject: [PATCH 3/4] Update Executability heading to h1 from h2 --- resources/schema/Executability.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/schema/Executability.md b/resources/schema/Executability.md index fd52967e4..a774c282a 100644 --- a/resources/schema/Executability.md +++ b/resources/schema/Executability.md @@ -1,4 +1,4 @@ -## Executability +# Executability Indicates the extent to which the rule can be automatically executed and validated by the rules engine. This is informational metadata that describes the rule's execution capability. From 4ccb4fabf5308be0c440d53caa2057d300e393fa Mon Sep 17 00:00:00 2001 From: Rakesh Date: Wed, 4 Feb 2026 21:30:37 -0500 Subject: [PATCH 4/4] refactor(schema): add Executability.json and reference it from CORE-base --- resources/schema/CORE-base.json | 24 +----------------------- resources/schema/Executability.json | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 23 deletions(-) create mode 100644 resources/schema/Executability.json diff --git a/resources/schema/CORE-base.json b/resources/schema/CORE-base.json index 9d63a2fa2..6fccb4afd 100644 --- a/resources/schema/CORE-base.json +++ b/resources/schema/CORE-base.json @@ -400,29 +400,7 @@ "type": "string" }, "Executability": { - "anyOf": [ - { - "const": "Fully Executable", - "title": "The rule can be fully executed and validated automatically by the rules engine" - }, - { - "const": "Not Executable", - "title": "The rule cannot be executed automatically by the rules engine" - }, - { - "const": "Partially Executable", - "title": "The rule can be partially executed, but may not capture all validation scenarios" - }, - { - "const": "Partially Executable - Possible Overreporting", - "title": "The rule can be partially executed but may report more violations than actually exist" - }, - { - "const": "Partially Executable - Possible Underreporting", - "title": "The rule can be partially executed but may miss some violations that should be reported" - } - ], - "markdownDescription": "Indicates the extent to which the rule can be automatically executed and validated by the rules engine" + "$ref": "Executability.json" }, "Match Datasets": { "items": { diff --git a/resources/schema/Executability.json b/resources/schema/Executability.json new file mode 100644 index 000000000..15526e8ee --- /dev/null +++ b/resources/schema/Executability.json @@ -0,0 +1,22 @@ +{ + "$id": "Executability.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "anyOf": [ + { + "const": "Fully Executable" + }, + { + "const": "Not Executable" + }, + { + "const": "Partially Executable" + }, + { + "const": "Partially Executable - Possible Overreporting" + }, + { + "const": "Partially Executable - Possible Underreporting" + } + ], + "markdownDescription": "Indicates the extent to which the rule can be automatically executed and validated by the rules engine" +}