LanguageTool · Schema

LanguageTool Match

A single grammar or style match returned by the LanguageTool /check endpoint.

GrammarLanguageProofreadingSpell CheckStyle CheckText Analysis

Properties

Name	Type	Description
message	string
shortMessage	string
offset	integer
length	integer
replacements	array
context	object
sentence	string
rule	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/languagetool/main/json-schema/languagetool-match-schema.json",
  "title": "LanguageTool Match",
  "description": "A single grammar or style match returned by the LanguageTool /check endpoint.",
  "type": "object",
  "properties": {
    "message": { "type": "string" },
    "shortMessage": { "type": "string" },
    "offset": { "type": "integer" },
    "length": { "type": "integer" },
    "replacements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": { "type": "string" }
        }
      }
    },
    "context": {
      "type": "object",
      "properties": {
        "text": { "type": "string" },
        "offset": { "type": "integer" },
        "length": { "type": "integer" }
      }
    },
    "sentence": { "type": "string" },
    "rule": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "description": { "type": "string" },
        "issueType": { "type": "string" },
        "category": {
          "type": "object",
          "properties": {
            "id": { "type": "string" },
            "name": { "type": "string" }
          }
        }
      }
    }
  },
  "required": ["message", "offset", "length", "rule"]
}