Add shard_failures to EQL response spec

elastic · Dec 19, 2024 · 287dcb3 · 287dcb3
1 parent 5987f79
commit 287dcb3
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 2 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/eql/_types/EqlSearchResponseBase.ts b/specification/eql/_types/EqlSearchResponseBase.ts
@@ -18,6 +18,7 @@
  */
 
 import { Id } from '@_types/common'
+import { ShardFailure } from '@_types/Errors'
 import { DurationValue, UnitMillis } from '@_types/Time'
 import { EqlHits } from './EqlHits'
 
@@ -46,4 +47,8 @@ export class EqlSearchResponseBase<TEvent> {
    * Contains matching events and sequences. Also contains related metadata.
    */
   hits: EqlHits<TEvent>
+  /**
+   * Contains information about shard failures (if any), in case allow_partial_search_results=true
+   */
+  shard_failures?: ShardFailure[]
 }