Zum Hauptinhalt springen

Diagnostic

One finding of a check. Only error findings make ok false.

severitystring

error: a render (or, for data, validate_data) would fail; warning and info are advice.

Possible values: [error, warning, info]

messagestring

The finding in English.

codestring

A stable name for the kind of finding.

location object

Where in the template source, line and column from 1.

lineinteger
columninteger
pathstring

Data errors only: where in the data, e.g. data.invoice.lines[0].qty.

partstring

Word and PowerPoint templates only: the file part the tag is in, e.g. word/document.xml or ppt/slides/slide2.xml.

paragraphinteger

Word and PowerPoint templates only: the 1-based paragraph in part, as the template page lists it.

Diagnostic
{
"severity": "error",
"message": "string",
"code": "string",
"location": {
"line": 0,
"column": 0
},
"path": "string",
"part": "string",
"paragraph": 0
}