Merge pull request #5610 from brethubbard/master

Improve error messages when schema validation fails

.changeset/smart-sheep-itch.md

@@ -0,0 +1,5 @@
+---
+'@backstage/catalog-model': patch
+---
+
+Improve error messages when schema validation fails

packages/catalog-model/src/kinds/ApiEntityV1alpha1.test.ts

@@ -168,4 +168,16 @@ components:
     (entity as any).spec.system = '';
     await expect(validator.check(entity)).rejects.toThrow(/system/);
   });
+
+  it('rejects additional properties', async () => {
+    (entity as any).annotations = 'Test';
+    await expect(validator.check(entity)).rejects.toThrow(
+      /additional properties/,
+    );
+  });
+
+  it('rejects with useful error message', async () => {
+    (entity as any).annotations = 'Test';
+    await expect(validator.check(entity)).rejects.toThrow(/annotations/);
+  });
 });

packages/catalog-model/src/kinds/util.ts

@@ -66,7 +66,13 @@ export function ajvCompiledJsonSchemaValidator(
       }
 
       throw new TypeError(
-        `Malformed ${kind}, ${error.dataPath || '<root>'} ${error.message}`,
+        `Malformed ${kind}, ${error.dataPath || '<root>'} ${error.message}${
+          error.params
+            ? ` - ${Object.entries(error.params)
+                .map(([key, val]) => `${key}: ${val}`)
+                .join(', ')}`
+            : ''
+        }`,
       );
     },
   };