@elastic/schemas 0.5.1 → 0.6.0

package/src/es/json/connector.sync_job_post.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_post","description":"Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.","x-api":{"id":"connector.sync_job_post","name":"sync-job-post","namespace":"connector"},"x-method":"POST","x-path":"/_connector/_sync_job","x-urls":[{"path":"/_connector/_sync_job","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"id":{"type":"string","description":"The id of the associated connector","x-found-in":"body"},"job_type":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType","x-found-in":"body"},"trigger_method":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobTriggerMethod","x-found-in":"body"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_post","description":"Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.","x-api":{"id":"connector.sync_job_post","name":"sync-job-post","namespace":"connector"},"x-method":"POST","x-path":"/_connector/_sync_job","x-urls":[{"path":"/_connector/_sync_job","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"id":{"type":"string","description":"The id of the associated connector","x-found-in":"body"},"job_type":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobType","x-found-in":"body"},"trigger_method":{"$ref":"./connector._types.json#/$defs/connector._types__SyncJobTriggerMethod","x-found-in":"body"},"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"]}

package/src/es/json/connector.sync_job_update_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_update_stats","description":"Set the connector sync job stats.\n\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_update_stats","name":"sync-job-update-stats","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_stats","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_stats","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"deleted_document_count":{"type":"number","description":"The number of documents the sync job deleted.","x-found-in":"body"},"indexed_document_count":{"type":"number","description":"The number of documents the sync job indexed.","x-found-in":"body"},"indexed_document_volume":{"type":"number","description":"The total size of the data (in MiB) the sync job indexed.","x-found-in":"body"},"last_seen":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The timestamp to use in the `last_seen` property for the connector sync job.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"The connector-specific metadata.","x-found-in":"body"},"total_document_count":{"type":"number","description":"The total number of documents in the target index after the sync job finished.","x-found-in":"body"},"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job.","x-found-in":"path"}},"required":["connector_sync_job_id","deleted_document_count","indexed_document_count","indexed_document_volume"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.sync_job_update_stats","description":"Set the connector sync job stats.\n\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.sync_job_update_stats","name":"sync-job-update-stats","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/_sync_job/{connector_sync_job_id}/_stats","x-urls":[{"path":"/_connector/_sync_job/{connector_sync_job_id}/_stats","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"deleted_document_count":{"type":"number","description":"The number of documents the sync job deleted.","x-found-in":"body"},"indexed_document_count":{"type":"number","description":"The number of documents the sync job indexed.","x-found-in":"body"},"indexed_document_volume":{"type":"number","description":"The total size of the data (in MiB) the sync job indexed.","x-found-in":"body"},"last_seen":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The timestamp to use in the `last_seen` property for the connector sync job.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"The connector-specific metadata.","x-found-in":"body"},"total_document_count":{"type":"number","description":"The total number of documents in the target index after the sync job finished.","x-found-in":"body"},"connector_sync_job_id":{"type":"string","description":"The unique identifier of the connector sync job.","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":["connector_sync_job_id","deleted_document_count","indexed_document_count","indexed_document_volume"]}

package/src/es/json/connector.update_active_filtering.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_active_filtering","description":"Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.","x-api":{"id":"connector.update_active_filtering","name":"update-active-filtering","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_filtering/_activate","x-urls":[{"path":"/_connector/{connector_id}/_filtering/_activate","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_active_filtering","description":"Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.","x-api":{"id":"connector.update_active_filtering","name":"update-active-filtering","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_filtering/_activate","x-urls":[{"path":"/_connector/{connector_id}/_filtering/_activate","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id"]}

package/src/es/json/connector.update_api_key_id.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_api_key_id","description":"Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.","x-api":{"id":"connector.update_api_key_id","name":"update-api-key-id","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_api_key_id","x-urls":[{"path":"/_connector/{connector_id}/_api_key_id","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"api_key_id":{"type":"string","x-found-in":"body"},"api_key_secret_id":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_api_key_id","description":"Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.","x-api":{"id":"connector.update_api_key_id","name":"update-api-key-id","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_api_key_id","x-urls":[{"path":"/_connector/{connector_id}/_api_key_id","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"api_key_id":{"type":"string","x-found-in":"body"},"api_key_secret_id":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id"]}

package/src/es/json/connector.update_configuration.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_configuration","description":"Update the connector configuration.\n\nUpdate the configuration field in the connector document.","x-api":{"id":"connector.update_configuration","name":"update-configuration","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_configuration","x-urls":[{"path":"/_connector/{connector_id}/_configuration","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"configuration":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfiguration","x-found-in":"body"},"values":{"type":"object","additionalProperties":{},"x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_configuration","description":"Update the connector configuration.\n\nUpdate the configuration field in the connector document.","x-api":{"id":"connector.update_configuration","name":"update-configuration","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_configuration","x-urls":[{"path":"/_connector/{connector_id}/_configuration","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"configuration":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorConfiguration","x-found-in":"body"},"values":{"type":"object","additionalProperties":{},"x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id"]}

package/src/es/json/connector.update_error.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_error","description":"Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.","x-api":{"id":"connector.update_error","name":"update-error","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_error","x-urls":[{"path":"/_connector/{connector_id}/_error","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"error":{"$ref":"./_spec_utils.json#/$defs/_spec_utils__WithNullValue","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","error"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_error","description":"Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.","x-api":{"id":"connector.update_error","name":"update-error","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_error","x-urls":[{"path":"/_connector/{connector_id}/_error","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"error":{"$ref":"./_spec_utils.json#/$defs/_spec_utils__WithNullValue","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","error"]}

package/src/es/json/connector.update_features.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_features","description":"Update the connector features.\n\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.update_features","name":"update-features","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_features","x-urls":[{"path":"/_connector/{connector_id}/_features","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"features":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorFeatures","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated.","x-found-in":"path"}},"required":["connector_id","features"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_features","description":"Update the connector features.\n\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.","x-api":{"id":"connector.update_features","name":"update-features","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_features","x-urls":[{"path":"/_connector/{connector_id}/_features","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"features":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorFeatures","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated.","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":["connector_id","features"]}

package/src/es/json/connector.update_filtering.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_filtering","description":"Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.","x-api":{"id":"connector.update_filtering","name":"update-filtering","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_filtering","x-urls":[{"path":"/_connector/{connector_id}/_filtering","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"filtering":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringConfig"},"x-found-in":"body"},"rules":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRule"},"x-found-in":"body"},"advanced_snippet":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringAdvancedSnippet","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_filtering","description":"Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.","x-api":{"id":"connector.update_filtering","name":"update-filtering","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_filtering","x-urls":[{"path":"/_connector/{connector_id}/_filtering","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"filtering":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringConfig"},"x-found-in":"body"},"rules":{"type":"array","items":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRule"},"x-found-in":"body"},"advanced_snippet":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringAdvancedSnippet","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id"]}

package/src/es/json/connector.update_filtering_validation.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_filtering_validation","description":"Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.","x-api":{"id":"connector.update_filtering_validation","name":"update-filtering-validation","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_filtering/_validation","x-urls":[{"path":"/_connector/{connector_id}/_filtering/_validation","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"validation":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRulesValidation","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","validation"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_filtering_validation","description":"Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.","x-api":{"id":"connector.update_filtering_validation","name":"update-filtering-validation","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_filtering/_validation","x-urls":[{"path":"/_connector/{connector_id}/_filtering/_validation","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"validation":{"$ref":"./connector._types.json#/$defs/connector._types__FilteringRulesValidation","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","validation"]}

package/src/es/json/connector.update_index_name.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_index_name","description":"Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.","x-api":{"id":"connector.update_index_name","name":"update-index-name","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_index_name","x-urls":[{"path":"/_connector/{connector_id}/_index_name","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"index_name":{"$ref":"./_spec_utils.json#/$defs/_spec_utils__WithNullValue","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","index_name"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_index_name","description":"Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.","x-api":{"id":"connector.update_index_name","name":"update-index-name","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_index_name","x-urls":[{"path":"/_connector/{connector_id}/_index_name","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"index_name":{"$ref":"./_spec_utils.json#/$defs/_spec_utils__WithNullValue","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","index_name"]}

package/src/es/json/connector.update_name.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_name","description":"Update the connector name and description.","x-api":{"id":"connector.update_name","name":"update-name","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_name","x-urls":[{"path":"/_connector/{connector_id}/_name","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"description":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_name","description":"Update the connector name and description.","x-api":{"id":"connector.update_name","name":"update-name","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_name","x-urls":[{"path":"/_connector/{connector_id}/_name","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"name":{"type":"string","x-found-in":"body"},"description":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id"]}

package/src/es/json/connector.update_native.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_native","description":"Update the connector is_native flag.","x-api":{"id":"connector.update_native","name":"update-native","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_native","x-urls":[{"path":"/_connector/{connector_id}/_native","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"is_native":{"type":"boolean","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","is_native"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_native","description":"Update the connector is_native flag.","x-api":{"id":"connector.update_native","name":"update-native","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_native","x-urls":[{"path":"/_connector/{connector_id}/_native","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"is_native":{"type":"boolean","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","is_native"]}

package/src/es/json/connector.update_pipeline.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_pipeline","description":"Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.","x-api":{"id":"connector.update_pipeline","name":"update-pipeline","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_pipeline","x-urls":[{"path":"/_connector/{connector_id}/_pipeline","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"pipeline":{"$ref":"./connector._types.json#/$defs/connector._types__IngestPipelineParams","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","pipeline"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_pipeline","description":"Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.","x-api":{"id":"connector.update_pipeline","name":"update-pipeline","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_pipeline","x-urls":[{"path":"/_connector/{connector_id}/_pipeline","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"pipeline":{"$ref":"./connector._types.json#/$defs/connector._types__IngestPipelineParams","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","pipeline"]}

package/src/es/json/connector.update_scheduling.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_scheduling","description":"Update the connector scheduling.","x-api":{"id":"connector.update_scheduling","name":"update-scheduling","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_scheduling","x-urls":[{"path":"/_connector/{connector_id}/_scheduling","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"scheduling":{"$ref":"./connector._types.json#/$defs/connector._types__SchedulingConfiguration","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","scheduling"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_scheduling","description":"Update the connector scheduling.","x-api":{"id":"connector.update_scheduling","name":"update-scheduling","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_scheduling","x-urls":[{"path":"/_connector/{connector_id}/_scheduling","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"scheduling":{"$ref":"./connector._types.json#/$defs/connector._types__SchedulingConfiguration","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","scheduling"]}

package/src/es/json/connector.update_service_type.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_service_type","description":"Update the connector service type.","x-api":{"id":"connector.update_service_type","name":"update-service-type","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_service_type","x-urls":[{"path":"/_connector/{connector_id}/_service_type","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"service_type":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","service_type"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_service_type","description":"Update the connector service type.","x-api":{"id":"connector.update_service_type","name":"update-service-type","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_service_type","x-urls":[{"path":"/_connector/{connector_id}/_service_type","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"beta"},"serverless":{"stability":"beta","visibility":"public"}},"type":"object","properties":{"service_type":{"type":"string","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","service_type"]}

package/src/es/json/connector.update_status.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_status","description":"Update the connector status.","x-api":{"id":"connector.update_status","name":"update-status","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_status","x-urls":[{"path":"/_connector/{connector_id}/_status","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"status":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorStatus","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","x-found-in":"path"}},"required":["connector_id","status"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"connector.update_status","description":"Update the connector status.","x-api":{"id":"connector.update_status","name":"update-status","namespace":"connector"},"x-method":"PUT","x-path":"/_connector/{connector_id}/_status","x-urls":[{"path":"/_connector/{connector_id}/_status","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"status":{"$ref":"./connector._types.json#/$defs/connector._types__ConnectorStatus","x-found-in":"body"},"connector_id":{"type":"string","description":"The unique identifier of the connector to be updated","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":["connector_id","status"]}

package/src/es/json/count.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"count","description":"Count search results.\n\nGet the number of documents matching a query.\n\nThe query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.\nThe query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n\nThe count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n\nThe operation is broadcast across all shards.\nFor each shard ID group, a replica is chosen and the search is run against it.\nThis means that replicas increase the scalability of the count.","x-api":{"id":"count","name":"count","namespace":null},"x-method":"POST","x-path":"/{index}/_count","x-urls":[{"path":"/_count","methods":["POST","GET"]},{"path":"/{index}/_count","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_throttled":{"type":"boolean","description":"If `true`, concrete, expanded, or aliased indices are ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"min_score":{"type":"number","description":"The minimum `_score` value that documents must have to be included in the result.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nBy default, it is random.","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"},"stats":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"q":{"type":"string","description":"The query in Lucene query string syntax. This parameter cannot be used with a request body.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"count","description":"Count search results.\n\nGet the number of documents matching a query.\n\nThe query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.\nThe query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n\nThe count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n\nThe operation is broadcast across all shards.\nFor each shard ID group, a replica is chosen and the search is run against it.\nThis means that replicas increase the scalability of the count.","x-api":{"id":"count","name":"count","namespace":null},"x-method":"POST","x-path":"/{index}/_count","x-urls":[{"path":"/_count","methods":["POST","GET"]},{"path":"/{index}/_count","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_throttled":{"type":"boolean","description":"If `true`, concrete, expanded, or aliased indices are ignored when frozen.","x-found-in":"query","x-deprecated":{"since":"7.16.0"}},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"min_score":{"type":"number","description":"The minimum `_score` value that documents must have to be included in the result.","x-found-in":"query"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nBy default, it is random.","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"},"stats":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"q":{"type":"string","description":"The query in Lucene query string syntax. This parameter cannot be used with a request body.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.","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/src/es/json/create.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"create","description":"Create a new document in the index.\n\nYou can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `/<target>/_doc/` API.\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 add a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\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**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.","x-api":{"id":"create","name":"create","namespace":null},"x-method":"PUT","x-path":"/{index}/_create/{id}","x-urls":[{"path":"/{index}/_create/{id}","methods":["PUT","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"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"},"pipeline":{"type":"string","description":"The ID of the pipeline 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`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the destination must be 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"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\nElasticsearch waits for at least the specified timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"version":{"type":"number","description":"The explicit version number for concurrency control.\nIt must be a non-negative long number.","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 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":{}}},"document":{"x-found-in":"body","x-body-root":true},"id":{"type":"string","description":"A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format.","x-found-in":"path"},"index":{"type":"string","description":"The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn’t match a data stream template, this request creates the index.","x-found-in":"path"}},"required":["id","index"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"create","description":"Create a new document in the index.\n\nYou can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `/<target>/_doc/` API.\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 add a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\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**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.","x-api":{"id":"create","name":"create","namespace":null},"x-method":"PUT","x-path":"/{index}/_create/{id}","x-urls":[{"path":"/{index}/_create/{id}","methods":["PUT","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"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"},"pipeline":{"type":"string","description":"The ID of the pipeline 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`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.","x-found-in":"query"},"require_alias":{"type":"boolean","description":"If `true`, the destination must be 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"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\nElasticsearch waits for at least the specified timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.","x-found-in":"query"},"version":{"type":"number","description":"The explicit version number for concurrency control.\nIt must be a non-negative long number.","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 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":{}}},"document":{"x-found-in":"body","x-body-root":true},"id":{"type":"string","description":"A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format.","x-found-in":"path"},"index":{"type":"string","description":"The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn’t match a data stream template, this request creates the 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"]}

package/src/es/json/dangling_indices.delete_dangling_index.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"dangling_indices.delete_dangling_index","description":"Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.","x-api":{"id":"dangling-indices.delete_dangling_index","name":"delete-dangling-index","namespace":"dangling-indices"},"x-method":"DELETE","x-path":"/_dangling/{index_uuid}","x-urls":[{"path":"/_dangling/{index_uuid}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"}},"type":"object","properties":{"accept_data_loss":{"type":"boolean","description":"This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.","x-found-in":"query"},"index_uuid":{"type":"string","description":"The UUID of the index to delete. Use the get dangling indices API to find the UUID.","x-found-in":"path"}},"required":["index_uuid"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"dangling_indices.delete_dangling_index","description":"Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.","x-api":{"id":"dangling-indices.delete_dangling_index","name":"delete-dangling-index","namespace":"dangling-indices"},"x-method":"DELETE","x-path":"/_dangling/{index_uuid}","x-urls":[{"path":"/_dangling/{index_uuid}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"}},"type":"object","properties":{"accept_data_loss":{"type":"boolean","description":"This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.","x-found-in":"query"},"index_uuid":{"type":"string","description":"The UUID of the index to delete. Use the get dangling indices API to find the UUID.","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":["index_uuid"]}

package/src/es/json/dangling_indices.import_dangling_index.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"dangling_indices.import_dangling_index","description":"Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.","x-api":{"id":"dangling-indices.import_dangling_index","name":"import-dangling-index","namespace":"dangling-indices"},"x-method":"POST","x-path":"/_dangling/{index_uuid}","x-urls":[{"path":"/_dangling/{index_uuid}","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"}},"type":"object","properties":{"accept_data_loss":{"type":"boolean","description":"This parameter must be set to true to import a dangling index.\nBecause Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.","x-found-in":"query"},"index_uuid":{"type":"string","description":"The UUID of the index to import. Use the get dangling indices API to locate the UUID.","x-found-in":"path"}},"required":["index_uuid"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"dangling_indices.import_dangling_index","description":"Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.","x-api":{"id":"dangling-indices.import_dangling_index","name":"import-dangling-index","namespace":"dangling-indices"},"x-method":"POST","x-path":"/_dangling/{index_uuid}","x-urls":[{"path":"/_dangling/{index_uuid}","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"}},"type":"object","properties":{"accept_data_loss":{"type":"boolean","description":"This parameter must be set to true to import a dangling index.\nBecause Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.","x-found-in":"query"},"index_uuid":{"type":"string","description":"The UUID of the index to import. Use the get dangling indices API to locate the UUID.","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":["index_uuid"]}

package/src/es/json/dangling_indices.list_dangling_indices.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"dangling_indices.list_dangling_indices","description":"Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.","x-api":{"id":"dangling-indices.list_dangling_indices","name":"list-dangling-indices","namespace":"dangling-indices"},"x-method":"GET","x-path":"/_dangling","x-urls":[{"path":"/_dangling","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"}},"type":"object","properties":{}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"dangling_indices.list_dangling_indices","description":"Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.","x-api":{"id":"dangling-indices.list_dangling_indices","name":"list-dangling-indices","namespace":"dangling-indices"},"x-method":"GET","x-path":"/_dangling","x-urls":[{"path":"/_dangling","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"}},"type":"object","properties":{"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/src/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"}},"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"},"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"]}

package/src/es/json/delete_by_query.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete_by_query","description":"Delete documents.\n\nDeletes documents that match the specified query.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `delete` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\nWhen you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.\nIf a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.\n\nNOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.\nA bulk delete request is performed for each batch of matching documents.\nIf a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.\nIf the maximum retry limit is reached, processing halts and all failed requests are returned in the response.\nAny delete requests that completed successfully still stick, they are not rolled back.\n\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.\n\n**Throttling delete requests**\n\nTo control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to disable throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is `1000`, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nDelete by query supports sliced scroll to parallelize the delete process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` lets Elasticsearch choose the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\nAdding slices to the delete by query operation creates sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with slices only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with `slices` will cancel each sub-request.\n* Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead.\n* Delete performance scales linearly across available resources with the number of slices.\n\nWhether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Cancel a delete by query operation**\n\nAny delete by query can be canceled using the task cancel API. For example:\n\n```\nPOST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel\n```\n\nThe task ID can be found by using the get tasks API.\n\nCancellation should happen quickly but might take a few seconds.\nThe get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.","x-api":{"id":"delete_by_query","name":"delete-by-query","namespace":null},"x-method":"POST","x-path":"/{index}/_delete_by_query","x-urls":[{"path":"/{index}/_delete_by_query","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"Analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"conflicts":{"$ref":"./_types.json#/$defs/_types__Conflicts","description":"What to do if delete by query hits version conflicts: `abort` or `proceed`.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of documents.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_docs":{"type":"number","description":"The maximum number of documents to delete.","x-found-in":"body"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.\nThis is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed.\nUnlike the delete API, it does not support `wait_for`.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the request cache is used for this request.\nDefaults to the index-level setting.","x-found-in":"query"},"requests_per_second":{"type":"number","description":"The maximum number of documents to delete per second, across the entire delete-by-query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","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"},"q":{"type":"string","description":"A query in the Lucene query string syntax.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"query"},"scroll_size":{"type":"number","description":"The size of the scroll request that powers the operation.","x-found-in":"query"},"search_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The explicit timeout for each search request.\nIt defaults to no timeout.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.\nAvailable options include `query_then_fetch` and `dfs_query_then_fetch`.","x-found-in":"query"},"slices":{"$ref":"./_types.json#/$defs/_types__Slices","description":"The number of slices this task should be divided into.","x-found-in":"query"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A sort object that specifies the order of deleted documents.","x-found-in":"body"},"stats":{"type":"array","items":{"type":"string"},"description":"The specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each deletion request waits for active shards.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, returns the document version as part of a hit.","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 `timeout` value controls how long each write request waits for unavailable shards to become available.","x-found-in":"query","x-availability":{"stack":{}}},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to delete specified with Query DSL.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the request manually using the provided slice ID and total number of slices.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"required":["index"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete_by_query","description":"Delete documents.\n\nDeletes documents that match the specified query.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `delete` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\nWhen you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.\nIf a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.\n\nNOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.\nA bulk delete request is performed for each batch of matching documents.\nIf a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.\nIf the maximum retry limit is reached, processing halts and all failed requests are returned in the response.\nAny delete requests that completed successfully still stick, they are not rolled back.\n\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.\n\n**Throttling delete requests**\n\nTo control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to disable throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is `1000`, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nDelete by query supports sliced scroll to parallelize the delete process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` lets Elasticsearch choose the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\nAdding slices to the delete by query operation creates sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with slices only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with `slices` will cancel each sub-request.\n* Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead.\n* Delete performance scales linearly across available resources with the number of slices.\n\nWhether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Cancel a delete by query operation**\n\nAny delete by query can be canceled using the task cancel API. For example:\n\n```\nPOST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel\n```\n\nThe task ID can be found by using the get tasks API.\n\nCancellation should happen quickly but might take a few seconds.\nThe get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.","x-api":{"id":"delete_by_query","name":"delete-by-query","namespace":null},"x-method":"POST","x-path":"/{index}/_delete_by_query","x-urls":[{"path":"/{index}/_delete_by_query","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"5.0.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"analyzer":{"type":"string","description":"Analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"analyze_wildcard":{"type":"boolean","description":"If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"conflicts":{"$ref":"./_types.json#/$defs/_types__Conflicts","description":"What to do if delete by query hits version conflicts: `abort` or `proceed`.","x-found-in":"query"},"default_operator":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__Operator","description":"The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"df":{"type":"string","description":"The field to use as default where no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"The type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nIt supports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"from":{"type":"number","description":"Skips the specified number of documents.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"lenient":{"type":"boolean","description":"If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.","x-found-in":"query"},"max_docs":{"type":"number","description":"The maximum number of documents to delete.","x-found-in":"body"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"refresh":{"type":"boolean","description":"If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.\nThis is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed.\nUnlike the delete API, it does not support `wait_for`.","x-found-in":"query"},"request_cache":{"type":"boolean","description":"If `true`, the request cache is used for this request.\nDefaults to the index-level setting.","x-found-in":"query"},"requests_per_second":{"type":"number","description":"The maximum number of documents to delete per second, across the entire delete-by-query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","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"},"q":{"type":"string","description":"A query in the Lucene query string syntax.","x-found-in":"query"},"scroll":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to retain the search context for scrolling.","x-found-in":"query"},"scroll_size":{"type":"number","description":"The size of the scroll request that powers the operation.","x-found-in":"query"},"search_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The explicit timeout for each search request.\nIt defaults to no timeout.","x-found-in":"query"},"search_type":{"$ref":"./_types.json#/$defs/_types__SearchType","description":"The type of the search operation.\nAvailable options include `query_then_fetch` and `dfs_query_then_fetch`.","x-found-in":"query"},"slices":{"$ref":"./_types.json#/$defs/_types__Slices","description":"The number of slices this task should be divided into.","x-found-in":"query"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"A sort object that specifies the order of deleted documents.","x-found-in":"body"},"stats":{"type":"array","items":{"type":"string"},"description":"The specific `tag` of the request for logging and statistical purposes.","x-found-in":"query"},"terminate_after":{"type":"number","description":"The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nUse with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period each deletion request waits for active shards.","x-found-in":"query"},"version":{"type":"boolean","description":"If `true`, returns the document version as part of a hit.","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 `timeout` value controls how long each write request waits for unavailable shards to become available.","x-found-in":"query","x-availability":{"stack":{}}},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.\nIf `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.","x-found-in":"query"},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The documents to delete specified with Query DSL.","x-found-in":"body"},"slice":{"$ref":"./_types.json#/$defs/_types__SlicedScroll","description":"Slice the request manually using the provided slice ID and total number of slices.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.","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":["index"]}

package/src/es/json/delete_by_query_rethrottle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete_by_query_rethrottle","description":"Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.","x-api":{"id":"delete_by_query_rethrottle","name":"delete-by-query-rethrottle","namespace":null},"x-method":"POST","x-path":"/_delete_by_query/{task_id}/_rethrottle","x-urls":[{"path":"/_delete_by_query/{task_id}/_rethrottle","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"requests_per_second":{"type":"number","description":"The maximum number of documents to delete per second, across the entire delete-by-query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"task_id":{"type":"string","description":"The ID for the task.","x-found-in":"path"}},"required":["task_id","requests_per_second"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete_by_query_rethrottle","description":"Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.","x-api":{"id":"delete_by_query_rethrottle","name":"delete-by-query-rethrottle","namespace":null},"x-method":"POST","x-path":"/_delete_by_query/{task_id}/_rethrottle","x-urls":[{"path":"/_delete_by_query/{task_id}/_rethrottle","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"requests_per_second":{"type":"number","description":"The maximum number of documents to delete per second, across the entire delete-by-query operation (including slices).\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.","x-found-in":"query"},"task_id":{"type":"string","description":"The ID for the task.","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":["task_id","requests_per_second"]}

package/src/es/json/delete_script.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete_script","description":"Delete a script or search template.\n\nDeletes a stored script or search template.","x-api":{"id":"delete_script","name":"delete-script","namespace":null},"x-method":"DELETE","x-path":"/_scripts/{id}","x-urls":[{"path":"/_scripts/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"id":{"type":"string","description":"The identifier for the stored script or search template.","x-found-in":"path"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"delete_script","description":"Delete a script or search template.\n\nDeletes a stored script or search template.","x-api":{"id":"delete_script","name":"delete-script","namespace":null},"x-method":"DELETE","x-path":"/_scripts/{id}","x-urls":[{"path":"/_scripts/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.","x-found-in":"query"},"id":{"type":"string","description":"The identifier for the stored script or search template.","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"]}

package/src/es/json/encryption.reset.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"encryption.reset","description":"Reset the project encryption key.\n\nDestroy the current project encryption key (PEK) and generate a new one.\nThis is the recovery path for when the on-disk encrypted PEK becomes permanently\ninaccessible, for example because the key encryption material protecting it was lost.\n\nAll data that was encrypted under the destroyed key becomes permanently unrecoverable.\nEach feature that stores encrypted data decides how to handle its own data during the\nreset: some features drop the encrypted values entirely, while others preserve the rest\nof the affected data and only clear the values that can no longer be decrypted.\n\nBecause this operation causes permanent data loss, it requires the `accept_data_loss`\nquery parameter to be set to `true`.","x-api":{"id":"encryption.reset","name":"reset","namespace":"encryption"},"x-method":"POST","x-path":"/_encryption/_reset","x-urls":[{"path":"/_encryption/_reset","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"9.5.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"accept_data_loss":{"type":"boolean","description":"Acknowledge that resetting the project encryption key permanently destroys all data\nthat was encrypted under the current key.\nThe request fails if this is not set to `true`.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["accept_data_loss"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"encryption.reset","description":"Reset the project encryption key.\n\nDestroy the current project encryption key (PEK) and generate a new one.\nThis is the recovery path for when the on-disk encrypted PEK becomes permanently\ninaccessible, for example because the key encryption material protecting it was lost.\n\nAll data that was encrypted under the destroyed key becomes permanently unrecoverable.\nEach feature that stores encrypted data decides how to handle its own data during the\nreset: some features drop the encrypted values entirely, while others preserve the rest\nof the affected data and only clear the values that can no longer be decrypted.\n\nBecause this operation causes permanent data loss, it requires the `accept_data_loss`\nquery parameter to be set to `true`.","x-api":{"id":"encryption.reset","name":"reset","namespace":"encryption"},"x-method":"POST","x-path":"/_encryption/_reset","x-urls":[{"path":"/_encryption/_reset","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"9.5.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"accept_data_loss":{"type":"boolean","description":"Acknowledge that resetting the project encryption key permanently destroys all data\nthat was encrypted under the current key.\nThe request fails if this is not set to `true`.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"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":["accept_data_loss"]}

package/src/es/json/enrich._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"enrich._types__Summary":{"type":"object","properties":{"config":{"type":"object","additionalProperties":{"$ref":"./enrich._types.json#/$defs/enrich._types__Policy"}}},"required":["config"]},"enrich._types__Policy":{"type":"object","properties":{"enrich_fields":{"$ref":"./_types.json#/$defs/_types__Fields"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices"},"match_field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},"name":{"type":"string"},"elasticsearch_version":{"type":"string"}},"required":["enrich_fields","indices","match_field"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"enrich._types__Summary":{"type":"object","properties":{"config":{"type":"object","additionalProperties":{"$ref":"./enrich._types.json#/$defs/enrich._types__Policy"},"minProperties":1,"maxProperties":1}},"required":["config"]},"enrich._types__Policy":{"type":"object","properties":{"enrich_fields":{"$ref":"./_types.json#/$defs/_types__Fields"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices"},"match_field":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},"name":{"type":"string"},"elasticsearch_version":{"type":"string"}},"required":["enrich_fields","indices","match_field"]}}}

package/src/es/json/enrich.delete_policy.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"enrich.delete_policy","description":"Delete an enrich policy.\n\nDeletes an existing enrich policy and its enrich index.","x-api":{"id":"enrich.delete_policy","name":"delete-policy","namespace":"enrich"},"x-method":"DELETE","x-path":"/_enrich/policy/{name}","x-urls":[{"path":"/_enrich/policy/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"name":{"type":"string","description":"Enrich policy to delete.","x-found-in":"path"}},"required":["name"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"enrich.delete_policy","description":"Delete an enrich policy.\n\nDeletes an existing enrich policy and its enrich index.","x-api":{"id":"enrich.delete_policy","name":"delete-policy","namespace":"enrich"},"x-method":"DELETE","x-path":"/_enrich/policy/{name}","x-urls":[{"path":"/_enrich/policy/{name}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node.","x-found-in":"query"},"name":{"type":"string","description":"Enrich policy to delete.","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":["name"]}