@elastic/schemas 0.7.1 → 0.7.3

package/lib/cjs/cloud/schemas/search_eligible_remote_clusters.d.ts

@@ -5,7 +5,7 @@ export declare const SearchEligibleRemoteClustersRequest: z.ZodObject<{
     from: z.ZodOptional<z.ZodNumber>;
     cursor: z.ZodOptional<z.ZodString>;
     size: z.ZodOptional<z.ZodNumber>;
-    query: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+    query: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
     sort: z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>;
 }, z.core.$strip>;
 export type SearchEligibleRemoteClustersRequest = SearchRequest;
@@ -18,30 +18,30 @@ export declare const SearchEligibleRemoteClustersResponse: z.ZodObject<{
         alias: z.ZodOptional<z.ZodString>;
         healthy: z.ZodBoolean;
         resources: z.ZodObject<{
-            elasticsearch: z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-            kibana: z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-            apm: z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-            appsearch: z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-            enterprise_search: z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-            integrations_server: z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            elasticsearch: z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            kibana: z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            apm: z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            appsearch: z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            enterprise_search: z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            integrations_server: z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         }, z.core.$strip>;
         settings: z.ZodOptional<z.ZodObject<{
-            traffic_filter_settings: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            traffic_filter_settings: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
             observability: z.ZodOptional<z.ZodObject<{
                 logging: z.ZodOptional<z.ZodObject<{
-                    destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                    destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
                 }, z.core.$strip>>;
                 metrics: z.ZodOptional<z.ZodObject<{
-                    destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                    destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
                 }, z.core.$strip>>;
             }, z.core.$strip>>;
             autoscaling_enabled: z.ZodOptional<z.ZodBoolean>;
-            auto_ops: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
-            byok: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+            auto_ops: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+            byok: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
             solution_type: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
         metadata: z.ZodOptional<z.ZodObject<{
-            tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
             byok_enabled: z.ZodOptional<z.ZodBoolean>;
             byok_migration: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>;

package/lib/cjs/cloud/schemas/set_deployment_es_resource_keystore.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { KeystoreContents } from './definitions/misc.js';
-export declare const SetDeploymentEsResourceKeystoreRequest: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+export declare const SetDeploymentEsResourceKeystoreRequest: z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 export type SetDeploymentEsResourceKeystoreRequest = KeystoreContents;
-export declare const SetDeploymentEsResourceKeystoreResponse: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+export declare const SetDeploymentEsResourceKeystoreResponse: z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 export type SetDeploymentEsResourceKeystoreResponse = KeystoreContents;
 //# sourceMappingURL=set_deployment_es_resource_keystore.d.ts.map

package/lib/cjs/cloud/schemas/set_deployment_es_resource_keystore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"set_deployment_es_resource_keystore.d.ts","sourceRoot":"","sources":["../../../../src/cloud/schemas/set_deployment_es_resource_keystore.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,gBAAgB,EAAkB,MAAM,uBAAuB,CAAA;AAExE,eAAO,MAAM,sCAAsC,yEAAmB,CAAA;AACtE,MAAM,MAAM,sCAAsC,GAAG,gBAAgB,CAAA;AAErE,eAAO,MAAM,uCAAuC,yEAAmB,CAAA;AACvE,MAAM,MAAM,uCAAuC,GAAG,gBAAgB,CAAA"}
+{"version":3,"file":"set_deployment_es_resource_keystore.d.ts","sourceRoot":"","sources":["../../../../src/cloud/schemas/set_deployment_es_resource_keystore.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,gBAAgB,EAAkB,MAAM,uBAAuB,CAAA;AAExE,eAAO,MAAM,sCAAsC,4EAAmB,CAAA;AACtE,MAAM,MAAM,sCAAsC,GAAG,gBAAgB,CAAA;AAErE,eAAO,MAAM,uCAAuC,4EAAmB,CAAA;AACvE,MAAM,MAAM,uCAAuC,GAAG,gBAAgB,CAAA"}

package/lib/cjs/cloud/schemas/set_deployment_tags.d.ts

@@ -1,11 +1,11 @@
 import { z } from 'zod';
 import { DeploymentTagsResponse } from './definitions/deployment.js';
 export declare const SetDeploymentTagsRequest: z.ZodObject<{
-    tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type SetDeploymentTagsRequest = DeploymentTagsResponse;
 export declare const SetDeploymentTagsResponse: z.ZodObject<{
-    tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type SetDeploymentTagsResponse = DeploymentTagsResponse;
 //# sourceMappingURL=set_deployment_tags.d.ts.map

package/lib/cjs/cloud/schemas/setup_organization_idp.d.ts

@@ -3,13 +3,13 @@ import { OrganizationIdp } from './definitions/organization.js';
 export declare const IdpConfigurationRequest: z.ZodObject<{
     enabled: z.ZodBoolean;
     login_identifier_prefix: z.ZodString;
-    saml_idp: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    saml_idp: z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 }, z.core.$strip>;
 export type IdpConfigurationRequest = z.infer<typeof IdpConfigurationRequest>;
 export declare const SetupOrganizationIdpRequest: z.ZodObject<{
     enabled: z.ZodBoolean;
     login_identifier_prefix: z.ZodString;
-    saml_idp: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    saml_idp: z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 }, z.core.$strip>;
 export type SetupOrganizationIdpRequest = IdpConfigurationRequest;
 export declare const SetupOrganizationIdpResponse: z.ZodObject<{
@@ -23,7 +23,7 @@ export declare const SetupOrganizationIdpResponse: z.ZodObject<{
     configuration: z.ZodObject<{
         enabled: z.ZodBoolean;
         login_identifier_prefix: z.ZodString;
-        saml_idp: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        saml_idp: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type SetupOrganizationIdpResponse = OrganizationIdp;

package/lib/cjs/cloud/schemas/shutdown_deployment.d.ts

@@ -2,13 +2,13 @@ import { z } from 'zod';
 export declare const DeploymentShutdownResponse: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
-    orphaned: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    orphaned: z.ZodOptional<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
 }, z.core.$strip>;
 export type DeploymentShutdownResponse = z.infer<typeof DeploymentShutdownResponse>;
 export declare const ShutdownDeploymentResponse: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
-    orphaned: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    orphaned: z.ZodOptional<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
 }, z.core.$strip>;
 export type ShutdownDeploymentResponse = DeploymentShutdownResponse;
 //# sourceMappingURL=shutdown_deployment.d.ts.map

package/lib/cjs/cloud/schemas/shutdown_deployment_es_resource.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const ShutdownDeploymentEsResourceResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type ShutdownDeploymentEsResourceResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=shutdown_deployment_es_resource.d.ts.map

package/lib/cjs/cloud/schemas/shutdown_deployment_stateless_resource.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const ShutdownDeploymentStatelessResourceResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type ShutdownDeploymentStatelessResourceResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=shutdown_deployment_stateless_resource.d.ts.map

package/lib/cjs/cloud/schemas/start_deployment_resource_instances.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StartDeploymentResourceInstancesResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StartDeploymentResourceInstancesResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=start_deployment_resource_instances.d.ts.map

package/lib/cjs/cloud/schemas/start_deployment_resource_instances_all.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StartDeploymentResourceInstancesAllResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StartDeploymentResourceInstancesAllResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=start_deployment_resource_instances_all.d.ts.map

package/lib/cjs/cloud/schemas/start_deployment_resource_instances_all_maintenance_mode.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StartDeploymentResourceInstancesAllMaintenanceModeResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StartDeploymentResourceInstancesAllMaintenanceModeResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=start_deployment_resource_instances_all_maintenance_mode.d.ts.map

package/lib/cjs/cloud/schemas/start_deployment_resource_maintenance_mode.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StartDeploymentResourceMaintenanceModeResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StartDeploymentResourceMaintenanceModeResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=start_deployment_resource_maintenance_mode.d.ts.map

package/lib/cjs/cloud/schemas/stop_deployment_resource_instances.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StopDeploymentResourceInstancesResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StopDeploymentResourceInstancesResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=stop_deployment_resource_instances.d.ts.map

package/lib/cjs/cloud/schemas/stop_deployment_resource_instances_all.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StopDeploymentResourceInstancesAllResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StopDeploymentResourceInstancesAllResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=stop_deployment_resource_instances_all.d.ts.map

package/lib/cjs/cloud/schemas/stop_deployment_resource_instances_all_maintenance_mode.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StopDeploymentResourceInstancesAllMaintenanceModeResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StopDeploymentResourceInstancesAllMaintenanceModeResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=stop_deployment_resource_instances_all_maintenance_mode.d.ts.map

package/lib/cjs/cloud/schemas/stop_deployment_resource_maintenance_mode.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { DeploymentResourceCommandResponse } from './definitions/deployment.js';
 export declare const StopDeploymentResourceMaintenanceModeResponse: z.ZodObject<{
-    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+    warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
 }, z.core.$strip>;
 export type StopDeploymentResourceMaintenanceModeResponse = DeploymentResourceCommandResponse;
 //# sourceMappingURL=stop_deployment_resource_maintenance_mode.d.ts.map

package/lib/cjs/cloud/schemas/update_deployment.d.ts

@@ -4,27 +4,27 @@ export declare const UpdateDeploymentRequest: z.ZodObject<{
     name: z.ZodOptional<z.ZodString>;
     prune_orphans: z.ZodBoolean;
     resources: z.ZodOptional<z.ZodObject<{
-        elasticsearch: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
-        kibana: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
-        apm: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
-        appsearch: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
-        enterprise_search: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
-        integrations_server: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        elasticsearch: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        kibana: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        apm: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        appsearch: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        enterprise_search: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        integrations_server: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
     }, z.core.$strip>>;
     settings: z.ZodOptional<z.ZodObject<{
         observability: z.ZodOptional<z.ZodObject<{
             logging: z.ZodOptional<z.ZodObject<{
-                destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
             }, z.core.$strip>>;
             metrics: z.ZodOptional<z.ZodObject<{
-                destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
         autoscaling_enabled: z.ZodOptional<z.ZodBoolean>;
-        auto_ops: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        auto_ops: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
     }, z.core.$strip>>;
     metadata: z.ZodOptional<z.ZodObject<{
-        tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
     }, z.core.$strip>>;
     alias: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
@@ -40,28 +40,28 @@ export declare const UpdateDeploymentResponse: z.ZodObject<{
         kind: z.ZodString;
         region: z.ZodString;
         cloud_id: z.ZodOptional<z.ZodString>;
-        credentials: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        credentials: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         secret_token: z.ZodOptional<z.ZodString>;
-        warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
     }, z.core.$strip>>;
-    shutdown_resources: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+    shutdown_resources: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
     diagnostics: z.ZodOptional<z.ZodObject<{
-        creates: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-        updates: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        creates: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        updates: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
     }, z.core.$strip>>;
     settings: z.ZodOptional<z.ZodObject<{
-        traffic_filter_settings: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        traffic_filter_settings: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         observability: z.ZodOptional<z.ZodObject<{
             logging: z.ZodOptional<z.ZodObject<{
-                destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
             }, z.core.$strip>>;
             metrics: z.ZodOptional<z.ZodObject<{
-                destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
         autoscaling_enabled: z.ZodOptional<z.ZodBoolean>;
-        auto_ops: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
-        byok: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        auto_ops: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        byok: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         solution_type: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;

package/lib/cjs/cloud/schemas/update_deployment_es_resource_tier.d.ts

@@ -78,28 +78,28 @@ export declare const UpdateDeploymentEsResourceTierResponse: z.ZodObject<{
         kind: z.ZodString;
         region: z.ZodString;
         cloud_id: z.ZodOptional<z.ZodString>;
-        credentials: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        credentials: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         secret_token: z.ZodOptional<z.ZodString>;
-        warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
+        warnings: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>>;
     }, z.core.$strip>>;
-    shutdown_resources: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+    shutdown_resources: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
     diagnostics: z.ZodOptional<z.ZodObject<{
-        creates: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
-        updates: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        creates: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        updates: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
     }, z.core.$strip>>;
     settings: z.ZodOptional<z.ZodObject<{
-        traffic_filter_settings: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        traffic_filter_settings: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         observability: z.ZodOptional<z.ZodObject<{
             logging: z.ZodOptional<z.ZodObject<{
-                destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
             }, z.core.$strip>>;
             metrics: z.ZodOptional<z.ZodObject<{
-                destination: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+                destination: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
         autoscaling_enabled: z.ZodOptional<z.ZodBoolean>;
-        auto_ops: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
-        byok: z.ZodOptional<z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+        auto_ops: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        byok: z.ZodOptional<z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
         solution_type: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;

package/lib/cjs/cloud/schemas/update_role_mapping.d.ts

@@ -14,7 +14,7 @@ export declare const UpdateRoleMappingRequest: z.ZodObject<{
                 email: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>>;
         }, z.core.$strip>;
-        role_assignments: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        role_assignments: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type UpdateRoleMappingRequest = z.infer<typeof UpdateRoleMappingRequest>;

package/lib/cjs/cloud/schemas/update_role_mappings.d.ts

@@ -14,7 +14,7 @@ export declare const UpdateOrganizationRoleMappingRequest: z.ZodObject<{
                 email: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>>;
         }, z.core.$strip>;
-        role_assignments: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        role_assignments: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type UpdateOrganizationRoleMappingRequest = z.infer<typeof UpdateOrganizationRoleMappingRequest>;
@@ -32,7 +32,7 @@ export declare const UpdateRoleMappingsRequest: z.ZodObject<{
                 email: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>>>;
         }, z.core.$strip>;
-        role_assignments: z.ZodLazy<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        role_assignments: z.ZodLazy<z.ZodTypeAny<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type UpdateRoleMappingsRequest = UpdateOrganizationRoleMappingRequest;

package/lib/cjs/es/json/bulk.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "bulk", "description": "Bulk index or delete documents.\n\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.\n\nYou might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.\nRefer to the linked documentation for step-by-step instructions using the index settings API.", "x-api": { "id": "bulk", "name": "bulk", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_bulk", "x-urls": [{ "path": "/_bulk", "methods": ["POST", "PUT"] }, { "path": "/{index}/_bulk", "methods": ["POST", "PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-body-format": ["ndjson"], "type": "object", "properties": { "include_source_on_error": { "type": "boolean", "description": "True or false if to include the document source in the error message in case of parsing errors.", "x-found-in": "query" }, "list_executed_pipelines": { "type": "boolean", "description": "If `true`, the response will include the ingest pipelines that were run for each index or create.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default is `1`, which waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the request's actions must target an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "operations": { "type": "array", "items": { "anyOf": [{ "$ref": "./_global.bulk.json#/$defs/_global.bulk__OperationContainer" }, { "$ref": "./_global.bulk.json#/$defs/_global.bulk__UpdateAction" }, {}] }, "x-found-in": "body", "x-body-root": true }, "index": { "type": "string", "description": "The name of the data stream, index, or index alias to perform bulk actions on.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "bulk", "description": "Bulk index or delete documents.\n\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* Java: Check out `co.elastic.clients.elasticsearch._helpers.bulk.BulkIngester`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.\n\nYou might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests.\nRefer to the linked documentation for step-by-step instructions using the index settings API.", "x-api": { "id": "bulk", "name": "bulk", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_bulk", "x-urls": [{ "path": "/_bulk", "methods": ["POST", "PUT"] }, { "path": "/{index}/_bulk", "methods": ["POST", "PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "x-body-format": ["ndjson"], "type": "object", "properties": { "include_source_on_error": { "type": "boolean", "description": "True or false if to include the document source in the error message in case of parsing errors.", "x-found-in": "query" }, "list_executed_pipelines": { "type": "boolean", "description": "If `true`, the response will include the ingest pipelines that were run for each index or create.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The pipeline identifier to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.\nIf a final pipeline is configured, it will always run regardless of the value of this parameter.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, wait for a refresh to make this operation visible to search.\nIf `false`, do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query", "x-availability": { "stack": { "stability": "stable" } } }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned.\nYou can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards.\nThe default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default is `1`, which waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "require_alias": { "type": "boolean", "description": "If `true`, the request's actions must target an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "operations": { "type": "array", "items": { "anyOf": [{ "$ref": "./_global.bulk.json#/$defs/_global.bulk__OperationContainer" }, { "$ref": "./_global.bulk.json#/$defs/_global.bulk__UpdateAction" }, {}] }, "x-found-in": "body", "x-body-root": true }, "index": { "type": "string", "description": "The name of the data stream, index, or index alias to perform bulk actions on.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/cat.recovery.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.recovery", "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "x-api": { "id": "cat.recovery", "name": "recovery", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/recovery/{index}", "x-urls": [{ "path": "/_cat/recovery", "methods": ["GET"] }, { "path": "/_cat/recovery/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "x-response-type": ["text", "json"], "type": "object", "properties": { "active_only": { "type": "boolean", "description": "If `true`, the response only includes ongoing shard recoveries.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatRecoveryColumns", "description": "A comma-separated list of columns names to display.\nIt supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "format": { "type": "string", "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "help": { "type": "boolean", "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "v": { "type": "boolean", "description": "When set to `true` will enable verbose output.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "bytes": { "$ref": "./_types.json#/$defs/_types__Bytes", "description": "Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "time": { "$ref": "./_types.json#/$defs/_types__TimeUnit", "description": "Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.recovery", "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "x-api": { "id": "cat.recovery", "name": "recovery", "namespace": "cat" }, "x-method": "GET", "x-path": "/_cat/recovery/{index}", "x-urls": [{ "path": "/_cat/recovery", "methods": ["GET"] }, { "path": "/_cat/recovery/{index}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "x-response-type": ["text", "json"], "type": "object", "properties": { "active_only": { "type": "boolean", "description": "If `true`, the response only includes shard recoveries that have not yet completed (excludes `done` stage).", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about shard recoveries.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatRecoveryColumns", "description": "A comma-separated list of columns names to display.\nIt supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of column names or aliases that determines the sort order.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "format": { "type": "string", "description": "Specifies the format to return the columnar data in, can be set to\n`text`, `json`, `cbor`, `yaml`, or `smile`.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "help": { "type": "boolean", "description": "When set to `true` will output available columns. This option\ncan't be combined with any other query string option.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "v": { "type": "boolean", "description": "When set to `true` will enable verbose output.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "bytes": { "$ref": "./_types.json#/$defs/_types__Bytes", "description": "Sets the units for columns that contain a byte-size value.\nNote that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.\nIf omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "time": { "$ref": "./_types.json#/$defs/_types__TimeUnit", "description": "Sets the units for columns that contain a time duration.\nIf omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.\nIf given, time duration values are rendered as an integer with no suffix.\nValues that are not an exact multiple of the chosen unit are rounded down.", "x-found-in": "query", "x-behavior": "CommonCatQueryParameters" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/cjs/es/json/delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete", "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", "x-api": { "id": "delete", "name": "delete", "namespace": null }, "x-method": "DELETE", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The minimum number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the target index.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete", "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", "x-api": { "id": "delete", "name": "delete", "namespace": null }, "x-method": "DELETE", "x-path": "/{index}/_doc/{id}", "x-urls": [{ "path": "/{index}/_doc/{id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query", "x-availability": { "stack": { "stability": "stable" } } }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "The minimum number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", "x-found-in": "query", "x-availability": { "stack": {} } }, "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the target index.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }