A user account is required in order to edit this wiki, but we've had to disable public user registrations due to spam.

To request an account, ask an autoconfirmed user on IRC (such as one of these permanent autoconfirmed members).

Difference between revisions of "Validator.nu JSON Output"

From WHATWG Wiki
Jump to: navigation, search
(Message ''object''s)
m (Example: Fixed formatting)
Line 64: Line 64:
 
<pre><nowiki>{
 
<pre><nowiki>{
 
"url": "http://example.org/",
 
"url": "http://example.org/",
"messages": [{
+
"messages": [
"type" : "info",
+
{
 +
"type"   : "info",
 +
"subtype": "warning",
 
"line"  : 20,
 
"line"  : 20,
 
"column" : 15,
 
"column" : 15,
 
"url"    : "http://example.com/",
 
"url"    : "http://example.com/",
"subtype"  : "warning",
 
 
"message": "Trailing slash for void element",
 
"message": "Trailing slash for void element",
 
"extract": "<br/>",
 
"extract": "<br/>",
"offset": 3
+
"offset" : 3
 
},
 
},
 
{
 
{
"type" : "error",
+
"type"   : "error",
 +
"subtype": "fatal",
 
"line"  : 42,
 
"line"  : 42,
 
"column" : 17,
 
"column" : 17,
 
"url"    : "http://example.com/",
 
"url"    : "http://example.com/",
"subtype"  : "fatal",
+
"message": "Missing end tag for the <code>foo</code> element"
"message": "Missing end tag for the “foo” element",
+
}
}],
+
],
 
"result": {
 
"result": {
 
"type"  : "failure",
 
"type"  : "failure",

Revision as of 17:53, 11 September 2007

This is a draft of a Web service response format for Validator.nu for clients that prefer JSON over XML.

Italicized words, such as object, refer to JSON data types.

Root Object

The root object is a JSON object. It has two mandatory keys, "messages" and "result", and three optional keys, "url", "source" and "parseTree".

The values for these keys are described below.

The "messages" array

The this array is an ordered collection of zero or more message objects.

Message objects

A message object has one mandatory key, "type", and seven optional keys, "subtype", "message", "extract", "offset", "url", "line" and "column".

The "type" string

The "type" string denotes the general class of the message. The permissible values are "info", "error" and "non-document-error".

"info" means an informational message or warning that does not affect the validity of the document being checked. "error" signifies a problem that causes the validation/checking to fail. "non-document-error" signifies an error that causes the checking to end in an indeterminate state because the document being validated could not be examined to the end. Examples of such errors include broken schemas, bugs in the validator and IO errors. (Note that when a schema has parse errors, they are first reported as errors and then a catch-all non-document-error is also emitted.)

The "subtype" string

The permissible value with "type":"info" is "warning", which means that the message seeks to warn about the user of a formally conforming but in some way questionable issue. Otherwise, the message is taken to generally informative.

The permissible value with "type":"error" is "fatal", which means that the error is an XML well-formedness error or, in the case of HTML, a condition that the implementor has opted to treat analogously to XML well-formedness errors (e.g. due to usability or performance considerations). Further errors are suppressed after a fatal error. In the absence of the "subtype" key, a "type":"error" message means a spec violation in general.

Permissible values with "type":"non-document-error" are: "io" (signifies an input/output error), "schema" (indicates that initializing a schema-based validator failed) and "internal" (indicates that the validator/checker found an error bug in itself, ran out of memory, etc., but was still able to emit a message). In the absence of the "subtype" key, a "type":"non-document-error" message means a problem external to the document in general.

The "message" string
The "extract" string
The "offset" number
The "url" string
The "line" number
The "column" number

The "url" string

The "result" object

The "source" object

The "parseTree" object

Example

{
	"url": "http://example.org/",
	"messages": [
		{
			"type"   : "info",
			"subtype": "warning",
			"line"   : 20,
			"column" : 15,
			"url"    : "http://example.com/",
			"message": "Trailing slash for void element",
			"extract": "<br/>",
			"offset" : 3
		},
		{
			"type"   : "error",
			"subtype": "fatal",
			"line"   : 42,
			"column" : 17,
			"url"    : "http://example.com/",
			"message": "Missing end tag for the <code>foo</code> element"
		}
	],
	"result": {
		"type"  : "failure",
		"source": {
			"type"    : "text/html",
			"encoding": "UTF-8"
		},
		"parseTree": {
			...
		}
	}
};

Processing Model

See also