NLdoc Validation API (3.0.135)

Download OpenAPI specification:

NLdoc: info@nldoc.nl URL: https://nldoc.nl/ License: EUPL1.2

This specification provides a standardized way to represent validation messages and notifications. The resources defined in this specification can be used to annotate resources present in the NLdoc Document Specification.

Validation

Validate a document.

Retrieve a list of validations for a given document.

Request Body schema: application/json
required

A document in NLdoc JSON schema format

any

Responses

Request samples

Payload

Content type

application/json

A document in NLdoc JSON schema format

{"id": "66edd412-b59e-4084-af46-ee8881850c90",
"type": "https://spec.nldoc.nl/Resource/Document",
"children": [{"id": "1a1dcd71-778a-492b-98cf-e5a8ed763905",
"type": "https://spec.nldoc.nl/Resource/Heading",
"level": 1,
"children": [{"id": "633bae3f-3f55-4ee0-8216-0eece81214cd",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "Document Heading 1"
}
]
},
{"id": "d0ba9207-bce4-42b8-be0e-38d146bb661b",
"type": "https://spec.nldoc.nl/Resource/Paragraph",
"children": [{"id": "270de2a7-dbe6-451a-a7db-25e122b34784",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "This is some text, "
},
{"id": "fa1321bb-27e2-4906-9916-63bf16496ede",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "can be bold, ",
"styling": ["bold"
]
},
{"id": "886a2f40-6b1c-4661-a53c-87ec2ee4ef25",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "can be italic, ",
"styling": ["italic"
]
},
{"id": "3b5d5a4d-6c2f-4703-9871-10eca1186a6c",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "or both.",
"styling": ["bold",
"italic"
]
}
]
},
{"id": "df15da68-973a-42a5-95fc-6489b8825226",
"type": "https://spec.nldoc.nl/Resource/Image",
"contentUrl": "https://www.creativefabrica.com/wp-content/uploads/2023/04/07/Fat-Cat-Eating-Burger-66469460-1.png",
"caption": [{"id": "a2deb31c-981b-4249-bb19-4fc2d474aef5",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "The cat loves the hamburger! Made by "
},
{"id": "8839d07b-5e71-4cc3-bc04-c4b0912ea841",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "Creative Fabrica",
"styling": ["italic"
]
},
{"id": "76f87346-c1c3-435d-9e73-c8da599a8ed2",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": " "
},
{"id": "eb697d13-7ff7-44aa-b81d-10a9bc8e18fa",
"type": "https://spec.nldoc.nl/Resource/Link",
"text": "(see source)",
"styling": ["superscript"
],
"uri": "https://www.creativefabrica.com/nl/product/fat-cat-eating-burger/",
"purpose": "Visit the source of the image."
},
{"id": "76f87346-c1c3-435d-9e73-c8da599a8ed2",
"type": "https://spec.nldoc.nl/Resource/Text",
"text": "."
}
],
"alternativeText": "A fat, white/brown cat with dark brown stripes eating a hamburger with cheese, lettuce, and tomato.",
"descriptors": [{"uri": "https://schema.org/author",
"value": {"@context": "https://schema.org",
"@type": "Organization",
"name": "Creative Fabrica",
"url": "https://www.creativefabrica.com/"
}
}
]
}
],
"descriptors": [{"uri": "https://schema.org/author",
"value": {"@context": "https://schema.org",
"@type": "Person",
"name": "John Doe",
"email": "mailto:john.doe@gmail.com",
"url": "https://john.doe.com/"
}
}
]
}

Response samples

Content type

application/json

{"data": [{"type": "https://spec.validation.nldoc.nl/Resource/ValidationFinding",
"resourceId": "d8c8fd4e-8036-472b-acb9-5797d44af08b",
"severity": "error",
"ruleset": "https://dequeuniversity.com/rules/axe/4.9/",
"rulesetVersion": "4.9",
"rule": "area-alt"
}
]
}

ValidationFinding — https://spec.validation.nldoc.nl/Resource/ValidationFinding

type required	string <uri> (https://spec.validation.nldoc.nl/Property/Type) URI type of the ValidationFinding resource. Value: "https://spec.validation.nldoc.nl/Resource/ValidationFinding"
resourceId required	string <uuid> (spec.validation.nldoc.nl.Property.Id) = 36 characters Identifier of the object
severity required	string (spec.validation.nldoc.nl.Property.Severity) Enum: "error" "warning" "notice" The severity of the validation finding. error The document is not accessible, as this finding prevents people with disabilities from accessing fundamental features or content. E.g. missing alt text on an image. warning The document is accessible, but this finding indicates a potential issue in the document's structure that the editor should review. E.g. bold text that might be a heading. notice The document is accessible, but the content could be improved. E.g. a word is not B1-level Dutch, or a link's purpose is not clear enough.
ruleset required	string <uri> (Ruleset) [ 1 .. 1000 ] characters URI of the ruleset that is being used.
rulesetVersion required	string (Ruleset version) non-empty Version of the ruleset that is being used.
rule required	string (Rule) [ 1 .. 1000 ] characters Rule ID of the rule that is being used.

{"type": "https://spec.validation.nldoc.nl/Resource/ValidationFinding",
"resourceId": "d8c8fd4e-8036-472b-acb9-5797d44af08b",
"severity": "error",
"ruleset": "https://dequeuniversity.com/rules/axe/4.9/",
"rulesetVersion": "4.9",
"rule": "area-alt"
}

Error — https://spec.validation.nldoc.nl/Resource/Error

code required	integer Error code.
message required	string Description of the error that occurred.

{"code": 500,
"message": "some error message"
}

Id — https://spec.validation.nldoc.nl/Property/Id

string <uuid> (https://spec.validation.nldoc.nl/Property/Id) = 36 characters

Identifier of the object

"550e8400-e29b-41d4-a716-446655440000"

Severity — https://spec.validation.nldoc.nl/Property/Severity

string (https://spec.validation.nldoc.nl/Property/Severity)

Enum: "error" "warning" "notice"

The severity of the validation finding.

error: The document is not accessible, as this finding prevents people with disabilities from accessing fundamental features or content. E.g. missing alt text on an image.
warning: The document is accessible, but this finding indicates a potential issue in the document's structure that the editor should review. E.g. bold text that might be a heading.
notice: The document is accessible, but the content could be improved. E.g. a word is not B1-level Dutch, or a link's purpose is not clear enough.

"error"