Arxo diagnostic 0.1

Reference page for the diagnostic.schema.json JSON schema.

Versions

No accepted version marker is declared.

Top-level fields

name	type-or-$ref	required	description
code	string	yes	—
severity	enum (4)	yes	—
message	string	yes	—
primarySpan	#/$defs/SourceSpan	no	—
primaryLocation	#/$defs/DiagnosticLocation	no	—
relatedSpans	array	no	—
relatedLocations	array	no	—
legalSourceAnchors	array	no	—
explanation	string	no	—
suggestedFixes	array	no	—
machineData	object	no	—

Enumerations

location	values
properties/severity	"error", "warning", "information", "hint"
allOf/1/if/properties/code	"LDC-E5301"
allOf/1/then/properties/severity	"error"
$defs/TableCellLocation/properties/kind	"table_cell"
$defs/ParameterRowLocation/properties/kind	"parameter_row"
$defs/JsonPointerLocation/properties/kind	"json_pointer"
$defs/SuggestedFix/properties/applicability	"always", "maybe", "manual_review"

Raw schema

https://law.arxo.io/schema/diagnostic.schema.json

Position

Type: object. Required: line, character.

name	type-or-$ref	description
line	integer	—
character	integer	—
offset	integer	—

SourceSpan

Type: object. Required: uri, start, end.

name	type-or-$ref	description
uri	string	—
start	#/$defs/Position	—
end	#/$defs/Position	—

RelatedSpan

Type: object. Required: span, message.

name	type-or-$ref	description
span	#/$defs/SourceSpan	—
message	string	—

TableCellLocation

Type: object. Required: kind, uri, table, row, column.

name	type-or-$ref	description
kind	"table_cell"	—
uri	string	—
table	string	—
row	string	—
column	string	—
jsonPointer	string	—
sheet	string	—
cell	string	—
xpath	string	—

ParameterRowLocation

Type: object. Required: kind, uri, dataset, row, jsonPointer.

name	type-or-$ref	description
kind	"parameter_row"	—
uri	string	—
dataset	string	—
row	string	—
jsonPointer	string	—

JsonPointerLocation

Type: object. Required: kind, uri, jsonPointer.

name	type-or-$ref	description
kind	"json_pointer"	—
uri	string	—
jsonPointer	string	—

DiagnosticLocation

Definition DiagnosticLocation.

RelatedLocation

Type: object. Required: location, message.

name	type-or-$ref	description
location	#/$defs/DiagnosticLocation	—
message	string	—

TextEdit

Type: object. Required: span, replacement.

name	type-or-$ref	description
span	#/$defs/SourceSpan	—
replacement	string	—

SuggestedFix

Type: object. Required: title, applicability, edits.

name	type-or-$ref	description
title	string	—
applicability	enum (3)	—
edits	array	—