Skip to content

Commit 9c01a42

Browse files
committed
feat: Add field description to schema validation errors
1 parent 970f6d6 commit 9c01a42

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/schema/applyRules.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,11 @@ function evalJsonCheck(
189189
const metadataDef = schema.objects.metadata[key]
190190
const keyName: string = metadataDef.name
191191
const value = json[keyName]
192+
const issueMessage = `Field description: ${metadataDef.description}`
193+
192194
if (value === undefined) {
193195
const severity = getFieldSeverity(requirement, context)
194196
if (severity && severity !== 'ignore') {
195-
const issueMessage = `Field description: ${metadataDef.description}`
196197
if (requirement.issue?.code && requirement.issue?.message) {
197198
context.dataset.issues.add({
198199
code: requirement.issue.code,
@@ -243,7 +244,7 @@ function evalJsonCheck(
243244
context.dataset.issues.add({
244245
code: 'JSON_SCHEMA_VALIDATION_ERROR',
245246
subCode: keyName,
246-
issueMessage: err['message'],
247+
issueMessage: `${err['message']}\n\n${issueMessage}`,
247248
rule: schemaPath,
248249
location,
249250
affects,

0 commit comments

Comments
 (0)