Adding allow_partial_search_results parameter to OpenPointInTime acti…

…on (#3155)
elastic · Nov 20, 2024 · db4203b · db4203b
1 parent 42097e7
commit db4203b
Show file tree

Hide file tree

Showing 7 changed files with 59 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/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts
@@ -71,6 +71,12 @@ export interface Request extends RequestBase {
      * @server_default open
      */
     expand_wildcards?: ExpandWildcards
+    /**
+     * If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.
+     * If `true`, the point in time will contain all the shards that are available at the time of the request.
+     * @server_default false
+     */
+    allow_partial_search_results?: boolean
   }
   body: {
     /**

diff --git a/specification/_json_spec/open_point_in_time.json b/specification/_json_spec/open_point_in_time.json
@@ -47,6 +47,10 @@
         "type": "string",
         "description": "Specific the time to live for the point in time",
         "required": true
+      },
+      "allow_partial_search_results": {
+        "type": "boolean",
+        "description": "Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)"
       }
     },
     "body": {