diff --git a/resources/schema/CORE-base.json b/resources/schema/CORE-base.json index d6a660437..6fccb4afd 100644 --- a/resources/schema/CORE-base.json +++ b/resources/schema/CORE-base.json @@ -400,14 +400,7 @@ "type": "string" }, "Executability": { - "enum": [ - "Fully Executable", - "Not Executable", - "Partially Executable", - "Partially Executable - Possible Overreporting", - "Partially Executable - Possible Underreporting" - ], - "type": "string" + "$ref": "Executability.json" }, "Match Datasets": { "items": { @@ -624,7 +617,9 @@ ], "if": { "properties": { - "Sensitivity": { "const": "Group" } + "Sensitivity": { + "const": "Group" + } } }, "then": { 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" +} diff --git a/resources/schema/Executability.md b/resources/schema/Executability.md new file mode 100644 index 000000000..a774c282a --- /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