Add force_synthethic_source parameter (#2472)

elastic · Apr 4, 2024 · bda8a6d · bda8a6d
1 parent 345c58f
commit bda8a6d
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 13 deletions.
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts
@@ -41,6 +41,13 @@ export interface Request extends RequestBase {
     index: IndexName
   }
   query_parameters: {
+    /**
+     * Should this request force synthetic _source?
+     * Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
+     * Fetches with this enabled will be slower the enabling synthetic source natively in the index.
+     * @availability stack since=8.4.0 visibility=feature_flag feature_flag=es.index_mode_feature_flag_registered
+     */
+    force_synthetic_source?: boolean
     /**
      * Specifies the node or shard the operation should be performed on. Random by default.
      */

diff --git a/specification/_global/mget/MultiGetRequest.ts b/specification/_global/mget/MultiGetRequest.ts
@@ -36,6 +36,13 @@ export interface Request extends RequestBase {
     index?: IndexName
   }
   query_parameters: {
+    /**
+     * Should this request force synthetic _source?
+     * Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
+     * Fetches with this enabled will be slower the enabling synthetic source natively in the index.
+     * @availability stack since=8.4.0 visibility=feature_flag feature_flag=es.index_mode_feature_flag_registered
+     */
+    force_synthetic_source?: boolean
     /**
      * Specifies the node or shard the operation should be performed on. Random by default.
      */

diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts
@@ -324,6 +324,13 @@ export interface Request extends RequestBase {
      * @doc_id sort-search-results
      */
     sort?: string | string[]
+    /**
+     * Should this request force synthetic _source?
+     * Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
+     * Fetches with this enabled will be slower the enabling synthetic source natively in the index.
+     * @availability stack since=8.4.0 visibility=feature_flag feature_flag=es.index_mode_feature_flag_registered
+     */
+    force_synthetic_source?: boolean
   }
   // We should keep this in sync with the multi search request body.
   body: {