changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "created_at": {
+ "type": "string"
+ },
+ "document": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "size": {
+ "type": "integer"
+ },
+ "source": {
+ "enum": [
+ "upload",
+ "url",
+ "body"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "error": {
+ "description": "What went wrong on our side when status is failed.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "finished_at": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "id": {
+ "description": "The validation id, for get_validation.",
+ "type": "string"
+ },
+ "progress": {
+ "maximum": 100,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "result": {
+ "description": "Null until the validation is done.",
+ "properties": {
+ "bytes": {
+ "type": "integer"
+ },
+ "documents": {
+ "description": "For an archive: errors and warnings are then in items.",
+ "properties": {
+ "failed": {
+ "type": "integer"
+ },
+ "passed": {
+ "type": "integer"
+ },
+ "skipped": {
+ "type": "integer"
+ },
+ "total": {
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "duration_ms": {
+ "type": "integer"
+ },
+ "engine": {
+ "properties": {
+ "libxml2": {
+ "type": "string"
+ },
+ "saxonjs": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "xmlvalid": {
+ "type": "string"
+ }
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "errors": {
+ "description": "The errors, the first 50 when errors_listed is set.",
+ "items": {
+ "properties": {
+ "column": {
+ "description": "0 when unknown.",
+ "type": "integer"
+ },
+ "help_url": {
+ "description": "A page explaining this kind of error and how to fix it.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "level": {
+ "enum": [
+ "warning",
+ "error",
+ "fatal"
+ ],
+ "type": "string"
+ },
+ "line": {
+ "description": "0 when the message is about the whole document.",
+ "type": "integer"
+ },
+ "message": {
+ "type": "string"
+ },
+ "message_en": {
+ "description": "The message in English, for a rule its publisher wrote in another language.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "path": {
+ "description": "Where a business rule fired, as an XPath with the document's prefixes.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "rule": {
+ "description": "The business rule that failed, such as BR-CO-15; explain it with explain_rule.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "rule_url": {
+ "description": "The rule's page on xmlvalid.com.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "type": {
+ "description": "syntax, xsd, relaxng, dtd, schema, io, schematron (a business rule), archive or pdf.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "line",
+ "message"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "errors_listed": {
+ "description": "Set when errors were cut to this many; errors_total counts them all.",
+ "type": "integer"
+ },
+ "errors_total": {
+ "type": "integer"
+ },
+ "errors_truncated": {
+ "description": "More than the 500 errors the API keeps were found.",
+ "type": "boolean"
+ },
+ "items": {
+ "description": "For an archive, one result per document.",
+ "items": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "outcome": {
+ "type": "string"
+ },
+ "valid": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "name",
+ "outcome"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "outcome": {
+ "enum": [
+ "valid",
+ "warnings",
+ "invalid",
+ "schema",
+ "input",
+ "failed"
+ ],
+ "type": "string"
+ },
+ "pdf": {
+ "description": "For a PDF, the invoice found in it.",
+ "properties": {
+ "attachment": {
+ "description": "The XML file validated, such as factur-x.xml.",
+ "type": "string"
+ },
+ "guideline": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "profile": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "sha256": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "valid": {
+ "description": "True for the outcomes valid and warnings.",
+ "type": "boolean"
+ },
+ "warnings": {
+ "description": "The warnings, the first 50 when warnings_listed is set.",
+ "items": {
+ "properties": {
+ "column": {
+ "description": "0 when unknown.",
+ "type": "integer"
+ },
+ "help_url": {
+ "description": "A page explaining this kind of error and how to fix it.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "level": {
+ "enum": [
+ "warning",
+ "error",
+ "fatal"
+ ],
+ "type": "string"
+ },
+ "line": {
+ "description": "0 when the message is about the whole document.",
+ "type": "integer"
+ },
+ "message": {
+ "type": "string"
+ },
+ "message_en": {
+ "description": "The message in English, for a rule its publisher wrote in another language.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "path": {
+ "description": "Where a business rule fired, as an XPath with the document's prefixes.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "rule": {
+ "description": "The business rule that failed, such as BR-CO-15; explain it with explain_rule.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "rule_url": {
+ "description": "The rule's page on xmlvalid.com.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "type": {
+ "description": "syntax, xsd, relaxng, dtd, schema, io, schematron (a business rule), archive or pdf.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "line",
+ "message"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "warnings_listed": {
+ "description": "Set when warnings were cut to this many.",
+ "type": "integer"
+ },
+ "warnings_total": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "valid",
+ "errors",
+ "warnings"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "rule_sets": {
+ "description": "The Schematron rule sets that ran after the schema check, at their releases.",
+ "items": {
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "version"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "rules": {
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "schema": {
+ "description": "Null when only well-formedness was checked.",
+ "properties": {
+ "catalog": {
+ "description": "The catalog slug.",
+ "type": "string"
+ },
+ "detected": {
+ "description": "True when schema \"auto\" picked this profile.",
+ "type": "boolean"
+ },
+ "kind": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "saved": {
+ "description": "The saved schema, as @<name>.",
+ "type": "string"
+ }
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "status": {
+ "description": "queued or running: poll get_validation with the id; done: see result.",
+ "enum": [
+ "queued",
+ "running",
+ "done",
+ "failed",
+ "cancelled"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "status"
+ ],
+ "type": "object"
+}