diff --git a/codetf.schema.json b/codetf.schema.json index da6f8aa..a3fcbb2 100644 --- a/codetf.schema.json +++ b/codetf.schema.json @@ -210,6 +210,10 @@ "type": "string", "description": "Name of the tool that detected the issue" }, + "rule": { + "$ref": "#/definitions/detector/rule", + "description": "The rule that detected the issue" + }, "ruleId": { "type": "string", "description": "ID of the tool vendor rule that detected the issue" @@ -217,10 +221,55 @@ "ruleDescription": { "type": "string", "description": "Short description of the tool vendor rule that detected the issue" + }, + "findings": { + "type": "array", + "items": { "$ref": "#/definitions/detector/finding" } } }, "additionalProperties": true, - "required": ["name", "ruleId"] + "required": ["name", "rule", "findings"] + }, + + "detector": { + "finding": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "description": "A unique identifier for the finding" + }, + "fixed": { + "type": "boolean", + "description": "Whether the finding was fixed by the codemod" + }, + "reason": { + "type": "string", + "description": "A human-readable description of the finding" + } + }, + "additionalProperties": true, + "required": ["guid", "fixed"] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the rule" + }, + "name": { + "type": "string", + "description": "The name of the rule" + }, + "description": { + "type": "string", + "description": "A description of the rule" + } + }, + "additionalProperties": false, + "required": ["id", "name"] + } } },