@elastic/schemas 0.4.4 → 0.4.5

package/lib/cjs/es/json/async_search.submit.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "async_search.submit", "type": "object", "properties": { "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "x-found-in": "body" }, "explain": { "type": "boolean", "description": "Specify whether to return detailed information about score computation as part of a hit", "x-found-in": "query" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "x-found-in": "body" }, "from": { "type": "number", "description": "Starting offset", "x-found-in": "query" }, "highlight": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Highlight", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "Indicate if the number of documents that match the query should be tracked.\nA number can also be specified, to accurately track the total hit count up to the number.", "x-found-in": "query" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boosts the _score of documents from specified indices.", "x-found-in": "body" }, "docvalue_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit", "x-found-in": "query" }, "knn": { "oneOf": [{ "$ref": "./_types.json#/$defs/_types__KnnSearch" }, { "type": "array", "items": { "$ref": "./_types.json#/$defs/_types__KnnSearch" } }], "description": "Defines the approximate kNN search to run.", "x-found-in": "body" }, "min_score": { "type": "number", "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.", "x-found-in": "body" }, "post_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "x-found-in": "body" }, "profile": { "type": "boolean", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "oneOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "x-found-in": "body" }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Retrieve a script evaluation (based on different fields) for each hit.", "x-found-in": "body" }, "search_after": { "$ref": "./_types.json#/$defs/_types__SortResults", "x-found-in": "body" }, "size": { "type": "number", "description": "Number of hits to return", "x-found-in": "query" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "x-found-in": "body" }, "sort": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of <field>:<direction> pairs", "x-found-in": "query" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfigParam", "description": "True or false to return the _source field or not, or a list of fields to return", "x-found-in": "query" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "suggest": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Suggester", "x-found-in": "body" }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Explicit operation timeout", "x-found-in": "query" }, "track_scores": { "type": "boolean", "description": "Whether to calculate and return scores even if they are not used for sorting", "x-found-in": "query" }, "version": { "type": "boolean", "description": "Specify whether to return document version as part of a hit", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "Specify whether to return sequence number and primary term of the last modification of each hit", "x-found-in": "query" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A comma-separated list of stored fields to return as part of a hit", "x-found-in": "query" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "x-found-in": "body" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "Specific 'tag' of the request for logging and statistical purposes", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", "x-found-in": "query" }, "keep_on_completion": { "type": "boolean", "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", "x-found-in": "query" }, "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" }, "allow_partial_search_results": { "type": "boolean", "description": "Indicate if an error should be returned if there is a partial search failure or timeout", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "Specify whether wildcard and prefix queries should be analyzed", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "description": "Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "The default value is the only supported value.", "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)", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as default where no field prefix is given in the query string", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", "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": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "x-found-in": "query" }, "preference": { "type": "string", "description": "Specify the node or shard the operation should be performed on", "x-found-in": "query" }, "request_cache": { "type": "boolean", "description": "Specify if request cache should be used for this request or not, defaults to true", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A comma-separated list of specific routing values", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Search operation type", "x-found-in": "query" }, "suggest_field": { "type": "string", "description": "Specifies which field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "description": "Specify suggest mode", "x-found-in": "query" }, "suggest_size": { "type": "number", "description": "How many suggestions to return in response", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.", "x-found-in": "query" }, "typed_keys": { "type": "boolean", "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "x-found-in": "query" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A list of fields to exclude from the returned _source field", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A list of fields to extract and return from the _source field", "x-found-in": "query" }, "q": { "type": "string", "description": "Query in the Lucene query string syntax", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "description": "Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "async_search.submit", "type": "object", "properties": { "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Blocks and waits until the search is completed up to a certain timeout.\nWhen the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", "x-found-in": "query" }, "keep_on_completion": { "type": "boolean", "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", "x-found-in": "query" }, "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" }, "allow_partial_search_results": { "type": "boolean", "description": "Indicate if an error should be returned if there is a partial search failure or timeout", "x-found-in": "query" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "Specify whether wildcard and prefix queries should be analyzed", "x-found-in": "query" }, "batched_reduce_size": { "type": "number", "description": "Affects how often partial results become available, which happens whenever shard results are reduced.\nA partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default).", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "The default value is the only supported value.", "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)", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as default where no field prefix is given in the query string", "x-found-in": "query" }, "docvalue_fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns doc values for field\nnames matching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, returns detailed information about score computation as part of a hit.", "x-found-in": "body" }, "ignore_throttled": { "type": "boolean", "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled", "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": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored", "x-found-in": "query" }, "max_concurrent_shard_requests": { "type": "number", "description": "The number of concurrent shard requests per node this search executes concurrently.\nThis value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests", "x-found-in": "query" }, "preference": { "type": "string", "description": "Specify the node or shard the operation should be performed on", "x-found-in": "query" }, "request_cache": { "type": "boolean", "description": "Specify if request cache should be used for this request or not, defaults to true", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A comma-separated list of specific routing values", "x-found-in": "query" }, "search_type": { "$ref": "./_types.json#/$defs/_types__SearchType", "description": "Search operation type", "x-found-in": "query" }, "stats": { "type": "array", "items": { "type": "string" }, "description": "Stats groups to associate with the search. Each group maintains a statistics\naggregation for its associated searches. You can retrieve these stats using\nthe indices stats API.", "x-found-in": "body" }, "stored_fields": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "List of stored fields to return as part of a hit. If no fields are specified,\nno stored fields are included in the response. If this field is specified, the _source\nparameter defaults to false. You can pass _source: true to return both source fields\nand stored fields in the search response.", "x-found-in": "body" }, "suggest_field": { "type": "string", "description": "Specifies which field to use for suggestions.", "x-found-in": "query" }, "suggest_mode": { "$ref": "./_types.json#/$defs/_types__SuggestMode", "description": "Specify suggest mode", "x-found-in": "query" }, "suggest_size": { "type": "number", "description": "How many suggestions to return in response", "x-found-in": "query" }, "suggest_text": { "type": "string", "description": "The source text for which the suggestions should be returned.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "Maximum number of documents to collect for each shard. If a query reaches this\nlimit, Elasticsearch terminates the query early. Elasticsearch collects documents\nbefore sorting. Defaults to 0, which does not terminate query execution early.", "x-found-in": "body" }, "timeout": { "type": "string", "description": "Specifies the period of time to wait for a response from each shard. If no response\nis received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "x-found-in": "body" }, "track_total_hits": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__TrackHits", "description": "Number of hits matching the query to count accurately. If true, the exact\nnumber of hits is returned at the cost of some performance. If false, the\nresponse does not include the total number of hits matching the query.\nDefaults to 10,000 hits.", "x-found-in": "body" }, "track_scores": { "type": "boolean", "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", "x-found-in": "body" }, "typed_keys": { "type": "boolean", "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response", "x-found-in": "query" }, "rest_total_hits_as_int": { "type": "boolean", "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response", "x-found-in": "query" }, "version": { "type": "boolean", "description": "If true, returns document version as part of a hit.", "x-found-in": "body" }, "_source": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__SourceConfig", "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "x-found-in": "body" }, "_source_excludes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A list of fields to exclude from the returned _source field", "x-found-in": "query" }, "_source_includes": { "$ref": "./_types.json#/$defs/_types__Fields", "description": "A list of fields to extract and return from the _source field", "x-found-in": "query" }, "seq_no_primary_term": { "type": "boolean", "description": "If true, returns sequence number and primary term of the last modification\nof each hit. See Optimistic concurrency control.", "x-found-in": "body" }, "q": { "type": "string", "description": "Query in the Lucene query string syntax", "x-found-in": "query" }, "size": { "type": "number", "description": "The number of hits to return. By default, you cannot page through more\nthan 10,000 hits using the from and size parameters. To page through more\nhits, use the search_after parameter.", "x-found-in": "body" }, "from": { "type": "number", "description": "Starting document offset. By default, you cannot page through more than 10,000\nhits using the from and size parameters. To page through more hits, use the\nsearch_after parameter.", "x-found-in": "body" }, "sort": { "$ref": "./_types.json#/$defs/_types__Sort", "x-found-in": "body" }, "aggregations": { "type": "object", "additionalProperties": { "$ref": "./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer" }, "x-found-in": "body" }, "collapse": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__FieldCollapse", "x-found-in": "body" }, "ext": { "type": "object", "additionalProperties": {}, "description": "Configuration of search extensions defined by Elasticsearch plugins.", "x-found-in": "body" }, "highlight": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Highlight", "x-found-in": "body" }, "indices_boost": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } }, "description": "Boosts the _score of documents from specified indices.", "x-found-in": "body" }, "knn": { "anyOf": [{ "$ref": "./_types.json#/$defs/_types__KnnSearch" }, { "type": "array", "items": { "$ref": "./_types.json#/$defs/_types__KnnSearch" } }], "description": "Defines the approximate kNN search to run.", "x-found-in": "body" }, "min_score": { "type": "number", "description": "Minimum _score for matching documents. Documents with a lower _score are\nnot included in search results and results collected by aggregations.", "x-found-in": "body" }, "post_filter": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "x-found-in": "body" }, "profile": { "type": "boolean", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search definition using the Query DSL.", "x-found-in": "body" }, "rescore": { "anyOf": [{ "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" }, { "type": "array", "items": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Rescore" } }], "x-found-in": "body" }, "script_fields": { "type": "object", "additionalProperties": { "$ref": "./_types.json#/$defs/_types__ScriptField" }, "description": "Retrieve a script evaluation (based on different fields) for each hit.", "x-found-in": "body" }, "search_after": { "$ref": "./_types.json#/$defs/_types__SortResults", "x-found-in": "body" }, "slice": { "$ref": "./_types.json#/$defs/_types__SlicedScroll", "x-found-in": "body" }, "fields": { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, "description": "Array of wildcard (*) patterns. The request returns values for field names\nmatching these patterns in the hits.fields property of the response.", "x-found-in": "body" }, "suggest": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__Suggester", "x-found-in": "body" }, "pit": { "$ref": "./_global.search._types.json#/$defs/_global.search._types__PointInTimeReference", "description": "Limits the search to a point in time (PIT). If you provide a PIT, you\ncannot specify an <index> in the request path.", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices", "x-found-in": "path" } }, "description": "Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting." }

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

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

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.circuit_breaker", "type": "object", "properties": { "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumns", "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "circuit_breaker_patterns": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of regular-expressions to filter the circuit breakers in the output", "x-found-in": "path" } }, "description": "Get circuit breakers statistics.\n\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cat.circuit_breaker", "type": "object", "properties": { "h": { "$ref": "./cat._types.json#/$defs/cat._types__CatCircuitBreakerColumns", "description": "A comma-separated list of columns names to display. It supports simple wildcards.", "x-found-in": "query" }, "s": { "$ref": "./_types.json#/$defs/_types__Names", "description": "List of columns that determine how the table should be sorted.\nSorting defaults to ascending and can be changed by setting `:asc`\nor `:desc` as a suffix to the column name.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request computes the list of selected nodes from the\nlocal cluster state. If `false` the list of selected nodes are computed\nfrom the cluster state of the master node. In both cases the coordinating\nnode will send requests for further information to each selected node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "circuit_breaker_patterns": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of regular-expressions to filter the circuit breakers in the output", "x-found-in": "path" } }, "description": "Get circuit breakers statistics.\n\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications." }

package/lib/cjs/es/json/ccr.follow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow", "type": "object", "properties": { "data_stream_name": { "type": "string", "description": "If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.", "x-found-in": "body" }, "leader_index": { "type": "string", "description": "The name of the index in the leader cluster to follow.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding write requests on the follower.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader index.", "x-found-in": "body" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Settings to override from the leader index.", "x-found-in": "body" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index", "leader_index", "remote_cluster"], "description": "Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.follow", "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" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be\nactive.\nA shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the\nremote Lucene segment files to the follower index.", "x-found-in": "query" }, "data_stream_name": { "type": "string", "description": "If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.", "x-found-in": "body" }, "leader_index": { "type": "string", "description": "The name of the index in the leader cluster to follow.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding write requests on the follower.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when\nretrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be\ndeferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will\nbe deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.\nWhen the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.\nThen the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader index.", "x-found-in": "body" }, "settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Settings to override from the leader index.", "x-found-in": "body" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index", "leader_index", "remote_cluster"], "description": "Create a follower.\n\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index." }

package/lib/cjs/es/json/ccr.forget_follower.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.forget_follower", "type": "object", "properties": { "follower_cluster": { "type": "string", "x-found-in": "body" }, "follower_index": { "type": "string", "x-found-in": "body" }, "follower_index_uuid": { "type": "string", "x-found-in": "body" }, "leader_remote_cluster": { "type": "string", "x-found-in": "body" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "index": { "type": "string", "description": "Name of the leader index for which specified follower retention leases should be removed", "x-found-in": "path" } }, "required": ["index"], "description": "Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.forget_follower", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "follower_cluster": { "type": "string", "x-found-in": "body" }, "follower_index": { "type": "string", "x-found-in": "body" }, "follower_index_uuid": { "type": "string", "x-found-in": "body" }, "leader_remote_cluster": { "type": "string", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the leader index for which specified follower retention leases should be removed", "x-found-in": "path" } }, "required": ["index"], "description": "Forget a follower.\n\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked." }

package/lib/cjs/es/json/ccr.put_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.put_auto_follow_pattern", "type": "object", "properties": { "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader indices to match against.", "x-found-in": "body" }, "follow_index_pattern": { "type": "string", "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", "x-found-in": "body" }, "leader_index_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", "x-found-in": "body" }, "leader_index_exclusion_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "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": "The name of the collection of auto-follow patterns.", "x-found-in": "path" } }, "required": ["name", "remote_cluster"], "description": "Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.put_auto_follow_pattern", "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" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader indices to match against.", "x-found-in": "body" }, "follow_index_pattern": { "type": "string", "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", "x-found-in": "body" }, "leader_index_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", "x-found-in": "body" }, "leader_index_exclusion_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "name": { "type": "string", "description": "The name of the collection of auto-follow patterns.", "x-found-in": "path" } }, "required": ["name", "remote_cluster"], "description": "Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns." }

package/lib/cjs/es/json/ccr.resume_follow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_follow", "type": "object", "properties": { "max_outstanding_read_requests": { "type": "number", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_read_request_size": { "type": "string", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "x-found-in": "body" }, "max_write_buffer_size": { "type": "string", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_write_request_size": { "type": "string", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "index": { "type": "string", "description": "Name of the follow index to resume following", "x-found-in": "path" } }, "required": ["index"], "description": "Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_follow", "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" }, "max_outstanding_read_requests": { "type": "number", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_read_request_size": { "type": "string", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "x-found-in": "body" }, "max_write_buffer_size": { "type": "string", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_write_request_size": { "type": "string", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the follow index to resume following", "x-found-in": "path" } }, "required": ["index"], "description": "Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index." }

package/lib/cjs/es/json/cluster.allocation_explain.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.allocation_explain", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index that you would like an explanation for.", "x-found-in": "query" }, "shard": { "type": "number", "description": "An identifier for the shard that you would like an explanation for.", "x-found-in": "query" }, "primary": { "type": "boolean", "description": "If true, returns an explanation for the primary shard for the specified shard ID.", "x-found-in": "query" }, "current_node": { "type": "string", "description": "Explain a shard only if it is currently located on the specified node name or node ID.", "x-found-in": "query" }, "include_disk_info": { "type": "boolean", "description": "If true, returns information about disk usage and shard sizes.", "x-found-in": "query" }, "include_yes_decisions": { "type": "boolean", "description": "If true, returns YES decisions in explanation.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } }, "description": "Explain the shard allocations.\n\nGet explanations for shard allocations in the cluster.\nThis API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.\nFor unassigned shards, it provides an explanation for why the shard is unassigned.\nFor assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.\nThis API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.\nRefer to the linked documentation for examples of how to troubleshoot allocation issues using this API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.allocation_explain", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the index that you would like an explanation for.", "x-found-in": "body" }, "shard": { "type": "number", "description": "An identifier for the shard that you would like an explanation for.", "x-found-in": "body" }, "primary": { "type": "boolean", "description": "If true, returns an explanation for the primary shard for the specified shard ID.", "x-found-in": "body" }, "current_node": { "type": "string", "description": "Explain a shard only if it is currently located on the specified node name or node ID.", "x-found-in": "body" }, "include_disk_info": { "type": "boolean", "description": "If true, returns information about disk usage and shard sizes.", "x-found-in": "query" }, "include_yes_decisions": { "type": "boolean", "description": "If true, returns YES decisions in explanation.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" } }, "description": "Explain the shard allocations.\n\nGet explanations for shard allocations in the cluster.\nThis API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.\nFor unassigned shards, it provides an explanation for why the shard is unassigned.\nFor assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.\nThis API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.\nRefer to the linked documentation for examples of how to troubleshoot allocation issues using this API." }

package/lib/cjs/es/json/cluster.get_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_component_template", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "settings_filter": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "Return all default configurations for the component template", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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" }, "name": { "type": "string", "description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "description": "Get component templates.\n\nGet information about component templates." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_component_template", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "settings_filter": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "Return all default configurations for the component template", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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" }, "name": { "type": "string", "description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "description": "Get component templates.\n\nGet information about component templates." }

package/lib/cjs/es/json/cluster.put_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_component_template", "type": "object", "properties": { "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing component templates.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for create the component template.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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" }, "name": { "type": "string", "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", "x-found-in": "path" } }, "required": ["name", "template"], "description": "Create or update a component template.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_component_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing component templates.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for create the component template.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "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" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", "x-found-in": "body" }, "deprecated": { "type": "boolean", "description": "Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", "x-found-in": "path" } }, "required": ["name", "template"], "description": "Create or update a component template.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list." }

package/lib/cjs/es/json/cluster.put_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_settings", "type": "object", "properties": { "persistent": { "type": "object", "additionalProperties": {}, "description": "The settings that persist after the cluster restarts.", "x-found-in": "body" }, "transient": { "type": "object", "additionalProperties": {}, "description": "The settings that do not persist after the cluster restarts.", "x-found-in": "body" }, "flat_settings": { "type": "boolean", "description": "Return settings in flat format", "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" } }, "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_settings", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "Return settings in flat format", "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" }, "persistent": { "type": "object", "additionalProperties": {}, "description": "The settings that persist after the cluster restarts.", "x-found-in": "body" }, "transient": { "type": "object", "additionalProperties": {}, "description": "The settings that do not persist after the cluster restarts.", "x-found-in": "body" } }, "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration." }

package/lib/cjs/es/json/cluster.reroute.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.reroute", "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "./cluster.reroute.json#/$defs/cluster.reroute__Command" }, "description": "Defines the commands to perform.", "x-found-in": "body" }, "dry_run": { "type": "boolean", "description": "If true, then the request simulates the operation.\nIt will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, then the response contains an explanation of why the commands can or cannot run.", "x-found-in": "query" }, "metric": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Limits the information returned to the specified metrics.", "x-found-in": "query" }, "retry_failed": { "type": "boolean", "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If 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": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Reroute the cluster.\n\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.reroute", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, then the request simulates the operation.\nIt will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, then the response contains an explanation of why the commands can or cannot run.", "x-found-in": "query" }, "metric": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Limits the information returned to the specified metrics.", "x-found-in": "query" }, "retry_failed": { "type": "boolean", "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If 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": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "commands": { "type": "array", "items": { "$ref": "./cluster.reroute.json#/$defs/cluster.reroute__Command" }, "description": "Defines the commands to perform.", "x-found-in": "body" } }, "description": "Reroute the cluster.\n\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards." }

package/lib/cjs/es/json/connector.sync_job_list.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_list", "type": "object", "properties": { "from": { "type": "number", "description": "Starting offset", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies a max number of results to get", "x-found-in": "query" }, "status": { "$ref": "./connector._types.json#/$defs/connector._types__SyncStatus", "description": "A sync job status to fetch connector sync jobs for", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "A connector id to fetch connector sync jobs for", "x-found-in": "query" }, "job_type": { "oneOf": [{ "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" }, { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" } }], "description": "A comma-separated list of job types to fetch the sync jobs for", "x-found-in": "query" } }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_list", "type": "object", "properties": { "from": { "type": "number", "description": "Starting offset", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies a max number of results to get", "x-found-in": "query" }, "status": { "$ref": "./connector._types.json#/$defs/connector._types__SyncStatus", "description": "A sync job status to fetch connector sync jobs for", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "A connector id to fetch connector sync jobs for", "x-found-in": "query" }, "job_type": { "anyOf": [{ "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" }, { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" } }], "description": "A comma-separated list of job types to fetch the sync jobs for", "x-found-in": "query" } }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "count", "type": "object", "properties": { "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" }, "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" }, "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": { "oneOf": [{ "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" }, "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" } }, "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "count", "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" }, "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" } }, "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create", "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" }, "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"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create", "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" }, "document": { "x-found-in": "body" }, "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"], "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." }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query", "type": "object", "properties": { "max_docs": { "type": "number", "description": "The maximum number of documents to process.\nDefaults to all documents.\nWhen set to a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.", "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" }, "sort": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of `<field>:<direction>` pairs.", "x-found-in": "query" }, "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" }, "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" }, "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" }, "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" }, "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"], "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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete_by_query", "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" }, "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"], "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." }

package/lib/cjs/es/json/enrich.put_policy.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "type": "object", "properties": { "geo_match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", "x-found-in": "body" }, "match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `term` query.", "x-found-in": "body" }, "range": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", "x-found-in": "body" }, "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": "Name of the enrich policy to create or update.", "x-found-in": "path" } }, "required": ["name"], "description": "Create an enrich policy.\n\nCreates an enrich policy." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "enrich.put_policy", "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" }, "geo_match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `geo_shape` query.", "x-found-in": "body" }, "match": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches enrich data to incoming documents based on a `term` query.", "x-found-in": "body" }, "range": { "$ref": "./enrich._types.json#/$defs/enrich._types__Policy", "description": "Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name of the enrich policy to create or update.", "x-found-in": "path" } }, "required": ["name"], "description": "Create an enrich policy.\n\nCreates an enrich policy." }

package/lib/cjs/es/json/eql.search.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "type": "object", "properties": { "query": { "type": "string", "description": "EQL query you wish to run.", "x-found-in": "body" }, "case_sensitive": { "type": "boolean", "x-found-in": "body" }, "event_category_field": { "type": "string", "description": "Field containing the event classification, such as process, file, or network.", "x-found-in": "body" }, "tiebreaker_field": { "type": "string", "description": "Field used to sort hits with the same timestamp in ascending order", "x-found-in": "body" }, "timestamp_field": { "type": "string", "description": "Field containing event timestamp.", "x-found-in": "body" }, "fetch_size": { "type": "number", "description": "Maximum number of events to search at a time for sequence queries.", "x-found-in": "body" }, "filter": { "oneOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" } }], "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", "x-found-in": "body" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period for which the search and its results are stored on the cluster.", "x-found-in": "query" }, "keep_on_completion": { "type": "boolean", "description": "If true, the search and its results are stored on the cluster.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "allow_partial_search_results": { "type": "boolean", "description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.", "x-found-in": "query" }, "allow_partial_sequence_results": { "type": "boolean", "description": "If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.\nThis flag has effect only if allow_partial_search_results is true.", "x-found-in": "query" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "oneOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" } }], "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", "x-found-in": "body" }, "result_position": { "$ref": "./eql.search.json#/$defs/eql.search__ResultPosition", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "x-found-in": "body" }, "max_samples_per_key": { "type": "number", "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", "x-found-in": "body" }, "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" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "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" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "x-found-in": "path" } }, "required": ["index", "query"], "description": "Get EQL search results.\n\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "eql.search", "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" }, "allow_partial_search_results": { "type": "boolean", "description": "Allow query execution also in case of shard failures.\nIf true, the query will keep running and will return results based on the available shards.\nFor sequences, the behavior can be further refined using allow_partial_sequence_results", "x-found-in": "body" }, "allow_partial_sequence_results": { "type": "boolean", "description": "This flag applies only to sequences and has effect only if allow_partial_search_results=true.\nIf true, the sequence query will return results based on the available shards, ignoring the others.\nIf false, the sequence query will return successfully, but will always have empty results.", "x-found-in": "body" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "ccs_minimize_roundtrips": { "type": "boolean", "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution", "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" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "keep_on_completion": { "type": "boolean", "x-found-in": "body" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "query": { "type": "string", "description": "EQL query you wish to run.", "x-found-in": "body" }, "case_sensitive": { "type": "boolean", "x-found-in": "body" }, "event_category_field": { "type": "string", "description": "Field containing the event classification, such as process, file, or network.", "x-found-in": "body" }, "tiebreaker_field": { "type": "string", "description": "Field used to sort hits with the same timestamp in ascending order", "x-found-in": "body" }, "timestamp_field": { "type": "string", "description": "Field containing event timestamp.", "x-found-in": "body" }, "fetch_size": { "type": "number", "description": "Maximum number of events to search at a time for sequence queries.", "x-found-in": "body" }, "filter": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer" } }], "description": "Query, written in Query DSL, used to filter the events on which the EQL query runs.", "x-found-in": "body" }, "size": { "type": "number", "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "x-found-in": "body" }, "fields": { "anyOf": [{ "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" }, { "type": "array", "items": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat" } }], "description": "Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.", "x-found-in": "body" }, "result_position": { "$ref": "./eql.search.json#/$defs/eql.search__ResultPosition", "x-found-in": "body" }, "runtime_mappings": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__RuntimeFields", "x-found-in": "body" }, "max_samples_per_key": { "type": "number", "description": "By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`\nparameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the\n`max_samples_per_key` parameter. Pipes are not supported for sample queries.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Comma-separated list of index names to scope the operation", "x-found-in": "path" } }, "required": ["index", "query"], "description": "Get EQL search results.\n\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event." }