{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-restquerycorrection-schema.json",
  "title": "Coveo Search RestQueryCorrection",
  "required": [
    "correctedQuery",
    "wordCorrections"
  ],
  "type": "object",
  "properties": {
    "correctedQuery": {
      "type": "string",
      "description": "The resulting query expression correction suggestion.",
      "example": "Coveo Cloud V2 platform"
    },
    "wordCorrections": {
      "type": "array",
      "description": "The word correction suggestions.",
      "items": {
        "required": [
          "correctedWord",
          "length",
          "offset",
          "originalWord"
        ],
        "type": "object",
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (in number of characters) of the corrected word, from the beginning of the resulting query expression correction suggestion.",
            "format": "int32",
            "example": 15
          },
          "length": {
            "type": "integer",
            "description": "The length (in number of characters) of the corrected word.",
            "format": "int32",
            "example": 8
          },
          "originalWord": {
            "type": "string",
            "description": "The original, un-corrected word.",
            "example": "plattfomr"
          },
          "correctedWord": {
            "type": "string",
            "description": "The suggested word correction.",
            "example": "platform"
          }
        }
      }
    }
  }
}