From 62434baed0554451ac170115795c82dc6df95110 Mon Sep 17 00:00:00 2001
From: Dan D'Avella <dan.davella@pixee.ai>
Date: Tue, 28 May 2024 09:57:40 -0400
Subject: [PATCH] Add CodeTF failure state to result (#31)

---
 codetf.schema.json | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/codetf.schema.json b/codetf.schema.json
index ad82833..9621927 100644
--- a/codetf.schema.json
+++ b/codetf.schema.json
@@ -87,6 +87,21 @@
           "description": "Vendor-specific properties to help storytelling",
           "additionalProperties": true
         },
+        "failure": {
+          "type": "object",
+          "description": "If present indicates that the codemod failed to run",
+          "properties": {
+            "reason": {
+              "type": "string",
+              "description": "A short description of why the codemod failed"
+            },
+            "exception": {
+              "type": "string",
+              "description": "More detailed information about the exception that caused the failure"
+            }
+          },
+          "required": ["reason"]
+        },
         "failedFiles": {
           "type": "array",
           "description": "A set of file paths for files that the tool failed to parse or transform",