Add default values for EQL allow_partial_search_results and allow_par…

…tial_sequence_results (#3637) (#3652) (cherry picked from commit d74ecca) Co-authored-by: Luigi Dell'Aquila <[email protected]> Co-authored-by: Laura Trotta <[email protected]>
elastic · Jan 31, 2025 · a38549b · a38549b
1 parent f7d9aaf
commit a38549b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts
@@ -118,7 +118,19 @@ export interface Request extends RequestBase {
     keep_alive?: Duration
     keep_on_completion?: boolean
     wait_for_completion_timeout?: Duration
+    /**
+     * Allow query execution also in case of shard failures.
+     * If true, the query will keep running and will return results based on the available shards.
+     * For sequences, the behavior can be further refined using allow_partial_sequence_results
+     * @server_default true
+     */
     allow_partial_search_results?: boolean
+    /**
+     * This flag applies only to sequences and has effect only if allow_partial_search_results=true.
+     * If true, the sequence query will return results based on the available shards, ignoring the others.
+     * If false, the sequence query will return successfully, but will always have empty results.
+     * @server_default false
+     */
     allow_partial_sequence_results?: boolean
     /**
      * For basic queries, the maximum number of matching events to return. Defaults to 10