Add a type for a search error response

The Elasticsearch client needs a type representing an ES error. It would be amazing to also have a type guard isElasticseachError, that accepts either a SearchResponse or a ErrorResponse and returns true if it’s an error.

A standard response looks like this:

{
  "error" : {
    "root_cause" : [
      {
        "type" : "parsing_exception",
        "reason" : "Unknown order direction [xxx]",
        "line" : 7,
        "col" : 16
      }
    ],
    "type" : "x_content_parse_exception",
    "reason" : "[7:16] [terms] failed to parse field [order]",
    "caused_by" : {
      "type" : "parsing_exception",
      "reason" : "Unknown order direction [xxx]",
      "line" : 7,
      "col" : 16
    }
  },
  "status" : 400
}

It can be generated by running the following command in DevTools:

GET kibana_sample_data_logs/_search
{
  "aggs": {
    "2": {
      "terms": {
        "field": "machine.os.keyword",
        "order": {
          "1": "xxx"
        }
      }
    }
  }
}

[lizozom]

I’m fine with closing it and \ or waiting until the new client provides types 🤷‍♀️

[delvedor]

at the moment, the new Elasticsearch Client doesn’t provide types for responses at all.

Correct.

if an error is returned but “ignored,” the error response follows the normal response path but does not match the SearchResponse type.

Also correct.

I’m not sure how this could be solved nicely.