diff --git a/output/schema/schema.json b/output/schema/schema.json index 57cc0b8612..bc59cc7ce1 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -174,7 +174,7 @@ "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.delete", "request": { "name": "Request", @@ -211,7 +211,7 @@ "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.get", "request": { "name": "Request", @@ -245,16 +245,11 @@ "stability": "stable" } }, - "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", + "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.status", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "async_search.status" @@ -290,7 +285,7 @@ "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.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.submit", "request": { "name": "Request", @@ -331,7 +326,7 @@ }, "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-delete-autoscaling-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.delete_autoscaling_policy", @@ -365,7 +360,7 @@ }, "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", "docId": "autoscaling-get-autoscaling-capacity", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_capacity", @@ -399,7 +394,7 @@ }, "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-get-autoscaling-capacity", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_policy", @@ -433,7 +428,7 @@ }, "description": "Create or update an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-put-autoscaling-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-put-autoscaling-policy.html", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.put_autoscaling_policy", @@ -471,10 +466,10 @@ "stability": "stable" } }, - "description": "Bulk index or delete documents.\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* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\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**Wait for active shards**\n\nWhen making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.\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.", + "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "docId": "docs-bulk", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html", "name": "bulk", "request": { "name": "Request", @@ -543,9 +538,9 @@ "stability": "stable" } }, - "description": "Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", + "description": "Get aliases.\nRetrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n\nCAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "docId": "cat-alias", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html", "name": "cat.aliases", "privileges": { "index": [ @@ -590,9 +585,9 @@ "stability": "stable" } }, - "description": "Get shard allocation information.\n\nGet a snapshot of the number of shards allocated to each data node and their disk space.\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.", + "description": "Get shard allocation information.\nGet a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-allocation", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html", "name": "cat.allocation", "privileges": { "cluster": [ @@ -638,9 +633,8 @@ "stability": "stable" } }, - "description": "Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", - "docId": "cat-component-templates", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates", + "description": "Get component templates.\nReturns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html", "name": "cat.component_templates", "privileges": { "cluster": [ @@ -685,9 +679,9 @@ "stability": "stable" } }, - "description": "Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "description": "Get a document count.\nProvides quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", "docId": "cat-count", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-count.html", "name": "cat.count", "privileges": { "index": [ @@ -732,9 +726,9 @@ "stability": "stable" } }, - "description": "Get field data cache information.\n\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "description": "Get field data cache information.\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "docId": "cat-fielddata", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-fielddata.html", "name": "cat.fielddata", "privileges": { "cluster": [ @@ -779,9 +773,9 @@ "stability": "stable" } }, - "description": "Get the cluster health status.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "description": "Get the cluster health status.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "docId": "cat-health", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-health.html", "name": "cat.health", "privileges": { "cluster": [ @@ -820,9 +814,9 @@ "stability": "stable" } }, - "description": "Get CAT help.\n\nGet help for the CAT APIs.", + "description": "Get CAT help.\nReturns help for the CAT APIs.", "docId": "cat", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html", "name": "cat.help", "request": { "name": "Request", @@ -855,9 +849,9 @@ "stability": "stable" } }, - "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", + "description": "Get index information.\nReturns high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "docId": "cat-indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-indices.html", "name": "cat.indices", "privileges": { "cluster": [ @@ -905,9 +899,9 @@ "stability": "stable" } }, - "description": "Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\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. For application consumption, use the nodes info API.", + "description": "Get master node information.\nGet information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-master", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-master.html", "name": "cat.master", "privileges": { "cluster": [ @@ -947,9 +941,9 @@ "stability": "stable" } }, - "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "description": "Get data frame analytics jobs.\nReturns configuration and usage information about data frame analytics jobs.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "docId": "cat-dfanalytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html", "name": "cat.ml_data_frame_analytics", "privileges": { "cluster": [ @@ -995,9 +989,9 @@ "stability": "stable" } }, - "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "description": "Get datafeeds.\nReturns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "docId": "cat-datafeeds", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html", "name": "cat.ml_datafeeds", "privileges": { "cluster": [ @@ -1043,9 +1037,9 @@ "stability": "stable" } }, - "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "description": "Get anomaly detection jobs.\nReturns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "docId": "cat-anomaly-detectors", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html", "name": "cat.ml_jobs", "privileges": { "cluster": [ @@ -1091,9 +1085,9 @@ "stability": "stable" } }, - "description": "Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "description": "Get trained models.\nReturns configuration and usage information about inference trained models.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", "docId": "cat-trained-model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html", "name": "cat.ml_trained_models", "privileges": { "cluster": [ @@ -1138,9 +1132,9 @@ "stability": "stable" } }, - "description": "Get node attribute information.\n\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get node attribute information.\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-nodeattrs", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodeattrs.html", "name": "cat.nodeattrs", "privileges": { "cluster": [ @@ -1179,9 +1173,9 @@ "stability": "stable" } }, - "description": "Get node information.\n\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get node information.\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-nodes", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodes.html", "name": "cat.nodes", "privileges": { "cluster": [ @@ -1220,9 +1214,9 @@ "stability": "stable" } }, - "description": "Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", + "description": "Get pending task information.\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", "docId": "cat-pending-tasks", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-pending-tasks.html", "name": "cat.pending_tasks", "privileges": { "cluster": [ @@ -1261,9 +1255,9 @@ "stability": "stable" } }, - "description": "Get plugin information.\n\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get plugin information.\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-plugins", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-plugins.html", "name": "cat.plugins", "privileges": { "cluster": [ @@ -1302,9 +1296,9 @@ "stability": "stable" } }, - "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", + "description": "Get shard recovery information.\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "docId": "cat-recovery", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-recovery.html", "name": "cat.recovery", "privileges": { "cluster": [ @@ -1353,9 +1347,9 @@ "stability": "stable" } }, - "description": "Get snapshot repository information.\n\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", + "description": "Get snapshot repository information.\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", "docId": "cat-repositories", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-repositories.html", "name": "cat.repositories", "privileges": { "cluster": [ @@ -1394,9 +1388,9 @@ "stability": "stable" } }, - "description": "Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", + "description": "Get segment information.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", "docId": "cat-segments", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html", "name": "cat.segments", "privileges": { "cluster": [ @@ -1444,9 +1438,9 @@ "stability": "stable" } }, - "description": "Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Get shard information.\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-shards", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-shards.html", "name": "cat.shards", "privileges": { "cluster": [ @@ -1495,9 +1489,9 @@ "stability": "stable" } }, - "description": "Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", + "description": "Get snapshot information\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", "docId": "cat-snapshots", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-snapshots.html", "name": "cat.snapshots", "privileges": { "cluster": [ @@ -1543,9 +1537,9 @@ "stability": "experimental" } }, - "description": "Get task information.\n\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", - "docId": "cat-tasks", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks", + "description": "Get task information.\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", + "docId": "tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "cat.tasks", "privileges": { "cluster": [ @@ -1585,9 +1579,9 @@ "stability": "stable" } }, - "description": "Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", + "description": "Get index template information.\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", "docId": "cat-templates", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-templates.html", "name": "cat.templates", "privileges": { "cluster": [ @@ -1632,9 +1626,9 @@ "stability": "stable" } }, - "description": "Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get thread pool statistics.\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-thread-pool", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-thread-pool.html", "name": "cat.thread_pool", "privileges": { "cluster": [ @@ -1680,9 +1674,9 @@ "stability": "stable" } }, - "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "description": "Get transform information.\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "docId": "cat-transforms", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html", "name": "cat.transforms", "privileges": { "cluster": [ @@ -1724,17 +1718,12 @@ "stability": "stable" } }, - "description": "Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns.", + "description": "Delete auto-follow patterns.\nDelete a collection of cross-cluster replication auto-follow patterns.", "docId": "ccr-delete-auto-follow-pattern", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-delete-auto-follow-pattern.html", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.delete_auto_follow_pattern", - "privileges": { - "cluster": [ - "manage_ccr" - ] - }, "request": { "name": "Request", "namespace": "ccr.delete_auto_follow_pattern" @@ -1765,7 +1754,7 @@ }, "description": "Create a follower.\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.", "docId": "ccr-put-follow", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html", "name": "ccr.follow", "request": { "name": "Request", @@ -1798,17 +1787,12 @@ "stability": "stable" } }, - "description": "Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", + "description": "Get follower information.\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "docId": "ccr-get-follow-info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-info.html", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.follow_info", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "ccr.follow_info" @@ -1837,17 +1821,12 @@ "stability": "stable" } }, - "description": "Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", + "description": "Get follower stats.\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "docId": "ccr-get-follow-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-stats.html", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.follow_stats", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "ccr.follow_stats" @@ -1878,9 +1857,9 @@ }, "description": "Forget a follower.\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.", "docId": "ccr-post-forget-follower", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-forget-follower.html", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.forget_follower", "request": { "name": "Request", @@ -1913,17 +1892,12 @@ "stability": "stable" } }, - "description": "Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns.", + "description": "Get auto-follow patterns.\nGet cross-cluster replication auto-follow patterns.", "docId": "ccr-get-auto-follow-pattern", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.get_auto_follow_pattern", - "privileges": { - "cluster": [ - "manage_ccr" - ] - }, "request": { "name": "Request", "namespace": "ccr.get_auto_follow_pattern" @@ -1958,17 +1932,12 @@ "stability": "stable" } }, - "description": "Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", + "description": "Pause an auto-follow pattern.\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "docId": "ccr-pause-auto-follow-pattern", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-pause-auto-follow-pattern.html", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.pause_auto_follow_pattern", - "privileges": { - "cluster": [ - "manage_ccr" - ] - }, "request": { "name": "Request", "namespace": "ccr.pause_auto_follow_pattern" @@ -1997,15 +1966,10 @@ "stability": "stable" } }, - "description": "Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", + "description": "Pause a follower.\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "docId": "ccr-post-pause-follow", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-pause-follow.html", "name": "ccr.pause_follow", - "privileges": { - "cluster": [ - "manage_ccr" - ] - }, "request": { "name": "Request", "namespace": "ccr.pause_follow" @@ -2036,9 +2000,9 @@ }, "description": "Create or update auto-follow patterns.\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.", "docId": "ccr-put-auto-follow-pattern", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-auto-follow-pattern.html", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.put_auto_follow_pattern", "request": { "name": "Request", @@ -2071,17 +2035,12 @@ "stability": "stable" } }, - "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", + "description": "Resume an auto-follow pattern.\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "docId": "ccr-resume-auto-follow-pattern", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.resume_auto_follow_pattern", - "privileges": { - "cluster": [ - "manage_ccr" - ] - }, "request": { "name": "Request", "namespace": "ccr.resume_auto_follow_pattern" @@ -2112,9 +2071,9 @@ }, "description": "Resume a follower.\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.", "docId": "ccr-post-resume-follow", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-resume-follow.html", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.resume_follow", "request": { "name": "Request", @@ -2147,15 +2106,10 @@ "stability": "stable" } }, - "description": "Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", + "description": "Get cross-cluster replication stats.\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "docId": "ccr-get-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-stats.html", "name": "ccr.stats", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "ccr.stats" @@ -2184,17 +2138,12 @@ "stability": "stable" } }, - "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", + "description": "Unfollow an index.\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\nNOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "docId": "ccr-post-unfollow", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-unfollow.html", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.unfollow", - "privileges": { - "index": [ - "manage_follow_index" - ] - }, "request": { "name": "Request", "namespace": "ccr.unfollow" @@ -2226,12 +2175,10 @@ "stability": "stable" } }, - "description": "Clear a scrolling search.\nClear the search context and results for a scrolling search.", + "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "docId": "clear-scroll-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll", - "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html", "name": "clear_scroll", "request": { "name": "Request", @@ -2279,10 +2226,10 @@ "stability": "stable" } }, - "description": "Close a point in time.\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", + "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "docId": "point-in-time-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", "name": "close_point_in_time", "request": { "name": "Request", @@ -2321,8 +2268,7 @@ }, "description": "Explain the shard allocations.\nGet explanations for shard allocations in the cluster.\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.", "docId": "cluster-allocation-explain", - "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html", "name": "cluster.allocation_explain", "request": { "name": "Request", @@ -2360,10 +2306,10 @@ "stability": "stable" } }, - "description": "Delete component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "description": "Delete component templates.\nDeletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.delete_component_template", "privileges": { "cluster": [ @@ -2400,9 +2346,9 @@ }, "description": "Clear cluster voting config exclusions.\nRemove master-eligible nodes from the voting configuration exclusion list.", "docId": "voting-config-exclusions", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html", "extDocId": "add-nodes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html", "name": "cluster.delete_voting_config_exclusions", "request": { "name": "Request", @@ -2439,7 +2385,7 @@ "description": "Check component templates.\nReturns information about whether a particular component template exists.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.exists_component_template", "request": { "name": "Request", @@ -2473,10 +2419,10 @@ "stability": "stable" } }, - "description": "Get component templates.\nGet information about component templates.", + "description": "Get component templates.\nRetrieves information about component templates.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.get_component_template", "privileges": { "cluster": [ @@ -2522,7 +2468,7 @@ }, "description": "Get cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", "docId": "cluster-get-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html", "name": "cluster.get_settings", "privileges": { "cluster": [ @@ -2561,10 +2507,10 @@ "stability": "stable" } }, - "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", + "description": "Get the cluster health status.\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", "docId": "cluster-health", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html", "name": "cluster.health", "privileges": { "cluster": [ @@ -2612,7 +2558,7 @@ }, "description": "Get cluster info.\nReturns basic information about the cluster.", "docId": "cluster-info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-info.html", "name": "cluster.info", "request": { "name": "Request", @@ -2647,7 +2593,7 @@ }, "description": "Get the pending cluster tasks.\nGet information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.\n\nNOTE: This API returns a list of any pending updates to the cluster state.\nThese are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.\nHowever, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.", "docId": "cluster-pending", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-pending.html", "name": "cluster.pending_tasks", "privileges": { "cluster": [ @@ -2684,9 +2630,9 @@ }, "description": "Update voting configuration exclusions.\nUpdate the cluster voting config exclusions by node IDs or node names.\nBy default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.\nIf you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.\nThe API adds an entry for each specified node to the cluster’s voting configuration exclusions list.\nIt then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.\n\nClusters should have no voting configuration exclusions in normal operation.\nOnce the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.\nThis API waits for the nodes to be fully removed from the cluster before it returns.\nIf your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.\n\nA response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.\nIf the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.\nIn that case, you may safely retry the call.\n\nNOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.\nThey are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.", "docId": "voting-config-exclusions", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html", "extDocId": "add-nodes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html", "name": "cluster.post_voting_config_exclusions", "request": { "name": "Request", @@ -2720,10 +2666,10 @@ "stability": "stable" } }, - "description": "Create or update a component template.\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.", + "description": "Create or update a component template.\nCreates or updates a component template.\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.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.put_component_template", "privileges": { "cluster": [ @@ -2765,9 +2711,9 @@ "stability": "stable" } }, - "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.", + "description": "Update the cluster settings.\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.", "docId": "cluster-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html", "name": "cluster.put_settings", "request": { "name": "Request", @@ -2800,17 +2746,10 @@ "stability": "stable" } }, - "description": "Get remote cluster information.\n\nGet information about configured remote clusters.\nThe API returns connection and endpoint information keyed by the configured remote cluster alias.\n\n> info\n> This API returns information that reflects current state on the local cluster.\n> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.\n> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.\n> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster).", + "description": "Get remote cluster information.\nGet all of the configured remote cluster information.\nThis API returns connection and endpoint information keyed by the configured remote cluster alias.", "docId": "cluster-remote-info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info", - "extDocId": "modules-cross-cluster-search", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html", "name": "cluster.remote_info", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "cluster.remote_info" @@ -2845,7 +2784,7 @@ }, "description": "Reroute the cluster.\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.", "docId": "cluster-reroute", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-reroute.html", "name": "cluster.reroute", "request": { "name": "Request", @@ -2884,7 +2823,7 @@ }, "description": "Get the cluster state.\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs.", "docId": "cluster-state", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-state.html", "name": "cluster.state", "privileges": { "cluster": [ @@ -2938,7 +2877,7 @@ }, "description": "Get cluster statistics.\nGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).", "docId": "cluster-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-stats.html", "name": "cluster.stats", "privileges": { "cluster": [ @@ -2985,7 +2924,7 @@ }, "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "docId": "connector-checkin", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", "name": "connector.check_in", "request": { "name": "Request", @@ -3021,7 +2960,7 @@ }, "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "docId": "connector-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", "name": "connector.delete", "request": { "name": "Request", @@ -3057,7 +2996,7 @@ }, "description": "Get a connector.\n\nGet the details about a connector.", "docId": "connector-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", "name": "connector.get", "request": { "name": "Request", @@ -3094,7 +3033,7 @@ }, "description": "Update the connector last sync stats.\n\nUpdate the fields related to the last sync of a connector.\nThis action is used for analytics and monitoring.", "docId": "connector-last-sync", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", "name": "connector.last_sync", "request": { "name": "Request", @@ -3133,7 +3072,7 @@ }, "description": "Get all connectors.\n\nGet information about all connectors.", "docId": "connector-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", "name": "connector.list", "request": { "name": "Request", @@ -3169,7 +3108,7 @@ }, "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "docId": "connector-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.post", "request": { "name": "Request", @@ -3208,7 +3147,7 @@ }, "description": "Create or update a connector.", "docId": "connector-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.put", "request": { "name": "Request", @@ -3353,7 +3292,7 @@ }, "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "docId": "connector-sync-job-cancel", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html", "name": "connector.sync_job_cancel", "request": { "name": "Request", @@ -3383,19 +3322,12 @@ "visibility": "public" } }, - "description": "Check in a connector sync job.\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "docId": "connector-sync-job-checkin", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in", + "description": "Checks in a connector sync job (refreshes 'last_seen').", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html", "name": "connector.sync_job_check_in", - "request": { - "name": "Request", - "namespace": "connector.sync_job_check_in" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "connector.sync_job_check_in" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -3415,22 +3347,15 @@ "visibility": "public" } }, - "description": "Claim a connector sync job.\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "docId": "connector-sync-job-claim", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim", + "description": "Claims a connector sync job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/claim-connector-sync-job-api.html", "name": "connector.sync_job_claim", - "request": { - "name": "Request", - "namespace": "connector.sync_job_claim" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "connector.sync_job_claim" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -3456,7 +3381,7 @@ }, "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "connector-sync-job-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html", "name": "connector.sync_job_delete", "request": { "name": "Request", @@ -3486,22 +3411,15 @@ "visibility": "public" } }, - "description": "Set a connector sync job error.\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "docId": "connector-sync-job-error", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error", + "description": "Sets an error for a connector sync job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-error-api.html", "name": "connector.sync_job_error", - "request": { - "name": "Request", - "namespace": "connector.sync_job_error" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "connector.sync_job_error" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -3527,7 +3445,7 @@ }, "description": "Get a connector sync job.", "docId": "connector-sync-job-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html", "name": "connector.sync_job_get", "request": { "name": "Request", @@ -3563,7 +3481,7 @@ }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "docId": "connector-sync-job-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html", "name": "connector.sync_job_list", "request": { "name": "Request", @@ -3599,7 +3517,7 @@ }, "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "docId": "connector-sync-job-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html", "name": "connector.sync_job_post", "request": { "name": "Request", @@ -3632,22 +3550,15 @@ "visibility": "public" } }, - "description": "Set the connector sync job stats.\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "docId": "connector-sync-job-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats", + "description": "Updates the stats fields in the connector sync job document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/set-connector-sync-job-stats-api.html", "name": "connector.sync_job_update_stats", - "request": { - "name": "Request", - "namespace": "connector.sync_job_update_stats" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "connector.sync_job_update_stats" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -3673,7 +3584,7 @@ }, "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "docId": "connector-update-filtering", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_active_filtering", "request": { "name": "Request", @@ -3712,7 +3623,7 @@ }, "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "docId": "connector-update-api-key-id", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", "name": "connector.update_api_key_id", "request": { "name": "Request", @@ -3751,7 +3662,7 @@ }, "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "docId": "connector-configuration", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", "name": "connector.update_configuration", "request": { "name": "Request", @@ -3790,7 +3701,7 @@ }, "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "docId": "connector-update-error", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", "name": "connector.update_error", "request": { "name": "Request", @@ -3823,22 +3734,15 @@ "visibility": "public" } }, - "description": "Update the connector features.\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "docId": "connector-features", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features", + "description": "Updates the connector features in the connector document.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-connector-features-api.html", "name": "connector.update_features", - "request": { - "name": "Request", - "namespace": "connector.update_features" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "connector.update_features" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -3864,7 +3768,7 @@ }, "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "docId": "connector-update-filtering", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_filtering", "request": { "name": "Request", @@ -3903,7 +3807,7 @@ }, "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "docId": "connector-update-filtering-validation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-validation-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-validation-api.html", "name": "connector.update_filtering_validation", "request": { "name": "Request", @@ -3942,7 +3846,7 @@ }, "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "docId": "connector-update-index-name", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", "name": "connector.update_index_name", "request": { "name": "Request", @@ -3981,7 +3885,7 @@ }, "description": "Update the connector name and description.", "docId": "connector-update-name", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", "name": "connector.update_name", "request": { "name": "Request", @@ -4020,7 +3924,7 @@ }, "description": "Update the connector is_native flag.", "docId": "connector-update-native", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-native-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html", "name": "connector.update_native", "request": { "name": "Request", @@ -4059,7 +3963,7 @@ }, "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "docId": "connector-update-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", "name": "connector.update_pipeline", "request": { "name": "Request", @@ -4098,7 +4002,7 @@ }, "description": "Update the connector scheduling.", "docId": "connector-update-scheduling", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", "name": "connector.update_scheduling", "request": { "name": "Request", @@ -4137,7 +4041,7 @@ }, "description": "Update the connector service type.", "docId": "connector-update-service-type", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", "name": "connector.update_service_type", "request": { "name": "Request", @@ -4176,7 +4080,7 @@ }, "description": "Update the connector status.", "docId": "connector-update-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", "name": "connector.update_status", "request": { "name": "Request", @@ -4212,16 +4116,10 @@ "stability": "stable" } }, - "description": "Count search results.\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.", - "docId": "search-count", + "description": "Count search results.\nGet the number of documents matching a query.", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "name": "count", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.count" @@ -4265,18 +4163,10 @@ "stability": "stable" } }, - "description": "Create a new document in the index.\n\nYou can index a new JSON document with the `//_doc/` or `//_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 `//_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 //_create/<_id>` or `POST //_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.", - "docId": "docs-index", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", - "extDocId": "data-streams", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "create", - "privileges": { - "index": [ - "create" - ] - }, "request": { "name": "Request", "namespace": "_global.create" @@ -4309,16 +4199,10 @@ "stability": "stable" } }, - "description": "Delete a dangling index.\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", - "docId": "dangling-index-delete", + "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.delete_dangling_index", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "dangling_indices.delete_dangling_index" @@ -4348,15 +4232,9 @@ } }, "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", - "docId": "dangling-index-import", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.import_dangling_index", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "dangling_indices.import_dangling_index" @@ -4386,15 +4264,9 @@ } }, "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", - "docId": "dangling-indices-list", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html", "name": "dangling_indices.list_dangling_indices", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "dangling_indices.list_dangling_indices" @@ -4426,16 +4298,10 @@ "stability": "stable" } }, - "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", - "docId": "docs-delete", + "description": "Delete a document.\nRemoves a JSON document from the specified index.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "name": "delete", - "privileges": { - "index": [ - "delete" - ] - }, "request": { "name": "Request", "namespace": "_global.delete" @@ -4468,17 +4334,10 @@ "stability": "stable" } }, - "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.", - "docId": "docs-delete-by-query", + "description": "Delete documents.\nDeletes documents that match the specified query.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "name": "delete_by_query", - "privileges": { - "index": [ - "read", - "delete" - ] - }, "request": { "name": "Request", "namespace": "_global.delete_by_query" @@ -4515,9 +4374,8 @@ } }, "description": "Throttle a delete by query operation.\n\nChange the number of requests per second for a particular delete by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", - "docId": "docs-delete-by-query-rethrottle", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html", "name": "delete_by_query_rethrottle", "request": { "name": "Request", @@ -4551,15 +4409,9 @@ } }, "description": "Delete a script or search template.\nDeletes a stored script or search template.", - "docId": "script-delete", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "delete_script", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "_global.delete_script" @@ -4593,8 +4445,7 @@ } }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", - "docId": "delete-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html", "name": "enrich.delete_policy", "request": { "name": "Request", @@ -4630,7 +4481,7 @@ }, "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "docId": "execute-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", "name": "enrich.execute_policy", "request": { "name": "Request", @@ -4665,8 +4516,7 @@ } }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", - "docId": "get-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html", "name": "enrich.get_policy", "request": { "name": "Request", @@ -4708,7 +4558,7 @@ }, "description": "Create an enrich policy.\nCreates an enrich policy.", "docId": "put-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html", "name": "enrich.put_policy", "request": { "name": "Request", @@ -4746,8 +4596,7 @@ } }, "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", - "docId": "enrich-stats-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html", "name": "enrich.stats", "request": { "name": "Request", @@ -4782,8 +4631,7 @@ } }, "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", - "docId": "eql-async-search-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.delete", "request": { "name": "Request", @@ -4819,7 +4667,7 @@ }, "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "docId": "eql-async-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", "name": "eql.get", "request": { "name": "Request", @@ -4855,7 +4703,7 @@ }, "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "docId": "eql-async-search-status-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", "name": "eql.get_status", "request": { "name": "Request", @@ -4890,10 +4738,9 @@ } }, "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", - "docId": "eql-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "extDocId": "eql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", "request": { "name": "Request", @@ -4923,34 +4770,19 @@ { "availability": { "stack": { - "since": "8.13.0", "stability": "stable", "visibility": "public" } }, - "description": "Run an async ES|QL query.\nAsynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.\n\nThe API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.", - "docId": "esql-async-query", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query", - "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "description": "Executes an ESQL request asynchronously", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-api.html", "name": "esql.async_query", - "privileges": { - "index": [ - "read" - ] - }, - "request": { - "name": "Request", - "namespace": "esql.async_query" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "esql.async_query" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -4966,61 +4798,16 @@ { "availability": { "stack": { - "since": "8.13.0", - "stability": "stable", - "visibility": "public" - } - }, - "description": "Delete an async ES|QL query.\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", - "docId": "esql-async-query-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete", - "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", - "name": "esql.async_query_delete", - "request": { - "name": "Request", - "namespace": "esql.async_query_delete" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "esql.async_query_delete" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "DELETE" - ], - "path": "/_query/async/{id}" - } - ] - }, - { - "availability": { - "stack": { - "since": "8.13.0", "stability": "stable", "visibility": "public" } }, - "description": "Get async ES|QL query results.\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", - "docId": "esql-async-query-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get", - "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "description": "Retrieves the results of a previously submitted async query request given its ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-async-query-get-api.html", "name": "esql.async_query_get", - "request": { - "name": "Request", - "namespace": "esql.async_query_get" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "esql.async_query_get" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -5033,41 +4820,6 @@ } ] }, - { - "availability": { - "stack": { - "since": "8.18.0", - "stability": "stable", - "visibility": "public" - } - }, - "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", - "docId": "esql-async-query-stop", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html", - "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", - "name": "esql.async_query_stop", - "request": { - "name": "Request", - "namespace": "esql.async_query_stop" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "esql.async_query_stop" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_query/async/{id}/stop" - } - ] - }, { "availability": { "serverless": {}, @@ -5077,9 +4829,9 @@ }, "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "docId": "esql-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.query", "request": { "name": "Request", @@ -5115,10 +4867,9 @@ "stability": "stable" } }, - "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", - "docId": "docs-get", + "description": "Check a document.\nChecks if a specified document exists.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists", "request": { "name": "Request", @@ -5152,18 +4903,10 @@ "stability": "stable" } }, - "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", - "docId": "docs-get", + "description": "Check for a document source.\nChecks if a document's `_source` is stored.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", - "extDocId": "mapping-source-field", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists_source", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.exists_source" @@ -5195,16 +4938,10 @@ "stability": "stable" } }, - "description": "Explain a document match result.\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document.", - "docId": "search-explain", + "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", "name": "explain", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.explain" @@ -5238,10 +4975,9 @@ } }, "description": "Get the features.\nGet a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", - "docId": "get-features-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-features-api.html", "extDocId": "snapshot-create", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html", "name": "features.get_features", "request": { "name": "Request", @@ -5276,8 +5012,7 @@ } }, "description": "Reset the features.\nClear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.\n\nWARNING: Intended for development and testing use only. Do not reset features on a production cluster.\n\nReturn a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.\nThis deletes all state information stored in system indices.\n\nThe response code is HTTP 200 if the state is successfully reset for all features.\nIt is HTTP 500 if the reset operation failed for any feature.\n\nNote that select features might provide a way to reset particular system indices.\nUsing this API resets all features, both those that are built-in and implemented as plugins.\n\nTo list the features that will be affected, use the get features API.\n\nIMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.", - "docId": "features-reset", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "features.reset_features", "request": { "name": "Request", @@ -5312,14 +5047,14 @@ } }, "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", - "docId": "search-field-caps", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", "name": "field_caps", "privileges": { "index": [ "view_index_metadata", - "read" + "read", + "manage" ] }, "request": { @@ -5415,9 +5150,8 @@ "stability": "stable" } }, - "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", - "docId": "get-global-checkpoints", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet", + "description": "Get global checkpoints.\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", "name": "fleet.global_checkpoints", "request": { "name": "Request", @@ -5455,8 +5189,7 @@ } }, "description": "Run multiple Fleet searches.\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", - "docId": "fleet-multi-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch", + "docUrl": null, "name": "fleet.msearch", "privileges": { "index": [ @@ -5532,8 +5265,7 @@ } }, "description": "Run a Fleet search.\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", - "docId": "fleet-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-search", + "docUrl": null, "name": "fleet.search", "privileges": { "index": [ @@ -5575,16 +5307,10 @@ "stability": "stable" } }, - "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", - "docId": "docs-get", + "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.get" @@ -5617,15 +5343,9 @@ } }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", - "docId": "script-get", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "_global.get_script" @@ -5654,15 +5374,9 @@ } }, "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", - "docId": "script-contexts", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html", "name": "get_script_context", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "_global.get_script_context" @@ -5691,15 +5405,9 @@ } }, "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", - "docId": "script-languages", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script_languages", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "_global.get_script_languages" @@ -5731,18 +5439,10 @@ "stability": "stable" } }, - "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", - "docId": "docs-get", + "description": "Get a document's source.\nReturns the source of a document.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", - "extDocId": "mapping-source-field", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get_source", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.get_source" @@ -5776,9 +5476,9 @@ }, "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "docId": "graph-explore-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", "extDocId": "graph", - "extDocUrl": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html", + "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html", "name": "graph.explore", "request": { "name": "Request", @@ -5817,8 +5517,7 @@ } }, "description": "Get the cluster health.\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.", - "docId": "health-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html", "name": "health_report", "request": { "name": "Request", @@ -5855,8 +5554,7 @@ } }, "description": "Delete a lifecycle policy.\nYou cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", - "docId": "ilm-delete-lifecycle", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html", "name": "ilm.delete_lifecycle", "privileges": { "cluster": [ @@ -5892,8 +5590,7 @@ } }, "description": "Explain the lifecycle state.\nGet the current lifecycle status for one or more indices.\nFor data streams, the API retrieves the current lifecycle status for the stream's backing indices.\n\nThe response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.", - "docId": "ilm-explain-lifecycle", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-explain-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html", "name": "ilm.explain_lifecycle", "privileges": { "index": [ @@ -5930,8 +5627,7 @@ } }, "description": "Get lifecycle policies.", - "docId": "ilm-get-lifecycle", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html", "name": "ilm.get_lifecycle", "privileges": { "cluster": [ @@ -5973,9 +5669,8 @@ "stability": "stable" } }, - "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", - "docId": "ilm-get-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status", + "description": "Get the ILM status.\nGet the current index lifecycle management status.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html", "name": "ilm.get_status", "privileges": { "cluster": [ @@ -6011,10 +5706,9 @@ } }, "description": "Migrate to data tiers routing.\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.", - "docId": "ilm-migrate-to-data-tiers", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html", "extDocId": "migrate-index-allocation-filters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-index-allocation-filters.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-index-allocation-filters.html", "name": "ilm.migrate_to_data_tiers", "request": { "name": "Request", @@ -6048,8 +5742,7 @@ } }, "description": "Move to a lifecycle step.\nManually move an index into a specific step in the lifecycle policy and run that step.\n\nWARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.\n\nYou must specify both the current step and the step to be executed in the body of the request.\nThe request will fail if the current step does not match the step currently running for the index\nThis is to prevent the index from being moved from an unexpected step into the next step.\n\nWhen specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional.\nIf only the phase is specified, the index will move to the first step of the first action in the target phase.\nIf the phase and action are specified, the index will move to the first step of the specified action in the specified phase.\nOnly actions specified in the ILM policy are considered valid.\nAn index cannot move to a step that is not part of its policy.", - "docId": "ilm-move-to-step", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-move-to-step", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html", "name": "ilm.move_to_step", "privileges": { "index": [ @@ -6088,10 +5781,9 @@ } }, "description": "Create or update a lifecycle policy.\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.", - "docId": "ilm-put-lifecycle", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html", "extDocId": "ilm-index-lifecycle", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-index-lifecycle.html", "name": "ilm.put_lifecycle", "privileges": { "cluster": [ @@ -6133,8 +5825,7 @@ } }, "description": "Remove policies from an index.\nRemove the assigned lifecycle policies from an index or a data stream's backing indices.\nIt also stops managing the indices.", - "docId": "ilm-remove-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-remove-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html", "name": "ilm.remove_policy", "privileges": { "index": [ @@ -6170,8 +5861,7 @@ } }, "description": "Retry a policy.\nRetry running the lifecycle policy for an index that is in the ERROR step.\nThe API sets the policy back to the step where the error occurred and runs the step.\nUse the explain lifecycle state API to determine whether an index is in the ERROR step.", - "docId": "ilm-retry-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-retry", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html", "name": "ilm.retry", "privileges": { "index": [ @@ -6207,8 +5897,7 @@ } }, "description": "Start the ILM plugin.\nStart the index lifecycle management plugin if it is currently stopped.\nILM is started automatically when the cluster is formed.\nRestarting ILM is necessary only when it has been stopped using the stop ILM API.", - "docId": "ilm-start", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html", "name": "ilm.start", "privileges": { "cluster": [ @@ -6244,8 +5933,7 @@ } }, "description": "Stop the ILM plugin.\nHalt all lifecycle management operations and stop the index lifecycle management plugin.\nThis is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.\n\nThe API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.\nUse the get ILM status API to check whether ILM is running.", - "docId": "ilm-stop", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html", "name": "ilm.stop", "privileges": { "cluster": [ @@ -6283,18 +5971,10 @@ "stability": "stable" } }, - "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\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 or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, 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\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\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**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**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.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", - "docId": "docs-index", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", - "extDocId": "data-streams", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "index", - "privileges": { - "index": [ - "index" - ] - }, "request": { "name": "Request", "namespace": "_global.index" @@ -6337,9 +6017,8 @@ "stability": "stable" } }, - "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", - "docId": "index-block-add", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block", + "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html", "name": "indices.add_block", "request": { "name": "Request", @@ -6372,17 +6051,10 @@ "stability": "stable" } }, - "description": "Get tokens from text analysis.\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "docId": "indices-analyze", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze", - "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", "name": "indices.analyze", - "privileges": { - "index": [ - "index" - ] - }, "request": { "name": "Request", "namespace": "indices.analyze" @@ -6415,46 +6087,6 @@ } ] }, - { - "availability": { - "serverless": { - "stability": "experimental", - "visibility": "private" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", - "docId": "migrate", - "docTag": "migration", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-data-stream.html", - "name": "indices.cancel_migrate_reindex", - "request": { - "name": "Request", - "namespace": "indices.cancel_migrate_reindex" - }, - "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "indices.cancel_migrate_reindex" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_migration/reindex/{index}/_cancel" - } - ] - }, { "availability": { "serverless": { @@ -6465,15 +6097,9 @@ "stability": "stable" } }, - "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter.", - "docId": "indices-clearcache", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache", + "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html", "name": "indices.clear_cache", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.clear_cache" @@ -6508,15 +6134,9 @@ "stability": "stable" } }, - "description": "Clone an index.\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.", - "docId": "indices-clone-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone", + "description": "Clone an index.\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html", "name": "indices.clone", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.clone" @@ -6554,13 +6174,8 @@ }, "description": "Close an index.\nA closed index is blocked for read or write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nClosed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behaviour can be turned off using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.", "docId": "indices-close", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html", "name": "indices.close", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.close" @@ -6592,9 +6207,9 @@ "stability": "stable" } }, - "description": "Create an index.\nYou can use the create index API to add a new index to an Elasticsearch cluster.\nWhen creating an index, you can specify the following:\n\n* Settings for the index.\n* Mappings for fields in the index.\n* Index aliases\n\n**Wait for active shards**\n\nBy default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.\nThe index creation response will indicate what happened.\nFor example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out.\nNote that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful.\nThese values simply indicate whether the operation completed before the timeout.\nIf `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.\nIf `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).\n\nYou can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.\nNote that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.", + "description": "Create an index.\nCreates a new index.", "docId": "indices-create-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html", "name": "indices.create", "privileges": { "index": [ @@ -6637,10 +6252,9 @@ "stability": "stable" } }, - "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", - "docId": "indices-create-data-stream", + "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.create_data_stream", "privileges": { "index": [ @@ -6668,47 +6282,6 @@ } ] }, - { - "availability": { - "serverless": { - "stability": "experimental", - "visibility": "private" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", - "docId": "migrate", - "docTag": "migration", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-data-stream.html", - "name": "indices.create_from", - "request": { - "name": "Request", - "namespace": "indices.create_from" - }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "indices.create_from" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "PUT", - "POST" - ], - "path": "/_create_from/{source}/{dest}" - } - ] - }, { "availability": { "serverless": { @@ -6720,10 +6293,9 @@ "stability": "stable" } }, - "description": "Get data stream stats.\n\nGet statistics for one or more data streams.", - "docId": "data-stream-stats-api", + "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", "privileges": { "index": [ @@ -6767,15 +6339,9 @@ "stability": "stable" } }, - "description": "Delete indices.\nDeleting an index deletes its documents, shards, and metadata.\nIt does not delete related Kibana components, such as data views, visualizations, or dashboards.\n\nYou cannot delete the current write index of a data stream.\nTo delete the index, you must roll over the data stream so a new write index is created.\nYou can then use the delete index API to delete the previous write index.", - "docId": "indices-delete-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete", + "description": "Delete indices.\nDeletes one or more indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html", "name": "indices.delete", - "privileges": { - "index": [ - "delete_index" - ] - }, "request": { "name": "Request", "namespace": "indices.delete" @@ -6808,14 +6374,8 @@ } }, "description": "Delete an alias.\nRemoves a data stream or index from an alias.", - "docId": "indices-delete-alias", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.delete_alias", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.delete_alias" @@ -6855,8 +6415,7 @@ } }, "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", - "docId": "data-stream-delete-lifecycle", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", "name": "indices.delete_data_lifecycle", "request": { "name": "Request", @@ -6891,9 +6450,7 @@ } }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", - "docId": "data-stream-delete", - "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", "privileges": { "index": [ @@ -6933,12 +6490,12 @@ } }, "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", - "docId": "indices-delete-template", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html", "name": "indices.delete_index_template", "privileges": { "cluster": [ - "manage_index_templates" + "manage_index_templates", + "manage" ] }, "request": { @@ -6968,13 +6525,13 @@ "stability": "stable" } }, - "description": "Delete a legacy index template.", - "docId": "indices-delete-template-v1", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template", + "description": "Deletes a legacy index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html", "name": "indices.delete_template", "privileges": { "cluster": [ - "manage_index_templates" + "manage_index_templates", + "manage" ] }, "request": { @@ -7009,9 +6566,9 @@ "stability": "experimental" } }, - "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.", + "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.", "docId": "indices-disk-usage", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html", "name": "indices.disk_usage", "request": { "name": "Request", @@ -7047,8 +6604,7 @@ }, "description": "Downsample an index.\nAggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read only (`index.blocks.write: true`).", "docId": "indices-downsample-data-stream", - "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html", "name": "indices.downsample", "request": { "name": "Request", @@ -7084,9 +6640,8 @@ "stability": "stable" } }, - "description": "Check indices.\nCheck if one or more indices, index aliases, or data streams exist.", - "docId": "indices-exists", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists", + "description": "Check indices.\nChecks if one or more indices, index aliases, or data streams exist.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html", "name": "indices.exists", "request": { "name": "Request", @@ -7119,9 +6674,8 @@ "stability": "stable" } }, - "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", - "docId": "indices-aliases-exist", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias", + "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.exists_alias", "request": { "name": "Request", @@ -7160,9 +6714,8 @@ "stability": "stable" } }, - "description": "Check index templates.\n\nCheck whether index templates exist.", - "docId": "index-templates-exist", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template", + "description": "Check index templates.\nCheck whether index templates exist.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html", "name": "indices.exists_index_template", "request": { "name": "Request", @@ -7191,17 +6744,9 @@ "stability": "stable" } }, - "description": "Check existence of index templates.\nGet information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", - "docId": "indices-template-exists-v1", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template", - "extDocId": "index-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html", + "description": "Check existence of index templates.\nReturns information about whether a particular index template exists.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html", "name": "indices.exists_template", - "privileges": { - "cluster": [ - "manage_index_templates" - ] - }, "request": { "name": "Request", "namespace": "indices.exists_template" @@ -7235,9 +6780,7 @@ } }, "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", - "docId": "data-stream-explain-lifecycle", - "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { "name": "Request", @@ -7271,9 +6814,8 @@ "stability": "experimental" } }, - "description": "Get field usage stats.\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.\n\nThe response body reports the per-shard usage count of the data structures that back the fields in the index.\nA given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.", - "docId": "field-usage-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats", + "description": "Get field usage stats.\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html", "name": "indices.field_usage_stats", "privileges": { "index": [ @@ -7313,13 +6855,8 @@ }, "description": "Flush data streams or indices.\nFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.\nWhen restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.\nElasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.\n\nAfter each operation has been flushed it is permanently stored in the Lucene index.\nThis may mean that there is no need to maintain an additional copy of it in the transaction log.\nThe transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.\n\nIt is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.\nIf you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.", "docId": "indices-flush", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html", "name": "indices.flush", - "privileges": { - "index": [ - "maintenance" - ] - }, "request": { "name": "Request", "namespace": "indices.flush" @@ -7360,17 +6897,11 @@ "stability": "stable" } }, - "description": "Force a merge.\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", - "docId": "indices-forcemerge", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge", + "description": "Force a merge.\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html", "extDocId": "index-modules-merge", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-merge.html", "name": "indices.forcemerge", - "privileges": { - "index": [ - "maintenance" - ] - }, "request": { "name": "Request", "namespace": "indices.forcemerge" @@ -7408,9 +6939,8 @@ "stability": "stable" } }, - "description": "Get index information.\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", - "docId": "indices-get-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get", + "description": "Get index information.\nReturns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html", "name": "indices.get", "privileges": { "index": [ @@ -7450,14 +6980,8 @@ } }, "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", - "docId": "indices-get-alias", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", "name": "indices.get_alias", - "privileges": { - "index": [ - "view_index_metadata" - ] - }, "request": { "name": "Request", "namespace": "indices.get_alias" @@ -7508,10 +7032,9 @@ "stability": "stable" } }, - "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", - "docId": "data-stream-get-lifecycle", + "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { "name": "Request", @@ -7534,44 +7057,6 @@ } ] }, - { - "availability": { - "stack": { - "since": "8.12.0", - "stability": "stable" - } - }, - "description": "Get data stream lifecycle stats.\nGet statistics about the data streams that are managed by a data stream lifecycle.", - "docId": "data-stream-lifecycle-stats", - "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats", - "name": "indices.get_data_lifecycle_stats", - "privileges": { - "cluster": [ - "monitor" - ] - }, - "request": { - "name": "Request", - "namespace": "indices.get_data_lifecycle_stats" - }, - "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "indices.get_data_lifecycle_stats" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "GET" - ], - "path": "/_lifecycle/stats" - } - ] - }, { "availability": { "serverless": { @@ -7583,10 +7068,9 @@ "stability": "stable" } }, - "description": "Get data streams.\n\nGet information about one or more data streams.", - "docId": "data-stream-get", + "description": "Get data streams.\nRetrieves information about one or more data streams.", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.get_data_stream", "privileges": { "index": [ @@ -7626,15 +7110,9 @@ "stability": "stable" } }, - "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.\n\nThis API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.", - "docId": "indices-get-field-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html", "name": "indices.get_field_mapping", - "privileges": { - "index": [ - "view_index_metadata" - ] - }, "request": { "name": "Request", "namespace": "indices.get_field_mapping" @@ -7673,13 +7151,13 @@ "stability": "stable" } }, - "description": "Get index templates.\nGet information about one or more index templates.", - "docId": "indices-get-template", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template", + "description": "Get index templates.\nReturns information about one or more index templates.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html", "name": "indices.get_index_template", "privileges": { "cluster": [ - "manage_index_templates" + "manage_index_templates", + "manage" ] }, "request": { @@ -7719,15 +7197,9 @@ "stability": "stable" } }, - "description": "Get mapping definitions.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", - "docId": "indices-get-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html", "name": "indices.get_mapping", - "privileges": { - "index": [ - "view_index_metadata" - ] - }, "request": { "name": "Request", "namespace": "indices.get_mapping" @@ -7755,46 +7227,6 @@ } ] }, - { - "availability": { - "serverless": { - "stability": "experimental", - "visibility": "private" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", - "docId": "migrate", - "docTag": "migration", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-data-stream.html", - "name": "indices.get_migrate_reindex_status", - "request": { - "name": "Request", - "namespace": "indices.get_migrate_reindex_status" - }, - "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "indices.get_migrate_reindex_status" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "GET" - ], - "path": "/_migration/reindex/{index}/_status" - } - ] - }, { "availability": { "serverless": { @@ -7805,13 +7237,14 @@ "stability": "stable" } }, - "description": "Get index settings.\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices.", - "docId": "indices-get-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings", + "description": "Get index settings.\nReturns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html", "name": "indices.get_settings", "privileges": { "index": [ - "view_index_metadata" + "view_index_metadata", + "monitor", + "manage" ] }, "request": { @@ -7859,17 +7292,9 @@ "stability": "stable" } }, - "description": "Get index templates.\nGet information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", - "docId": "indices-get-template-v1", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template", - "extDocId": "index-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html", + "description": "Get index templates.\nRetrieves information about one or more index templates.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html", "name": "indices.get_template", - "privileges": { - "cluster": [ - "manage_index_templates" - ] - }, "request": { "name": "Request", "namespace": "indices.get_template" @@ -7897,42 +7322,6 @@ } ] }, - { - "availability": { - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", - "docId": "migrate", - "docTag": "migration", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-data-stream.html", - "name": "indices.migrate_reindex", - "request": { - "name": "Request", - "namespace": "indices.migrate_reindex" - }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "indices.migrate_reindex" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_migration/reindex" - } - ] - }, { "availability": { "serverless": { @@ -8023,15 +7412,9 @@ "stability": "stable" } }, - "description": "Open a closed index.\nFor data streams, the API opens any closed backing indices.\n\nA closed index is blocked for read/write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nThis allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behavior can be turned off by using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nThis setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.\n\nBecause opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.", - "docId": "indices-open-close", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open", + "description": "Opens a closed index.\nFor data streams, the API opens any closed backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html", "name": "indices.open", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.open" @@ -8061,7 +7444,6 @@ } }, "description": "Promote a data stream.\nPromote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention.", - "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.promote_data_stream", "request": { @@ -8142,7 +7524,6 @@ } }, "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", - "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "name": "indices.put_data_lifecycle", "request": { @@ -8180,14 +7561,9 @@ "stability": "stable" } }, - "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", "name": "indices.put_index_template", - "privileges": { - "cluster": [ - "manage_index_templates" - ] - }, "request": { "name": "Request", "namespace": "indices.put_index_template" @@ -8223,17 +7599,9 @@ "stability": "stable" } }, - "description": "Update field mappings.\nAdd new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", - "docId": "indices-put-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping", - "extDocId": "mapping-params", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html", + "description": "Update field mappings.\nAdds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html", "name": "indices.put_mapping", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.put_mapping" @@ -8269,11 +7637,8 @@ "stability": "stable" } }, - "description": "Update index settings.\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", - "docId": "indices-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings", - "extDocId": "index-modules", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html", + "description": "Update index settings.\nChanges dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html", "name": "indices.put_settings", "privileges": { "index": [ @@ -8316,11 +7681,10 @@ "stability": "stable" } }, - "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.", - "docId": "index-templates-v1", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html", "extDocId": "index-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html", "name": "indices.put_template", "privileges": { "cluster": [ @@ -8363,15 +7727,9 @@ "stability": "stable" } }, - "description": "Get index recovery information.\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nAll recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", - "docId": "indices-recovery", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery", + "description": "Get index recovery information.\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html", "name": "indices.recovery", - "privileges": { - "index": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "indices.recovery" @@ -8409,15 +7767,9 @@ "stability": "stable" } }, - "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.\n\nBy default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.\nYou can change this default interval with the `index.refresh_interval` setting.\n\nRefresh requests are synchronous and do not return a response until the refresh operation completes.\n\nRefreshes are resource-intensive.\nTo ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.\n\nIf your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.\nThis option ensures the indexing operation waits for a periodic refresh before running the search.", - "docId": "indices-refresh", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh", + "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html", "name": "indices.refresh", - "privileges": { - "index": [ - "maintenance" - ] - }, "request": { "name": "Request", "namespace": "indices.refresh" @@ -8455,16 +7807,10 @@ } }, "description": "Reload search analyzers.\nReload an index's search analyzers and their resources.\nFor data streams, the API reloads search analyzers and resources for the stream's backing indices.\n\nIMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.\n\nYou can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer.\nTo be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.\n\nNOTE: This API does not perform a reload for each shard of an index.\nInstead, it performs a reload for each node containing index shards.\nAs a result, the total shard count returned by the API can differ from the number of index shards.\nBecause reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API.\nThis ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.", - "docId": "indices-reload-analyzers", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", "extDocId": "search-analyzer", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-analyzer.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-analyzer.html", "name": "indices.reload_search_analyzers", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.reload_search_analyzers" @@ -8494,15 +7840,9 @@ "stability": "stable" } }, - "description": "Resolve the cluster.\n\nResolve the specified index expressions to return information about each cluster, including the local \"querying\" cluster, if included.\nIf no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.\n\nThis endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.\n\nYou use the same index expression with this endpoint as you would for cross-cluster search.\nIndex and cluster exclusions are also supported with this endpoint.\n\nFor each cluster in the index expression, information is returned about:\n\n* Whether the querying (\"local\") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.\n* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.\n* Whether there are any indices, aliases, or data streams on that cluster that match the index expression.\n* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).\n* Cluster version information, including the Elasticsearch server version.\n\nFor example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.\nEach cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.\n\n## Note on backwards compatibility\nThe ability to query without an index expression was added in version 8.18, so when\nquerying remote clusters older than that, the local cluster will send the index\nexpression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference\nto that index expression even though you didn't request it. If it causes a problem, you can\ninstead include an index expression like `*:*` to bypass the issue.\n\n## Advantages of using this endpoint before a cross-cluster search\n\nYou may want to exclude a cluster or index from a search when:\n\n* A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.\n* A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.\n* The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the \"error\" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)\n* A remote cluster is an older version that does not support the feature you want to use in your search.\n\n## Test availability of remote clusters\n\nThe `remote/info` endpoint is commonly used to test whether the \"local\" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.\nThe remote cluster may be available, while the local cluster is not currently connected to it.\n\nYou can use the `_resolve/cluster` API to attempt to reconnect to remote clusters.\nFor example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`.\nThe `connected` field in the response will indicate whether it was successful.\nIf a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.", - "docId": "indices-resolve-cluster-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster", + "description": "Resolve the cluster.\nResolve the specified index expressions to return information about each cluster, including the local cluster, if included.\nMultiple patterns and remote clusters are supported.\n\nThis endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.\n\nYou use the same index expression with this endpoint as you would for cross-cluster search.\nIndex and cluster exclusions are also supported with this endpoint.\n\nFor each cluster in the index expression, information is returned about:\n\n* Whether the querying (\"local\") cluster is currently connected to each remote cluster in the index expression scope.\n* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.\n* Whether there are any indices, aliases, or data streams on that cluster that match the index expression.\n* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).\n* Cluster version information, including the Elasticsearch server version.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html", "name": "indices.resolve_cluster", - "privileges": { - "index": [ - "view_index_metadata" - ] - }, "request": { "name": "Request", "namespace": "indices.resolve_cluster" @@ -8516,12 +7856,6 @@ "application/json" ], "urls": [ - { - "methods": [ - "GET" - ], - "path": "/_resolve/cluster" - }, { "methods": [ "GET" @@ -8542,14 +7876,8 @@ } }, "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", - "docId": "indices-resolve-index-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html", "name": "indices.resolve_index", - "privileges": { - "index": [ - "view_index_metadata" - ] - }, "request": { "name": "Request", "namespace": "indices.resolve_index" @@ -8582,15 +7910,10 @@ "stability": "stable" } }, - "description": "Roll over to a new index.\nTIP: It is recommended to use the index lifecycle rollover action to automate rollovers.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named ``.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.", + "description": "Roll over to a new index.\nCreates a new index for a data stream or index alias.", "docId": "indices-rollover-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html", "name": "indices.rollover", - "privileges": { - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "indices.rollover" @@ -8632,14 +7955,8 @@ } }, "description": "Get index segments.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the stream's backing indices.", - "docId": "indices-segments", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html", "name": "indices.segments", - "privileges": { - "index": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "indices.segments" @@ -8674,12 +7991,12 @@ } }, "description": "Get index shard stores.\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.", - "docId": "indices-shards-stores", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html", "name": "indices.shard_stores", "privileges": { "index": [ - "monitor" + "monitor", + "manage" ] }, "request": { @@ -8718,7 +8035,7 @@ }, "description": "Shrink an index.\nShrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.", "docId": "indices-shrink-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html", "name": "indices.shrink", "privileges": { "index": [ @@ -8761,15 +8078,9 @@ "stability": "stable" } }, - "description": "Simulate an index.\nGet the index configuration that would be applied to the specified index from an existing index template.", - "docId": "indices-simulate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template", + "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html", "name": "indices.simulate_index_template", - "privileges": { - "cluster": [ - "manage_index_templates" - ] - }, "request": { "name": "Request", "namespace": "indices.simulate_index_template" @@ -8804,13 +8115,13 @@ "stability": "stable" } }, - "description": "Simulate an index template.\nGet the index configuration that would be applied by a particular index template.", - "docId": "indices-simulate-template", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template", + "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html", "name": "indices.simulate_template", "privileges": { "cluster": [ - "manage_index_templates" + "manage_index_templates", + "manage" ] }, "request": { @@ -8850,9 +8161,9 @@ "stability": "stable" } }, - "description": "Split an index.\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.", + "description": "Split an index.\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.", "docId": "indices-split-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html", "name": "indices.split", "privileges": { "index": [ @@ -8896,11 +8207,11 @@ } }, "description": "Get index statistics.\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.", - "docId": "indices-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html", "name": "indices.stats", "privileges": { "index": [ + "manage", "monitor" ] }, @@ -8943,6 +8254,46 @@ } ] }, + { + "availability": { + "stack": { + "since": "6.6.0", + "stability": "stable" + } + }, + "description": "Unfreeze an index.\nWhen a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html", + "name": "indices.unfreeze", + "privileges": { + "index": [ + "manage" + ] + }, + "request": { + "name": "Request", + "namespace": "indices.unfreeze" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "indices.unfreeze" + }, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "deprecation": { + "description": "Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release.", + "version": "7.14.0" + }, + "methods": [ + "POST" + ], + "path": "/{index}/_unfreeze" + } + ] + }, { "availability": { "serverless": { @@ -9040,8 +8391,7 @@ } }, "description": "Delete an inference endpoint", - "docId": "inference-api-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html", "name": "inference.delete", "request": { "name": "Request", @@ -9083,8 +8433,7 @@ } }, "description": "Get an inference endpoint", - "docId": "inference-api-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html", "name": "inference.get", "request": { "name": "Request", @@ -9131,15 +8480,9 @@ "visibility": "public" } }, - "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", - "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "description": "Perform inference on the service", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html", "name": "inference.inference", - "privileges": { - "cluster": [ - "monitor_inference" - ] - }, "request": { "name": "Request", "namespace": "inference.inference" @@ -9182,15 +8525,9 @@ "visibility": "public" } }, - "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", - "docId": "inference-api-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put", + "description": "Create an inference endpoint", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html", "name": "inference.put", - "privileges": { - "cluster": [ - "manage_inference" - ] - }, "request": { "name": "Request", "namespace": "inference.put" @@ -9224,32 +8561,19 @@ { "availability": { "stack": { - "since": "8.16.0", "stability": "stable", "visibility": "public" } }, - "description": "Perform streaming inference.\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming.", - "docId": "inference-api-stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-stream-inference", + "description": "Perform streaming inference", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/post-stream-inference-api.html", "name": "inference.stream_inference", - "privileges": { - "cluster": [ - "monitor_inference" - ] - }, - "request": { - "name": "Request", - "namespace": "inference.stream_inference" - }, + "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "inference.stream_inference" - }, + "response": null, "responseMediaType": [ "text/event-stream" ], @@ -9268,98 +8592,6 @@ } ] }, - { - "availability": { - "serverless": { - "stability": "stable", - "visibility": "public" - }, - "stack": { - "since": "8.18.0", - "stability": "stable", - "visibility": "public" - } - }, - "description": "Perform inference on the service using the Unified Schema", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/unified-inference-api.html", - "name": "inference.unified_inference", - "request": { - "name": "Request", - "namespace": "inference.unified_inference" - }, - "requestBodyRequired": false, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "inference.unified_inference" - }, - "responseMediaType": [ - "text/event-stream" - ], - "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_inference/{inference_id}/_unified" - }, - { - "methods": [ - "POST" - ], - "path": "/_inference/{task_type}/{inference_id}/_unified" - } - ] - }, - { - "availability": { - "stack": { - "since": "8.17.0", - "stability": "stable", - "visibility": "public" - } - }, - "description": "Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", - "docId": "inference-api-update", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-update", - "name": "inference.update", - "privileges": { - "cluster": [ - "manage_inference" - ] - }, - "request": { - "name": "Request", - "namespace": "inference.update" - }, - "requestBodyRequired": true, - "requestMediaType": [ - "application/json" - ], - "response": { - "name": "Response", - "namespace": "inference.update" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_inference/{inference_id}/_update" - }, - { - "methods": [ - "POST" - ], - "path": "/_inference/{task_type}/{inference_id}/_update" - } - ] - }, { "availability": { "serverless": { @@ -9370,16 +8602,9 @@ "stability": "stable" } }, - "description": "Get cluster info.\nGet basic build, version, and cluster information.", - "docId": "api-root", - "docTag": "info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info", + "description": "Get cluster info.\nReturns basic information about the cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "info", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "_global.info" @@ -9411,9 +8636,8 @@ "stability": "stable" } }, - "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations.", - "docId": "geoip-delete-database", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-geoip-database", + "description": "Delete GeoIP database configurations.\nDelete one or more IP geolocation database configurations.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-geoip-database-api.html", "name": "ingest.delete_geoip_database", "request": { "name": "Request", @@ -9438,32 +8662,17 @@ }, { "availability": { - "serverless": { - "visibility": "private" - }, "stack": { - "since": "8.15.0", - "stability": "stable" + "stability": "stable", + "visibility": "public" } }, - "description": "Delete IP geolocation database configurations.", - "docId": "ip-location-delete-database", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-ip-location-database", + "description": "Deletes an ip location database configuration", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-ip-location-database-api.html", "name": "ingest.delete_ip_location_database", - "privileges": { - "cluster": [ - "manage" - ] - }, - "request": { - "name": "Request", - "namespace": "ingest.delete_ip_location_database" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "ingest.delete_ip_location_database" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -9488,10 +8697,9 @@ } }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", - "docId": "delete-pipeline-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", "request": { "name": "Request", @@ -9527,9 +8735,9 @@ }, "description": "Get GeoIP statistics.\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "docId": "geoip-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "extDocId": "geoip-processor", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "name": "ingest.geo_ip_stats", "request": { "name": "Request", @@ -9562,9 +8770,8 @@ "stability": "stable" } }, - "description": "Get GeoIP database configurations.\n\nGet information about one or more IP geolocation database configurations.", - "docId": "geoip-get-database", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-geoip-database", + "description": "Get GeoIP database configurations.\nGet information about one or more IP geolocation database configurations.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-geoip-database-api.html", "name": "ingest.get_geoip_database", "request": { "name": "Request", @@ -9595,32 +8802,17 @@ }, { "availability": { - "serverless": { - "visibility": "private" - }, "stack": { - "since": "8.15.0", - "stability": "stable" + "stability": "stable", + "visibility": "public" } }, - "description": "Get IP geolocation database configurations.", - "docId": "ip-location-get-database", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-ip-location-database", + "description": "Returns the specified ip location database configuration", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-ip-location-database-api.html", "name": "ingest.get_ip_location_database", - "privileges": { - "cluster": [ - "manage" - ] - }, - "request": { - "name": "Request", - "namespace": "ingest.get_ip_location_database" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "ingest.get_ip_location_database" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -9650,11 +8842,10 @@ "stability": "stable" } }, - "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", - "docId": "get-pipeline-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline", + "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", "request": { "name": "Request", @@ -9696,9 +8887,9 @@ }, "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "extDocId": "grok-processor", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "ingest.processor_grok", "request": { "name": "Request", @@ -9731,9 +8922,8 @@ "stability": "stable" } }, - "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API.", - "docId": "geoip-put-database", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-geoip-database", + "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-geoip-database-api.html", "name": "ingest.put_geoip_database", "request": { "name": "Request", @@ -9761,35 +8951,20 @@ }, { "availability": { - "serverless": { - "visibility": "private" - }, "stack": { - "since": "8.15.0", - "stability": "stable" + "stability": "stable", + "visibility": "public" } }, - "description": "Create or update an IP geolocation database configuration.", - "docId": "ip-location-put-database", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-ip-location-database", + "description": "Puts the configuration for a ip location database to be downloaded", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-ip-location-database-api.html", "name": "ingest.put_ip_location_database", - "privileges": { - "cluster": [ - "manage" - ] - }, - "request": { - "name": "Request", - "namespace": "ingest.put_ip_location_database" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "ingest.put_ip_location_database" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -9815,9 +8990,9 @@ }, "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "docId": "ingest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.put_pipeline", "request": { "name": "Request", @@ -9854,15 +9029,9 @@ "stability": "stable" } }, - "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", - "docId": "simulate-pipeline-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate", + "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html", "name": "ingest.simulate", - "privileges": { - "cluster": [ - "read_pipeline" - ] - }, "request": { "name": "Request", "namespace": "ingest.simulate" @@ -9906,10 +9075,9 @@ "description": "The kNN search API has been replaced by the `knn` option in the search API.", "version": "8.4.0" }, - "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.\n\nA kNN search response has the exact same structure as a search API response.\nHowever, certain sections have a meaning specific to kNN search:\n\n* The document `_score` is determined by the similarity between the query and document vector.\n* The `hits.total` object contains the total number of nearest neighbor candidates considered, which is `num_candidates * num_shards`. The `hits.total.relation` will always be `eq`, indicating an exact value.", - "docId": "search-knn", + "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "knn_search", "request": { "name": "Request", @@ -9942,11 +9110,10 @@ "stability": "stable" } }, - "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", - "docId": "delete-license", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete", + "description": "Delete the license.\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", "extDocId": "license-management", - "extDocUrl": "https://www.elastic.co/guide/en/kibana/current/managing-licenses.html", + "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html", "name": "license.delete", "privileges": { "cluster": [ @@ -9984,9 +9151,8 @@ "stability": "stable" } }, - "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", - "docId": "get-license", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get", + "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "name": "license.get", "request": { "name": "Request", @@ -10017,8 +9183,7 @@ } }, "description": "Get the basic license status.", - "docId": "get-basic-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "name": "license.get_basic_status", "privileges": { "cluster": [ @@ -10054,8 +9219,7 @@ } }, "description": "Get the trial status.", - "docId": "get-trial-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-trial-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "name": "license.get_trial_status", "privileges": { "cluster": [ @@ -10089,9 +9253,8 @@ "stability": "stable" } }, - "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", - "docId": "update-license", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post", + "description": "Update the license.\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "name": "license.post", "privileges": { "cluster": [ @@ -10130,9 +9293,8 @@ "stability": "stable" } }, - "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", - "docId": "start-basic", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic", + "description": "Start a basic license.\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "name": "license.post_start_basic", "privileges": { "cluster": [ @@ -10168,8 +9330,7 @@ } }, "description": "Start a trial.\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", - "docId": "start-trial", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-trial", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "name": "license.post_start_trial", "privileges": { "cluster": [ @@ -10208,11 +9369,8 @@ "stability": "stable" } }, - "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", - "docId": "logstash-api-delete-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline", - "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "description": "Deletes a pipeline used for Logstash Central Management.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ @@ -10251,11 +9409,8 @@ "stability": "stable" } }, - "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", - "docId": "logstash-api-get-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline", - "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "description": "Retrieves pipelines used for Logstash Central Management.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html", "name": "logstash.get_pipeline", "privileges": { "cluster": [ @@ -10300,11 +9455,8 @@ "stability": "stable" } }, - "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", - "docId": "logstash-api-put-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline", - "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "description": "Creates or updates a pipeline used for Logstash Central Management.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html", "name": "logstash.put_pipeline", "privileges": { "cluster": [ @@ -10346,10 +9498,9 @@ "stability": "stable" } }, - "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", - "docId": "docs-multi-get", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "name": "mget", "privileges": { "index": [ @@ -10395,15 +9546,9 @@ "stability": "stable" } }, - "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", - "docId": "migration-api-deprecation", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations", + "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", "name": "migration.deprecations", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "migration.deprecations" @@ -10438,14 +9583,10 @@ "stability": "stable" } }, - "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", - "docId": "migration-api-feature-upgrade", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status", + "description": "Find out whether system features need to be upgraded or not", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.get_feature_upgrade_status", "privileges": { - "cluster": [ - "manage" - ], "index": [ "manage" ] @@ -10478,14 +9619,10 @@ "stability": "stable" } }, - "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", - "docId": "migration-api-feature-upgrade", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status", + "description": "Begin upgrades for system features", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", "name": "migration.post_feature_upgrade", "privileges": { - "cluster": [ - "manage" - ], "index": [ "manage" ] @@ -10522,10 +9659,9 @@ "stability": "stable" } }, - "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", - "docId": "clear-trained-model", + "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html", "name": "ml.clear_trained_model_deployment_cache", "privileges": { "cluster": [ @@ -10567,10 +9703,10 @@ "stability": "stable" } }, - "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "description": "Close anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "docId": "ml-close-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html", "name": "ml.close_job", "privileges": { "cluster": [ @@ -10612,10 +9748,10 @@ "stability": "stable" } }, - "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", + "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", "docId": "ml-delete-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html", "name": "ml.delete_calendar", "privileges": { "cluster": [ @@ -10657,7 +9793,7 @@ "description": "Delete events from a calendar.", "docId": "ml-delete-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html", "name": "ml.delete_calendar_event", "request": { "name": "Request", @@ -10694,7 +9830,7 @@ "description": "Delete anomaly jobs from a calendar.", "docId": "ml-delete-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html", "name": "ml.delete_calendar_job", "privileges": { "cluster": [ @@ -10736,7 +9872,7 @@ "description": "Delete a data frame analytics job.", "docId": "ml-delete-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html", "name": "ml.delete_data_frame_analytics", "privileges": { "cluster": [ @@ -10778,7 +9914,7 @@ "description": "Delete a datafeed.", "docId": "ml-delete-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html", "name": "ml.delete_datafeed", "privileges": { "cluster": [ @@ -10817,10 +9953,9 @@ "stability": "stable" } }, - "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", - "docId": "ml-delete-expired-data", + "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", "name": "ml.delete_expired_data", "privileges": { "cluster": [ @@ -10868,10 +10003,9 @@ "stability": "stable" } }, - "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", - "docId": "ml-delete-filter", + "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", "name": "ml.delete_filter", "privileges": { "cluster": [ @@ -10910,10 +10044,9 @@ "stability": "stable" } }, - "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", - "docId": "ml-delete-forecast", + "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", "name": "ml.delete_forecast", "privileges": { "cluster": [ @@ -10958,10 +10091,9 @@ "stability": "stable" } }, - "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", - "docId": "ml-delete-job", + "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", "name": "ml.delete_job", "privileges": { "cluster": [ @@ -11000,10 +10132,9 @@ "stability": "stable" } }, - "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", - "docId": "ml-delete-snapshot", + "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", "name": "ml.delete_model_snapshot", "privileges": { "cluster": [ @@ -11042,10 +10173,9 @@ "stability": "stable" } }, - "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", - "docId": "delete-trained-models", + "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", "name": "ml.delete_trained_model", "privileges": { "cluster": [ @@ -11084,10 +10214,9 @@ "stability": "stable" } }, - "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", - "docId": "delete-trained-models-aliases", + "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ @@ -11129,10 +10258,9 @@ "stability": "stable" } }, - "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", - "docId": "ml-estimate-memory", + "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html", "name": "ml.estimate_model_memory", "privileges": { "cluster": [ @@ -11174,10 +10302,9 @@ "stability": "stable" } }, - "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", - "docId": "evaluate-dfanalytics", + "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ @@ -11219,10 +10346,9 @@ "stability": "stable" } }, - "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", - "docId": "explain-dfanalytics", + "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics", + "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", "name": "ml.explain_data_frame_analytics", "privileges": { "cluster": [ @@ -11273,9 +10399,8 @@ } }, "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", - "docId": "ml-flush-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html", "name": "ml.flush_job", "privileges": { "cluster": [ @@ -11318,9 +10443,8 @@ } }, "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", - "docId": "ml-forecast", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html", "name": "ml.forecast", "privileges": { "cluster": [ @@ -11363,9 +10487,8 @@ } }, "description": "Get anomaly detection job results for buckets.\nThe API presents a chronological view of the records, grouped by bucket.", - "docId": "ml-get-bucket", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html", "name": "ml.get_buckets", "privileges": { "cluster": [ @@ -11416,9 +10539,8 @@ } }, "description": "Get info about events in calendars.", - "docId": "ml-get-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html", "name": "ml.get_calendar_events", "privileges": { "cluster": [ @@ -11458,9 +10580,8 @@ } }, "description": "Get calendar configuration info.", - "docId": "ml-get-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html", "name": "ml.get_calendars", "privileges": { "cluster": [ @@ -11511,9 +10632,8 @@ } }, "description": "Get anomaly detection job results for categories.", - "docId": "ml-get-category", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html", "name": "ml.get_categories", "privileges": { "cluster": [ @@ -11564,9 +10684,8 @@ } }, "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", - "docId": "get-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html", "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ @@ -11612,9 +10731,8 @@ } }, "description": "Get data frame analytics jobs usage info.", - "docId": "get-dfanalytics-stats", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html", "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ @@ -11660,9 +10778,8 @@ } }, "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", - "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html", "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ @@ -11708,9 +10825,8 @@ } }, "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", - "docId": "ml-get-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html", "name": "ml.get_datafeeds", "privileges": { "cluster": [ @@ -11756,9 +10872,8 @@ } }, "description": "Get filters.\nYou can get a single filter or all filters.", - "docId": "ml-get-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html", "name": "ml.get_filters", "privileges": { "cluster": [ @@ -11804,9 +10919,8 @@ } }, "description": "Get anomaly detection job results for influencers.\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", - "docId": "ml-get-influencer", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html", "name": "ml.get_influencers", "privileges": { "cluster": [ @@ -11850,9 +10964,8 @@ } }, "description": "Get anomaly detection jobs usage info.", - "docId": "ml-get-job-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html", "name": "ml.get_job_stats", "privileges": { "cluster": [ @@ -11898,9 +11011,8 @@ } }, "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", - "docId": "ml-get-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html", "name": "ml.get_jobs", "privileges": { "cluster": [ @@ -11946,8 +11058,7 @@ } }, "description": "Get machine learning memory usage info.\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", - "docId": "ml-get-memory", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html", "name": "ml.get_memory_stats", "privileges": { "cluster": [ @@ -11993,9 +11104,8 @@ } }, "description": "Get anomaly detection job model snapshot upgrade usage info.", - "docId": "ml-get-job-model-snapshot-upgrade-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshot-upgrade-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html", "name": "ml.get_model_snapshot_upgrade_stats", "privileges": { "cluster": [ @@ -12035,9 +11145,8 @@ } }, "description": "Get model snapshots info.", - "docId": "ml-get-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html", "name": "ml.get_model_snapshots", "privileges": { "cluster": [ @@ -12088,9 +11197,8 @@ } }, "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", - "docId": "ml-get-overall-buckets", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html", "name": "ml.get_overall_buckets", "privileges": { "cluster": [ @@ -12134,9 +11242,8 @@ } }, "description": "Get anomaly records for an anomaly detection job.\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", - "docId": "ml-get-record", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html", "name": "ml.get_records", "privileges": { "cluster": [ @@ -12180,9 +11287,8 @@ } }, "description": "Get trained model configuration info.", - "docId": "get-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html", "name": "ml.get_trained_models", "privileges": { "cluster": [ @@ -12228,9 +11334,8 @@ } }, "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", - "docId": "get-trained-models-stats", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html", "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ @@ -12276,9 +11381,8 @@ } }, "description": "Evaluate a trained model.", - "docId": "infer-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html", "name": "ml.infer_trained_model", "request": { "name": "Request", @@ -12325,9 +11429,8 @@ "stability": "stable" } }, - "description": "Get machine learning information.\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", - "docId": "get-ml-info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info", + "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html", "name": "ml.info", "privileges": { "cluster": [ @@ -12366,10 +11469,9 @@ "stability": "stable" } }, - "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", - "docId": "ml-open-job", + "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", "name": "ml.open_job", "privileges": { "cluster": [ @@ -12412,9 +11514,8 @@ } }, "description": "Add scheduled events to the calendar.", - "docId": "ml-post-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html", "name": "ml.post_calendar_events", "privileges": { "cluster": [ @@ -12457,9 +11558,8 @@ "version": "7.11.0" }, "description": "Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", - "docId": "ml-post-data", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html", "name": "ml.post_data", "privileges": { "cluster": [ @@ -12502,10 +11602,9 @@ "stability": "stable" } }, - "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", - "docId": "preview-dfanalytics", + "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics", + "docUrl": "http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html", "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ @@ -12556,9 +11655,8 @@ } }, "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", - "docId": "ml-preview-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html", "name": "ml.preview_datafeed", "privileges": { "cluster": [ @@ -12612,9 +11710,8 @@ } }, "description": "Create a calendar.", - "docId": "ml-put-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html", "name": "ml.put_calendar", "privileges": { "cluster": [ @@ -12657,9 +11754,8 @@ } }, "description": "Add anomaly detection job to calendar.", - "docId": "ml-put-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html", "name": "ml.put_calendar_job", "privileges": { "cluster": [ @@ -12698,10 +11794,10 @@ "stability": "stable" } }, - "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", + "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "docId": "put-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", "name": "ml.put_data_frame_analytics", "privileges": { "cluster": [ @@ -12750,10 +11846,9 @@ "stability": "stable" } }, - "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", - "docId": "ml-put-datafeed", + "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay`) at each interval.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html", "name": "ml.put_datafeed", "privileges": { "cluster": [ @@ -12799,9 +11894,8 @@ } }, "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", - "docId": "ml-put-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html", "name": "ml.put_filter", "privileges": { "cluster": [ @@ -12843,10 +11937,9 @@ "stability": "stable" } }, - "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", - "docId": "ml-put-job", + "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "name": "ml.put_job", "privileges": { "cluster": [ @@ -12892,9 +11985,8 @@ } }, "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", - "docId": "put-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "name": "ml.put_trained_model", "privileges": { "cluster": [ @@ -12937,9 +12029,8 @@ } }, "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", - "docId": "put-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html", "name": "ml.put_trained_model_alias", "privileges": { "cluster": [ @@ -12982,9 +12073,8 @@ } }, "description": "Create part of a trained model definition.", - "docId": "put-trained-model-definition-part", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html", "name": "ml.put_trained_model_definition_part", "privileges": { "cluster": [ @@ -13027,9 +12117,8 @@ } }, "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", - "docId": "put-trained-model-vocabulary", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html", "name": "ml.put_trained_model_vocabulary", "privileges": { "cluster": [ @@ -13072,9 +12161,8 @@ } }, "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", - "docId": "ml-reset-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html", "name": "ml.reset_job", "privileges": { "cluster": [ @@ -13114,9 +12202,8 @@ } }, "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", - "docId": "ml-revert-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html", "name": "ml.revert_model_snapshot", "privileges": { "cluster": [ @@ -13159,8 +12246,7 @@ } }, "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", - "docId": "ml-set-upgrade-mode", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html", "name": "ml.set_upgrade_mode", "privileges": { "cluster": [ @@ -13200,9 +12286,8 @@ } }, "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", - "docId": "start-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html", "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ @@ -13252,9 +12337,8 @@ } }, "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", - "docId": "ml-start-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html", "name": "ml.start_datafeed", "privileges": { "cluster": [ @@ -13297,9 +12381,8 @@ } }, "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", - "docId": "start-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html", "name": "ml.start_trained_model_deployment", "privileges": { "cluster": [ @@ -13342,9 +12425,8 @@ } }, "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", - "docId": "stop-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html", "name": "ml.stop_data_frame_analytics", "privileges": { "cluster": [ @@ -13387,9 +12469,8 @@ } }, "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", - "docId": "ml-stop-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html", "name": "ml.stop_datafeed", "privileges": { "cluster": [ @@ -13432,9 +12513,8 @@ } }, "description": "Stop a trained model deployment.", - "docId": "stop-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html", "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ @@ -13477,9 +12557,8 @@ } }, "description": "Update a data frame analytics job.", - "docId": "update-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ @@ -13529,9 +12608,8 @@ } }, "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", - "docId": "ml-update-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html", "name": "ml.update_datafeed", "privileges": { "cluster": [ @@ -13574,9 +12652,8 @@ } }, "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", - "docId": "ml-update-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html", "name": "ml.update_filter", "privileges": { "cluster": [ @@ -13619,9 +12696,8 @@ } }, "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", - "docId": "ml-update-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html", "name": "ml.update_job", "privileges": { "cluster": [ @@ -13664,9 +12740,8 @@ } }, "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", - "docId": "ml-update-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html", "name": "ml.update_model_snapshot", "privileges": { "cluster": [ @@ -13709,9 +12784,8 @@ } }, "description": "Update a trained model deployment.", - "docId": "update-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ @@ -13753,10 +12827,9 @@ "stability": "stable" } }, - "description": "Upgrade a snapshot.\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", - "docId": "ml-upgrade-job-model-snapshot", + "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html", "name": "ml.upgrade_job_snapshot", "privileges": { "cluster": [ @@ -13796,8 +12869,7 @@ "visibility": "private" } }, - "description": "Validate an anomaly detection job.", - "docTag": "ml anomaly", + "description": "Validates an anomaly detection job.", "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate", "request": { @@ -13836,10 +12908,8 @@ "visibility": "private" } }, - "description": "Validate an anomaly detection job.", - "docId": "apis", - "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch", + "description": "Validates an anomaly detection detector.", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html", "name": "ml.validate_detector", "request": { "name": "Request", @@ -13869,13 +12939,11 @@ "availability": { "stack": { "since": "6.3.0", - "stability": "stable", - "visibility": "private" + "stability": "stable" } }, - "description": "Send monitoring data.\nThis API is used by the monitoring features to send monitoring data.", - "docId": "apis", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch", + "description": "Used by the monitoring features to send monitoring data.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/monitor-elasticsearch-cluster.html", "name": "monitoring.bulk", "request": { "name": "Request", @@ -13925,9 +12993,8 @@ } }, "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: 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 requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", - "docId": "search-multi-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "name": "msearch", "privileges": { "index": [ @@ -13977,12 +13044,11 @@ "stability": "stable" } }, - "description": "Run multiple templated searches.\n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", - "docId": "search-multi-search-template", + "description": "Run multiple templated searches.", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", "extDocId": "search-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "msearch_template", "privileges": { "index": [ @@ -14031,16 +13097,10 @@ "stability": "stable" } }, - "description": "Get multiple term vectors.\n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.", - "docId": "docs-multi-termvectors", + "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "name": "mtermvectors", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.mtermvectors" @@ -14085,9 +13145,8 @@ } }, "description": "Clear the archived repositories metering.\nClear the archived repositories metering information in the cluster.", - "docId": "clear-repositories-metering-archive-api", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", "name": "nodes.clear_repositories_metering_archive", "privileges": { "cluster": [ @@ -14128,9 +13187,8 @@ } }, "description": "Get cluster repositories metering.\nGet repositories metering information for a cluster.\nThis API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.\nAdditionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.", - "docId": "get-repositories-metering-api", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", "name": "nodes.get_repositories_metering_info", "privileges": { "cluster": [ @@ -14172,7 +13230,7 @@ "description": "Get the hot threads for nodes.\nGet a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of the top hot threads for each node.", "docId": "cluster-nodes-hot-threads", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html", "name": "nodes.hot_threads", "privileges": { "cluster": [ @@ -14218,10 +13276,10 @@ "stability": "stable" } }, - "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes.", + "description": "Get node information.\nBy default, the API returns all attributes and core settings for cluster nodes.", "docId": "cluster-nodes-info", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html", "name": "nodes.info", "request": { "name": "Request", @@ -14270,9 +13328,8 @@ } }, "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.", - "docId": "cluster-nodes-reload-secure-settings", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "name": "nodes.reload_secure_settings", "request": { "name": "Request", @@ -14317,7 +13374,7 @@ "description": "Get node statistics.\nGet statistics for nodes in a cluster.\nBy default, all stats are returned. You can limit the returned information by using metrics.", "docId": "cluster-nodes-stats", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", "name": "nodes.stats", "privileges": { "cluster": [ @@ -14390,7 +13447,7 @@ "description": "Get feature usage information.", "docId": "cluster-nodes-usage", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", "name": "nodes.usage", "privileges": { "cluster": [ @@ -14448,10 +13505,10 @@ "stability": "stable" } }, - "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API.", + "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "docId": "point-in-time-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", "name": "open_point_in_time", "privileges": { "index": [ @@ -14493,9 +13550,8 @@ } }, "description": "Ping the cluster.\nGet information about whether the cluster is running.", - "docId": "cluster-ping", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "ping", "request": { "name": "Request", @@ -14638,17 +13694,9 @@ } }, "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", - "docId": "script-put", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script", - "extDocId": "search-template", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "put_script", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "_global.put_script" @@ -14692,15 +13740,9 @@ "stability": "stable" } }, - "description": "Delete a query rule.\nDelete a query rule within a query ruleset.\nThis is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.", - "docId": "query-rule-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule", + "description": "Delete a query rule.\nDelete a query rule within a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-rule.html", "name": "query_rules.delete_rule", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.delete_rule" @@ -14733,15 +13775,9 @@ "stability": "stable" } }, - "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", - "docId": "query-ruleset-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset", + "description": "Delete a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-query-ruleset.html", "name": "query_rules.delete_ruleset", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.delete_ruleset" @@ -14775,16 +13811,10 @@ } }, "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", - "docId": "query-rule-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-rule.html", "extDocId": "query-rule", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.get_rule", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.get_rule" @@ -14818,14 +13848,8 @@ } }, "description": "Get a query ruleset.\nGet details about a query ruleset.", - "docId": "query-ruleset-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.html", "name": "query_rules.get_ruleset", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.get_ruleset" @@ -14859,14 +13883,8 @@ } }, "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", - "docId": "query-ruleset-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-query-rulesets.html", "name": "query_rules.list_rulesets", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.list_rulesets" @@ -14899,15 +13917,9 @@ "stability": "stable" } }, - "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", - "docId": "query-rule-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule", + "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-rule.html", "name": "query_rules.put_rule", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.put_rule" @@ -14943,17 +13955,11 @@ "stability": "stable" } }, - "description": "Create or update a query ruleset.\nThere is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", - "docId": "query-ruleset-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset", + "description": "Create or update a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-query-ruleset.html", "extDocId": "query-rule", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.put_ruleset", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.put_ruleset" @@ -14990,14 +13996,8 @@ } }, "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria.", - "docId": "query-ruleset-test", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html", "name": "query_rules.test", - "privileges": { - "cluster": [ - "manage_search_query_rules" - ] - }, "request": { "name": "Request", "namespace": "query_rules.test" @@ -15034,9 +14034,8 @@ } }, "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", - "docId": "search-rank-eval", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "name": "rank_eval", "privileges": { "index": [ @@ -15086,17 +14085,10 @@ "stability": "stable" } }, - "description": "Reindex documents.\n\nCopy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nNOTE: The reindex API makes no effort to handle ID collisions.\nThe last document written will \"win\" but the order isn't usually predictable so it is not a good idea to rely on this behavior.\nInstead, make sure that IDs are unique by using a script.\n\n**Running reindex asynchronously**\n\nIf the request contains `wait_for_completion=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.\nElasticsearch creates a record of this task as a document at `_tasks/`.\n\n**Reindex from multiple sources**\n\nIf you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources.\nThat way you can resume the process if there are any errors by removing the partially completed source and starting over.\nIt also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel.\n\nFor example, you can use a bash script like this:\n\n```\nfor index in i1 i2 i3 i4 i5; do\n curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{\n \"source\": {\n \"index\": \"'$index'\"\n },\n \"dest\": {\n \"index\": \"'$index'-reindexed\"\n }\n }'\ndone\n```\n\n**Throttling**\n\nSet `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations.\nRequests are throttled by padding each batch with a wait time.\nTo turn off throttling, set `requests_per_second` to `-1`.\n\nThe throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding.\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 then wait for a while before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nYou can slice a reindex request manually by providing a slice ID and total number of slices to each request.\nYou can also let reindex automatically parallelize by using sliced scroll to slice on `_id`.\nThe `slices` parameter specifies the number of slices to use.\n\nAdding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks API. 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 previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed.\n* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time.\n\nIf slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices.\nIf slicing manually or otherwise tuning automatic slicing, use the following guidelines.\n\nQuery performance is most efficient when the number of slices is equal to the number of shards in the index.\nIf that number is large (for example, `500`), choose a lower number as too many slices will hurt performance.\nSetting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n\nIndexing performance scales linearly across available resources with the number of slices.\n\nWhether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Modify documents during reindexing**\n\nLike `_update_by_query`, reindex operations support a script that modifies the document.\nUnlike `_update_by_query`, the script is allowed to modify the document's metadata.\n\nJust as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination.\nFor example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This \"no operation\" will be reported in the `noop` counter in the response body.\nSet `ctx.op` to `delete` if your script decides that the document must be deleted from the destination.\nThe deletion will be reported in the `deleted` counter in the response body.\nSetting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`.\n\nThink of the possibilities! Just be careful; you are able to change:\n\n* `_id`\n* `_index`\n* `_version`\n* `_routing`\n\nSetting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request.\nIt will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API.\n\n**Reindex from remote**\n\nReindex supports reindexing from a remote Elasticsearch cluster.\nThe `host` parameter must contain a scheme, host, port, and optional path.\nThe `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication.\nBe sure to use HTTPS when using basic authentication or the password will be sent in plain text.\nThere are a range of settings available to configure the behavior of the HTTPS connection.\n\nWhen using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key.\nRemote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting.\nIt can be set to a comma delimited list of allowed remote host and port combinations.\nScheme is ignored; only the host and port are used.\nFor example:\n\n```\nreindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*\"]\n```\n\nThe list of allowed hosts must be configured on any nodes that will coordinate the reindex.\nThis feature should work with remote clusters of any version of Elasticsearch.\nThis should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version.\n\nWARNING: Elasticsearch does not support forward compatibility across major versions.\nFor example, you cannot reindex from a 7.x cluster into a 6.x cluster.\n\nTo enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nReindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb.\nIf the remote index includes very large documents you'll need to use a smaller batch size.\nIt is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field.\nBoth default to 30 seconds.\n\n**Configuring SSL parameters**\n\nReindex from remote supports configurable SSL settings.\nThese must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore.\nIt is not possible to configure SSL in the body of the reindex request.", - "docId": "docs-reindex", + "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex", - "privileges": { - "index": [ - "read", - "write" - ] - }, "request": { "name": "Request", "namespace": "_global.reindex" @@ -15132,10 +14124,9 @@ "stability": "stable" } }, - "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.\nFor example:\n\n```\nPOST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n```\n\nRethrottling that speeds up the query takes effect immediately.\nRethrottling that slows down the query will take effect after completing the current batch.\nThis behavior prevents scroll timeouts.", - "docId": "docs-reindex", + "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex_rethrottle", "request": { "name": "Request", @@ -15169,15 +14160,9 @@ } }, "description": "Render a search template.\n\nRender a search template as a search request body.", - "docId": "render-search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "name": "render_search_template", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.render_search_template" @@ -15217,19 +14202,9 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", - "docId": "rollup-delete-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job", + "description": "Deletes an existing rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "name": "rollup.delete_job", - "privileges": { - "cluster": [ - "manage_rollup" - ] - }, "request": { "name": "Request", "namespace": "rollup.delete_job" @@ -15258,19 +14233,9 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", - "docId": "rollup-get-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs", + "description": "Retrieves the configuration, stats, and status of rollup jobs.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "name": "rollup.get_jobs", - "privileges": { - "cluster": [ - "monitor_rollup" - ] - }, "request": { "name": "Request", "namespace": "rollup.get_jobs" @@ -15305,19 +14270,9 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", - "docId": "rollup-get-rollup-caps", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps", + "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "name": "rollup.get_rollup_caps", - "privileges": { - "cluster": [ - "monitor_rollup" - ] - }, "request": { "name": "Request", "namespace": "rollup.get_rollup_caps" @@ -15352,19 +14307,9 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", - "docId": "rollup-get-rollup-index-caps", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps", + "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "name": "rollup.get_rollup_index_caps", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "rollup.get_rollup_index_caps" @@ -15393,13 +14338,8 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", - "docId": "rollup-put-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job", + "description": "Creates a rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "name": "rollup.put_job", "privileges": { "cluster": [ @@ -15438,13 +14378,8 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\n**Searching both historical rollup and non-rollup data**\n\nThe rollup search API has the capability to search across both \"live\" non-rollup data and the aggregated rollup data.\nThis is done by simply adding the live indices to the URI. For example:\n\n```\nGET sensor-1,sensor_rollup/_rollup_search\n{\n \"size\": 0,\n \"aggregations\": {\n \"max_temperature\": {\n \"max\": {\n \"field\": \"temperature\"\n }\n }\n }\n}\n```\n\nThe rollup search endpoint does two things when the search runs:\n\n* The original request is sent to the non-rollup index unaltered.\n* A rewritten version of the original request is sent to the rollup index.\n\nWhen the two responses are received, the endpoint rewrites the rollup response and merges the two together.\nDuring the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.", - "docId": "rollup-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search", + "description": "Enables searching rolled-up data using the standard Query DSL.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "name": "rollup.rollup_search", "request": { "name": "Request", @@ -15478,19 +14413,9 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", - "docId": "rollup-start-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job", + "description": "Starts an existing, stopped rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "name": "rollup.start_job", - "privileges": { - "cluster": [ - "manage_rollup" - ] - }, "request": { "name": "Request", "namespace": "rollup.start_job" @@ -15519,19 +14444,9 @@ "stability": "experimental" } }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs.", - "docId": "rollup-stop-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job", + "description": "Stops an existing, started rollup job.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "name": "rollup.stop_job", - "privileges": { - "cluster": [ - "manage_rollup" - ] - }, "request": { "name": "Request", "namespace": "rollup.stop_job" @@ -15564,10 +14479,9 @@ "stability": "experimental" } }, - "description": "Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.", - "docId": "painless-execute-api", + "description": "Run a script.\nRuns a script and returns a result.", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", "name": "scripts_painless_execute", "request": { "name": "Request", @@ -15605,17 +14519,11 @@ } }, "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", - "docId": "scroll-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.scroll" @@ -15662,11 +14570,8 @@ "stability": "stable" } }, - "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", - "docId": "search-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search", - "extDocId": "ccs-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs", + "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "search", "privileges": { "index": [ @@ -15716,18 +14621,9 @@ "stability": "beta" } }, - "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", - "docId": "search-application-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete", + "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html", "name": "search_application.delete", - "privileges": { - "cluster": [ - "manage_search_application" - ], - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "search_application.delete" @@ -15761,9 +14657,8 @@ } }, "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", - "docId": "delete-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", "name": "search_application.delete_behavioral_analytics", "request": { "name": "Request", @@ -15798,14 +14693,8 @@ } }, "description": "Get search application details.", - "docId": "search-application-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html", "name": "search_application.get", - "privileges": { - "cluster": [ - "manage_search_application" - ] - }, "request": { "name": "Request", "namespace": "search_application.get" @@ -15839,9 +14728,8 @@ } }, "description": "Get behavioral analytics collections.", - "docId": "list-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", @@ -15881,15 +14769,9 @@ "stability": "beta" } }, - "description": "Get search applications.\nGet information about search applications.", - "docId": "list-analytics-collection", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", + "description": "Returns the existing search applications.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html", "name": "search_application.list", - "privileges": { - "cluster": [ - "manage_search_application" - ] - }, "request": { "name": "Request", "namespace": "search_application.list" @@ -15918,25 +14800,15 @@ "visibility": "public" } }, - "description": "Create a behavioral analytics collection event.", - "docId": "behavioral-analytics-collection-event", - "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event", - "extDocId": "behavioral-analytics-event-reference", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/behavioral-analytics-event-reference.html", + "description": "Creates a behavioral analytics event for existing collection.", + "docUrl": "http://todo.com/tbd", "name": "search_application.post_behavioral_analytics_event", - "request": { - "name": "Request", - "namespace": "search_application.post_behavioral_analytics_event" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "search_application.post_behavioral_analytics_event" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -15961,17 +14833,8 @@ } }, "description": "Create or update a search application.", - "docId": "search-application-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html", "name": "search_application.put", - "privileges": { - "cluster": [ - "manage_search_application" - ], - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "search_application.put" @@ -16008,9 +14871,8 @@ } }, "description": "Create a behavioral analytics collection.", - "docId": "put-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", @@ -16036,27 +14898,19 @@ { "availability": { "stack": { - "since": "8.9.0", "stability": "experimental", "visibility": "public" } }, - "description": "Render a search application query.\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application.", - "docId": "search-render-query", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query", + "description": "Renders a query for given search application search parameters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-render-query.html", "name": "search_application.render_query", - "request": { - "name": "Request", - "namespace": "search_application.render_query" - }, + "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "search_application.render_query" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -16081,8 +14935,7 @@ } }, "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", - "docId": "search-application-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-search.html", "name": "search_application.search", "request": { "name": "Request", @@ -16120,18 +14973,10 @@ "stability": "stable" } }, - "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", - "docId": "search-vector-tile-api", + "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt", - "extDocId": "mapbox-vector-tile", - "extDocUrl": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", "name": "search_mvt", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.search_mvt" @@ -16163,16 +15008,10 @@ "stability": "stable" } }, - "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.", - "docId": "search-shards", + "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", "name": "search_shards", - "privileges": { - "index": [ - "view_index_metadata" - ] - }, "request": { "name": "Request", "namespace": "_global.search_shards" @@ -16214,17 +15053,11 @@ } }, "description": "Run a search with a search template.", - "docId": "search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", "extDocId": "search-template", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "search_template", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.search_template" @@ -16264,17 +15097,9 @@ "stability": "experimental" } }, - "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", - "docId": "searchable-snapshots-api-cache-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats", - "extDocId": "searchable-snapshots", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html", + "description": "Retrieve node-level cache statistics about searchable snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.cache_stats", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "searchable_snapshots.cache_stats" @@ -16309,20 +15134,9 @@ "stability": "experimental" } }, - "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", - "docId": "searchable-snapshots-api-clear-cache", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache", - "extDocId": "searchable-snapshots", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html", + "description": "Clear the cache of searchable snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.clear_cache", - "privileges": { - "cluster": [ - "manage" - ], - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "searchable_snapshots.clear_cache" @@ -16357,18 +15171,9 @@ "stability": "stable" } }, - "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", - "docId": "searchable-snapshots-api-mount-snapshot", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount", + "description": "Mount a snapshot as a searchable index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-api-mount-snapshot.html", "name": "searchable_snapshots.mount", - "privileges": { - "cluster": [ - "manage" - ], - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "searchable_snapshots.mount" @@ -16400,18 +15205,9 @@ "stability": "stable" } }, - "description": "Get searchable snapshot statistics.", - "docId": "searchable-snapshots-api-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats", + "description": "Retrieve shard-level statistics about searchable snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html", "name": "searchable_snapshots.stats", - "privileges": { - "cluster": [ - "manage" - ], - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "searchable_snapshots.stats" @@ -16450,9 +15246,8 @@ "stability": "stable" } }, - "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.", - "docId": "security-api-activate-user-profile", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-activate-user-profile", + "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", "name": "security.activate_user_profile", "privileges": { "cluster": [ @@ -16495,8 +15290,7 @@ } }, "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", - "docId": "security-api-authenticate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "name": "security.authenticate", "request": { "name": "Request", @@ -16531,8 +15325,7 @@ } }, "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", - "docId": "security-api-bulk-delete-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-delete-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", "name": "security.bulk_delete_role", "privileges": { "cluster": [ @@ -16575,8 +15368,7 @@ } }, "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", - "docId": "security-api-bulk-put-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-put-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", "name": "security.bulk_put_role", "privileges": { "cluster": [ @@ -16610,32 +15402,19 @@ { "availability": { "stack": { - "since": "8.5.0", "stability": "stable", "visibility": "public" } }, - "description": "Bulk update API keys.\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.", - "docId": "security-api-bulk-update-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-update-api-keys", + "description": "Updates the attributes of multiple existing API keys.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html", "name": "security.bulk_update_api_keys", - "privileges": { - "cluster": [ - "manage_own_api_key" - ] - }, - "request": { - "name": "Request", - "namespace": "security.bulk_update_api_keys" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.bulk_update_api_keys" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -16655,8 +15434,7 @@ } }, "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", - "docId": "security-api-change-password", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-change-password", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "name": "security.change_password", "request": { "name": "Request", @@ -16702,8 +15480,7 @@ } }, "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", - "docId": "security-api-clear-api-key-cache", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-api-key-cache", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "name": "security.clear_api_key_cache", "privileges": { "cluster": [ @@ -16743,14 +15520,8 @@ } }, "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", - "docId": "security-api-clear-privilege-cache", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-privileges", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "name": "security.clear_cached_privileges", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.clear_cached_privileges" @@ -16782,11 +15553,8 @@ "stability": "stable" } }, - "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", - "docId": "security-api-clear-cache", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms", - "extDocId": "security-user-cache", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/controlling-user-cache.html", + "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "name": "security.clear_cached_realms", "request": { "name": "Request", @@ -16820,14 +15588,8 @@ } }, "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", - "docId": "security-api-clear-role-cache", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-roles", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "name": "security.clear_cached_roles", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.clear_cached_roles" @@ -16859,17 +15621,11 @@ "stability": "stable" } }, - "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", - "docId": "security-api-clear-service-token-caches", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-service-tokens", + "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.clear_cached_service_tokens", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.clear_cached_service_tokens" @@ -16902,11 +15658,8 @@ "stability": "stable" } }, - "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", - "docId": "security-api-create-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key", - "extDocId": "security-settings-api-keys", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", "privileges": { "cluster": [ @@ -16945,10 +15698,9 @@ } }, "description": "Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.", - "docId": "security-api-cross-cluster-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html", "extDocId": "remote-clusters-api-key", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html", "name": "security.create_cross_cluster_api_key", "privileges": { "cluster": [ @@ -16989,17 +15741,11 @@ "stability": "stable" } }, - "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", - "docId": "security-api-create-service-token", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token", + "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.create_service_token", - "privileges": { - "cluster": [ - "manage_service_account" - ] - }, "request": { "name": "Request", "namespace": "security.create_service_token" @@ -17028,45 +15774,6 @@ } ] }, - { - "availability": { - "stack": { - "since": "7.4.0", - "stability": "stable" - } - }, - "description": "Delegate PKI authentication.\n\nThis API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.", - "docId": "security-api-delegate-pki", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delegate-pki", - "extDocId": "pki-realm", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/pki-realm.html", - "name": "security.delegate_pki", - "privileges": { - "cluster": [ - "all" - ] - }, - "request": { - "name": "Request", - "namespace": "security.delegate_pki" - }, - "requestBodyRequired": true, - "response": { - "name": "Response", - "namespace": "security.delegate_pki" - }, - "responseMediaType": [ - "application/json" - ], - "urls": [ - { - "methods": [ - "POST" - ], - "path": "/_security/delegate_pki" - } - ] - }, { "availability": { "serverless": { @@ -17078,17 +15785,11 @@ "stability": "stable" } }, - "description": "Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", - "docId": "security-api-delete-privilege", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-privileges", + "description": "Delete application privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.delete_privileges", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.delete_privileges" @@ -17120,15 +15821,9 @@ "stability": "stable" } }, - "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", - "docId": "security-api-delete-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role", + "description": "Delete roles.\n\nDelete roles in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.delete_role" @@ -17161,17 +15856,9 @@ "stability": "stable" } }, - "description": "Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", - "docId": "security-api-delete-role-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role-mapping", - "extDocId": "mapping-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html", + "description": "Delete role mappings.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "name": "security.delete_role_mapping", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.delete_role_mapping" @@ -17205,16 +15892,10 @@ } }, "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", - "docId": "security-api-delete-service-token", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-service-token", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.delete_service_token", - "privileges": { - "cluster": [ - "manage_service_account" - ] - }, "request": { "name": "Request", "namespace": "security.delete_service_token" @@ -17243,14 +15924,8 @@ } }, "description": "Delete users.\n\nDelete users from the native realm.", - "docId": "security-api-delete-user", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-user", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "name": "security.delete_user", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.delete_user" @@ -17278,15 +15953,9 @@ "stability": "stable" } }, - "description": "Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.", - "docId": "security-api-disable-user", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user", + "description": "Disable users.\n\nDisable users in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "name": "security.disable_user", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.disable_user" @@ -17320,9 +15989,8 @@ "stability": "stable" } }, - "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .", - "docId": "security-api-disable-user-profile", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user-profile", + "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", "name": "security.disable_user_profile", "privileges": { "cluster": [ @@ -17357,15 +16025,9 @@ "stability": "stable" } }, - "description": "Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.", - "docId": "security-api-enable-user", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user", + "description": "Enable users.\n\nEnable users in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "name": "security.enable_user", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.enable_user" @@ -17399,9 +16061,8 @@ "stability": "stable" } }, - "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.", - "docId": "security-api-enable-user-profile", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user-profile", + "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", "name": "security.enable_user_profile", "privileges": { "cluster": [ @@ -17437,9 +16098,8 @@ "stability": "stable" } }, - "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.", - "docId": "security-api-kibana-enrollment", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-kibana", + "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", "name": "security.enroll_kibana", "request": { "name": "Request", @@ -17472,9 +16132,8 @@ "stability": "stable" } }, - "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.\n\nThe response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.\nThe response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.", - "docId": "security-api-node-enrollment", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-node", + "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", "name": "security.enroll_node", "request": { "name": "Request", @@ -17512,8 +16171,7 @@ } }, "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", - "docId": "security-api-get-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "name": "security.get_api_key", "privileges": { "cluster": [ @@ -17554,10 +16212,9 @@ } }, "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", - "docId": "security-api-get-builtin-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_builtin_privileges", "privileges": { "cluster": [ @@ -17596,17 +16253,11 @@ "stability": "stable" } }, - "description": "Get application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", - "docId": "security-api-get-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges", + "description": "Get application privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_privileges", - "privileges": { - "cluster": [ - "read_security" - ] - }, "request": { "name": "Request", "namespace": "security.get_privileges" @@ -17650,13 +16301,12 @@ "stability": "stable" } }, - "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", - "docId": "security-api-get-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role", + "description": "Get roles.\n\nGet roles in the native realm.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { "cluster": [ - "read_security" + "manage_security" ] }, "request": { @@ -17698,10 +16348,9 @@ } }, "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", - "docId": "security-api-get-role-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", "extDocId": "mapping-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.get_role_mapping", "privileges": { "cluster": [ @@ -17746,11 +16395,10 @@ "stability": "stable" } }, - "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", - "docId": "security-api-get-service-accounts", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts", + "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_accounts", "privileges": { "cluster": [ @@ -17801,17 +16449,11 @@ "stability": "stable" } }, - "description": "Get service account credentials.\n\nTo use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", - "docId": "security-api-get-service-credentials", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials", + "description": "Get service account credentials.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_credentials", - "privileges": { - "cluster": [ - "read_security" - ] - }, "request": { "name": "Request", "namespace": "security.get_service_credentials" @@ -17840,27 +16482,15 @@ "visibility": "public" } }, - "description": "Get security index settings.\n\nGet the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`", - "docId": "security-api-get-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings", + "description": "Retrieve settings for the security system indices", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html", "name": "security.get_settings", - "privileges": { - "cluster": [ - "read_security" - ] - }, - "request": { - "name": "Request", - "namespace": "security.get_settings" - }, + "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.get_settings" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -17884,17 +16514,9 @@ "stability": "stable" } }, - "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.\nThe tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.\nAlternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting.\nWhen you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.\n\nThe get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.\n\nA successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.\n\nThe tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.\nThat time period is defined by the `xpack.security.authc.token.timeout` setting.\nIf you want to invalidate a token immediately, you can do so by using the invalidate token API.", - "docId": "security-api-get-token", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token", - "extDocId": "security-encrypt-http", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup-https.html#encrypt-http-communication", + "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "name": "security.get_token", - "privileges": { - "cluster": [ - "manage_token" - ] - }, "request": { "name": "Request", "namespace": "security.get_token" @@ -17926,14 +16548,8 @@ } }, "description": "Get users.\n\nGet information about users in the native realm and built-in users.", - "docId": "security-api-get-user", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "name": "security.get_user", - "privileges": { - "cluster": [ - "read_security" - ] - }, "request": { "name": "Request", "namespace": "security.get_user" @@ -17972,9 +16588,8 @@ "stability": "stable" } }, - "description": "Get user privileges.\n\nGet the security privileges for the logged in user.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.\nTo check whether a user has a specific list of privileges, use the has privileges API.", - "docId": "security-api-get-user-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-privileges", + "description": "Get user privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", "name": "security.get_user_privileges", "request": { "name": "Request", @@ -18008,13 +16623,12 @@ "stability": "stable" } }, - "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", - "docId": "security-api-get-user-profile", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-profile", + "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", "name": "security.get_user_profile", "privileges": { "cluster": [ - "read_security" + "manage_user_profile" ] }, "request": { @@ -18049,9 +16663,8 @@ "stability": "stable" } }, - "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user's credentials.\nThe supported user authentication credential types are:\n\n* username and password\n* Elasticsearch access tokens\n* JWTs\n\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", - "docId": "security-api-grant-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-grant-api-key", + "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", "name": "security.grant_api_key", "privileges": { "cluster": [ @@ -18093,11 +16706,10 @@ "stability": "stable" } }, - "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", - "docId": "security-api-has-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges", + "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.has_privileges", "request": { "name": "Request", @@ -18142,15 +16754,14 @@ "stability": "stable" } }, - "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", - "docId": "security-api-has-privileges-profile", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile", + "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", "extDocId": "user-profile", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html", "name": "security.has_privileges_user_profile", "privileges": { "cluster": [ - "read_security" + "manage_user_profile" ] }, "request": { @@ -18189,9 +16800,8 @@ "stability": "stable" } }, - "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\n\nTo use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.\nThe `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.\nThe `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.\nThe `manage_own_api_key` only allows deleting REST API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user's identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", - "docId": "security-api-invalidate-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key", + "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "name": "security.invalidate_api_key", "privileges": { "cluster": [ @@ -18234,9 +16844,8 @@ "stability": "stable" } }, - "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours.\nThey can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.\n\nNOTE: While all parameters are optional, at least one of them is required.\nMore specifically, either one of `token` or `refresh_token` parameters is required.\nIf none of these two are specified, then `realm_name` and/or `username` need to be specified.", - "docId": "security-api-invalidate-token", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-token", + "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", "name": "security.invalidate_token", "request": { "name": "Request", @@ -18269,22 +16878,15 @@ "visibility": "public" } }, - "description": "Authenticate OpenID Connect.\n\nExchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", - "docId": "security-api-oidc-authenticate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-authenticate", + "description": "Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html", "name": "security.oidc_authenticate", - "request": { - "name": "Request", - "namespace": "security.oidc_authenticate" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.oidc_authenticate" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -18304,22 +16906,15 @@ "visibility": "public" } }, - "description": "Logout of OpenID Connect.\n\nInvalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.\n\nIf the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", - "docId": "security-api-oidc-logout", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-logout", + "description": "Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html", "name": "security.oidc_logout", - "request": { - "name": "Request", - "namespace": "security.oidc_logout" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.oidc_logout" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -18339,22 +16934,15 @@ "visibility": "public" } }, - "description": "Prepare OpenID connect authentication.\n\nCreate an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.\n\nThe response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", - "docId": "security-api-oidc-prepare", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-prepare-authentication", + "description": "Creates an OAuth 2.0 authentication request as a URL string", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html", "name": "security.oidc_prepare_authentication", - "request": { - "name": "Request", - "namespace": "security.oidc_prepare_authentication" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.oidc_prepare_authentication" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -18378,17 +16966,11 @@ "stability": "stable" } }, - "description": "Create or update application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.", - "docId": "security-api-put-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges", + "description": "Create or update application privileges.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.put_privileges", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.put_privileges" @@ -18425,10 +17007,9 @@ } }, "description": "Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", - "docId": "security-api-put-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", "extDocId": "defining-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html", "name": "security.put_role", "privileges": { "cluster": [ @@ -18471,17 +17052,11 @@ "stability": "stable" } }, - "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names.", - "docId": "security-api-put-role-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping", + "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", "extDocId": "mapping-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.put_role_mapping", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.put_role_mapping" @@ -18513,15 +17088,9 @@ "stability": "stable" } }, - "description": "Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API.", - "docId": "security-api-put-user", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user", + "description": "Create or update users.\n\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", "name": "security.put_user", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.put_user" @@ -18558,9 +17127,8 @@ "stability": "stable" } }, - "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information.\nYou can optionally filter the results with a query.\n\nTo use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.\nIf you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", - "docId": "security-api-query-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys", + "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", "name": "security.query_api_keys", "privileges": { "cluster": [ @@ -18597,16 +17165,15 @@ "availability": { "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" }, "stack": { "since": "8.15.0", "stability": "stable" } }, - "description": "Find roles with a query.\n\nGet roles in a paginated manner.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe query roles API does not retrieve roles that are defined in roles files, nor built-in ones.\nYou can optionally filter the results with a query.\nAlso, the results can be paginated and sorted.", - "docId": "security-api-query-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role", + "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html", "name": "security.query_role", "privileges": { "cluster": [ @@ -18649,9 +17216,8 @@ "stability": "stable" } }, - "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.\n\nNOTE: As opposed to the get user API, built-in users are excluded from the result.\nThis API is only for native users.", - "docId": "security-api-query-user", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-user", + "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html", "name": "security.query_user", "privileges": { "cluster": [ @@ -18694,11 +17260,8 @@ "stability": "stable" } }, - "description": "Authenticate SAML.\n\nSubmit a SAML response message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML message that is submitted can be:\n\n* A response to a SAML authentication request that was previously created using the SAML prepare authentication API.\n* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.\n\nIn either case, the SAML message needs to be a base64 encoded XML document with a root element of ``.\n\nAfter successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\nThis API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.", - "docId": "security-api-saml-authenticate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate", - "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "description": "Authenticate SAML.\n\nSubmits a SAML response message to Elasticsearch for consumption.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", "name": "security.saml_authenticate", "request": { "name": "Request", @@ -18735,11 +17298,8 @@ "stability": "stable" } }, - "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.\nThis API verifies the response by ensuring the content is relevant and validating its signature.\nAn empty response is returned if the verification process is successful.\nThe response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.\nThe caller of this API must prepare the request accordingly so that this API can handle either of them.", - "docId": "security-api-saml-complete-logout", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout", - "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", "name": "security.saml_complete_logout", "request": { "name": "Request", @@ -18776,11 +17336,8 @@ "stability": "stable" } }, - "description": "Invalidate SAML.\n\nSubmit a SAML LogoutRequest message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe logout request comes from the SAML IdP during an IdP initiated Single Logout.\nThe custom web application can use this API to have Elasticsearch process the `LogoutRequest`.\nAfter successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.\nThus the user can be redirected back to their IdP.", - "docId": "security-api-saml-invalidate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate", - "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "description": "Invalidate SAML.\n\nSubmits a SAML LogoutRequest message to Elasticsearch for consumption.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "name": "security.saml_invalidate", "request": { "name": "Request", @@ -18817,11 +17374,8 @@ "stability": "stable" } }, - "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API invalidates the tokens that were generated for a user by the SAML authenticate API.\nIf the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).", - "docId": "security-api-saml-logout", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout", - "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", "name": "security.saml_logout", "request": { "name": "Request", @@ -18858,11 +17412,8 @@ "stability": "stable" } }, - "description": "Prepare SAML authentication.\n\nCreate a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API returns a URL pointing to the SAML Identity Provider.\nYou can use the URL to redirect the browser of the user in order to continue the authentication process.\nThe URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.\nIf the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.\nThese parameters contain the algorithm used for the signature and the signature value itself.\nIt also returns a random string that uniquely identifies this SAML Authentication request.\nThe caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.", - "docId": "security-api-saml-prepare-authentication", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication", - "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "description": "Prepare SAML authentication.\n\nCreates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "name": "security.saml_prepare_authentication", "request": { "name": "Request", @@ -18899,9 +17450,8 @@ "stability": "stable" } }, - "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.\n\nThe SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.\nThis API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.", - "docId": "security-api-saml-sp-metadata", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-service-provider-metadata", + "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", "name": "security.saml_service_provider_metadata", "request": { "name": "Request", @@ -18938,15 +17488,9 @@ "stability": "stable" } }, - "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", - "docId": "security-api-suggest", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-suggest-user-profiles", + "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", "name": "security.suggest_user_profiles", - "privileges": { - "cluster": [ - "read_security" - ] - }, "request": { "name": "Request", "namespace": "security.suggest_user_profiles" @@ -18983,9 +17527,8 @@ "stability": "stable" } }, - "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.", - "docId": "security-api-update-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key", + "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", "name": "security.update_api_key", "privileges": { "cluster": [ @@ -19022,17 +17565,11 @@ "stability": "stable" } }, - "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.", - "docId": "security-api-cross-cluster-key-update", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key", + "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html", "extDocId": "remote-clusters-api-key", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html", "name": "security.update_cross_cluster_api_key", - "privileges": { - "cluster": [ - "manage_security" - ] - }, "request": { "name": "Request", "namespace": "security.update_cross_cluster_api_key" @@ -19064,27 +17601,15 @@ "visibility": "public" } }, - "description": "Update security index settings.\n\nUpdate the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.\n\nNOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.\n\nIf a specific index is not in use on the system and settings are provided for it, the request will be rejected.\nThis API does not yet support configuring the settings for indices before they are in use.", - "docId": "security-api-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings", + "description": "Update settings for the security system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html", "name": "security.update_settings", - "privileges": { - "cluster": [ - "manage_security" - ] - }, - "request": { - "name": "Request", - "namespace": "security.update_settings" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "security.update_settings" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -19108,9 +17633,8 @@ "stability": "stable" } }, - "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.", - "docId": "security-api-update-user-data", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data", + "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", "name": "security.update_user_profile_data", "privileges": { "cluster": [ @@ -19149,15 +17673,9 @@ "stability": "stable" } }, - "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", - "docId": "nodes-api-shutdown-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-delete-node", + "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.delete_node", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "shutdown.delete_node" @@ -19189,15 +17707,9 @@ "stability": "stable" } }, - "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", - "docId": "nodes-api-shutdown-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node", + "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.get_node", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "shutdown.get_node" @@ -19235,15 +17747,9 @@ "stability": "stable" } }, - "description": "Prepare a node to be shut down.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", - "docId": "nodes-api-shutdown", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node", + "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current", "name": "shutdown.put_node", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "shutdown.put_node" @@ -19271,33 +17777,19 @@ { "availability": { "stack": { - "since": "8.12.0", "stability": "experimental", "visibility": "public" } }, - "description": "Simulate data ingestion.\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.", - "docId": "simulate-ingest-api", - "docTag": "ingest", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest", + "description": "Simulates running ingest with example documents.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-ingest-api.html", "name": "simulate.ingest", - "privileges": { - "index": [ - "index" - ] - }, - "request": { - "name": "Request", - "namespace": "simulate.ingest" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "simulate.ingest" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -19329,15 +17821,9 @@ "stability": "stable" } }, - "description": "Delete a policy.\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", - "docId": "slm-api-delete-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle", + "description": "Deletes an existing snapshot lifecycle policy.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html", "name": "slm.delete_lifecycle", - "privileges": { - "cluster": [ - "manage_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.delete_lifecycle" @@ -19370,15 +17856,9 @@ "stability": "stable" } }, - "description": "Run a policy.\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", - "docId": "slm-api-execute-lifecycle", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle", + "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html", "name": "slm.execute_lifecycle", - "privileges": { - "cluster": [ - "manage_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.execute_lifecycle" @@ -19411,15 +17891,9 @@ "stability": "stable" } }, - "description": "Run a retention policy.\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", - "docId": "slm-api-execute-retention", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention", + "description": "Deletes any snapshots that are expired according to the policy's retention rules.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html", "name": "slm.execute_retention", - "privileges": { - "cluster": [ - "manage_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.execute_retention" @@ -19452,15 +17926,9 @@ "stability": "stable" } }, - "description": "Get policy information.\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.", - "docId": "slm-api-get-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle", + "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html", "name": "slm.get_lifecycle", - "privileges": { - "cluster": [ - "manage_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.get_lifecycle" @@ -19499,15 +17967,9 @@ "stability": "stable" } }, - "description": "Get snapshot lifecycle management statistics.\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.", - "docId": "slm-api-get-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats", + "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-get-stats.html", "name": "slm.get_stats", - "privileges": { - "cluster": [ - "manage_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.get_stats" @@ -19540,15 +18002,9 @@ "stability": "stable" } }, - "description": "Get the snapshot lifecycle management status.", - "docId": "slm-api-get-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status", + "description": "Retrieves the status of snapshot lifecycle management (SLM).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html", "name": "slm.get_status", - "privileges": { - "cluster": [ - "read_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.get_status" @@ -19581,18 +18037,9 @@ "stability": "stable" } }, - "description": "Create or update a policy.\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.", - "docId": "slm-api-put-policy", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle", + "description": "Creates or updates a snapshot lifecycle policy.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html", "name": "slm.put_lifecycle", - "privileges": { - "cluster": [ - "manage_slm" - ], - "index": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "slm.put_lifecycle" @@ -19628,15 +18075,9 @@ "stability": "stable" } }, - "description": "Start snapshot lifecycle management.\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", - "docId": "slm-api-start", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start", + "description": "Turns on snapshot lifecycle management (SLM).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html", "name": "slm.start", - "privileges": { - "cluster": [ - "manage_slm" - ] - }, "request": { "name": "Request", "namespace": "slm.start" @@ -19669,9 +18110,8 @@ "stability": "stable" } }, - "description": "Stop snapshot lifecycle management.\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.", - "docId": "slm-api-stop", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop", + "description": "Turns off snapshot lifecycle management (SLM).", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html", "name": "slm.stop", "request": { "name": "Request", @@ -19705,17 +18145,9 @@ "stability": "stable" } }, - "description": "Clean up the snapshot repository.\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", - "docId": "snapshot-repo-cleanup", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository", - "extDocId": "clean-up-snapshot-repo", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-cleanup", + "description": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clean-up-snapshot-repo-api.html", "name": "snapshot.cleanup_repository", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.cleanup_repository" @@ -19748,15 +18180,9 @@ "stability": "stable" } }, - "description": "Clone a snapshot.\nClone part of all of a snapshot into another snapshot in the same repository.", - "docId": "snapshot-clone", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone", + "description": "Clones indices from one snapshot into another snapshot in the same repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.clone", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.clone" @@ -19792,17 +18218,9 @@ "stability": "stable" } }, - "description": "Create a snapshot.\nTake a snapshot of a cluster or of data streams and indices.", - "docId": "snapshot-create-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create", - "extDocId": "snapshot-create", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html", + "description": "Creates a snapshot in a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.create", - "privileges": { - "cluster": [ - "create_snapshot" - ] - }, "request": { "name": "Request", "namespace": "snapshot.create" @@ -19839,17 +18257,9 @@ "stability": "stable" } }, - "description": "Create or update a snapshot repository.\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.", - "docId": "snapshot-repo-create", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository", - "extDocId": "register-repository", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html", + "description": "Creates a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.create_repository", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.create_repository" @@ -19885,15 +18295,9 @@ "stability": "stable" } }, - "description": "Delete snapshots.", - "docId": "snapshot-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete", + "description": "Deletes one or more snapshots.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.delete" @@ -19926,15 +18330,9 @@ "stability": "stable" } }, - "description": "Delete snapshot repositories.\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", - "docId": "snapshot-repo-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete-repository", + "description": "Deletes a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.delete_repository", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.delete_repository" @@ -19967,15 +18365,9 @@ "stability": "stable" } }, - "description": "Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration.", - "docId": "snapshot-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get", + "description": "Returns information about a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get", - "privileges": { - "cluster": [ - "monitor_snapshot" - ] - }, "request": { "name": "Request", "namespace": "snapshot.get" @@ -20008,15 +18400,9 @@ "stability": "stable" } }, - "description": "Get snapshot repository information.", - "docId": "snapshot-repo-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get-repository", + "description": "Returns information about a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.get_repository", - "privileges": { - "cluster": [ - "monitor_snapshot" - ] - }, "request": { "name": "Request", "namespace": "snapshot.get_repository" @@ -20047,29 +18433,16 @@ { "availability": { "stack": { - "since": "7.12.0", "stability": "stable", "visibility": "public" } }, - "description": "Analyze a snapshot repository.\nAnalyze the performance characteristics and any incorrect behaviour found in a repository.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nIf successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes.", - "docId": "analyze-repository", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze", + "description": "Analyzes a repository for correctness and performance", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.repository_analyze", - "privileges": { - "cluster": [ - "manage" - ] - }, - "request": { - "name": "Request", - "namespace": "snapshot.repository_analyze" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "snapshot.repository_analyze" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -20090,15 +18463,9 @@ "visibility": "private" } }, - "description": "Verify the repository integrity.\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.", - "docId": "snapshot-repo-verify-integrity", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-verify-integrity", + "description": "Verifies the integrity of the contents of a snapshot repository", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.repository_verify_integrity", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.repository_verify_integrity" @@ -20131,17 +18498,9 @@ "stability": "stable" } }, - "description": "Restore a snapshot.\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", - "docId": "snapshot-restore-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-restore", - "extDocId": "restore-snapshot", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-restore-snapshot.html", + "description": "Restores a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.restore", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.restore" @@ -20177,15 +18536,9 @@ "stability": "stable" } }, - "description": "Get the snapshot status.\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", - "docId": "snapshot-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-status", + "description": "Returns information about the status of a snapshot.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.status", - "privileges": { - "cluster": [ - "monitor_snapshot" - ] - }, "request": { "name": "Request", "namespace": "snapshot.status" @@ -20230,17 +18583,9 @@ "stability": "stable" } }, - "description": "Verify a snapshot repository.\nCheck for common misconfigurations in a snapshot repository.", - "docId": "snapshot-repo-verify", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository", - "extDocId": "verify-repository", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-verification", + "description": "Verifies a repository.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html", "name": "snapshot.verify_repository", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "snapshot.verify_repository" @@ -20274,8 +18619,7 @@ } }, "description": "Clear an SQL search cursor.", - "docId": "sql-clear-cursor-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", "name": "sql.clear_cursor", "request": { "name": "Request", @@ -20312,15 +18656,9 @@ "stability": "stable" } }, - "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", - "docId": "sql-delete-async-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async", + "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", "name": "sql.delete_async", - "privileges": { - "cluster": [ - "cancel_task" - ] - }, "request": { "name": "Request", "namespace": "sql.delete_async" @@ -20353,9 +18691,8 @@ "stability": "stable" } }, - "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", - "docId": "sql-async-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async", + "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", "name": "sql.get_async", "request": { "name": "Request", @@ -20390,14 +18727,8 @@ } }, "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", - "docId": "sql-async-status-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", "name": "sql.get_async_status", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "sql.get_async_status" @@ -20431,14 +18762,8 @@ } }, "description": "Get SQL search results.\nRun an SQL request.", - "docId": "sql-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", "name": "sql.query", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "sql.query" @@ -20475,15 +18800,9 @@ "stability": "stable" } }, - "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.", - "docId": "sql-translate-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate", + "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", "name": "sql.translate", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "sql.translate" @@ -20521,17 +18840,9 @@ } }, "description": "Get SSL certificates.\n\nGet information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.", - "docId": "security-api-ssl", "docTag": "security", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ssl-certificates", - "extDocId": "security-encrypt-internode", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup.html#encrypt-internode-communication", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html", "name": "ssl.certificates", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "ssl.certificates" @@ -20564,15 +18875,9 @@ "stability": "stable" } }, - "description": "Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.", - "docId": "synonym-set-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym", + "description": "Delete a synonym set.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html", "name": "synonyms.delete_synonym", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.delete_synonym" @@ -20606,14 +18911,8 @@ } }, "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", - "docId": "synonym-rule-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html", "name": "synonyms.delete_synonym_rule", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.delete_synonym_rule" @@ -20650,14 +18949,8 @@ } }, "description": "Get a synonym set.", - "docId": "synonym-set-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html", "name": "synonyms.get_synonym", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.get_synonym" @@ -20691,14 +18984,8 @@ } }, "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", - "docId": "synonym-rule-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html", "name": "synonyms.get_synonym_rule", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.get_synonym_rule" @@ -20735,14 +19022,8 @@ } }, "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", - "docId": "synonym-set-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html", "name": "synonyms.get_synonyms_sets", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.get_synonyms_sets" @@ -20775,15 +19056,9 @@ "stability": "stable" } }, - "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", - "docId": "synonym-set-create", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html", "name": "synonyms.put_synonym", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.put_synonym" @@ -20819,15 +19094,9 @@ "stability": "stable" } }, - "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.", - "docId": "synonym-rule-create", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule", + "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html", "name": "synonyms.put_synonym_rule", - "privileges": { - "cluster": [ - "manage_search_synonyms" - ] - }, "request": { "name": "Request", "namespace": "synonyms.put_synonym_rule" @@ -20863,15 +19132,10 @@ "stability": "experimental" } }, - "description": "Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.", + "description": "Cancels a task, if it can be cancelled through an API.", "docId": "tasks", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.cancel", - "privileges": { - "cluster": [ - "manage" - ] - }, "request": { "name": "Request", "namespace": "tasks.cancel" @@ -20910,15 +19174,10 @@ "stability": "experimental" } }, - "description": "Get task information.\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.", + "description": "Get task information.\nReturns information about the tasks currently executing in the cluster.", "docId": "tasks", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.get", - "privileges": { - "cluster": [ - "monitor" - ] - }, "request": { "name": "Request", "namespace": "tasks.get" @@ -20951,13 +19210,14 @@ "stability": "experimental" } }, - "description": "Get all tasks.\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n \"tasks\" : {\n \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 45,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1513823752749,\n \"running_time_in_nanos\" : 293139,\n \"cancellable\" : false,\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n },\n \"children\" : [\n {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 46,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1513823752750,\n \"running_time_in_nanos\" : 92133,\n \"cancellable\" : false,\n \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n }\n }\n ]\n }\n }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.", + "description": "The task management API returns information about tasks currently executing on one or more nodes in the cluster.", "docId": "tasks", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", "name": "tasks.list", "privileges": { "cluster": [ - "monitor" + "monitor", + "manage" ] }, "request": { @@ -20992,10 +19252,9 @@ "stability": "stable" } }, - "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", - "docId": "search-terms-enum", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "name": "terms_enum", "request": { "name": "Request", @@ -21032,16 +19291,10 @@ "stability": "stable" } }, - "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.", - "docId": "docs-termvectors", + "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "name": "termvectors", - "privileges": { - "index": [ - "read" - ] - }, "request": { "name": "Request", "namespace": "_global.termvectors" @@ -21081,24 +19334,12 @@ "visibility": "public" } }, - "description": "Find the structure of a text field.\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", - "docId": "find-field-structure", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure", + "description": "Finds the structure of a text field in an index.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html", "name": "text_structure.find_field_structure", - "privileges": { - "cluster": [ - "monitor_text_structure" - ] - }, - "request": { - "name": "Request", - "namespace": "text_structure.find_field_structure" - }, + "request": null, "requestBodyRequired": false, - "response": { - "name": "Response", - "namespace": "text_structure.find_field_structure" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -21118,27 +19359,15 @@ "visibility": "public" } }, - "description": "Find the structure of text messages.\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", - "docId": "find-message-structure", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure", + "description": "Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html", "name": "text_structure.find_message_structure", - "privileges": { - "cluster": [ - "monitor_text_structure" - ] - }, - "request": { - "name": "Request", - "namespace": "text_structure.find_message_structure" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "text_structure.find_message_structure" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -21163,15 +19392,9 @@ "stability": "stable" } }, - "description": "Find the structure of a text file.\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.", - "docId": "find-structure", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure", + "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html", "name": "text_structure.find_structure", - "privileges": { - "cluster": [ - "monitor_text_structure" - ] - }, "request": { "name": "Request", "namespace": "text_structure.find_structure" @@ -21207,11 +19430,8 @@ "stability": "stable" } }, - "description": "Test a Grok pattern.\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.", - "docId": "test-grok-pattern", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern", - "extDocId": "grok", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok.html", + "description": "Tests a Grok pattern on some text.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html", "name": "text_structure.test_grok_pattern", "request": { "name": "Request", @@ -21249,9 +19469,8 @@ "stability": "stable" } }, - "description": "Delete a transform.", - "docId": "delete-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform", + "description": "Delete a transform.\nDeletes a transform.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html", "name": "transform.delete_transform", "privileges": { "cluster": [ @@ -21315,9 +19534,8 @@ "stability": "stable" } }, - "description": "Get transforms.\nGet configuration information for transforms.", - "docId": "get-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform", + "description": "Get transforms.\nRetrieves configuration information for transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html", "name": "transform.get_transform", "privileges": { "cluster": [ @@ -21362,9 +19580,8 @@ "stability": "stable" } }, - "description": "Get transform stats.\n\nGet usage information for transforms.", - "docId": "get-transform-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats", + "description": "Get transform stats.\nRetrieves usage information for transforms.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html", "name": "transform.get_transform_stats", "privileges": { "cluster": [ @@ -21408,8 +19625,7 @@ } }, "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", - "docId": "preview-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html", "name": "transform.preview_transform", "privileges": { "cluster": [ @@ -21464,8 +19680,7 @@ } }, "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", - "docId": "put-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html", "name": "transform.put_transform", "privileges": { "cluster": [ @@ -21513,9 +19728,8 @@ "stability": "stable" } }, - "description": "Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", - "docId": "reset-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform", + "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html", "name": "transform.reset_transform", "privileges": { "cluster": [ @@ -21554,9 +19768,8 @@ "stability": "stable" } }, - "description": "Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", - "docId": "schedule-now-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform", + "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html", "name": "transform.schedule_now_transform", "privileges": { "cluster": [ @@ -21598,9 +19811,8 @@ "stability": "stable" } }, - "description": "Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", - "docId": "start-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform", + "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html", "name": "transform.start_transform", "privileges": { "cluster": [ @@ -21644,8 +19856,7 @@ } }, "description": "Stop transforms.\nStops one or more transforms.", - "docId": "stop-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html", "name": "transform.stop_transform", "privileges": { "cluster": [ @@ -21685,8 +19896,7 @@ } }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", - "docId": "update-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html", "name": "transform.update_transform", "privileges": { "cluster": [ @@ -21733,9 +19943,8 @@ "stability": "stable" } }, - "description": "Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", - "docId": "upgrade-transforms", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms", + "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html", "name": "transform.upgrade_transforms", "privileges": { "cluster": [ @@ -21776,16 +19985,10 @@ "stability": "stable" } }, - "description": "Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).", - "docId": "docs-update", + "description": "Update a document.\nUpdates a document by running a script or passing a partial document.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "name": "update", - "privileges": { - "index": [ - "write" - ] - }, "request": { "name": "Request", "namespace": "_global.update" @@ -21821,17 +20024,10 @@ "stability": "stable" } }, - "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\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* `index` 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.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\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 update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update 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 turn off 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\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\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.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating 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 point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\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* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Update the document source**\n\nUpdate by query supports scripts to update the document source.\nAs with the update API, you can set `ctx.op` to change the operation that is performed.\n\nSet `ctx.op = \"noop\"` if your script decides that it doesn't have to make any changes.\nThe update by query operation skips updating the document and increments the `noop` counter.\n\nSet `ctx.op = \"delete\"` if your script decides that the document should be deleted.\nThe update by query operation deletes the document and increments the `deleted` counter.\n\nUpdate by query supports only `index`, `noop`, and `delete`.\nSetting `ctx.op` to anything else is an error.\nSetting any other field in `ctx` is an error.\nThis API enables you to only modify the source of matching documents; you cannot move them.", - "docId": "docs-update-by-query", + "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "name": "update_by_query", - "privileges": { - "index": [ - "read", - "write" - ] - }, "request": { "name": "Request", "namespace": "_global.update_by_query" @@ -21868,9 +20064,8 @@ } }, "description": "Throttle an update by query operation.\n\nChange the number of requests per second for a particular update by query operation.\nRethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.", - "docId": "docs-update-by-query-rethrottle", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html", "name": "update_by_query_rethrottle", "request": { "name": "Request", @@ -21899,15 +20094,9 @@ "stability": "stable" } }, - "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", - "docId": "watcher-api-ack-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch", + "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html", "name": "watcher.ack_watch", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.ack_watch" @@ -21943,17 +20132,9 @@ "stability": "stable" } }, - "description": "Activate a watch.\nA watch can be either active or inactive.", - "docId": "watcher-api-activate-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch", - "extDocId": "watcher-works", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html", + "description": "Activates a currently inactive watch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html", "name": "watcher.activate_watch", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.activate_watch" @@ -21982,17 +20163,9 @@ "stability": "stable" } }, - "description": "Deactivate a watch.\nA watch can be either active or inactive.", - "docId": "watcher-api-deactivate-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch", - "extDocId": "watcher-works", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html", + "description": "Deactivates a currently active watch.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html", "name": "watcher.deactivate_watch", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.deactivate_watch" @@ -22021,15 +20194,9 @@ "stability": "stable" } }, - "description": "Delete a watch.\nWhen the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.\n\nDeleting a watch does not delete any watch execution records related to this watch from the watch history.\n\nIMPORTANT: Deleting a watch must be done by using only this API.\nDo not delete the watch directly from the `.watches` index using the Elasticsearch delete document API\nWhen Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.", - "docId": "watcher-api-delete-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch", + "description": "Removes a watch from Watcher.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html", "name": "watcher.delete_watch", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.delete_watch" @@ -22057,9 +20224,8 @@ "stability": "stable" } }, - "description": "Run a watch.\nThis API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\n\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs.\nYou can run the watch without running all of its actions or alternatively by simulating them.\nYou can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.\n\nYou can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.\nThis serves as great tool for testing and debugging your watches prior to adding them to Watcher.\n\nWhen Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.\nIf your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.\n\nWhen using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.", - "docId": "watcher-api-execute-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch", + "description": "This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs. You can execute the watch without executing all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after execution.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html", "name": "watcher.execute_watch", "privileges": { "cluster": [ @@ -22105,22 +20271,15 @@ "visibility": "public" } }, - "description": "Get Watcher index settings.\nGet settings for the Watcher internal index (`.watches`).\nOnly a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.", - "docId": "watcher-api-get-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings", + "description": "Retrieve settings for the watcher system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html", "name": "watcher.get_settings", - "request": { - "name": "Request", - "namespace": "watcher.get_settings" - }, + "request": null, "requestBodyRequired": false, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "watcher.get_settings" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -22140,15 +20299,9 @@ "stability": "stable" } }, - "description": "Get a watch.", - "docId": "watcher-api-get-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch", + "description": "Retrieves a watch by its ID.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html", "name": "watcher.get_watch", - "privileges": { - "cluster": [ - "monitor_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.get_watch" @@ -22176,15 +20329,9 @@ "stability": "stable" } }, - "description": "Create or update a watch.\nWhen a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine.\nTypically for the `schedule` trigger, the scheduler is the trigger engine.\n\nIMPORTANT: You must use Kibana or this API to create a watch.\nDo not add a watch directly to the `.watches` index by using the Elasticsearch index API.\nIf Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.\n\nWhen you add a watch you can also define its initial active state by setting the *active* parameter.\n\nWhen Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.\nIf the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.", - "docId": "watcher-api-put-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch", + "description": "Creates a new watch, or updates an existing one.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html", "name": "watcher.put_watch", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.put_watch" @@ -22217,15 +20364,9 @@ "stability": "stable" } }, - "description": "Query watches.\nGet all registered watches in a paginated manner and optionally filter watches by a query.\n\nNote that only the `_id` and `metadata.*` fields are queryable or sortable.", - "docId": "watcher-api-query-watches", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches", + "description": "Retrieves stored watches.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html", "name": "watcher.query_watches", - "privileges": { - "cluster": [ - "monitor_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.query_watches" @@ -22257,15 +20398,9 @@ "stability": "stable" } }, - "description": "Start the watch service.\nStart the Watcher service if it is not already running.", - "docId": "watcher-api-start", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start", + "description": "Starts Watcher if it is not already running.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html", "name": "watcher.start", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.start" @@ -22294,15 +20429,9 @@ "stability": "stable" } }, - "description": "Get Watcher statistics.\nThis API always returns basic metrics.\nYou retrieve more metrics by using the metric parameter.", - "docId": "watcher-api-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats", + "description": "Retrieves the current Watcher metrics.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html", "name": "watcher.stats", - "privileges": { - "cluster": [ - "monitor_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.stats" @@ -22336,15 +20465,9 @@ "stability": "stable" } }, - "description": "Stop the watch service.\nStop the Watcher service if it is running.", - "docId": "watcher-api-stop", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop", + "description": "Stops Watcher if it is running.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html", "name": "watcher.stop", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, "request": { "name": "Request", "namespace": "watcher.stop" @@ -22373,27 +20496,15 @@ "visibility": "public" } }, - "description": "Update Watcher index settings.\nUpdate settings for the Watcher internal index (`.watches`).\nOnly a subset of settings can be modified.\nThis includes `index.auto_expand_replicas` and `index.number_of_replicas`.", - "docId": "watcher-api-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings", + "description": "Update settings for the watcher system index", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html", "name": "watcher.update_settings", - "privileges": { - "cluster": [ - "manage_watcher" - ] - }, - "request": { - "name": "Request", - "namespace": "watcher.update_settings" - }, + "request": null, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": { - "name": "Response", - "namespace": "watcher.update_settings" - }, + "response": null, "responseMediaType": [ "application/json" ], @@ -22416,13 +20527,13 @@ "stability": "stable" } }, - "description": "Get information.\nThe information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", - "docId": "info-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info", + "description": "Provides general information about the installed X-Pack features.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html", "name": "xpack.info", "privileges": { "cluster": [ - "monitor" + "monitor", + "manage" ] }, "request": { @@ -22456,13 +20567,13 @@ "stability": "stable" } }, - "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", - "docId": "usage-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack", + "description": "This API provides information about which features are currently enabled and available under the current license and some usage statistics.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html", "name": "xpack.usage", "privileges": { "cluster": [ - "monitor" + "monitor", + "manage" ] }, "request": { @@ -22501,7 +20612,7 @@ "namespace": "_global.bulk" }, "properties": [], - "specLocation": "_global/bulk/types.ts#L132-L132" + "specLocation": "_global/bulk/types.ts#L130-L130" }, { "kind": "interface", @@ -22516,7 +20627,7 @@ "namespace": "_global.bulk" }, "properties": [], - "specLocation": "_global/bulk/types.ts#L136-L136" + "specLocation": "_global/bulk/types.ts#L134-L134" }, { "kind": "interface", @@ -22531,7 +20642,7 @@ "namespace": "_global.bulk" }, "properties": [], - "specLocation": "_global/bulk/types.ts#L134-L134" + "specLocation": "_global/bulk/types.ts#L132-L132" }, { "kind": "interface", @@ -22553,7 +20664,7 @@ } }, { - "description": "The name of the index or index alias to perform the action on.", + "description": "Name of the index or index alias to perform the action on.", "name": "_index", "required": false, "type": { @@ -22565,7 +20676,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -22621,7 +20732,7 @@ } } ], - "specLocation": "_global/bulk/types.ts#L92-L109" + "specLocation": "_global/bulk/types.ts#L90-L107" }, { "kind": "interface", @@ -22631,7 +20742,7 @@ }, "properties": [ { - "description": "Index the specified document.\nIf the document exists, it replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", + "description": "Indexes the specified document.\nIf the document exists, replaces the document and increments the version.\nThe following line must contain the source data to be indexed.", "name": "index", "required": false, "type": { @@ -22643,7 +20754,7 @@ } }, { - "description": "Index the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", + "description": "Indexes the specified document if it does not already exist.\nThe following line must contain the source data to be indexed.", "name": "create", "required": false, "type": { @@ -22655,7 +20766,7 @@ } }, { - "description": "Perform a partial document update.\nThe following line must contain the partial document and update options.", + "description": "Performs a partial document update.\nThe following line must contain the partial document and update options.", "name": "update", "required": false, "type": { @@ -22667,7 +20778,7 @@ } }, { - "description": "Remove the specified document from the index.", + "description": "Removes the specified document from the index.", "name": "delete", "required": false, "type": { @@ -22679,7 +20790,7 @@ } } ], - "specLocation": "_global/bulk/types.ts#L150-L172", + "specLocation": "_global/bulk/types.ts#L145-L167", "variants": { "kind": "container" } @@ -22704,7 +20815,7 @@ "name": "OperationType", "namespace": "_global.bulk" }, - "specLocation": "_global/bulk/types.ts#L85-L90" + "specLocation": "_global/bulk/types.ts#L83-L88" }, { "kind": "request", @@ -22760,7 +20871,7 @@ } } }, - "description": "Bulk index or delete documents.\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* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\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**Wait for active shards**\n\nWhen making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.\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.", + "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "generics": [ { "name": "TDocument", @@ -22783,7 +20894,7 @@ }, "path": [ { - "description": "The name of the data stream, index, or index alias to perform bulk actions on.", + "description": "Name of the data stream, index, or index alias to perform bulk actions on.", "name": "index", "required": false, "type": { @@ -22797,7 +20908,7 @@ ], "query": [ { - "description": "If `true`, the response will include the ingest pipelines that were run for each index or create.", + "description": "If `true`, the response will include the ingest pipelines that were executed for each index or create.", "name": "list_executed_pipelines", "required": false, "serverDefault": false, @@ -22810,7 +20921,7 @@ } }, { - "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.", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { @@ -22822,7 +20933,7 @@ } }, { - "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`.", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "serverDefault": "false", @@ -22835,7 +20946,7 @@ } }, { - "description": "A custom value that is used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -22847,7 +20958,7 @@ } }, { - "description": "Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return.", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -22859,7 +20970,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to exclude from the response.", "name": "_source_excludes", "required": false, "type": { @@ -22871,7 +20982,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -22883,7 +20994,7 @@ } }, { - "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.", + "description": "Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -22896,7 +21007,7 @@ } }, { - "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.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -22909,7 +21020,7 @@ } }, { - "description": "If `true`, the request's actions must target an index alias.", + "description": "If `true`, the request’s actions must target an index alias.", "name": "require_alias", "required": false, "serverDefault": false, @@ -22922,7 +21033,7 @@ } }, { - "description": "If `true`, the request's actions must target a data stream (existing or to be created).", + "description": "If `true`, the request's actions must target a data stream (existing or to-be-created).", "name": "require_data_stream", "required": false, "serverDefault": false, @@ -22935,7 +21046,7 @@ } } ], - "specLocation": "_global/bulk/BulkRequest.ts#L32-L242" + "specLocation": "_global/bulk/BulkRequest.ts#L32-L115" }, { "kind": "response", @@ -22943,7 +21054,6 @@ "kind": "properties", "properties": [ { - "description": "If `true`, one or more of the operations in the bulk request did not complete successfully.", "name": "errors", "required": true, "type": { @@ -22955,7 +21065,6 @@ } }, { - "description": "The result of each operation in the bulk request, in the order they were submitted.", "name": "items", "required": true, "type": { @@ -22981,7 +21090,6 @@ } }, { - "description": "The length of time, in milliseconds, it took to process the bulk request.", "name": "took", "required": true, "type": { @@ -23009,7 +21117,7 @@ "name": "Response", "namespace": "_global.bulk" }, - "specLocation": "_global/bulk/BulkResponse.ts#L24-L45" + "specLocation": "_global/bulk/BulkResponse.ts#L24-L31" }, { "kind": "interface", @@ -23043,7 +21151,7 @@ } }, { - "description": "The name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.", + "description": "Name of the index associated with the operation.\nIf the operation targeted a data stream, this is the backing index into which the document was written.", "name": "_index", "required": true, "type": { @@ -23055,7 +21163,7 @@ } }, { - "description": "The HTTP status code returned for the operation.", + "description": "HTTP status code returned for the operation.", "name": "status", "required": true, "type": { @@ -23067,7 +21175,7 @@ } }, { - "description": "Additional information about the failed operation.\nThe property is returned only for failed operations.", + "description": "Contains additional information about the failed operation.\nThe parameter is only returned for failed operations.", "name": "error", "required": false, "type": { @@ -23079,7 +21187,7 @@ } }, { - "description": "The primary term assigned to the document for the operation.\nThis property is returned only for successful operations.", + "description": "The primary term assigned to the document for the operation.", "name": "_primary_term", "required": false, "type": { @@ -23091,7 +21199,7 @@ } }, { - "description": "The result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", + "description": "Result of the operation.\nSuccessful values are `created`, `deleted`, and `updated`.", "name": "result", "required": false, "type": { @@ -23103,7 +21211,7 @@ } }, { - "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", + "description": "The sequence number assigned to the document for the operation.\nSequence numbers are used to ensure an older version of a document doesn’t overwrite a newer version.", "name": "_seq_no", "required": false, "type": { @@ -23115,7 +21223,7 @@ } }, { - "description": "Shard information for the operation.", + "description": "Contains shard information for the operation.", "name": "_shards", "required": false, "type": { @@ -23127,7 +21235,7 @@ } }, { - "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.\nThis property is returned only for successful actions.", + "description": "The document version associated with the operation.\nThe document version is incremented each time the document is updated.", "name": "_version", "required": false, "type": { @@ -23177,7 +21285,7 @@ } } ], - "specLocation": "_global/bulk/types.ts#L37-L83" + "specLocation": "_global/bulk/types.ts#L37-L81" }, { "kind": "interface", @@ -23197,7 +21305,7 @@ }, "properties": [ { - "description": "If true, the `result` in the response is set to 'noop' when no changes to the document occur.", + "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", "name": "detect_noop", "required": false, "serverDefault": true, @@ -23222,7 +21330,7 @@ } }, { - "description": "Set to `true` to use the contents of `doc` as the value of `upsert`.", + "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", "name": "doc_as_upsert", "required": false, "serverDefault": false, @@ -23235,7 +21343,7 @@ } }, { - "description": "The script to run to update the document.", + "description": "Script to execute to update the document.", "name": "script", "required": false, "type": { @@ -23247,7 +21355,7 @@ } }, { - "description": "Set to `true` to run the script whether or not the document exists.", + "description": "Set to true to execute the script whether or not the document exists.", "name": "scripted_upsert", "required": false, "serverDefault": false, @@ -23260,7 +21368,7 @@ } }, { - "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", "name": "_source", "required": false, "serverDefault": "true", @@ -23273,7 +21381,7 @@ } }, { - "description": "If the document does not already exist, the contents of `upsert` are inserted as a new document.\nIf the document exists, the `script` is run.", + "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", "name": "upsert", "required": false, "type": { @@ -23285,7 +21393,7 @@ } } ], - "specLocation": "_global/bulk/types.ts#L174-L209" + "specLocation": "_global/bulk/types.ts#L169-L205" }, { "kind": "interface", @@ -23301,7 +21409,7 @@ }, "properties": [ { - "description": "If `true`, the request's actions must target an index alias.", + "description": "If `true`, the request’s actions must target an index alias.", "name": "require_alias", "required": false, "serverDefault": false, @@ -23314,7 +21422,6 @@ } }, { - "description": "The number of times an update should be retried in the case of a version conflict.", "name": "retry_on_conflict", "required": false, "type": { @@ -23326,7 +21433,7 @@ } } ], - "specLocation": "_global/bulk/types.ts#L138-L148" + "specLocation": "_global/bulk/types.ts#L136-L143" }, { "kind": "interface", @@ -23342,7 +21449,7 @@ }, "properties": [ { - "description": "A map from the full name of fields to the name of dynamic templates.\nIt defaults to an empty map.\nIf a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won't be used.", + "description": "A map from the full name of fields to the name of dynamic templates.\nDefaults to an empty map.\nIf a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.\nIf a field is already defined in the mapping, then this parameter won’t be used.", "name": "dynamic_templates", "required": false, "type": { @@ -23365,7 +21472,7 @@ } }, { - "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.", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { @@ -23377,7 +21484,7 @@ } }, { - "description": "If `true`, the request's actions must target an index alias.", + "description": "If `true`, the request’s actions must target an index alias.", "name": "require_alias", "required": false, "serverDefault": false, @@ -23390,7 +21497,7 @@ } } ], - "specLocation": "_global/bulk/types.ts#L111-L130" + "specLocation": "_global/bulk/types.ts#L109-L128" }, { "kind": "request", @@ -23401,7 +21508,7 @@ "kind": "properties", "properties": [ { - "description": "The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", + "description": "Scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", "name": "scroll_id", "required": false, "type": { @@ -23414,7 +21521,7 @@ } ] }, - "description": "Clear a scrolling search.\nClear the search context and results for a scrolling search.", + "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search.", "inherits": { "type": { "name": "RequestBase", @@ -23427,11 +21534,7 @@ }, "path": [ { - "deprecation": { - "description": "", - "version": "7.0.0" - }, - "description": "A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.", + "description": "Comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", "name": "scroll_id", "required": false, "type": { @@ -23444,7 +21547,7 @@ } ], "query": [], - "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L61" + "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L48" }, { "kind": "response", @@ -23452,7 +21555,6 @@ "kind": "properties", "properties": [ { - "description": "If `true`, the request succeeded.\nThis does not indicate whether any scrolling search requests were cleared.", "name": "succeeded", "required": true, "type": { @@ -23464,7 +21566,6 @@ } }, { - "description": "The number of scrolling search requests cleared.", "name": "num_freed", "required": true, "type": { @@ -23515,7 +21616,7 @@ "name": "Response", "namespace": "_global.clear_scroll" }, - "specLocation": "_global/clear_scroll/ClearScrollResponse.ts#L22-L43" + "specLocation": "_global/clear_scroll/ClearScrollResponse.ts#L22-L36" }, { "kind": "request", @@ -23539,7 +21640,7 @@ } ] }, - "description": "Close a point in time.\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", + "description": "Close a point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "inherits": { "type": { "name": "RequestBase", @@ -23552,7 +21653,7 @@ }, "path": [], "query": [], - "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L48" + "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L43" }, { "kind": "response", @@ -23560,7 +21661,6 @@ "kind": "properties", "properties": [ { - "description": "If `true`, all search contexts associated with the point-in-time ID were successfully closed.", "name": "succeeded", "required": true, "type": { @@ -23572,7 +21672,6 @@ } }, { - "description": "The number of search contexts that were successfully closed.", "name": "num_freed", "required": true, "type": { @@ -23623,7 +21722,7 @@ "name": "Response", "namespace": "_global.close_point_in_time" }, - "specLocation": "_global/close_point_in_time/ClosePointInTimeResponse.ts#L22-L42" + "specLocation": "_global/close_point_in_time/ClosePointInTimeResponse.ts#L22-L36" }, { "kind": "request", @@ -23634,7 +21733,7 @@ "kind": "properties", "properties": [ { - "description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.", + "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { @@ -23647,7 +21746,7 @@ } ] }, - "description": "Count search results.\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.", + "description": "Count search results.\nGet the number of documents matching a query.", "inherits": { "type": { "name": "RequestBase", @@ -23660,7 +21759,7 @@ }, "path": [ { - "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`.", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": false, "type": { @@ -23674,7 +21773,7 @@ ], "query": [ { - "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", "name": "allow_no_indices", "required": false, "serverDefault": true, @@ -23687,7 +21786,7 @@ } }, { - "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyzer", "required": false, "type": { @@ -23699,7 +21798,7 @@ } }, { - "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyze_wildcard", "required": false, "serverDefault": false, @@ -23712,10 +21811,9 @@ } }, { - "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.", + "description": "The default operator for query string query: `AND` or `OR`.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "default_operator", "required": false, - "serverDefault": "OR", "type": { "kind": "instance_of", "type": { @@ -23725,7 +21823,7 @@ } }, { - "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.", + "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "df", "required": false, "type": { @@ -23737,7 +21835,7 @@ } }, { - "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`.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -23750,11 +21848,7 @@ } }, { - "deprecation": { - "description": "", - "version": "7.16.0" - }, - "description": "If `true`, concrete, expanded, or aliased indices are ignored when frozen.", + "description": "If `true`, concrete, expanded or aliased indices are ignored when frozen.", "name": "ignore_throttled", "required": false, "serverDefault": true, @@ -23780,7 +21874,7 @@ } }, { - "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.", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, @@ -23793,7 +21887,7 @@ } }, { - "description": "The minimum `_score` value that documents must have to be included in the result.", + "description": "Sets the minimum `_score` value that documents must have to be included in the result.", "name": "min_score", "required": false, "type": { @@ -23805,7 +21899,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nBy default, it is random.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -23817,7 +21911,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -23829,7 +21923,7 @@ } }, { - "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.", + "description": "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.", "name": "terminate_after", "required": false, "type": { @@ -23841,7 +21935,7 @@ } }, { - "description": "The query in Lucene query string syntax. This parameter cannot be used with a request body.", + "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { @@ -23853,7 +21947,7 @@ } } ], - "specLocation": "_global/count/CountRequest.ts#L26-L154" + "specLocation": "_global/count/CountRequest.ts#L26-L123" }, { "kind": "response", @@ -23906,7 +22000,7 @@ } } }, - "description": "Create a new document in the index.\n\nYou can index a new JSON document with the `//_doc/` or `//_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 `//_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 //_create/<_id>` or `POST //_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.", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", @@ -23925,7 +22019,7 @@ }, "path": [ { - "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST //_doc/` request format.", + "description": "Unique identifier for the document.", "name": "id", "required": true, "type": { @@ -23937,7 +22031,7 @@ } }, { - "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.", + "description": "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.", "name": "index", "required": true, "type": { @@ -23951,7 +22045,7 @@ ], "query": [ { - "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.", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { @@ -23963,7 +22057,7 @@ } }, { - "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.", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "serverDefault": "false", @@ -23976,7 +22070,7 @@ } }, { - "description": "A custom value that is used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -23988,7 +22082,7 @@ } }, { - "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.", + "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -24001,7 +22095,7 @@ } }, { - "description": "The explicit version number for concurrency control.\nIt must be a non-negative long number.", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -24013,7 +22107,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -24025,7 +22119,7 @@ } }, { - "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.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -24038,7 +22132,7 @@ } } ], - "specLocation": "_global/create/CreateRequest.ts#L32-L184" + "specLocation": "_global/create/CreateRequest.ts#L32-L96" }, { "kind": "response", @@ -24066,7 +22160,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", + "description": "Delete a document.\nRemoves a JSON document from the specified index.", "inherits": { "type": { "name": "RequestBase", @@ -24079,7 +22173,7 @@ }, "path": [ { - "description": "A unique identifier for the document.", + "description": "Unique identifier for the document.", "name": "id", "required": true, "type": { @@ -24091,7 +22185,7 @@ } }, { - "description": "The name of the target index.", + "description": "Name of the target index.", "name": "index", "required": true, "type": { @@ -24106,8 +22200,6 @@ "query": [ { "description": "Only perform the operation if the document has this primary term.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", "name": "if_primary_term", "required": false, "type": { @@ -24120,8 +22212,6 @@ }, { "description": "Only perform the operation if the document has this sequence number.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", "name": "if_seq_no", "required": false, "type": { @@ -24133,7 +22223,7 @@ } }, { - "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.", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, "serverDefault": "false", @@ -24146,7 +22236,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -24158,7 +22248,7 @@ } }, { - "description": "The period to wait for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", + "description": "Period to wait for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -24171,7 +22261,7 @@ } }, { - "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -24183,7 +22273,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -24195,7 +22285,7 @@ } }, { - "description": "The minimum number of shard copies that must be active before proceeding with the operation.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -24208,7 +22298,7 @@ } } ], - "specLocation": "_global/delete/DeleteRequest.ts#L34-L146" + "specLocation": "_global/delete/DeleteRequest.ts#L34-L93" }, { "kind": "response", @@ -24279,7 +22369,7 @@ } }, { - "description": "The documents to delete specified with Query DSL.", + "description": "Specifies the documents to delete using the Query DSL.", "name": "query", "required": false, "type": { @@ -24304,7 +22394,7 @@ } ] }, - "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.", + "description": "Delete documents.\nDeletes documents that match the specified query.", "inherits": { "type": { "name": "RequestBase", @@ -24317,7 +22407,7 @@ }, "path": [ { - "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`.", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": true, "type": { @@ -24344,7 +22434,7 @@ } }, { - "description": "Analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "Analyzer to use for the query string.", "name": "analyzer", "required": false, "type": { @@ -24356,7 +22446,7 @@ } }, { - "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "If `true`, wildcard and prefix queries are analyzed.", "name": "analyze_wildcard", "required": false, "serverDefault": false, @@ -24382,7 +22472,7 @@ } }, { - "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.", + "description": "The default operator for query string query: `AND` or `OR`.", "name": "default_operator", "required": false, "serverDefault": "OR", @@ -24395,7 +22485,7 @@ } }, { - "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.", + "description": "Field to use as default where no field prefix is given in the query string.", "name": "df", "required": false, "type": { @@ -24407,7 +22497,7 @@ } }, { - "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`.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -24445,7 +22535,7 @@ } }, { - "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.", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, @@ -24458,7 +22548,7 @@ } }, { - "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.", + "description": "Maximum number of documents to process.\nDefaults to all documents.", "name": "max_docs", "required": false, "type": { @@ -24470,7 +22560,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -24482,7 +22572,7 @@ } }, { - "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`.", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, "serverDefault": false, @@ -24510,7 +22600,6 @@ "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, - "serverDefault": -1, "type": { "kind": "instance_of", "type": { @@ -24520,7 +22609,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -24532,7 +22621,7 @@ } }, { - "description": "A query in the Lucene query string syntax.", + "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { @@ -24544,9 +22633,7 @@ } }, { - "description": "The period to retain the search context for scrolling.", - "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "description": "Period to retain the search context for scrolling.", "name": "scroll", "required": false, "type": { @@ -24558,7 +22645,7 @@ } }, { - "description": "The size of the scroll request that powers the operation.", + "description": "Size of the scroll request that powers the operation.", "name": "scroll_size", "required": false, "serverDefault": 1000, @@ -24571,7 +22658,7 @@ } }, { - "description": "The explicit timeout for each search request.\nIt defaults to no timeout.", + "description": "Explicit timeout for each search request.\nDefaults to no timeout.", "name": "search_timeout", "required": false, "type": { @@ -24583,7 +22670,7 @@ } }, { - "description": "The type of the search operation.\nAvailable options include `query_then_fetch` and `dfs_query_then_fetch`.", + "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", "name": "search_type", "required": false, "type": { @@ -24608,7 +22695,7 @@ } }, { - "description": "A comma-separated list of `:` pairs.", + "description": "A comma-separated list of : pairs.", "name": "sort", "required": false, "type": { @@ -24623,7 +22710,7 @@ } }, { - "description": "The specific `tag` of the request for logging and statistical purposes.", + "description": "Specific `tag` of the request for logging and statistical purposes.", "name": "stats", "required": false, "type": { @@ -24638,7 +22725,7 @@ } }, { - "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.", + "description": "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.\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.", "name": "terminate_after", "required": false, "type": { @@ -24650,7 +22737,7 @@ } }, { - "description": "The period each deletion request waits for active shards.", + "description": "Period each deletion request waits for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -24675,7 +22762,7 @@ } }, { - "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.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -24688,7 +22775,7 @@ } }, { - "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.", + "description": "If `true`, the request blocks until the operation is complete.", "name": "wait_for_completion", "required": false, "serverDefault": true, @@ -24701,7 +22788,7 @@ } } ], - "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L310" + "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L211" }, { "kind": "response", @@ -24709,7 +22796,6 @@ "kind": "properties", "properties": [ { - "description": "The number of scroll responses pulled back by the delete by query.", "name": "batches", "required": false, "type": { @@ -24721,7 +22807,6 @@ } }, { - "description": "The number of documents that were successfully deleted.", "name": "deleted", "required": false, "type": { @@ -24733,7 +22818,6 @@ } }, { - "description": "An array of failures if there were any unrecoverable errors during the process.\nIf this array is not empty, the request ended abnormally because of those failures.\nDelete by query is implemented using batches and any failures cause the entire process to end but all failures in the current batch are collected into the array.\nYou can use the `conflicts` option to prevent reindex from ending on version conflicts.", "name": "failures", "required": false, "type": { @@ -24748,7 +22832,6 @@ } }, { - "description": "This field is always equal to zero for delete by query.\nIt exists only so that delete by query, update by query, and reindex APIs return responses with the same structure.", "name": "noops", "required": false, "type": { @@ -24760,7 +22843,6 @@ } }, { - "description": "The number of requests per second effectively run during the delete by query.", "name": "requests_per_second", "required": false, "type": { @@ -24772,7 +22854,6 @@ } }, { - "description": "The number of retries attempted by delete by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.", "name": "retries", "required": false, "type": { @@ -24817,7 +22898,6 @@ } }, { - "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", "name": "throttled_millis", "required": false, "type": { @@ -24849,7 +22929,6 @@ } }, { - "description": "This field should always be equal to zero in a `_delete_by_query` response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.", "name": "throttled_until_millis", "required": false, "type": { @@ -24870,7 +22949,6 @@ } }, { - "description": "If `true`, some requests run during the delete by query operation timed out.", "name": "timed_out", "required": false, "type": { @@ -24882,7 +22960,6 @@ } }, { - "description": "The number of milliseconds from start to end of the whole operation.", "name": "took", "required": false, "type": { @@ -24903,7 +22980,6 @@ } }, { - "description": "The number of documents that were successfully processed.", "name": "total", "required": false, "type": { @@ -24915,7 +22991,6 @@ } }, { - "description": "The number of version conflicts that the delete by query hit.", "name": "version_conflicts", "required": false, "type": { @@ -24932,7 +23007,7 @@ "name": "Response", "namespace": "_global.delete_by_query" }, - "specLocation": "_global/delete_by_query/DeleteByQueryResponse.ts#L26-L88" + "specLocation": "_global/delete_by_query/DeleteByQueryResponse.ts#L26-L45" }, { "kind": "request", @@ -24969,7 +23044,7 @@ ], "query": [ { - "description": "The throttle for this request in sub-requests per second.\nTo disable throttling, set it to `-1`.", + "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "type": { @@ -24981,7 +23056,7 @@ } } ], - "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L55" + "specLocation": "_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts#L24-L47" }, { "kind": "response", @@ -25022,7 +23097,7 @@ }, "path": [ { - "description": "The identifier for the stored script or search template.", + "description": "Identifier for the stored script or search template.", "name": "id", "required": true, "type": { @@ -25036,7 +23111,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -25049,7 +23124,7 @@ } }, { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -25062,7 +23137,7 @@ } } ], - "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L63" + "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L53" }, { "kind": "response", @@ -25090,7 +23165,7 @@ "body": { "kind": "no_body" }, - "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", + "description": "Check a document.\nChecks if a specified document exists.", "inherits": { "type": { "name": "RequestBase", @@ -25103,7 +23178,7 @@ }, "path": [ { - "description": "A unique document identifier.", + "description": "Identifier of the document.", "name": "id", "required": true, "type": { @@ -25115,7 +23190,7 @@ } }, { - "description": "A comma-separated list of data streams, indices, and aliases.\nIt supports wildcards (`*`).", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "name": "index", "required": true, "type": { @@ -25129,7 +23204,7 @@ ], "query": [ { - "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -25143,7 +23218,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, @@ -25156,7 +23231,7 @@ } }, { - "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, "serverDefault": false, @@ -25169,9 +23244,9 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", - "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "description": "Target the specified primary shard.", + "docId": "routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { @@ -25183,7 +23258,7 @@ } }, { - "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -25195,7 +23270,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { @@ -25207,7 +23282,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -25219,7 +23294,7 @@ } }, { - "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.", + "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to false.", "name": "stored_fields", "required": false, "type": { @@ -25243,7 +23318,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -25255,7 +23330,7 @@ } } ], - "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L136" + "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L101" }, { "kind": "response", @@ -25276,7 +23351,7 @@ "body": { "kind": "no_body" }, - "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", + "description": "Check for a document source.\nChecks if a document's `_source` is stored.", "inherits": { "type": { "name": "RequestBase", @@ -25289,7 +23364,7 @@ }, "path": [ { - "description": "A unique identifier for the document.", + "description": "Identifier of the document.", "name": "id", "required": true, "type": { @@ -25301,7 +23376,7 @@ } }, { - "description": "A comma-separated list of data streams, indices, and aliases.\nIt supports wildcards (`*`).", + "description": "Comma-separated list of data streams, indices, and aliases.\nSupports wildcards (`*`).", "name": "index", "required": true, "type": { @@ -25315,7 +23390,7 @@ ], "query": [ { - "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -25327,9 +23402,9 @@ } }, { - "description": "If `true`, the request is real-time as opposed to near-real-time.", - "extDocId": "realtime", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "description": "If true, the request is real-time as opposed to near-real-time.", + "docId": "realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, @@ -25342,7 +23417,7 @@ } }, { - "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "description": "If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes.", "name": "refresh", "required": false, "serverDefault": false, @@ -25355,9 +23430,9 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", - "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "description": "Target the specified primary shard.", + "docId": "routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { @@ -25369,7 +23444,7 @@ } }, { - "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "description": "`true` or `false` to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -25405,7 +23480,7 @@ } }, { - "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -25417,7 +23492,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -25429,7 +23504,7 @@ } } ], - "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L113" + "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L95" }, { "kind": "response", @@ -25556,7 +23631,7 @@ } ] }, - "description": "Explain a document match result.\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document.", + "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", "inherits": { "type": { "name": "RequestBase", @@ -25569,7 +23644,7 @@ }, "path": [ { - "description": "The document identifier.", + "description": "Defines the document ID.", "name": "id", "required": true, "type": { @@ -25581,7 +23656,7 @@ } }, { - "description": "Index names that are used to limit the request.\nOnly a single index name can be provided to this parameter.", + "description": "Index names used to limit the request.\nOnly a single index name can be provided to this parameter.", "name": "index", "required": true, "type": { @@ -25595,7 +23670,7 @@ ], "query": [ { - "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "analyzer", "required": false, "type": { @@ -25607,7 +23682,7 @@ } }, { - "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "If `true`, wildcard and prefix queries are analyzed.", "name": "analyze_wildcard", "required": false, "serverDefault": false, @@ -25620,7 +23695,7 @@ } }, { - "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.", + "description": "The default operator for query string query: `AND` or `OR`.", "name": "default_operator", "required": false, "serverDefault": "OR", @@ -25633,7 +23708,7 @@ } }, { - "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.", + "description": "Field to use as default where no field prefix is given in the query string.", "name": "df", "required": false, "type": { @@ -25645,7 +23720,7 @@ } }, { - "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.", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, @@ -25658,7 +23733,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -25670,7 +23745,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -25682,7 +23757,7 @@ } }, { - "description": "`True` or `false` to return the `_source` field or not or a list of fields to return.", + "description": "True or false to return the `_source` field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -25694,7 +23769,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to exclude from the response.", "name": "_source_excludes", "required": false, "type": { @@ -25706,7 +23781,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -25730,7 +23805,7 @@ } }, { - "description": "The query in the Lucene query string syntax.", + "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { @@ -25742,7 +23817,7 @@ } } ], - "specLocation": "_global/explain/ExplainRequest.ts#L26-L125" + "specLocation": "_global/explain/ExplainRequest.ts#L26-L107" }, { "kind": "response", @@ -25920,7 +23995,7 @@ { "description": "Whether this field is registered as a metadata field.", "docId": "mapping-metadata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html", "name": "metadata_field", "required": false, "type": { @@ -26039,7 +24114,7 @@ "since": "8.5.0" } }, - "description": "A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "description": "List of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "name": "fields", "required": false, "type": { @@ -26051,7 +24126,7 @@ } }, { - "description": "Filter indices if the provided query rewrites to `match_none` on every shard.\n\nIMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request.\nFor instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range.\nHowever, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document.", + "description": "Allows to filter indices if the provided query rewrites to match_none on every shard.", "name": "index_filter", "required": false, "type": { @@ -26069,9 +24144,9 @@ "since": "7.12.0" } }, - "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", + "description": "Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", "docId": "runtime-search-request", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/runtime-search-request.html", "name": "runtime_mappings", "required": false, "type": { @@ -26097,7 +24172,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.", "name": "index", "required": false, "type": { @@ -26124,7 +24199,7 @@ } }, { - "description": "The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", + "description": "Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -26137,7 +24212,7 @@ } }, { - "description": "A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", + "description": "Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported.", "name": "fields", "required": false, "type": { @@ -26181,7 +24256,7 @@ "since": "8.2.0" } }, - "description": "A comma-separated list of filters to apply to the response.", + "description": "An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent", "name": "filters", "required": false, "type": { @@ -26199,7 +24274,7 @@ "since": "8.2.0" } }, - "description": "A comma-separated list of field types to include.\nAny fields that do not match one of these types will be excluded from the results.\nIt defaults to empty, meaning that all field types are returned.", + "description": "Only return results for fields that have one of the types in the list", "name": "types", "required": false, "type": { @@ -26233,7 +24308,7 @@ } } ], - "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L130" + "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L111" }, { "kind": "response", @@ -26241,7 +24316,6 @@ "kind": "properties", "properties": [ { - "description": "The list of indices where this field has the same type family, or null if all indices have the same type family for the field.", "name": "indices", "required": true, "type": { @@ -26291,7 +24365,7 @@ "name": "Response", "namespace": "_global.field_caps" }, - "specLocation": "_global/field_caps/FieldCapabilitiesResponse.ts#L24-L38" + "specLocation": "_global/field_caps/FieldCapabilitiesResponse.ts#L24-L35" }, { "kind": "interface", @@ -26307,7 +24381,6 @@ }, "properties": [ { - "description": "The name of the index the document belongs to.", "name": "_index", "required": true, "type": { @@ -26319,7 +24392,6 @@ } }, { - "description": "If the `stored_fields` parameter is set to `true` and `found` is `true`, it contains the document fields stored in the index.", "name": "fields", "required": false, "type": { @@ -26352,7 +24424,6 @@ } }, { - "description": "Indicates whether the document exists.", "name": "found", "required": true, "type": { @@ -26364,7 +24435,6 @@ } }, { - "description": "The unique identifier for the document.", "name": "_id", "required": true, "type": { @@ -26376,8 +24446,6 @@ } }, { - "description": "The primary term assigned to the document for the indexing operation.", - "extDocId": "optimistic_concurrency", "name": "_primary_term", "required": false, "type": { @@ -26389,7 +24457,6 @@ } }, { - "description": "The explicit routing, if set.", "name": "_routing", "required": false, "type": { @@ -26401,8 +24468,6 @@ } }, { - "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", - "extDocId": "optimistic_concurrency", "name": "_seq_no", "required": false, "type": { @@ -26414,7 +24479,6 @@ } }, { - "description": "If `found` is `true`, it contains the document data formatted in JSON.\nIf the `_source` parameter is set to `false` or the `stored_fields` parameter is set to `true`, it is excluded.", "name": "_source", "required": false, "type": { @@ -26426,7 +24490,6 @@ } }, { - "description": "The document version, which is ncremented each time the document is updated.", "name": "_version", "required": false, "type": { @@ -26438,7 +24501,7 @@ } } ], - "specLocation": "_global/get/types.ts#L25-L67" + "specLocation": "_global/get/types.ts#L25-L36" }, { "kind": "request", @@ -26448,7 +24511,7 @@ "body": { "kind": "no_body" }, - "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", + "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", "inherits": { "type": { "name": "RequestBase", @@ -26461,7 +24524,7 @@ }, "path": [ { - "description": "A unique document identifier.", + "description": "Unique identifier of the document.", "name": "id", "required": true, "type": { @@ -26473,7 +24536,7 @@ } }, { - "description": "The name of the index that contains the document.", + "description": "Name of the index that contains the document.", "name": "index", "required": true, "type": { @@ -26494,7 +24557,7 @@ "visibility": "feature_flag" } }, - "description": "Indicates whether the request forces synthetic `_source`.\nUse this paramater to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance.\nFetches with this parameter enabled will be slower than enabling synthetic source natively in the index.", + "description": "Should this request force synthetic _source?\nUse this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.\nFetches with this enabled will be slower the enabling synthetic source natively in the index.", "name": "force_synthetic_source", "required": false, "type": { @@ -26506,7 +24569,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.\n\nIf it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible.\nIf it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.\nThis can help with \"jumping values\" when hitting different shards in different refresh states.\nA sample value can be something like the web session ID or the user name.", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", "required": false, "type": { @@ -26520,7 +24583,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, @@ -26533,7 +24596,7 @@ } }, { - "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": false, @@ -26546,9 +24609,9 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", - "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "description": "Target the specified primary shard.", + "docId": "routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { @@ -26560,7 +24623,7 @@ } }, { - "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "description": "True or false to return the _source field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -26572,7 +24635,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to exclude in the response.", "name": "_source_excludes", "required": false, "type": { @@ -26584,7 +24647,7 @@ } }, { - "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.", + "description": "A comma-separated list of source fields to include in the response.", "name": "_source_includes", "required": false, "type": { @@ -26596,7 +24659,7 @@ } }, { - "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nOnly leaf fields can be retrieved with the `stored_field` option.\nObject fields can't be returned;​if specified, the request fails.", + "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to false.", "name": "stored_fields", "required": false, "type": { @@ -26608,7 +24671,7 @@ } }, { - "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -26620,7 +24683,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: internal, external, external_gte.", "name": "version_type", "required": false, "type": { @@ -26632,7 +24695,7 @@ } } ], - "specLocation": "_global/get/GetRequest.ts#L31-L180" + "specLocation": "_global/get/GetRequest.ts#L31-L101" }, { "kind": "response", @@ -26726,7 +24789,7 @@ }, "path": [ { - "description": "The identifier for the stored script or search template.", + "description": "Identifier for the stored script or search template.", "name": "id", "required": true, "type": { @@ -26740,10 +24803,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, - "serverDefault": "", "type": { "kind": "instance_of", "type": { @@ -26753,7 +24815,7 @@ } } ], - "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L56" + "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L43" }, { "kind": "response", @@ -26935,7 +24997,7 @@ }, "path": [], "query": [], - "specLocation": "_global/get_script_context/GetScriptContextRequest.ts#L22-L39" + "specLocation": "_global/get_script_context/GetScriptContextRequest.ts#L22-L30" }, { "kind": "response", @@ -27020,7 +25082,7 @@ }, "path": [], "query": [], - "specLocation": "_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L39" + "specLocation": "_global/get_script_languages/GetScriptLanguagesRequest.ts#L22-L30" }, { "kind": "response", @@ -27071,7 +25133,7 @@ "body": { "kind": "no_body" }, - "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", + "description": "Get a document's source.\nReturns the source of a document.", "inherits": { "type": { "name": "RequestBase", @@ -27084,7 +25146,7 @@ }, "path": [ { - "description": "A unique document identifier.", + "description": "Unique identifier of the document.", "name": "id", "required": true, "type": { @@ -27096,7 +25158,7 @@ } }, { - "description": "The name of the index that contains the document.", + "description": "Name of the index that contains the document.", "name": "index", "required": true, "type": { @@ -27110,7 +25172,7 @@ ], "query": [ { - "description": "The node or shard the operation should be performed on.\nBy default, the operation is randomized between the shard replicas.", + "description": "Specifies the node or shard the operation should be performed on. Random by default.", "name": "preference", "required": false, "type": { @@ -27122,7 +25184,7 @@ } }, { - "description": "If `true`, the request is real-time as opposed to near-real-time.", + "description": "Boolean) If true, the request is real-time as opposed to near-real-time.", "docId": "realtiime", "name": "realtime", "required": false, @@ -27136,7 +25198,7 @@ } }, { - "description": "If `true`, the request refreshes the relevant shards before retrieving the document.\nSetting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).", + "description": "If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": false, @@ -27149,9 +25211,9 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", - "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "description": "Target the specified primary shard.", + "docId": "routing", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#get-routing", "name": "routing", "required": false, "type": { @@ -27163,7 +25225,7 @@ } }, { - "description": "Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.", + "description": "True or false to return the _source field or not, or a list of fields to return.", "name": "_source", "required": false, "type": { @@ -27199,7 +25261,6 @@ } }, { - "description": "A comma-separated list of stored fields to return as part of a hit.", "name": "stored_fields", "required": false, "type": { @@ -27211,7 +25272,7 @@ } }, { - "description": "The version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", + "description": "Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -27223,7 +25284,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: internal, external, external_gte.", "name": "version_type", "required": false, "type": { @@ -27235,7 +25296,7 @@ } } ], - "specLocation": "_global/get_source/SourceRequest.ts#L31-L116" + "specLocation": "_global/get_source/SourceRequest.ts#L31-L89" }, { "kind": "response", @@ -28352,7 +26413,7 @@ } } ], - "specLocation": "_global/health_report/Request.ts#L24-L81" + "specLocation": "_global/health_report/Request.ts#L24-L70" }, { "kind": "response", @@ -28813,7 +26874,7 @@ } } }, - "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\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 or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, 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\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\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**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**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.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", + "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", "generics": [ { "name": "TDocument", @@ -28832,7 +26893,7 @@ }, "path": [ { - "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter.", + "description": "Unique identifier for the document.", "name": "id", "required": false, "type": { @@ -28844,7 +26905,7 @@ } }, { - "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.\nYou can check for existing targets with the resolve index API.", + "description": "Name of the data stream or index to target.", "name": "index", "required": true, "type": { @@ -28859,8 +26920,6 @@ "query": [ { "description": "Only perform the operation if the document has this primary term.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", "name": "if_primary_term", "required": false, "type": { @@ -28873,8 +26932,6 @@ }, { "description": "Only perform the operation if the document has this sequence number.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", "name": "if_seq_no", "required": false, "type": { @@ -28886,7 +26943,7 @@ } }, { - "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", + "description": "Set to create to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nSame as using the `/_create` endpoint.\nValid values: `index`, `create`.\nIf document id is specified, it defaults to `index`.\nOtherwise, it defaults to `create`.", "name": "op_type", "required": false, "type": { @@ -28898,7 +26955,7 @@ } }, { - "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { @@ -28910,10 +26967,9 @@ } }, { - "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.", + "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes.\nValid values: `true`, `false`, `wait_for`.", "name": "refresh", "required": false, - "serverDefault": "false", "type": { "kind": "instance_of", "type": { @@ -28923,7 +26979,7 @@ } }, { - "description": "A custom value that is used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -28935,7 +26991,7 @@ } }, { - "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\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.", + "description": "Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -28948,7 +27004,7 @@ } }, { - "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", + "description": "Explicit version number for concurrency control.\nThe specified version must match the current version of the document for the request to succeed.", "name": "version", "required": false, "type": { @@ -28960,7 +27016,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type: `external`, `external_gte`.", "name": "version_type", "required": false, "type": { @@ -28972,7 +27028,7 @@ } }, { - "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.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -28998,7 +27054,7 @@ } } ], - "specLocation": "_global/index/IndexRequest.ts#L35-L263" + "specLocation": "_global/index/IndexRequest.ts#L35-L119" }, { "kind": "response", @@ -29026,7 +27082,7 @@ "body": { "kind": "no_body" }, - "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "description": "Get cluster info.\nReturns basic information about the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -29039,7 +27095,7 @@ }, "path": [], "query": [], - "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L39" + "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L29" }, { "kind": "response", @@ -29047,7 +27103,6 @@ "kind": "properties", "properties": [ { - "description": "The responding cluster's name.", "name": "cluster_name", "required": true, "type": { @@ -29070,7 +27125,6 @@ } }, { - "description": "The responding node's name.", "name": "name", "required": true, "type": { @@ -29093,7 +27147,6 @@ } }, { - "description": "The running version of Elasticsearch.", "name": "version", "required": true, "type": { @@ -29110,7 +27163,7 @@ "name": "Response", "namespace": "_global.info" }, - "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L40" + "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L31" }, { "kind": "request", @@ -29121,10 +27174,9 @@ "kind": "properties", "properties": [ { - "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the `hits._source` property of the search response.", + "description": "Indicates which source fields are returned for matching documents. These\nfields are returned in the hits._source property of the search response.", "name": "_source", "required": false, - "serverDefault": "true", "type": { "kind": "instance_of", "type": { @@ -29134,7 +27186,7 @@ } }, { - "description": "The request returns doc values for field names matching these patterns\nin the `hits.fields` property of the response.\nIt accepts wildcard (`*`) patterns.", + "description": "The request returns doc values for field names matching these patterns\nin the hits.fields property of the response. Accepts wildcard (*) patterns.", "name": "docvalue_fields", "required": false, "type": { @@ -29149,7 +27201,7 @@ } }, { - "description": "A 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.", + "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.", "name": "stored_fields", "required": false, "type": { @@ -29161,7 +27213,7 @@ } }, { - "description": "The request returns values for field names matching these patterns\nin the `hits.fields` property of the response.\nIt accepts wildcard (`*`) patterns.", + "description": "The request returns values for field names matching these patterns\nin the hits.fields property of the response. Accepts wildcard (*) patterns.", "name": "fields", "required": false, "type": { @@ -29179,7 +27231,7 @@ "since": "8.2.0" } }, - "description": "A query to filter the documents that can match. The kNN search will return the top\n`k` documents that also match this filter. The value can be a single query or a\nlist of queries. If `filter` isn't provided, all documents are allowed to match.", + "description": "Query to filter the documents that can match. The kNN search will return the top\n`k` documents that also match this filter. The value can be a single query or a\nlist of queries. If `filter` isn't provided, all documents are allowed to match.", "name": "filter", "required": false, "type": { @@ -29206,9 +27258,9 @@ } }, { - "description": "The kNN query to run.", + "description": "kNN query to execute", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", "name": "knn", "required": true, "type": { @@ -29225,7 +27277,7 @@ "description": "The kNN search API has been replaced by the `knn` option in the search API.", "version": "8.4.0" }, - "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.\n\nA kNN search response has the exact same structure as a search API response.\nHowever, certain sections have a meaning specific to kNN search:\n\n* The document `_score` is determined by the similarity between the query and document vector.\n* The `hits.total` object contains the total number of nearest neighbor candidates considered, which is `num_candidates * num_shards`. The `hits.total.relation` will always be `eq`, indicating an exact value.", + "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.", "inherits": { "type": { "name": "RequestBase", @@ -29238,7 +27290,7 @@ }, "path": [ { - "description": "A comma-separated list of index names to search;\nuse `_all` or to perform the operation on all indices.", + "description": "A comma-separated list of index names to search;\nuse `_all` or to perform the operation on all indices", "name": "index", "required": true, "type": { @@ -29252,7 +27304,7 @@ ], "query": [ { - "description": "A comma-separated list of specific routing values.", + "description": "A comma-separated list of specific routing values", "name": "routing", "required": false, "type": { @@ -29264,7 +27316,7 @@ } } ], - "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L112" + "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L96" }, { "kind": "response", @@ -29272,7 +27324,7 @@ "kind": "properties", "properties": [ { - "description": "The milliseconds it took Elasticsearch to run the request.", + "description": "Milliseconds it took Elasticsearch to execute the request.", "name": "took", "required": true, "type": { @@ -29296,7 +27348,7 @@ } }, { - "description": "A count of shards used for the request.", + "description": "Contains a count of shards used for the request.", "name": "_shards", "required": true, "type": { @@ -29308,7 +27360,7 @@ } }, { - "description": "The returned documents and metadata.", + "description": "Contains returned documents and metadata.", "name": "hits", "required": true, "type": { @@ -29329,7 +27381,7 @@ } }, { - "description": "The field values for the documents. These fields\nmust be specified in the request using the `fields` parameter.", + "description": "Contains field values for the documents. These fields\nmust be specified in the request using the `fields` parameter.", "name": "fields", "required": false, "type": { @@ -29348,7 +27400,7 @@ } }, { - "description": "The highest returned document score. This value is null for requests\nthat do not sort by score.", + "description": "Highest returned document score. This value is null for requests\nthat do not sort by score.", "name": "max_score", "required": false, "type": { @@ -29603,7 +27655,7 @@ } ] }, - "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", + "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.", "inherits": { "type": { "name": "RequestBase", @@ -29663,7 +27715,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, @@ -29715,7 +27767,7 @@ { "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.", "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html", "name": "_source_excludes", "required": false, "type": { @@ -29729,7 +27781,7 @@ { "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html", "name": "_source_includes", "required": false, "type": { @@ -29754,7 +27806,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L127" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "kind": "response", @@ -29762,7 +27814,6 @@ "kind": "properties", "properties": [ { - "description": "The response includes a docs array that contains the documents in the order specified in the request.\nThe structure of the returned documents is similar to that returned by the get API.\nIf there is a failure getting a particular document, the error is included in place of the document.", "name": "docs", "required": true, "type": { @@ -29797,7 +27848,7 @@ "name": "Response", "namespace": "_global.mget" }, - "specLocation": "_global/mget/MultiGetResponse.ts#L22-L31" + "specLocation": "_global/mget/MultiGetResponse.ts#L22-L26" }, { "kind": "type_alias", @@ -29949,7 +28000,7 @@ "aggs" ], "extDocId": "search-aggregations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations.html", "name": "aggregations", "required": false, "type": { @@ -30245,7 +28296,7 @@ }, { "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -30603,7 +28654,7 @@ { "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "docId": "ccs-network-delays", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -30753,7 +28804,7 @@ } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L135" + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L124" }, { "kind": "type_alias", @@ -30884,7 +28935,7 @@ } } }, - "description": "Run multiple templated searches.\n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", + "description": "Run multiple templated searches.", "inherits": { "type": { "name": "RequestBase", @@ -30897,7 +28948,7 @@ }, "path": [ { - "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 `*`.", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*`.", "name": "index", "required": false, "type": { @@ -30924,7 +28975,7 @@ } }, { - "description": "The maximum number of concurrent searches the API can run.", + "description": "Maximum number of concurrent searches the API can run.", "name": "max_concurrent_searches", "required": false, "type": { @@ -30936,7 +28987,7 @@ } }, { - "description": "The type of the search operation.", + "description": "The type of the search operation.\nAvailable options: `query_then_fetch`, `dfs_query_then_fetch`.", "name": "search_type", "required": false, "type": { @@ -30974,7 +29025,7 @@ } } ], - "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L116" + "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L72" }, { "kind": "type_alias", @@ -31038,7 +29089,7 @@ "name": "Response", "namespace": "_global.msearch_template" }, - "specLocation": "_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L31" + "specLocation": "_global/msearch_template/MultiSearchTemplateResponse.ts#L22-L24" }, { "kind": "interface", @@ -31061,7 +29112,7 @@ } }, { - "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", "name": "id", "required": false, "type": { @@ -31105,7 +29156,7 @@ } }, { - "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", "name": "source", "required": false, "type": { @@ -31295,7 +29346,7 @@ "kind": "properties", "properties": [ { - "description": "An array of existing or artificial documents.", + "description": "Array of existing or artificial documents.", "name": "docs", "required": false, "type": { @@ -31310,7 +29361,7 @@ } }, { - "description": "A simplified syntax to specify documents by their ID if they're in the same index.", + "description": "Simplified syntax to specify documents by their ID if they're in the same index.", "name": "ids", "required": false, "type": { @@ -31326,7 +29377,7 @@ } ] }, - "description": "Get multiple term vectors.\n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.", + "description": "Get multiple term vectors.\n\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.", "inherits": { "type": { "name": "RequestBase", @@ -31339,7 +29390,7 @@ }, "path": [ { - "description": "The name of the index that contains the documents.", + "description": "Name of the index that contains the documents.", "name": "index", "required": false, "type": { @@ -31368,7 +29419,7 @@ } }, { - "description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", "name": "fields", "required": false, "type": { @@ -31432,7 +29483,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -31446,7 +29497,7 @@ { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, @@ -31459,7 +29510,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -31496,7 +29547,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type.", "name": "version_type", "required": false, "type": { @@ -31508,7 +29559,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L134" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "kind": "response", @@ -31644,7 +29695,7 @@ "kind": "properties", "properties": [ { - "description": "Filter indices if the provided query rewrites to `match_none` on every shard.", + "description": "Allows to filter indices if the provided query rewrites to `match_none` on every shard.", "name": "index_filter", "required": false, "type": { @@ -31657,7 +29708,7 @@ } ] }, - "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API.", + "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.", "inherits": { "type": { "name": "RequestBase", @@ -31684,7 +29735,7 @@ ], "query": [ { - "description": "Extend the length of time that the point in time persists.", + "description": "Extends the time to live of the corresponding point in time.", "name": "keep_alive", "required": true, "type": { @@ -31709,7 +29760,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nBy default, it is random.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -31721,7 +29772,7 @@ } }, { - "description": "A custom value that is used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -31733,7 +29784,7 @@ } }, { - "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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -31746,7 +29797,7 @@ } }, { - "description": "Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.\nIf `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.\nIf `true`, the point in time will contain all the shards that are available at the time of the request.", + "description": "If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.\nIf `true`, the point in time will contain all the shards that are available at the time of the request.", "name": "allow_partial_search_results", "required": false, "serverDefault": false, @@ -31759,7 +29810,7 @@ } } ], - "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L121" + "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L87" }, { "kind": "response", @@ -31818,7 +29869,7 @@ }, "path": [], "query": [], - "specLocation": "_global/ping/PingRequest.ts#L22-L38" + "specLocation": "_global/ping/PingRequest.ts#L22-L30" }, { "kind": "response", @@ -31840,7 +29891,7 @@ "kind": "properties", "properties": [ { - "description": "The script or search template, its parameters, and its language.", + "description": "Contains the script or search template, its parameters, and its language.", "name": "script", "required": true, "type": { @@ -31866,7 +29917,7 @@ }, "path": [ { - "description": "The identifier for the stored script or search template.\nIt must be unique within the cluster.", + "description": "Identifier for the stored script or search template.\nMust be unique within the cluster.", "name": "id", "required": true, "type": { @@ -31878,7 +29929,7 @@ } }, { - "description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.", + "description": "Context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.", "name": "context", "required": false, "type": { @@ -31892,19 +29943,7 @@ ], "query": [ { - "description": "The context in which the script or search template should run.\nTo prevent errors, the API immediately compiles the script or template in this context.\nIf you specify both this and the `` path parameter, the API uses the request path parameter.", - "name": "context", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -31917,7 +29956,7 @@ } }, { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -31930,7 +29969,7 @@ } } ], - "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L87" + "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L66" }, { "kind": "response", @@ -32257,7 +30296,7 @@ "kind": "interface", "description": "Discounted cumulative gain (DCG)", "docId": "dcg", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_discounted_cumulative_gain_dcg", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg", "inherits": { "type": { "name": "RankEvalMetricBase", @@ -32290,7 +30329,7 @@ "kind": "interface", "description": "Expected Reciprocal Rank (ERR)", "docId": "expected-reciprocal", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_expected_reciprocal_rank_err", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err", "inherits": { "type": { "name": "RankEvalMetricBase", @@ -32321,7 +30360,7 @@ "kind": "interface", "description": "Mean Reciprocal Rank", "docId": "mean-reciprocal", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_mean_reciprocal_rank", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_mean_reciprocal_rank", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -32339,7 +30378,7 @@ "kind": "interface", "description": "Precision at K (P@k)", "docId": "k-precision", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-precision", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-precision", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -32400,7 +30439,7 @@ "kind": "interface", "description": "Recall at K (R@k)", "docId": "k-recall", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-recall", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-recall", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -32577,7 +30616,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams, indices, and index aliases used to limit the request.\nWildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", + "description": "Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.", "name": "index", "required": false, "type": { @@ -32641,7 +30680,7 @@ } } ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L76" + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L64" }, { "kind": "response", @@ -32761,7 +30800,7 @@ } }, { - "description": "If it is `create`, the operation will only index documents that do not already exist (also known as \"put if absent\").\n\nIMPORTANT: To reindex to a data stream destination, this argument must be `create`.", + "description": "Set to `create` to only index documents that do not already exist.\nImportant: To reindex to a data stream destination, this argument must be `create`.", "name": "op_type", "required": false, "serverDefault": "index", @@ -32786,7 +30825,7 @@ } }, { - "description": "By default, a document's routing is preserved unless it's changed by the script.\nIf it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.\nIf it is `discard`, the routing on the bulk request sent for each match is set to `null`.\nIf it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`).", + "description": "By default, a document's routing is preserved unless it’s changed by the script.\nSet to `discard` to set routing to `null`, or `=value` to route using the specified `value`.", "name": "routing", "required": false, "serverDefault": "keep", @@ -32811,7 +30850,7 @@ } } ], - "specLocation": "_global/reindex/types.ts#L39-L67" + "specLocation": "_global/reindex/types.ts#L39-L64" }, { "kind": "interface", @@ -32821,10 +30860,9 @@ }, "properties": [ { - "description": "The remote connection timeout.", + "description": "The remote connection timeout.\nDefaults to 30 seconds.", "name": "connect_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -32857,7 +30895,7 @@ } }, { - "description": "The URL for the remote instance of Elasticsearch that you want to index from.\nThis information is required when you're indexing from remote.", + "description": "The URL for the remote instance of Elasticsearch that you want to index from.", "name": "host", "required": true, "type": { @@ -32893,10 +30931,9 @@ } }, { - "description": "The remote socket read timeout.", + "description": "The remote socket read timeout. Defaults to 30 seconds.", "name": "socket_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -32906,7 +30943,7 @@ } } ], - "specLocation": "_global/reindex/types.ts#L112-L140" + "specLocation": "_global/reindex/types.ts#L99-L125" }, { "kind": "request", @@ -32917,7 +30954,7 @@ "kind": "properties", "properties": [ { - "description": "Indicates whether to continue reindexing even when there are conflicts.", + "description": "Set to proceed to continue reindexing even if there are conflicts.", "name": "conflicts", "required": false, "serverDefault": "abort", @@ -32942,7 +30979,7 @@ } }, { - "description": "The maximum number of documents to reindex.\nBy default, all documents are reindexed.\nIf it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.\n\nIf `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.", + "description": "The maximum number of documents to reindex.", "name": "max_docs", "required": false, "type": { @@ -32990,7 +31027,7 @@ } ] }, - "description": "Reindex documents.\n\nCopy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nNOTE: The reindex API makes no effort to handle ID collisions.\nThe last document written will \"win\" but the order isn't usually predictable so it is not a good idea to rely on this behavior.\nInstead, make sure that IDs are unique by using a script.\n\n**Running reindex asynchronously**\n\nIf the request contains `wait_for_completion=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.\nElasticsearch creates a record of this task as a document at `_tasks/`.\n\n**Reindex from multiple sources**\n\nIf you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources.\nThat way you can resume the process if there are any errors by removing the partially completed source and starting over.\nIt also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel.\n\nFor example, you can use a bash script like this:\n\n```\nfor index in i1 i2 i3 i4 i5; do\n curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{\n \"source\": {\n \"index\": \"'$index'\"\n },\n \"dest\": {\n \"index\": \"'$index'-reindexed\"\n }\n }'\ndone\n```\n\n**Throttling**\n\nSet `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations.\nRequests are throttled by padding each batch with a wait time.\nTo turn off throttling, set `requests_per_second` to `-1`.\n\nThe throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding.\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 then wait for a while before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nYou can slice a reindex request manually by providing a slice ID and total number of slices to each request.\nYou can also let reindex automatically parallelize by using sliced scroll to slice on `_id`.\nThe `slices` parameter specifies the number of slices to use.\n\nAdding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks API. 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 previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed.\n* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time.\n\nIf slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices.\nIf slicing manually or otherwise tuning automatic slicing, use the following guidelines.\n\nQuery performance is most efficient when the number of slices is equal to the number of shards in the index.\nIf that number is large (for example, `500`), choose a lower number as too many slices will hurt performance.\nSetting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n\nIndexing performance scales linearly across available resources with the number of slices.\n\nWhether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Modify documents during reindexing**\n\nLike `_update_by_query`, reindex operations support a script that modifies the document.\nUnlike `_update_by_query`, the script is allowed to modify the document's metadata.\n\nJust as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination.\nFor example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This \"no operation\" will be reported in the `noop` counter in the response body.\nSet `ctx.op` to `delete` if your script decides that the document must be deleted from the destination.\nThe deletion will be reported in the `deleted` counter in the response body.\nSetting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`.\n\nThink of the possibilities! Just be careful; you are able to change:\n\n* `_id`\n* `_index`\n* `_version`\n* `_routing`\n\nSetting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request.\nIt will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API.\n\n**Reindex from remote**\n\nReindex supports reindexing from a remote Elasticsearch cluster.\nThe `host` parameter must contain a scheme, host, port, and optional path.\nThe `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication.\nBe sure to use HTTPS when using basic authentication or the password will be sent in plain text.\nThere are a range of settings available to configure the behavior of the HTTPS connection.\n\nWhen using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key.\nRemote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting.\nIt can be set to a comma delimited list of allowed remote host and port combinations.\nScheme is ignored; only the host and port are used.\nFor example:\n\n```\nreindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*\"]\n```\n\nThe list of allowed hosts must be configured on any nodes that will coordinate the reindex.\nThis feature should work with remote clusters of any version of Elasticsearch.\nThis should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version.\n\nWARNING: Elasticsearch does not support forward compatibility across major versions.\nFor example, you cannot reindex from a 7.x cluster into a 6.x cluster.\n\nTo enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nReindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb.\nIf the remote index includes very large documents you'll need to use a smaller batch size.\nIt is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field.\nBoth default to 30 seconds.\n\n**Configuring SSL parameters**\n\nReindex from remote supports configurable SSL settings.\nThese must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore.\nIt is not possible to configure SSL in the body of the reindex request.", + "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", "inherits": { "type": { "name": "RequestBase", @@ -33017,7 +31054,7 @@ } }, { - "description": "The throttle for this request in sub-requests per second.\nBy default, there is no throttle.", + "description": "The throttle for this request in sub-requests per second.\nDefaults to no throttle.", "name": "requests_per_second", "required": false, "serverDefault": -1, @@ -33030,7 +31067,7 @@ } }, { - "description": "The period of time that a consistent view of the index should be maintained for scrolled search.", + "description": "Specifies how long a consistent view of the index should be maintained for scrolled search.", "name": "scroll", "required": false, "type": { @@ -33042,9 +31079,7 @@ } }, { - "description": "The number of slices this task should be divided into.\nIt defaults to one slice, which means the task isn't sliced into subtasks.\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nIf set to `auto`, Elasticsearch chooses the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", - "extDocId": "slice-scroll", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#slice-scroll", + "description": "The number of slices this task should be divided into.\nDefaults to 1 slice, meaning the task isn’t sliced into subtasks.", "name": "slices", "required": false, "serverDefault": "1", @@ -33057,7 +31092,7 @@ } }, { - "description": "The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.\nBy default, Elasticsearch waits for at least one minute before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", + "description": "Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -33070,7 +31105,7 @@ } }, { - "description": "The number of shard copies that must be active before proceeding with the operation.\nSet it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value is one, which means it waits for each primary shard to be active.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -33109,7 +31144,7 @@ } } ], - "specLocation": "_global/reindex/ReindexRequest.ts#L27-L309" + "specLocation": "_global/reindex/ReindexRequest.ts#L27-L104" }, { "kind": "response", @@ -33117,7 +31152,6 @@ "kind": "properties", "properties": [ { - "description": "The number of scroll responses that were pulled back by the reindex.", "name": "batches", "required": false, "type": { @@ -33129,7 +31163,6 @@ } }, { - "description": "The number of documents that were successfully created.", "name": "created", "required": false, "type": { @@ -33141,7 +31174,6 @@ } }, { - "description": "The number of documents that were successfully deleted.", "name": "deleted", "required": false, "type": { @@ -33153,7 +31185,6 @@ } }, { - "description": "If there were any unrecoverable errors during the process, it is an array of those failures.\nIf this array is not empty, the request ended because of those failures.\nReindex is implemented using batches and any failure causes the entire process to end but all failures in the current batch are collected into the array.\nYou can use the `conflicts` option to prevent the reindex from ending on version conflicts.", "name": "failures", "required": false, "type": { @@ -33168,7 +31199,6 @@ } }, { - "description": "The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.", "name": "noops", "required": false, "type": { @@ -33180,7 +31210,6 @@ } }, { - "description": "The number of retries attempted by reindex.", "name": "retries", "required": false, "type": { @@ -33192,7 +31221,6 @@ } }, { - "description": "The number of requests per second effectively run during the reindex.", "name": "requests_per_second", "required": false, "type": { @@ -33226,7 +31254,6 @@ } }, { - "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", "name": "throttled_millis", "required": false, "type": { @@ -33247,7 +31274,6 @@ } }, { - "description": "This field should always be equal to zero in a reindex response.\nIt has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) that a throttled request will be run again in order to conform to `requests_per_second`.", "name": "throttled_until_millis", "required": false, "type": { @@ -33268,7 +31294,6 @@ } }, { - "description": "If any of the requests that ran during the reindex timed out, it is `true`.", "name": "timed_out", "required": false, "type": { @@ -33280,7 +31305,6 @@ } }, { - "description": "The total milliseconds the entire operation took.", "name": "took", "required": false, "type": { @@ -33301,7 +31325,6 @@ } }, { - "description": "The number of documents that were successfully processed.", "name": "total", "required": false, "type": { @@ -33313,7 +31336,6 @@ } }, { - "description": "The number of documents that were successfully updated.\nThat is to say, a document with the same ID already existed before the reindex updated it.", "name": "updated", "required": false, "type": { @@ -33325,7 +31347,6 @@ } }, { - "description": "The number of version conflicts that occurred.", "name": "version_conflicts", "required": false, "type": { @@ -33342,7 +31363,7 @@ "name": "Response", "namespace": "_global.reindex" }, - "specLocation": "_global/reindex/ReindexResponse.ts#L26-L92" + "specLocation": "_global/reindex/ReindexResponse.ts#L26-L45" }, { "kind": "interface", @@ -33352,7 +31373,7 @@ }, "properties": [ { - "description": "The name of the data stream, index, or alias you are copying from.\nIt accepts a comma-separated list to reindex from multiple sources.", + "description": "The name of the data stream, index, or alias you are copying from.\nAccepts a comma-separated list to reindex from multiple sources.", "name": "index", "required": true, "type": { @@ -33364,7 +31385,7 @@ } }, { - "description": "The documents to reindex, which is defined with Query DSL.", + "description": "Specifies the documents to reindex using the Query DSL.", "name": "query", "required": false, "type": { @@ -33388,10 +31409,9 @@ } }, { - "description": "The number of documents to index per batch.\nUse it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.", + "description": "The number of documents to index per batch.\nUse when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.", "name": "size", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { @@ -33413,11 +31433,6 @@ } }, { - "deprecation": { - "description": "", - "version": "7.6.0" - }, - "description": "A comma-separated list of `:` pairs to sort by before indexing.\nUse it in conjunction with `max_docs` to control what documents are reindexed.\n\nWARNING: Sort in reindex is deprecated.\nSorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements.\nIf used in combination with `max_docs`, consider using a query filter instead.", "name": "sort", "required": false, "type": { @@ -33430,7 +31445,7 @@ }, { "codegenName": "source_fields", - "description": "If `true`, reindex all source fields.\nSet it to a list to reindex select fields.", + "description": "If `true` reindexes all source fields.\nSet to a list to reindex select fields.", "name": "_source", "required": false, "serverDefault": "true", @@ -33454,7 +31469,7 @@ } } ], - "specLocation": "_global/reindex/types.ts#L69-L110" + "specLocation": "_global/reindex/types.ts#L66-L97" }, { "kind": "interface", @@ -33822,7 +31837,7 @@ "body": { "kind": "no_body" }, - "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.\nFor example:\n\n```\nPOST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n```\n\nRethrottling that speeds up the query takes effect immediately.\nRethrottling that slows down the query will take effect after completing the current batch.\nThis behavior prevents scroll timeouts.", + "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.", "inherits": { "type": { "name": "RequestBase", @@ -33835,7 +31850,7 @@ }, "path": [ { - "description": "The task identifier, which can be found by using the tasks API.", + "description": "Identifier for the task.", "name": "task_id", "required": true, "type": { @@ -33849,7 +31864,7 @@ ], "query": [ { - "description": "The throttle for this request in sub-requests per second.\nIt can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level.", + "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "type": { @@ -33861,7 +31876,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L63" + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L46" }, { "kind": "response", @@ -33906,18 +31921,6 @@ "body": { "kind": "properties", "properties": [ - { - "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `` request path parameter is required.\nIf you specify both this parameter and the `` parameter, the API uses only ``.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, { "name": "file", "required": false, @@ -33949,7 +31952,7 @@ } }, { - "description": "An inline search template.\nIt supports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", + "description": "An inline search template.\nSupports the same parameters as the search API's request body.\nThese parameters also support Mustache variables.\nIf no `id` or `` is specified, this parameter is required.", "name": "source", "required": false, "type": { @@ -33975,7 +31978,7 @@ }, "path": [ { - "description": "The ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", + "description": "ID of the search template to render.\nIf no `source` is specified, this or the `id` request body parameter is required.", "name": "id", "required": false, "type": { @@ -33988,7 +31991,7 @@ } ], "query": [], - "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L76" + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L58" }, { "kind": "response", @@ -34021,60 +32024,6 @@ }, "specLocation": "_global/render_search_template/RenderSearchTemplateResponse.ts#L23-L25" }, - { - "kind": "enum", - "members": [ - { - "description": "The default context if no other context is specified.", - "name": "painless_test" - }, - { - "description": "Treats scripts as if they were run inside a script query.", - "name": "filter" - }, - { - "description": "Treats scripts as if they were run inside a `script_score` function in a `function_score` query.", - "name": "score" - }, - { - "description": "The context for boolean fields. The script returns a `true` or `false` response.", - "name": "boolean_field" - }, - { - "description": "The context for date fields. `emit` takes a long value and the script returns a sorted list of dates.", - "name": "date_field" - }, - { - "description": "The context for double numeric fields. The script returns a sorted list of double values.", - "name": "double_field" - }, - { - "description": "The context for geo-point fields. `emit` takes two double parameters, the latitude and longitude values, and the script returns an object in GeoJSON format containing the coordinates for the geo point.", - "name": "geo_point_field" - }, - { - "description": "The context for `ip` fields. The script returns a sorted list of IP addresses.", - "name": "ip_field" - }, - { - "description": "The context for keyword fields. The script returns a sorted list of string values.", - "name": "keyword_field" - }, - { - "description": "The context for long numeric fields. The script returns a sorted list of long values.", - "name": "long_field" - }, - { - "description": "The context for composite runtime fields. The script returns a map of values.", - "name": "composite_field" - } - ], - "name": { - "name": "PainlessContext", - "namespace": "_global.scripts_painless_execute" - }, - "specLocation": "_global/scripts_painless_execute/types.ts#L57-L80" - }, { "kind": "interface", "name": { @@ -34083,7 +32032,7 @@ }, "properties": [ { - "description": "Document that's temporarily indexed in-memory and accessible from the script.", + "description": "Document that’s temporarily indexed in-memory and accessible from the script.", "name": "document", "required": true, "type": { @@ -34091,7 +32040,7 @@ } }, { - "description": "Index containing a mapping that's compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.\nFor example, `remote1:my_index` indicates that you want to run the painless script against the \"my_index\" index on the \"remote1\" cluster.\nThis request will be forwarded to the \"remote1\" cluster if you have configured a connection to that remote cluster.\n\nNOTE: Wildcards are not accepted in the index expression for this endpoint.\nThe expression `*:myindex` will return the error \"No such remote cluster\" and the expression `logs*` or `remote1:logs*` will return the error \"index not found\".", + "description": "Index containing a mapping that’s compatible with the indexed document.\nYou may specify a remote index by prefixing the index with the remote cluster alias.", "name": "index", "required": true, "type": { @@ -34115,7 +32064,7 @@ } } ], - "specLocation": "_global/scripts_painless_execute/types.ts#L27-L46" + "specLocation": "_global/scripts_painless_execute/types.ts#L25-L39" }, { "kind": "request", @@ -34126,20 +32075,20 @@ "kind": "properties", "properties": [ { - "description": "The context that the script should run in.\nNOTE: Result ordering in the field contexts is not guaranteed.", + "description": "The context that the script should run in.", "name": "context", "required": false, "serverDefault": "painless_test", "type": { "kind": "instance_of", "type": { - "name": "PainlessContext", - "namespace": "_global.scripts_painless_execute" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Additional parameters for the `context`.\nNOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`.", + "description": "Additional parameters for the `context`.", "name": "context_setup", "required": false, "type": { @@ -34151,7 +32100,7 @@ } }, { - "description": "The Painless script to run.", + "description": "The Painless script to execute.", "name": "script", "required": false, "type": { @@ -34164,7 +32113,7 @@ } ] }, - "description": "Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.", + "description": "Run a script.\nRuns a script and returns a result.", "inherits": { "type": { "name": "RequestBase", @@ -34177,7 +32126,7 @@ }, "path": [], "query": [], - "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L64" + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L48" }, { "kind": "response", @@ -34218,9 +32167,9 @@ "kind": "properties", "properties": [ { - "description": "The period to retain the search context for scrolling.", + "description": "Period to retain the search context for scrolling.", "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", @@ -34233,7 +32182,7 @@ } }, { - "description": "The scroll ID of the search.", + "description": "Scroll ID of the search.", "name": "scroll_id", "required": true, "type": { @@ -34277,9 +32226,9 @@ ], "query": [ { - "description": "The period to retain the search context for scrolling.", + "description": "Period to retain the search context for scrolling.", "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", @@ -34321,7 +32270,7 @@ } } ], - "specLocation": "_global/scroll/ScrollRequest.ts#L24-L88" + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L75" }, { "kind": "response", @@ -34403,7 +32352,7 @@ } }, { - "description": "If `true`, the request returns detailed information about score computation as part of a hit.", + "description": "If true, returns detailed information about score computation as part of a hit.", "name": "explain", "required": false, "serverDefault": false, @@ -34435,7 +32384,7 @@ } }, { - "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "Starting document offset.\nNeeds to be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, @@ -34473,9 +32422,7 @@ } }, { - "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", - "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "description": "Boosts the _score of documents from specified indices.", "name": "indices_boost", "required": false, "type": { @@ -34501,9 +32448,7 @@ } }, { - "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", - "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "description": "Array of wildcard (`*`) patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "name": "docvalue_fields", "required": false, "type": { @@ -34524,9 +32469,7 @@ "since": "8.4.0" } }, - "description": "The approximate kNN search to run.", - "extDocId": "knn-approximate", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn", + "description": "Defines the approximate kNN search to run.", "name": "knn", "required": false, "type": { @@ -34558,7 +32501,7 @@ "since": "8.8.0" } }, - "description": "The Reciprocal Rank Fusion (RRF) to use.", + "description": "Defines the Reciprocal Rank Fusion (RRF) to use.", "name": "rank", "required": false, "type": { @@ -34570,7 +32513,7 @@ } }, { - "description": "The minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in the search results.", + "description": "Minimum `_score` for matching documents.\nDocuments with a lower `_score` are not included in the search results.", "name": "min_score", "required": false, "type": { @@ -34607,9 +32550,7 @@ } }, { - "description": "The search definition using the Query DSL.", - "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "description": "Defines the search definition using the Query DSL.", "name": "query", "required": false, "type": { @@ -34657,7 +32598,7 @@ "stability": "stable" } }, - "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "description": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn.", "name": "retriever", "required": false, "type": { @@ -34704,7 +32645,7 @@ } }, { - "description": "The number of hits to return, which must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` property.", + "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, @@ -34717,7 +32658,7 @@ } }, { - "description": "Split a scrolled search into multiple slices that can be consumed independently.", + "description": "Can be used to split a scrolled search into multiple slices that can be consumed independently.", "name": "slice", "required": false, "type": { @@ -34730,8 +32671,8 @@ }, { "description": "A comma-separated list of : pairs.", - "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docId": "sort-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -34743,9 +32684,7 @@ } }, { - "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", - "extDocId": "source-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering", + "description": "Indicates which source fields are returned for matching documents.\nThese fields are returned in the hits._source property of the search response.", "name": "_source", "required": false, "type": { @@ -34757,7 +32696,7 @@ } }, { - "description": "An array of wildcard (`*`) field patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", + "description": "Array of wildcard (`*`) patterns.\nThe request returns values for field names matching these patterns in the `hits.fields` property of the response.", "name": "fields", "required": false, "type": { @@ -34784,7 +32723,7 @@ } }, { - "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 property to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this property for requests that target data streams with backing indices across multiple data tiers.\n\nIf set to `0` (default), the query does not terminate early.", + "description": "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.\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.\nIf set to `0` (default), the query does not terminate early.", "name": "terminate_after", "required": false, "serverDefault": 0, @@ -34797,7 +32736,7 @@ } }, { - "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", + "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "name": "timeout", "required": false, "type": { @@ -34809,7 +32748,7 @@ } }, { - "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", + "description": "If true, calculate and return document scores, even if the scores are not used for sorting.", "name": "track_scores", "required": false, "serverDefault": false, @@ -34822,7 +32761,7 @@ } }, { - "description": "If `true`, the request returns the document version as part of a hit.", + "description": "If true, returns document version as part of a hit.", "name": "version", "required": false, "serverDefault": false, @@ -34835,9 +32774,7 @@ } }, { - "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", "name": "seq_no_primary_term", "required": false, "type": { @@ -34849,9 +32786,7 @@ } }, { - "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", - "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "description": "List of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "name": "stored_fields", "required": false, "type": { @@ -34863,7 +32798,7 @@ } }, { - "description": "Limit the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", + "description": "Limits the search to a point in time (PIT).\nIf you provide a PIT, you cannot specify an `` in the request path.", "name": "pit", "required": false, "type": { @@ -34875,9 +32810,7 @@ } }, { - "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", - "extDocId": "runtime-search-request", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "description": "Defines one or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "name": "runtime_mappings", "required": false, "type": { @@ -34889,7 +32822,7 @@ } }, { - "description": "The stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", + "description": "Stats groups to associate with the search.\nEach group maintains a statistics aggregation for its associated searches.\nYou can retrieve these stats using the indices stats API.", "name": "stats", "required": false, "type": { @@ -34905,7 +32838,7 @@ } ] }, - "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", + "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "inherits": { "type": { "name": "RequestBase", @@ -34918,7 +32851,7 @@ }, "path": [ { - "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`.", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": false, "type": { @@ -34945,7 +32878,7 @@ } }, { - "description": "If `true` and there are shard request timeouts or shard failures, the request returns partial results.\nIf `false`, it returns an error with no partial results.\n\nTo override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`.", + "description": "If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results.", "name": "allow_partial_search_results", "required": false, "serverDefault": true, @@ -34958,7 +32891,7 @@ } }, { - "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "Analyzer to use for the query string.\nThis parameter can only be used when the q query string parameter is specified.", "name": "analyzer", "required": false, "type": { @@ -34970,7 +32903,7 @@ } }, { - "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "If true, wildcard and prefix queries are analyzed.\nThis parameter can only be used when the q query string parameter is specified.", "name": "analyze_wildcard", "required": false, "serverDefault": false, @@ -34983,7 +32916,7 @@ } }, { - "description": "The number of shard results that should be reduced at once on the coordinating node.\nIf the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.", + "description": "The number of shard results that should be reduced at once on the coordinating node.\nThis value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "name": "batched_reduce_size", "required": false, "serverDefault": 512, @@ -34996,9 +32929,9 @@ } }, { - "description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", - "extDocId": "ccs-network-delays", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "description": "If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.", + "docId": "ccs-network-delays", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -35011,7 +32944,7 @@ } }, { - "description": "The default operator for the query string query: `AND` or `OR`.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "The default operator for query string query: AND or OR.\nThis parameter can only be used when the `q` query string parameter is specified.", "name": "default_operator", "required": false, "serverDefault": "OR", @@ -35024,7 +32957,7 @@ } }, { - "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.", + "description": "Field to use as default where no field prefix is given in the query string.\nThis parameter can only be used when the q query string parameter is specified.", "name": "df", "required": false, "type": { @@ -35036,9 +32969,7 @@ } }, { - "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "description": "A comma-separated list of fields to return as the docvalue representation for each hit.", "name": "docvalue_fields", "required": false, "type": { @@ -35050,10 +32981,9 @@ } }, { - "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`.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`.", "name": "expand_wildcards", "required": false, - "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -35063,7 +32993,7 @@ } }, { - "description": "If `true`, the request returns detailed information about score computation as part of a hit.", + "description": "If `true`, returns detailed information about score computation as part of a hit.", "name": "explain", "required": false, "serverDefault": false, @@ -35076,10 +33006,6 @@ } }, { - "deprecation": { - "description": "", - "version": "7.16.0" - }, "description": "If `true`, concrete, expanded or aliased indices will be ignored when frozen.", "name": "ignore_throttled", "required": false, @@ -35106,7 +33032,7 @@ } }, { - "description": "If `true`, the response includes the score contribution from any named queries.\n\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.", + "description": "Indicates whether hit.matched_queries should be rendered as a map that includes\nthe name of the matched query associated with its score (true)\nor as an array containing the name of the matched queries (false)\nThis functionality reruns each named query on every hit in a search response.\nTypically, this adds a small overhead to a request.\nHowever, using computationally expensive named queries on a large number of hits may add significant overhead.", "name": "include_named_queries_score", "required": false, "serverDefault": false, @@ -35119,7 +33045,7 @@ } }, { - "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.", + "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 only be used when the `q` query string parameter is specified.", "name": "lenient", "required": false, "serverDefault": false, @@ -35132,7 +33058,7 @@ } }, { - "description": "The number of concurrent shard requests per node that the search runs 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.", + "description": "Defines 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.", "name": "max_concurrent_shard_requests", "required": false, "serverDefault": 5, @@ -35145,7 +33071,7 @@ } }, { - "description": "The nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.\nValid values are:\n\n* `_only_local` to run the search only on shards on the local node.\n* `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method.\n* `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.\n* `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.\n`_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`.\n`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.", + "description": "Nodes and shards used for the search.\nBy default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:\n`_only_local` to run the search only on shards on the local node;\n`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;\n`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;\n`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;\n`_shards:,` to run the search only on the specified shards;\n`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order.", "name": "preference", "required": false, "type": { @@ -35157,7 +33083,7 @@ } }, { - "description": "A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\n\n* The request targets more than 128 shards.\n* The request targets one or more read-only index.\n* The primary sort of the query targets an indexed field.", + "description": "Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.\nThis filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).\nWhen unspecified, the pre-filter phase is executed if any of these conditions is met:\nthe request targets more than 128 shards;\nthe request targets one or more read-only index;\nthe primary sort of the query targets an indexed field.", "name": "pre_filter_shard_size", "required": false, "type": { @@ -35169,9 +33095,7 @@ } }, { - "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.", - "extDocId": "shard-request-cache", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-request-cache.html", + "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nDefaults to index level settings.", "name": "request_cache", "required": false, "type": { @@ -35183,7 +33107,7 @@ } }, { - "description": "A custom value that is used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -35195,9 +33119,9 @@ } }, { - "description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.", - "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "description": "Period to retain the search context for scrolling. See Scroll search results.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit using the `search.max_keep_alive` cluster-level setting.", + "docId": "scroll-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "required": false, "type": { @@ -35209,9 +33133,7 @@ } }, { - "description": "Indicates how distributed term frequencies are calculated for relevance scoring.", - "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "description": "How distributed term frequencies are calculated for relevance scoring.", "name": "search_type", "required": false, "type": { @@ -35239,8 +33161,6 @@ }, { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", - "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -35252,7 +33172,7 @@ } }, { - "description": "The field to use for suggestions.", + "description": "Specifies which field to use for suggestions.", "name": "suggest_field", "required": false, "type": { @@ -35264,7 +33184,7 @@ } }, { - "description": "The suggest mode.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", + "description": "Specifies the suggest mode.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", "name": "suggest_mode", "required": false, "serverDefault": "missing", @@ -35277,7 +33197,7 @@ } }, { - "description": "The number of suggestions to return.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", + "description": "Number of suggestions to return.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", "name": "suggest_size", "required": false, "type": { @@ -35289,7 +33209,7 @@ } }, { - "description": "The source text for which the suggestions should be returned.\nThis parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified.", + "description": "The source text for which the suggestions should be returned.\nThis parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.", "name": "suggest_text", "required": false, "type": { @@ -35301,7 +33221,7 @@ } }, { - "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.\nIf set to `0` (default), the query does not terminate early.", + "description": "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.\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.\nIf set to `0` (default), the query does not terminate early.", "name": "terminate_after", "required": false, "serverDefault": 0, @@ -35314,7 +33234,7 @@ } }, { - "description": "The period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt defaults to no timeout.", + "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "type": { @@ -35326,7 +33246,7 @@ } }, { - "description": "The number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", + "description": "Number of hits matching the query to count accurately.\nIf `true`, the exact number of hits is returned at the cost of some performance.\nIf `false`, the response does not include the total number of hits matching the query.", "name": "track_total_hits", "required": false, "serverDefault": "10000", @@ -35339,7 +33259,7 @@ } }, { - "description": "If `true`, the request calculates and returns document scores, even if the scores are not used for sorting.", + "description": "If `true`, calculate and return document scores, even if the scores are not used for sorting.", "name": "track_scores", "required": false, "serverDefault": false, @@ -35355,7 +33275,7 @@ "description": "If `true`, aggregation and suggester names are be prefixed by their respective types in the response.", "name": "typed_keys", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -35378,7 +33298,7 @@ } }, { - "description": "If `true`, the request returns the document version as part of a hit.", + "description": "If `true`, returns document version as part of a hit.", "name": "version", "required": false, "serverDefault": false, @@ -35391,7 +33311,7 @@ } }, { - "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n\n* `true` to return the entire document source.\n* `false` to not return the document source.\n* `` to return the source fields that are specified as a comma-separated list that supports wildcard (`*`) patterns.", + "description": "Indicates which source fields are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nValid values are:\n`true` to return the entire document source;\n`false` to not return the document source;\n`` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns).", "name": "_source", "required": false, "serverDefault": "true", @@ -35428,9 +33348,7 @@ } }, { - "description": "If `true`, the request returns the sequence number and primary term of the last modification of each hit.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "description": "If `true`, returns sequence number and primary term of the last modification of each hit.", "name": "seq_no_primary_term", "required": false, "type": { @@ -35442,7 +33360,7 @@ } }, { - "description": "A query in the Lucene query string syntax.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.\n\nIMPORTANT: This parameter overrides the query parameter in the request body.\nIf both parameters are specified, documents matching the query request body parameter are not returned.", + "description": "Query in the Lucene query string syntax using query parameter search.\nQuery parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.", "name": "q", "required": false, "type": { @@ -35454,7 +33372,7 @@ } }, { - "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "Defines the number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, @@ -35467,7 +33385,7 @@ } }, { - "description": "The starting document offset, which must be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "Starting document offset.\nNeeds to be non-negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, @@ -35480,9 +33398,9 @@ } }, { - "description": "A comma-separated list of `:` pairs.", - "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "description": "A comma-separated list of : pairs.", + "docId": "sort-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -35528,7 +33446,7 @@ } } ], - "specLocation": "_global/search/SearchRequest.ts#L53-L584" + "specLocation": "_global/search/SearchRequest.ts#L53-L525" }, { "kind": "response", @@ -35577,7 +33495,6 @@ }, "properties": [ { - "description": "The number of milliseconds it took Elasticsearch to run the request.\nThis value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response.\nIt includes:\n\n* Communication time between the coordinating node and data nodes\n* Time the request spends in the search thread pool, queued for execution\n* Actual run time\n\nIt does not include:\n\n* Time needed to send the request to Elasticsearch\n* Time needed to serialize the JSON response\n* Time needed to send the response to a client", "name": "took", "required": true, "type": { @@ -35589,7 +33506,6 @@ } }, { - "description": "If `true`, the request timed out before completion; returned results may be partial or empty.", "name": "timed_out", "required": true, "type": { @@ -35601,7 +33517,6 @@ } }, { - "description": "A count of shards used for the request.", "name": "_shards", "required": true, "type": { @@ -35613,7 +33528,6 @@ } }, { - "description": "The returned documents and metadata.", "name": "hits", "required": true, "type": { @@ -35729,9 +33643,6 @@ } }, { - "description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.", - "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", "name": "_scroll_id", "required": false, "type": { @@ -35788,7 +33699,7 @@ } } ], - "specLocation": "_global/search/SearchResponse.ts#L38-L84" + "specLocation": "_global/search/SearchResponse.ts#L38-L54" }, { "kind": "interface", @@ -36919,7 +34830,7 @@ ], "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html#_document_input_parameters", "name": { "name": "Context", "namespace": "_global.search._types" @@ -37617,7 +35528,7 @@ { "kind": "interface", "extDocId": "collapse-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html", "name": { "name": "FieldCollapse", "namespace": "_global.search._types" @@ -40203,7 +38114,7 @@ { "description": "Optional operators for the regular expression.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html", "name": "flags", "required": false, "type": { @@ -40855,7 +38766,7 @@ { "description": "The fuzziness factor.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "serverDefault": "AUTO", @@ -41404,7 +39315,7 @@ "kind": "properties", "properties": [ { - "description": "Sub-aggregations for the geotile_grid.\n\nIt supports the following aggregation types:\n\n- `avg`\n- `boxplot`\n- `cardinality`\n- `extended stats`\n- `max`\n- `median absolute deviation`\n- `min`\n- `percentile`\n- `percentile-rank`\n- `stats`\n- `sum`\n- `value count`\n\nThe aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations.", + "description": "Sub-aggregations for the geotile_grid.\n\nSupports the following aggregation types:\n- avg\n- cardinality\n- max\n- min\n- sum", "name": "aggs", "required": false, "type": { @@ -41427,7 +39338,7 @@ } }, { - "description": "The size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.", + "description": "Size, in pixels, of a clipping buffer outside the tile. This allows renderers\nto avoid outline artifacts from geometries that extend past the extent of the tile.", "name": "buffer", "required": false, "serverDefault": 5, @@ -41440,7 +39351,7 @@ } }, { - "description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf `true`, the meta layer's feature is a bounding box resulting from a\n`geo_bounds` aggregation. The aggregation runs on values that intersect\nthe `//` tile with `wrap_longitude` set to `false`. The resulting\nbounding box may be larger than the vector tile.", + "description": "If false, the meta layer’s feature is the bounding box of the tile.\nIf true, the meta layer’s feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", "name": "exact_bounds", "required": false, "serverDefault": false, @@ -41453,7 +39364,7 @@ } }, { - "description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "description": "Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", "name": "extent", "required": false, "serverDefault": 4096, @@ -41466,7 +39377,7 @@ } }, { - "description": "The fields to return in the `hits` layer.\nIt supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", + "description": "Fields to return in the `hits` layer. Supports wildcards (`*`).\nThis parameter does not support fields with array values. Fields with array\nvalues may return inconsistent results.", "name": "fields", "required": false, "type": { @@ -41478,7 +39389,7 @@ } }, { - "description": "The aggregation used to create a grid for the `field`.", + "description": "Aggregation used to create a grid for the `field`.", "name": "grid_agg", "required": false, "type": { @@ -41490,7 +39401,7 @@ } }, { - "description": "Additional zoom levels available through the aggs layer. For example, if `` is `7`\nand `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.", + "description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon’t include the aggs layer.", "name": "grid_precision", "required": false, "serverDefault": 8, @@ -41503,7 +39414,7 @@ } }, { - "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a `geotile_grid` cell. If `grid, each feature is a polygon\nof the cells bounding box. If `point`, each feature is a Point that is the centroid\nof the cell.", + "description": "Determines the geometry type for features in the aggs layer. In the aggs layer,\neach feature represents a geotile_grid cell. If 'grid' each feature is a Polygon\nof the cells bounding box. If 'point' each feature is a Point that is the centroid\nof the cell.", "name": "grid_type", "required": false, "serverDefault": "grid", @@ -41516,7 +39427,7 @@ } }, { - "description": "The query DSL used to filter documents for the search.", + "description": "Query DSL used to filter documents for the search.", "name": "query", "required": false, "type": { @@ -41540,7 +39451,7 @@ } }, { - "description": "The maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.", + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don’t include the hits layer.", "name": "size", "required": false, "serverDefault": 10000, @@ -41553,7 +39464,7 @@ } }, { - "description": "Sort the features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box's diagonal length,\nfrom longest to shortest.", + "description": "Sorts features in the hits layer. By default, the API calculates a bounding\nbox for each feature. It sorts features based on this box’s diagonal length,\nfrom longest to shortest.", "name": "sort", "required": false, "type": { @@ -41565,7 +39476,7 @@ } }, { - "description": "The number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.", + "description": "Number of hits matching the query to count accurately. If `true`, the exact number\nof hits is returned at the cost of some performance. If `false`, the response does\nnot include the total number of hits matching the query.", "name": "track_total_hits", "required": false, "serverDefault": "10000", @@ -41578,7 +39489,7 @@ } }, { - "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", + "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.", "name": "with_labels", "required": false, "type": { @@ -41591,7 +39502,7 @@ } ] }, - "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", + "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.", "inherits": { "type": { "name": "RequestBase", @@ -41666,7 +39577,7 @@ ], "query": [ { - "description": "If `false`, the meta layer's feature is the bounding box of the tile.\nIf true, the meta layer's feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", + "description": "If false, the meta layer’s feature is the bounding box of the tile.\nIf true, the meta layer’s feature is a bounding box resulting from a\ngeo_bounds aggregation. The aggregation runs on values that intersect\nthe // tile with wrap_longitude set to false. The resulting\nbounding box may be larger than the vector tile.", "name": "exact_bounds", "required": false, "serverDefault": false, @@ -41679,7 +39590,7 @@ } }, { - "description": "The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", + "description": "Size, in pixels, of a side of the tile. Vector tiles are square with equal sides.", "name": "extent", "required": false, "serverDefault": 4096, @@ -41704,7 +39615,7 @@ } }, { - "description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon't include the aggs layer.", + "description": "Additional zoom levels available through the aggs layer. For example, if is 7\nand grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results\ndon’t include the aggs layer.", "name": "grid_precision", "required": false, "serverDefault": 8, @@ -41730,7 +39641,7 @@ } }, { - "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don't include the hits layer.", + "description": "Maximum number of features to return in the hits layer. Accepts 0-10000.\nIf 0, results don’t include the hits layer.", "name": "size", "required": false, "serverDefault": 10000, @@ -41743,7 +39654,7 @@ } }, { - "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.\n\n* `Point` and `MultiPoint` features will have one of the points selected.\n* `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.\n* `LineString` features will likewise provide a roughly central point selected from the triangle-tree.\n* The aggregation results will provide one central point for each aggregation bucket.\n\nAll attributes from the original features will also be copied to the new label features.\nIn addition, the new features will be distinguishable using the tag `_mvt_label_position`.", + "description": "If `true`, the hits and aggs layers will contain additional point features representing\nsuggested label positions for the original features.", "name": "with_labels", "required": false, "type": { @@ -41755,7 +39666,7 @@ } } ], - "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L373" + "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L193" }, { "kind": "response", @@ -41854,7 +39765,7 @@ "body": { "kind": "no_body" }, - "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.", + "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the indices section.", "inherits": { "type": { "name": "RequestBase", @@ -41867,7 +39778,7 @@ }, "path": [ { - "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`.", + "description": "Returns the indices and shards that a search request would be executed against.", "name": "index", "required": false, "type": { @@ -41933,20 +39844,7 @@ } }, { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIT can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -41958,7 +39856,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -41970,7 +39868,7 @@ } } ], - "specLocation": "_global/search_shards/SearchShardsRequest.ts#L24-L100" + "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L76" }, { "kind": "response", @@ -42220,7 +40118,7 @@ "kind": "properties", "properties": [ { - "description": "If `true`, returns detailed information about score calculation as part of each hit.\nIf you specify both this and the `explain` query parameter, the API uses only the query parameter.", + "description": "If `true`, returns detailed information about score calculation as part of each hit.", "name": "explain", "required": false, "serverDefault": false, @@ -42233,7 +40131,7 @@ } }, { - "description": "The ID of the search template to use. If no `source` is specified,\nthis parameter is required.", + "description": "ID of the search template to use. If no source is specified,\nthis parameter is required.", "name": "id", "required": false, "type": { @@ -42277,7 +40175,7 @@ } }, { - "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. It also supports Mustache variables. If no `id` is specified, this\nparameter is required.", + "description": "An inline search template. Supports the same parameters as the search API's\nrequest body. Also supports Mustache variables. If no id is specified, this\nparameter is required.", "name": "source", "required": false, "type": { @@ -42303,7 +40201,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).", + "description": "Comma-separated list of data streams, indices,\nand aliases to search. Supports wildcards (*).", "name": "index", "required": false, "type": { @@ -42343,7 +40241,7 @@ } }, { - "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.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "type": { @@ -42368,10 +40266,6 @@ } }, { - "deprecation": { - "description": "", - "version": "7.16.0" - }, "description": "If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled.", "name": "ignore_throttled", "required": false, @@ -42398,7 +40292,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -42423,7 +40317,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -42465,7 +40359,7 @@ "since": "7.0.0" } }, - "description": "If `true`, `hits.total` is rendered as an integer in the response.\nIf `false`, it is rendered as an object.", + "description": "If true, hits.total are rendered as an integer in the response.", "name": "rest_total_hits_as_int", "required": false, "serverDefault": false, @@ -42491,7 +40385,7 @@ } } ], - "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L153" + "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L136" }, { "kind": "response", @@ -42737,7 +40631,7 @@ } }, { - "description": "The number of matching terms to return.", + "description": "How many matching terms to return.", "name": "size", "required": false, "serverDefault": 10, @@ -42750,7 +40644,7 @@ } }, { - "description": "The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.", + "description": "The maximum length of time to spend collecting results. Defaults to \"1s\" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty.", "name": "timeout", "required": false, "serverDefault": "1s", @@ -42763,7 +40657,7 @@ } }, { - "description": "When `true`, the provided search string is matched against index terms without case sensitivity.", + "description": "When true the provided search string is matched against index terms without case sensitivity.", "name": "case_insensitive", "required": false, "serverDefault": false, @@ -42776,9 +40670,9 @@ } }, { - "description": "Filter an index shard if the provided query rewrites to `match_none`.", + "description": "Allows to filter an index shard if the provided query rewrites to match_none.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "name": "index_filter", "required": false, "type": { @@ -42790,7 +40684,7 @@ } }, { - "description": "The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.", + "description": "The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.", "name": "string", "required": false, "type": { @@ -42802,7 +40696,6 @@ } }, { - "description": "The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.", "name": "search_after", "required": false, "type": { @@ -42815,7 +40708,7 @@ } ] }, - "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "inherits": { "type": { "name": "RequestBase", @@ -42828,7 +40721,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", + "description": "Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported.", "name": "index", "required": true, "type": { @@ -42841,7 +40734,7 @@ } ], "query": [], - "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L93" + "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L75" }, { "kind": "response", @@ -42874,7 +40767,6 @@ } }, { - "description": "If `false`, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.", "name": "complete", "required": true, "type": { @@ -42891,7 +40783,7 @@ "name": "Response", "namespace": "_global.terms_enum" }, - "specLocation": "_global/terms_enum/TermsEnumResponse.ts#L22-L32" + "specLocation": "_global/terms_enum/TermsEnumResponse.ts#L22-L28" }, { "kind": "interface", @@ -42956,7 +40848,7 @@ } }, { - "description": "The maximum number of terms that must be returned per field.", + "description": "Maximum number of terms that must be returned per field.", "name": "max_num_terms", "required": false, "serverDefault": 25, @@ -42969,7 +40861,7 @@ } }, { - "description": "Ignore words with more than this frequency in the source doc.\nIt defaults to unbounded.", + "description": "Ignore words with more than this frequency in the source doc.\nDefaults to unbounded.", "name": "max_term_freq", "required": false, "type": { @@ -43056,9 +40948,7 @@ } }, { - "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.", - "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "description": "Filter terms based on their tf-idf scores.", "name": "filter", "required": false, "type": { @@ -43070,7 +40960,7 @@ } }, { - "description": "Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.", + "description": "Overrides the default per-field analyzer.", "name": "per_field_analyzer", "required": false, "type": { @@ -43094,7 +40984,7 @@ } ] }, - "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.", + "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.", "generics": [ { "name": "TDocument", @@ -43113,7 +41003,7 @@ }, "path": [ { - "description": "The name of the index that contains the document.", + "description": "Name of the index that contains the document.", "name": "index", "required": true, "type": { @@ -43125,7 +41015,7 @@ } }, { - "description": "A unique identifier for the document.", + "description": "Unique identifier of the document.", "name": "id", "required": false, "type": { @@ -43139,7 +41029,7 @@ ], "query": [ { - "description": "A comma-separated list or wildcard expressions of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", + "description": "Comma-separated list or wildcard expressions of fields to include in the statistics.\nUsed as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.", "name": "fields", "required": false, "type": { @@ -43151,7 +41041,7 @@ } }, { - "description": "If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).", + "description": "If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.", "name": "field_statistics", "required": false, "serverDefault": true, @@ -43203,7 +41093,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -43217,7 +41107,7 @@ { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html#realtime", "name": "realtime", "required": false, "serverDefault": true, @@ -43230,7 +41120,7 @@ } }, { - "description": "A custom value that is used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -43242,7 +41132,7 @@ } }, { - "description": "If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.", + "description": "If `true`, the response includes term frequency and document frequency.", "name": "term_statistics", "required": false, "serverDefault": false, @@ -43267,7 +41157,7 @@ } }, { - "description": "The version type.", + "description": "Specific version type.", "name": "version_type", "required": false, "type": { @@ -43279,7 +41169,7 @@ } } ], - "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L187" + "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L122" }, { "kind": "response", @@ -43545,7 +41435,7 @@ "kind": "properties", "properties": [ { - "description": "If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document.", + "description": "Set to false to disable setting 'result' in the response\nto 'noop' if no change to the document occurred.", "name": "detect_noop", "required": false, "serverDefault": true, @@ -43558,7 +41448,7 @@ } }, { - "description": "A partial update to an existing document.\nIf both `doc` and `script` are specified, `doc` is ignored.", + "description": "A partial update to an existing document.", "name": "doc", "required": false, "type": { @@ -43570,7 +41460,7 @@ } }, { - "description": "If `true`, use the contents of 'doc' as the value of 'upsert'.\nNOTE: Using ingest pipelines with `doc_as_upsert` is not supported.", + "description": "Set to true to use the contents of 'doc' as the value of 'upsert'", "name": "doc_as_upsert", "required": false, "serverDefault": false, @@ -43583,7 +41473,7 @@ } }, { - "description": "The script to run to update the document.", + "description": "Script to execute to update the document.", "name": "script", "required": false, "type": { @@ -43595,7 +41485,7 @@ } }, { - "description": "If `true`, run the script whether or not the document exists.", + "description": "Set to true to execute the script whether or not the document exists.", "name": "scripted_upsert", "required": false, "serverDefault": false, @@ -43608,7 +41498,7 @@ } }, { - "description": "If `false`, turn off source retrieval.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", "name": "_source", "required": false, "serverDefault": "true", @@ -43621,7 +41511,7 @@ } }, { - "description": "If the document does not already exist, the contents of 'upsert' are inserted as a new document.\nIf the document exists, the 'script' is run.", + "description": "If the document does not already exist, the contents of 'upsert' are inserted as a\nnew document. If the document exists, the 'script' is executed.", "name": "upsert", "required": false, "type": { @@ -43634,7 +41524,7 @@ } ] }, - "description": "Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).", + "description": "Update a document.\nUpdates a document by running a script or passing a partial document.", "generics": [ { "name": "TDocument", @@ -43657,7 +41547,7 @@ }, "path": [ { - "description": "A unique identifier for the document to be updated.", + "description": "Document ID", "name": "id", "required": true, "type": { @@ -43669,7 +41559,7 @@ } }, { - "description": "The name of the target index.\nBy default, the index is created automatically if it doesn't exist.", + "description": "The name of the index", "name": "index", "required": true, "type": { @@ -43684,8 +41574,6 @@ "query": [ { "description": "Only perform the operation if the document has this primary term.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", "name": "if_primary_term", "required": false, "type": { @@ -43698,8 +41586,6 @@ }, { "description": "Only perform the operation if the document has this sequence number.", - "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", "name": "if_seq_no", "required": false, "type": { @@ -43724,7 +41610,7 @@ } }, { - "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.", + "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search, if 'wait_for' then wait for a refresh to make this operation\nvisible to search, if 'false' do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": "false", @@ -43737,7 +41623,7 @@ } }, { - "description": "If `true`, the destination must be an index alias.", + "description": "If true, the destination must be an index alias.", "name": "require_alias", "required": false, "serverDefault": false, @@ -43750,7 +41636,7 @@ } }, { - "description": "The number of times the operation should be retried when a conflict occurs.", + "description": "Specify how many times should the operation be retried when a conflict occurs.", "name": "retry_on_conflict", "required": false, "serverDefault": 0, @@ -43763,7 +41649,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -43775,7 +41661,7 @@ } }, { - "description": "The period to wait for the following operations: dynamic mapping updates and waiting for active shards.\nElasticsearch waits for at least the timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", + "description": "Period to wait for dynamic mapping updates and active shards.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -43788,7 +41674,7 @@ } }, { - "description": "The number of copies of each shard 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 value of `1` means it waits for each primary shard to be active.", + "description": "The number of shard copies that must be active before proceeding with the operations.\nSet to 'all' or any positive integer up to the total number of shards in the index\n(number_of_replicas+1). Defaults to 1 meaning the primary shard.", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -43801,7 +41687,7 @@ } }, { - "description": "If `false`, source retrieval is turned off.\nYou can also specify a comma-separated list of the fields you want to retrieve.", + "description": "Set to false to disable source retrieval. You can also specify a comma-separated\nlist of the fields you want to retrieve.", "name": "_source", "required": false, "serverDefault": "true", @@ -43814,7 +41700,7 @@ } }, { - "description": "The source fields you want to exclude.", + "description": "Specify the source fields you want to exclude.", "name": "_source_excludes", "required": false, "type": { @@ -43826,7 +41712,7 @@ } }, { - "description": "The source fields you want to retrieve.", + "description": "Specify the source fields you want to retrieve.", "name": "_source_includes", "required": false, "type": { @@ -43838,7 +41724,7 @@ } } ], - "specLocation": "_global/update/UpdateRequest.ts#L38-L189" + "specLocation": "_global/update/UpdateRequest.ts#L38-L154" }, { "kind": "response", @@ -43936,7 +41822,7 @@ } }, { - "description": "The documents to update using the Query DSL.", + "description": "Specifies the documents to update using the Query DSL.", "name": "query", "required": false, "type": { @@ -43972,7 +41858,7 @@ } }, { - "description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.", + "description": "What to do if update by query hits version conflicts: `abort` or `proceed`.", "name": "conflicts", "required": false, "serverDefault": "abort", @@ -43986,7 +41872,7 @@ } ] }, - "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\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* `index` 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.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\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 update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update 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 turn off 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\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\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.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating 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 point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\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* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Update the document source**\n\nUpdate by query supports scripts to update the document source.\nAs with the update API, you can set `ctx.op` to change the operation that is performed.\n\nSet `ctx.op = \"noop\"` if your script decides that it doesn't have to make any changes.\nThe update by query operation skips updating the document and increments the `noop` counter.\n\nSet `ctx.op = \"delete\"` if your script decides that the document should be deleted.\nThe update by query operation deletes the document and increments the `deleted` counter.\n\nUpdate by query supports only `index`, `noop`, and `delete`.\nSetting `ctx.op` to anything else is an error.\nSetting any other field in `ctx` is an error.\nThis API enables you to only modify the source of matching documents; you cannot move them.", + "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", "inherits": { "type": { "name": "RequestBase", @@ -43999,7 +41885,7 @@ }, "path": [ { - "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`.", + "description": "Comma-separated list of data streams, indices, and aliases to search.\nSupports wildcards (`*`).\nTo search all data streams or indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": true, "type": { @@ -44026,7 +41912,7 @@ } }, { - "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "Analyzer to use for the query string.", "name": "analyzer", "required": false, "type": { @@ -44038,7 +41924,7 @@ } }, { - "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", + "description": "If `true`, wildcard and prefix queries are analyzed.", "name": "analyze_wildcard", "required": false, "serverDefault": false, @@ -44051,7 +41937,7 @@ } }, { - "description": "The preferred behavior when update by query hits version conflicts: `abort` or `proceed`.", + "description": "What to do if update by query hits version conflicts: `abort` or `proceed`.", "name": "conflicts", "required": false, "serverDefault": "abort", @@ -44064,7 +41950,7 @@ } }, { - "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.", + "description": "The default operator for query string query: `AND` or `OR`.", "name": "default_operator", "required": false, "serverDefault": "OR", @@ -44077,7 +41963,7 @@ } }, { - "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.", + "description": "Field to use as default where no field prefix is given in the query string.", "name": "df", "required": false, "type": { @@ -44089,7 +41975,7 @@ } }, { - "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`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "type": { @@ -44126,7 +42012,7 @@ } }, { - "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.", + "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.", "name": "lenient", "required": false, "serverDefault": false, @@ -44139,7 +42025,7 @@ } }, { - "description": "The maximum number of documents to process.\nIt defaults to all documents.\nWhen set to a value less then or equal to `scroll_size` then a scroll will not be used to retrieve the results for the operation.", + "description": "Maximum number of documents to process.\nDefaults to all documents.", "name": "max_docs", "required": false, "type": { @@ -44151,7 +42037,7 @@ } }, { - "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", + "description": "ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "name": "pipeline", "required": false, "type": { @@ -44163,7 +42049,7 @@ } }, { - "description": "The node or shard the operation should be performed on.\nIt is random by default.", + "description": "Specifies the node or shard the operation should be performed on.\nRandom by default.", "name": "preference", "required": false, "type": { @@ -44175,7 +42061,7 @@ } }, { - "description": "A query in the Lucene query string syntax.", + "description": "Query in the Lucene query string syntax.", "name": "q", "required": false, "type": { @@ -44187,7 +42073,7 @@ } }, { - "description": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes.\nThis is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed.", + "description": "If `true`, Elasticsearch refreshes affected shards to make the operation visible to search.", "name": "refresh", "required": false, "serverDefault": false, @@ -44200,7 +42086,7 @@ } }, { - "description": "If `true`, the request cache is used for this request.\nIt defaults to the index-level setting.", + "description": "If `true`, the request cache is used for this request.", "name": "request_cache", "required": false, "type": { @@ -44225,7 +42111,7 @@ } }, { - "description": "A custom value used to route operations to a specific shard.", + "description": "Custom value used to route operations to a specific shard.", "name": "routing", "required": false, "type": { @@ -44237,11 +42123,9 @@ } }, { - "description": "The period to retain the search context for scrolling.", - "extDocId": "search-scroll-results", + "description": "Period to retain the search context for scrolling.", "name": "scroll", "required": false, - "serverDefault": "5m", "type": { "kind": "instance_of", "type": { @@ -44251,7 +42135,7 @@ } }, { - "description": "The size of the scroll request that powers the operation.", + "description": "Size of the scroll request that powers the operation.", "name": "scroll_size", "required": false, "serverDefault": 1000, @@ -44264,7 +42148,7 @@ } }, { - "description": "An explicit timeout for each search request.\nBy default, there is no timeout.", + "description": "Explicit timeout for each search request.", "name": "search_timeout", "required": false, "type": { @@ -44276,7 +42160,7 @@ } }, { - "description": "The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`.", + "description": "The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.", "name": "search_type", "required": false, "type": { @@ -44316,7 +42200,7 @@ } }, { - "description": "The specific `tag` of the request for logging and statistical purposes.", + "description": "Specific `tag` of the request for logging and statistical purposes.", "name": "stats", "required": false, "type": { @@ -44331,7 +42215,7 @@ } }, { - "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.", + "description": "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.\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.", "name": "terminate_after", "required": false, "type": { @@ -44343,7 +42227,7 @@ } }, { - "description": "The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.\nBy default, it is one minute.\nThis guarantees Elasticsearch waits for at least the timeout before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.", + "description": "Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.", "name": "timeout", "required": false, "serverDefault": "1m", @@ -44380,7 +42264,7 @@ } }, { - "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` parameter controls how long each write request waits for unavailable shards to become available.\nBoth work exactly the way they work in the bulk API.", + "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`).", "name": "wait_for_active_shards", "required": false, "serverDefault": "1", @@ -44393,7 +42277,7 @@ } }, { - "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 ID that you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.", + "description": "If `true`, the request blocks until the operation is complete.", "name": "wait_for_completion", "required": false, "serverDefault": true, @@ -44406,7 +42290,7 @@ } } ], - "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L336" + "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L227" }, { "kind": "response", @@ -44414,7 +42298,6 @@ "kind": "properties", "properties": [ { - "description": "The number of scroll responses pulled back by the update by query.", "name": "batches", "required": false, "type": { @@ -44426,7 +42309,6 @@ } }, { - "description": "Array of failures if there were any unrecoverable errors during the process.\nIf this is non-empty then the request ended because of those failures.\nUpdate by query is implemented using batches.\nAny failure causes the entire process to end, but all failures in the current batch are collected into the array.\nYou can use the `conflicts` option to prevent reindex from ending when version conflicts occur.", "name": "failures", "required": false, "type": { @@ -44441,7 +42323,6 @@ } }, { - "description": "The number of documents that were ignored because the script used for the update by query returned a noop value for `ctx.op`.", "name": "noops", "required": false, "type": { @@ -44453,7 +42334,6 @@ } }, { - "description": "The number of documents that were successfully deleted.", "name": "deleted", "required": false, "type": { @@ -44465,7 +42345,6 @@ } }, { - "description": "The number of requests per second effectively run during the update by query.", "name": "requests_per_second", "required": false, "type": { @@ -44477,7 +42356,6 @@ } }, { - "description": "The number of retries attempted by update by query.\n`bulk` is the number of bulk actions retried.\n`search` is the number of search actions retried.", "name": "retries", "required": false, "type": { @@ -44500,7 +42378,6 @@ } }, { - "description": "If true, some requests timed out during the update by query.", "name": "timed_out", "required": false, "type": { @@ -44512,7 +42389,6 @@ } }, { - "description": "The number of milliseconds from start to end of the whole operation.", "name": "took", "required": false, "type": { @@ -44533,7 +42409,6 @@ } }, { - "description": "The number of documents that were successfully processed.", "name": "total", "required": false, "type": { @@ -44545,7 +42420,6 @@ } }, { - "description": "The number of documents that were successfully updated.", "name": "updated", "required": false, "type": { @@ -44557,7 +42431,6 @@ } }, { - "description": "The number of version conflicts that the update by query hit.", "name": "version_conflicts", "required": false, "type": { @@ -44580,7 +42453,6 @@ } }, { - "description": "The number of milliseconds the request slept to conform to `requests_per_second`.", "name": "throttled_millis", "required": false, "type": { @@ -44612,7 +42484,6 @@ } }, { - "description": "This field should always be equal to zero in an _update_by_query response.\nIt only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`.", "name": "throttled_until_millis", "required": false, "type": { @@ -44638,7 +42509,7 @@ "name": "Response", "namespace": "_global.update_by_query" }, - "specLocation": "_global/update_by_query/UpdateByQueryResponse.ts#L26-L67" + "specLocation": "_global/update_by_query/UpdateByQueryResponse.ts#L26-L45" }, { "kind": "request", @@ -44675,7 +42546,7 @@ ], "query": [ { - "description": "The throttle for this request in sub-requests per second.\nTo turn off throttling, set it to `-1`.", + "description": "The throttle for this request in sub-requests per second.", "name": "requests_per_second", "required": false, "serverDefault": -1, @@ -44688,7 +42559,7 @@ } } ], - "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L56" + "specLocation": "_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts#L24-L48" }, { "kind": "response", @@ -45004,7 +42875,7 @@ } } ], - "specLocation": "_types/Base.ts#L69-L72" + "specLocation": "_types/Base.ts#L47-L50" }, { "kind": "type_alias", @@ -45013,7 +42884,7 @@ "name": "AggregateName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L148-L152", + "specLocation": "_types/common.ts#L146-L150", "type": { "kind": "instance_of", "type": { @@ -45212,17 +43083,17 @@ } } ], - "specLocation": "_types/Stats.ts#L71-L81" + "specLocation": "_types/Stats.ts#L68-L78" }, { "kind": "type_alias", "docId": "byte-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#byte-units", "name": { "name": "ByteSize", "namespace": "_types" }, - "specLocation": "_types/common.ts#L96-L97", + "specLocation": "_types/common.ts#L97-L98", "type": { "kind": "union_of", "items": [ @@ -45275,7 +43146,7 @@ "name": "Bytes", "namespace": "_types" }, - "specLocation": "_types/common.ts#L172-L184" + "specLocation": "_types/common.ts#L170-L182" }, { "kind": "type_alias", @@ -45418,7 +43289,7 @@ "name": "ClusterInfoTarget", "namespace": "_types" }, - "specLocation": "_types/common.ts#L384-L390" + "specLocation": "_types/common.ts#L382-L388" }, { "kind": "type_alias", @@ -45426,7 +43297,7 @@ "name": "ClusterInfoTargets", "namespace": "_types" }, - "specLocation": "_types/common.ts#L392-L392", + "specLocation": "_types/common.ts#L390-L390", "type": { "kind": "union_of", "items": [ @@ -45627,7 +43498,7 @@ } } ], - "specLocation": "_types/Stats.ts#L83-L93" + "specLocation": "_types/Stats.ts#L80-L90" }, { "kind": "enum", @@ -45645,7 +43516,7 @@ "name": "Conflicts", "namespace": "_types" }, - "specLocation": "_types/common.ts#L186-L195" + "specLocation": "_types/common.ts#L184-L193" }, { "kind": "interface", @@ -45772,11 +43643,13 @@ }, { "kind": "type_alias", + "docId": "data-stream-path-param", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params", "name": { "name": "DataStreamName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L92-L92", + "specLocation": "_types/common.ts#L92-L93", "type": { "kind": "instance_of", "type": { @@ -45791,7 +43664,7 @@ "name": "DataStreamNames", "namespace": "_types" }, - "specLocation": "_types/common.ts#L94-L94", + "specLocation": "_types/common.ts#L95-L95", "type": { "kind": "union_of", "items": [ @@ -45818,7 +43691,7 @@ { "kind": "type_alias", "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html", "name": { "name": "DateFormat", "namespace": "_types" @@ -45977,13 +43850,13 @@ } } ], - "specLocation": "_types/Stats.ts#L100-L112" + "specLocation": "_types/Stats.ts#L97-L109" }, { "kind": "type_alias", "description": "A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and\n`d` (days). Also accepts \"0\" without a unit and \"-1\" to indicate an unspecified value.", "docId": "time-value", - "docUrl": "https://github.com/elastic/elasticsearch/blob/current/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java", + "docUrl": "https://github.com/elastic/elasticsearch/blob/{branch}/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java", "name": { "name": "Duration", "namespace": "_types" @@ -46055,7 +43928,6 @@ }, "properties": [ { - "description": "The Elasticsearch Git commit's date.", "name": "build_date", "required": true, "type": { @@ -46067,7 +43939,6 @@ } }, { - "description": "The build flavor. For example, `default`.", "name": "build_flavor", "required": true, "type": { @@ -46079,7 +43950,6 @@ } }, { - "description": "The Elasticsearch Git commit's SHA hash.", "name": "build_hash", "required": true, "type": { @@ -46091,7 +43961,6 @@ } }, { - "description": "Indicates whether the Elasticsearch build was a snapshot.", "name": "build_snapshot", "required": true, "type": { @@ -46103,7 +43972,6 @@ } }, { - "description": "The build type that corresponds to how Elasticsearch was installed.\nFor example, `docker`, `rpm`, or `tar`.", "name": "build_type", "required": true, "type": { @@ -46115,7 +43983,6 @@ } }, { - "description": "The version number of Elasticsearch's underlying Lucene software.", "name": "lucene_version", "required": true, "type": { @@ -46127,7 +43994,6 @@ } }, { - "description": "The minimum index version with which the responding node can read from disk.", "name": "minimum_index_compatibility_version", "required": true, "type": { @@ -46139,7 +44005,6 @@ } }, { - "description": "The minimum node version with which the responding node can communicate.\nAlso the minimum version from which you can perform a rolling upgrade.", "name": "minimum_wire_compatibility_version", "required": true, "type": { @@ -46151,7 +44016,6 @@ } }, { - "description": "The Elasticsearch version number.", "name": "number", "required": true, "type": { @@ -46163,7 +44027,7 @@ } } ], - "specLocation": "_types/Base.ts#L76-L115" + "specLocation": "_types/Base.ts#L54-L64" }, { "kind": "interface", @@ -46218,7 +44082,7 @@ } } ], - "specLocation": "_types/Base.ts#L117-L125" + "specLocation": "_types/Base.ts#L66-L74" }, { "kind": "interface", @@ -46228,7 +44092,7 @@ "namespace": "_types" }, "properties": [], - "specLocation": "_types/common.ts#L163-L164" + "specLocation": "_types/common.ts#L161-L162" }, { "kind": "type_alias", @@ -46299,7 +44163,7 @@ } }, { - "description": "A human-readable explanation of the error, in English.", + "description": "A human-readable explanation of the error, in english", "name": "reason", "required": false, "type": { @@ -46395,12 +44259,12 @@ } } ], - "specLocation": "_types/Base.ts#L127-L136" + "specLocation": "_types/Base.ts#L76-L85" }, { "kind": "type_alias", "name": { - "name": "EsqlResult", + "name": "EsqlColumns", "namespace": "_types" }, "specLocation": "_types/Binary.ts#L24-L24", @@ -46428,7 +44292,7 @@ "name": "closed" }, { - "description": "Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.", + "description": "Match hidden data streams and hidden indices. Must be combined with open, closed, or both.", "name": "hidden" }, { @@ -46440,7 +44304,7 @@ "name": "ExpandWildcard", "namespace": "_types" }, - "specLocation": "_types/common.ts#L204-L218" + "specLocation": "_types/common.ts#L202-L216" }, { "kind": "type_alias", @@ -46448,7 +44312,7 @@ "name": "ExpandWildcards", "namespace": "_types" }, - "specLocation": "_types/common.ts#L220-L220", + "specLocation": "_types/common.ts#L218-L218", "type": { "kind": "union_of", "items": [ @@ -46479,7 +44343,7 @@ "name": "Field", "namespace": "_types" }, - "specLocation": "_types/common.ts#L141-L142", + "specLocation": "_types/common.ts#L139-L140", "type": { "kind": "instance_of", "type": { @@ -46518,7 +44382,7 @@ } } ], - "specLocation": "_types/Stats.ts#L121-L124" + "specLocation": "_types/Stats.ts#L118-L121" }, { "kind": "interface", @@ -46550,7 +44414,7 @@ } } ], - "specLocation": "_types/Stats.ts#L95-L98" + "specLocation": "_types/Stats.ts#L92-L95" }, { "kind": "interface", @@ -46785,7 +44649,7 @@ } } ], - "specLocation": "_types/Stats.ts#L114-L119" + "specLocation": "_types/Stats.ts#L111-L116" }, { "kind": "type_alias", @@ -46793,7 +44657,7 @@ "name": "Fields", "namespace": "_types" }, - "specLocation": "_types/common.ts#L143-L143", + "specLocation": "_types/common.ts#L141-L141", "type": { "kind": "union_of", "items": [ @@ -46878,17 +44742,17 @@ } } ], - "specLocation": "_types/Stats.ts#L126-L131" + "specLocation": "_types/Stats.ts#L123-L128" }, { "kind": "type_alias", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": { "name": "Fuzziness", "namespace": "_types" }, - "specLocation": "_types/common.ts#L136-L137", + "specLocation": "_types/common.ts#L134-L135", "type": { "kind": "union_of", "items": [ @@ -47487,7 +45351,7 @@ } } ], - "specLocation": "_types/Stats.ts#L133-L144" + "specLocation": "_types/Stats.ts#L130-L141" }, { "kind": "type_alias", @@ -47533,7 +45397,7 @@ "name": "HealthStatus", "namespace": "_types" }, - "specLocation": "_types/common.ts#L222-L242" + "specLocation": "_types/common.ts#L220-L240" }, { "kind": "type_alias", @@ -47556,7 +45420,7 @@ "name": "HttpHeaders", "namespace": "_types" }, - "specLocation": "_types/common.ts#L161-L161", + "specLocation": "_types/common.ts#L159-L159", "type": { "kind": "dictionary_of", "key": { @@ -47942,7 +45806,7 @@ } } ], - "specLocation": "_types/Stats.ts#L146-L162" + "specLocation": "_types/Stats.ts#L143-L159" }, { "kind": "type_alias", @@ -48033,7 +45897,7 @@ } } ], - "specLocation": "_types/common.ts#L338-L365" + "specLocation": "_types/common.ts#L336-L363" }, { "kind": "interface", @@ -48060,7 +45924,7 @@ } } ], - "specLocation": "_types/Base.ts#L138-L140" + "specLocation": "_types/Base.ts#L87-L89" }, { "kind": "interface", @@ -48176,7 +46040,7 @@ } } ], - "specLocation": "_types/common.ts#L323-L336" + "specLocation": "_types/common.ts#L321-L334" }, { "kind": "type_alias", @@ -48196,7 +46060,7 @@ { "kind": "interface", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", "inherits": { "type": { "name": "QueryBase", @@ -48306,30 +46170,9 @@ "namespace": "_types" } } - }, - { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Apply oversampling and rescoring to quantized vectors *", - "name": "rescore_vector", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RescoreVector", - "namespace": "_types" - } - } } ], - "specLocation": "_types/Knn.ts#L64-L87" + "specLocation": "_types/Knn.ts#L54-L72" }, { "kind": "interface", @@ -48415,30 +46258,9 @@ "namespace": "_types" } } - }, - { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Apply oversampling and rescoring to quantized vectors *", - "name": "rescore_vector", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RescoreVector", - "namespace": "_types" - } - } } ], - "specLocation": "_types/Retriever.ts#L64-L82" + "specLocation": "_types/Retriever.ts#L64-L77" }, { "kind": "interface", @@ -48561,7 +46383,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "knn-inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#nested-knn-search-inner-hits", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/knn-search.html#nested-knn-search-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -48571,30 +46393,9 @@ "namespace": "_global.search._types" } } - }, - { - "availability": { - "serverless": { - "stability": "experimental" - }, - "stack": { - "since": "8.18.0", - "stability": "experimental" - } - }, - "description": "Apply oversampling and rescoring to quantized vectors *", - "name": "rescore_vector", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RescoreVector", - "namespace": "_types" - } - } } ], - "specLocation": "_types/Knn.ts#L35-L62" + "specLocation": "_types/Knn.ts#L30-L52" }, { "kind": "interface", @@ -48647,7 +46448,7 @@ "name": "Level", "namespace": "_types" }, - "specLocation": "_types/common.ts#L252-L256" + "specLocation": "_types/common.ts#L250-L254" }, { "kind": "enum", @@ -48894,7 +46695,7 @@ } } ], - "specLocation": "_types/Stats.ts#L164-L181" + "specLocation": "_types/Stats.ts#L161-L178" }, { "kind": "type_alias", @@ -48902,7 +46703,7 @@ "name": "Metadata", "namespace": "_types" }, - "specLocation": "_types/common.ts#L99-L99", + "specLocation": "_types/common.ts#L100-L100", "type": { "kind": "dictionary_of", "key": { @@ -48952,12 +46753,12 @@ "kind": "type_alias", "description": "The minimum number of terms that should match as integer, percentage or range", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": { "name": "MinimumShouldMatch", "namespace": "_types" }, - "specLocation": "_types/common.ts#L166-L170", + "specLocation": "_types/common.ts#L164-L168", "type": { "kind": "union_of", "items": [ @@ -48981,12 +46782,12 @@ { "kind": "type_alias", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": { "name": "MultiTermQueryRewrite", "namespace": "_types" }, - "specLocation": "_types/common.ts#L138-L139", + "specLocation": "_types/common.ts#L136-L137", "type": { "kind": "instance_of", "type": { @@ -49238,7 +47039,7 @@ { "kind": "type_alias", "docId": "modules-node", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-node.html", "name": { "name": "NodeName", "namespace": "_types" @@ -49579,7 +47380,7 @@ "name": "OpType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L258-L267" + "specLocation": "_types/common.ts#L256-L265" }, { "kind": "type_alias", @@ -49587,7 +47388,7 @@ "name": "Password", "namespace": "_types" }, - "specLocation": "_types/common.ts#L198-L198", + "specLocation": "_types/common.ts#L196-L196", "type": { "kind": "instance_of", "type": { @@ -49748,7 +47549,7 @@ } } ], - "specLocation": "_types/Stats.ts#L183-L193" + "specLocation": "_types/Stats.ts#L180-L190" }, { "kind": "type_alias", @@ -49756,7 +47557,7 @@ "name": "PropertyName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L133-L133", + "specLocation": "_types/common.ts#L131-L131", "type": { "kind": "instance_of", "type": { @@ -49869,7 +47670,7 @@ } } ], - "specLocation": "_types/Stats.ts#L195-L229" + "specLocation": "_types/Stats.ts#L192-L226" }, { "kind": "type_alias", @@ -49908,7 +47709,7 @@ } } ], - "specLocation": "_types/Knn.ts#L89-L92", + "specLocation": "_types/Knn.ts#L74-L77", "variants": { "kind": "container" } @@ -49966,7 +47767,7 @@ } } ], - "specLocation": "_types/Retriever.ts#L84-L91" + "specLocation": "_types/Retriever.ts#L79-L86" }, { "kind": "interface", @@ -50063,7 +47864,7 @@ } } ], - "specLocation": "_types/Stats.ts#L231-L236" + "specLocation": "_types/Stats.ts#L228-L233" }, { "kind": "enum", @@ -50083,7 +47884,7 @@ "name": "Refresh", "namespace": "_types" }, - "specLocation": "_types/common.ts#L269-L276" + "specLocation": "_types/common.ts#L267-L274" }, { "kind": "interface", @@ -50177,7 +47978,7 @@ } } ], - "specLocation": "_types/Stats.ts#L238-L245" + "specLocation": "_types/Stats.ts#L235-L242" }, { "kind": "type_alias", @@ -50185,7 +47986,7 @@ "name": "RelationName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L134-L134", + "specLocation": "_types/common.ts#L132-L132", "type": { "kind": "instance_of", "type": { @@ -50298,29 +48099,7 @@ } } ], - "specLocation": "_types/Stats.ts#L247-L253" - }, - { - "kind": "interface", - "name": { - "name": "RescoreVector", - "namespace": "_types" - }, - "properties": [ - { - "description": "Applies the specified oversample factor to k on the approximate kNN search", - "name": "oversample", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - } - ], - "specLocation": "_types/Knn.ts#L30-L33" + "specLocation": "_types/Stats.ts#L244-L250" }, { "kind": "enum", @@ -50356,7 +48135,6 @@ }, "properties": [ { - "description": "The number of bulk actions retried.", "name": "bulk", "required": true, "type": { @@ -50368,7 +48146,6 @@ } }, { - "description": "The number of search actions retried.", "name": "search", "required": true, "type": { @@ -50380,7 +48157,7 @@ } } ], - "specLocation": "_types/Retries.ts#L22-L31" + "specLocation": "_types/Retries.ts#L22-L25" }, { "kind": "interface", @@ -50620,7 +48397,7 @@ } } ], - "specLocation": "_types/Retriever.ts#L106-L115" + "specLocation": "_types/Retriever.ts#L101-L110" }, { "kind": "type_alias", @@ -50786,7 +48563,7 @@ } ], "shortcutProperty": "source", - "specLocation": "_types/Scripting.ts#L75-L99" + "specLocation": "_types/Scripting.ts#L73-L97" }, { "kind": "interface", @@ -50818,7 +48595,7 @@ } } ], - "specLocation": "_types/Scripting.ts#L101-L104" + "specLocation": "_types/Scripting.ts#L99-L102" }, { "kind": "enum", @@ -51291,7 +49068,7 @@ } } ], - "specLocation": "_types/Stats.ts#L255-L274" + "specLocation": "_types/Stats.ts#L252-L271" }, { "kind": "interface", @@ -51341,7 +49118,7 @@ "name": "SearchType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L278-L283" + "specLocation": "_types/common.ts#L276-L281" }, { "kind": "interface", @@ -51648,7 +49425,7 @@ } } ], - "specLocation": "_types/Stats.ts#L276-L369" + "specLocation": "_types/Stats.ts#L273-L366" }, { "kind": "type_alias", @@ -51656,7 +49433,7 @@ "name": "SequenceNumber", "namespace": "_types" }, - "specLocation": "_types/common.ts#L131-L131", + "specLocation": "_types/common.ts#L129-L129", "type": { "kind": "instance_of", "type": { @@ -51753,7 +49530,6 @@ }, "properties": [ { - "description": "The number of shards the operation or search attempted to run on but failed.", "name": "failed", "required": true, "type": { @@ -51765,7 +49541,7 @@ } }, { - "description": "The number of shards the operation or search succeeded on.", + "description": "Indicates how many shards have successfully run the search.", "name": "successful", "required": true, "type": { @@ -51777,7 +49553,7 @@ } }, { - "description": "The number of shards the operation or search will run on overall.", + "description": "Indicates how many shards the search will run on overall.", "name": "total", "required": true, "type": { @@ -51814,7 +49590,7 @@ } } ], - "specLocation": "_types/Stats.ts#L54-L69" + "specLocation": "_types/Stats.ts#L54-L66" }, { "kind": "interface", @@ -51835,7 +49611,7 @@ } } ], - "specLocation": "_types/Base.ts#L142-L145" + "specLocation": "_types/Base.ts#L91-L94" }, { "kind": "interface", @@ -51891,7 +49667,7 @@ "name": "Slices", "namespace": "_types" }, - "specLocation": "_types/common.ts#L367-L372", + "specLocation": "_types/common.ts#L365-L370", "type": { "kind": "union_of", "items": [ @@ -51924,7 +49700,7 @@ "name": "SlicesCalculation", "namespace": "_types" }, - "specLocation": "_types/common.ts#L374-L382" + "specLocation": "_types/common.ts#L372-L380" }, { "kind": "type_alias", @@ -52046,7 +49822,7 @@ } ], "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": { "name": "SortOptions", "namespace": "_types" @@ -52294,7 +50070,7 @@ } } ], - "specLocation": "_types/Stats.ts#L371-L398" + "specLocation": "_types/Stats.ts#L368-L395" }, { "kind": "interface", @@ -52304,7 +50080,7 @@ }, "properties": [ { - "description": "The language the script is written in.\nFor serach templates, use `mustache`.", + "description": "Specifies the language the script is written in.", "name": "lang", "required": true, "type": { @@ -52338,7 +50114,7 @@ } }, { - "description": "The script source.\nFor search templates, an object containing the search template.", + "description": "The script source.", "name": "source", "required": true, "type": { @@ -52350,22 +50126,7 @@ } } ], - "specLocation": "_types/Scripting.ts#L47-L59" - }, - { - "kind": "type_alias", - "name": { - "name": "StreamResult", - "namespace": "_types" - }, - "specLocation": "_types/Binary.ts#L27-L27", - "type": { - "kind": "instance_of", - "type": { - "name": "binary", - "namespace": "_builtins" - } - } + "specLocation": "_types/Scripting.ts#L47-L57" }, { "kind": "enum", @@ -52387,7 +50148,7 @@ "name": "SuggestMode", "namespace": "_types" }, - "specLocation": "_types/common.ts#L285-L298" + "specLocation": "_types/common.ts#L283-L296" }, { "kind": "type_alias", @@ -52396,7 +50157,7 @@ "name": "SuggestionName", "namespace": "_types" }, - "specLocation": "_types/common.ts#L154-L158", + "specLocation": "_types/common.ts#L152-L156", "type": { "kind": "instance_of", "type": { @@ -52465,7 +50226,7 @@ "name": "TaskId", "namespace": "_types" }, - "specLocation": "_types/common.ts#L135-L135", + "specLocation": "_types/common.ts#L133-L133", "type": { "kind": "union_of", "items": [ @@ -52516,7 +50277,7 @@ } } ], - "specLocation": "_types/Knn.ts#L94-L97" + "specLocation": "_types/Knn.ts#L79-L82" }, { "kind": "interface", @@ -52592,7 +50353,7 @@ } } ], - "specLocation": "_types/Retriever.ts#L93-L104" + "specLocation": "_types/Retriever.ts#L88-L99" }, { "kind": "enum", @@ -52617,7 +50378,7 @@ "name": "ThreadType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L300-L306" + "specLocation": "_types/common.ts#L298-L304" }, { "kind": "type_alias", @@ -52886,7 +50647,7 @@ } } ], - "specLocation": "_types/Stats.ts#L400-L408" + "specLocation": "_types/Stats.ts#L397-L405" }, { "kind": "type_alias", @@ -52973,7 +50734,7 @@ "name": "Username", "namespace": "_types" }, - "specLocation": "_types/common.ts#L197-L197", + "specLocation": "_types/common.ts#L195-L195", "type": { "kind": "instance_of", "type": { @@ -52988,7 +50749,7 @@ "name": "Uuid", "namespace": "_types" }, - "specLocation": "_types/common.ts#L128-L128", + "specLocation": "_types/common.ts#L126-L126", "type": { "kind": "instance_of", "type": { @@ -53003,7 +50764,7 @@ "name": "VersionNumber", "namespace": "_types" }, - "specLocation": "_types/common.ts#L102-L102", + "specLocation": "_types/common.ts#L103-L103", "type": { "kind": "instance_of", "type": { @@ -53018,7 +50779,7 @@ "name": "VersionString", "namespace": "_types" }, - "specLocation": "_types/common.ts#L104-L104", + "specLocation": "_types/common.ts#L105-L105", "type": { "kind": "instance_of", "type": { @@ -53035,15 +50796,14 @@ "name": "internal" }, { - "description": "Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.", + "description": "Only index the document if the given version is strictly higher than the version of the stored document or if there is no existing document.", "name": "external" }, { - "description": "Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.", + "description": "Only index the document if the given version is equal or higher than the version of the stored document or if there is no existing document.\nNote: the external_gte version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.", "name": "external_gte" }, { - "description": "This option is deprecated because it can cause primary and replica shards to diverge.", "name": "force" } ], @@ -53051,7 +50811,7 @@ "name": "VersionType", "namespace": "_types" }, - "specLocation": "_types/common.ts#L106-L125" + "specLocation": "_types/common.ts#L107-L123" }, { "kind": "enum", @@ -53067,7 +50827,7 @@ "name": "WaitForActiveShardOptions", "namespace": "_types" }, - "specLocation": "_types/common.ts#L308-L312" + "specLocation": "_types/common.ts#L306-L310" }, { "kind": "type_alias", @@ -53079,7 +50839,7 @@ "name": "WaitForActiveShards", "namespace": "_types" }, - "specLocation": "_types/common.ts#L145-L146", + "specLocation": "_types/common.ts#L143-L144", "type": { "kind": "union_of", "items": [ @@ -53126,7 +50886,7 @@ "name": "WaitForEvents", "namespace": "_types" }, - "specLocation": "_types/common.ts#L314-L321" + "specLocation": "_types/common.ts#L312-L319" }, { "kind": "interface", @@ -53189,7 +50949,7 @@ } } ], - "specLocation": "_types/Stats.ts#L410-L415" + "specLocation": "_types/Stats.ts#L407-L412" }, { "kind": "interface", @@ -53220,7 +50980,6 @@ }, "properties": [ { - "description": "The unique identifier for the added document.", "name": "_id", "required": true, "type": { @@ -53232,7 +50991,6 @@ } }, { - "description": "The name of the index the document was added to.", "name": "_index", "required": true, "type": { @@ -53244,7 +51002,6 @@ } }, { - "description": "The primary term assigned to the document for the indexing operation.", "name": "_primary_term", "required": false, "type": { @@ -53256,7 +51013,6 @@ } }, { - "description": "The result of the indexing operation: `created` or `updated`.", "name": "result", "required": true, "type": { @@ -53268,7 +51024,6 @@ } }, { - "description": "The sequence number assigned to the document for the indexing operation.\nSequence numbers are used to ensure an older version of a document doesn't overwrite a newer version.", "name": "_seq_no", "required": false, "type": { @@ -53280,7 +51035,6 @@ } }, { - "description": "Information about the replication process of the operation.", "name": "_shards", "required": true, "type": { @@ -53292,7 +51046,6 @@ } }, { - "description": "The document version, which is incremented each time the document is updated.", "name": "_version", "required": true, "type": { @@ -53315,7 +51068,7 @@ } } ], - "specLocation": "_types/Base.ts#L36-L67" + "specLocation": "_types/Base.ts#L36-L45" }, { "kind": "type_alias", @@ -53440,7 +51193,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html", "inherits": { "generics": [ { @@ -53548,7 +51301,7 @@ { "kind": "type_alias", "extDocId": "search-aggregations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations.html", "name": { "name": "Aggregate", "namespace": "_types.aggregations" @@ -54185,7 +51938,7 @@ { "description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.", "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html", "name": "adjacency_matrix", "required": false, "type": { @@ -54199,7 +51952,7 @@ { "description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", "name": "auto_date_histogram", "required": false, "type": { @@ -54213,7 +51966,7 @@ { "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html", "name": "avg", "required": false, "type": { @@ -54227,7 +51980,7 @@ { "description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html", "name": "avg_bucket", "required": false, "type": { @@ -54241,7 +51994,7 @@ { "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html", "name": "boxplot", "required": false, "type": { @@ -54255,7 +52008,7 @@ { "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html", "name": "bucket_script", "required": false, "type": { @@ -54269,7 +52022,7 @@ { "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html", "name": "bucket_selector", "required": false, "type": { @@ -54283,7 +52036,7 @@ { "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html", "name": "bucket_sort", "required": false, "type": { @@ -54305,7 +52058,7 @@ }, "description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.", "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html", "name": "bucket_count_ks_test", "required": false, "type": { @@ -54327,7 +52080,7 @@ }, "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.", "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html", "name": "bucket_correlation", "required": false, "type": { @@ -54341,7 +52094,7 @@ { "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", "extDocId": "search-aggregations-metrics-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html", "name": "cardinality", "required": false, "type": { @@ -54363,7 +52116,7 @@ }, "description": "A multi-bucket aggregation that groups semi-structured text into buckets.", "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html", "name": "categorize_text", "required": false, "type": { @@ -54377,7 +52130,7 @@ { "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.", "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html", "name": "children", "required": false, "type": { @@ -54403,7 +52156,7 @@ { "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", "name": "cumulative_cardinality", "required": false, "type": { @@ -54417,7 +52170,7 @@ { "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html", "name": "cumulative_sum", "required": false, "type": { @@ -54431,7 +52184,7 @@ { "description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html", "name": "date_histogram", "required": false, "type": { @@ -54445,7 +52198,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html", "name": "date_range", "required": false, "type": { @@ -54459,7 +52212,7 @@ { "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html", "name": "derivative", "required": false, "type": { @@ -54473,7 +52226,7 @@ { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.", "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html", "name": "diversified_sampler", "required": false, "type": { @@ -54487,7 +52240,7 @@ { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html", "name": "extended_stats", "required": false, "type": { @@ -54501,7 +52254,7 @@ { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-extended-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-extended-stats-bucket-aggregation.html", "name": "extended_stats_bucket", "required": false, "type": { @@ -54515,7 +52268,7 @@ { "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.", "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html", "name": "frequent_item_sets", "required": false, "type": { @@ -54529,7 +52282,7 @@ { "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html", "name": "filter", "required": false, "type": { @@ -54543,7 +52296,7 @@ { "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filters-aggregation.html", "name": "filters", "required": false, "type": { @@ -54557,7 +52310,7 @@ { "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", "name": "geo_bounds", "required": false, "type": { @@ -54571,7 +52324,7 @@ { "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.", "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geocentroid-aggregation.html", "name": "geo_centroid", "required": false, "type": { @@ -54585,7 +52338,7 @@ { "description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.", "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geodistance-aggregation.html", "name": "geo_distance", "required": false, "type": { @@ -54599,7 +52352,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.", "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohashgrid-aggregation.html", "name": "geohash_grid", "required": false, "type": { @@ -54613,7 +52366,7 @@ { "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.", "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geo-line.html", "name": "geo_line", "required": false, "type": { @@ -54627,7 +52380,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.", "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geotilegrid-aggregation.html", "name": "geotile_grid", "required": false, "type": { @@ -54641,7 +52394,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.", "extDocId": "search-aggregations-bucket-geohexgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohexgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohexgrid-aggregation.html", "name": "geohex_grid", "required": false, "type": { @@ -54655,7 +52408,7 @@ { "description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.", "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-global-aggregation.html", "name": "global", "required": false, "type": { @@ -54669,7 +52422,7 @@ { "description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-histogram-aggregation.html", "name": "histogram", "required": false, "type": { @@ -54683,7 +52436,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-iprange-aggregation.html", "name": "ip_range", "required": false, "type": { @@ -54697,7 +52450,7 @@ { "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.", "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-ipprefix-aggregation.html", "name": "ip_prefix", "required": false, "type": { @@ -54711,7 +52464,7 @@ { "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.", "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-inference-bucket-aggregation.html", "name": "inference", "required": false, "type": { @@ -54736,7 +52489,7 @@ { "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.", "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-matrix-stats-aggregation.html", "name": "matrix_stats", "required": false, "type": { @@ -54750,7 +52503,7 @@ { "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-max-aggregation.html", "name": "max", "required": false, "type": { @@ -54764,7 +52517,7 @@ { "description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-max-bucket-aggregation.html", "name": "max_bucket", "required": false, "type": { @@ -54778,7 +52531,7 @@ { "description": "A single-value aggregation that approximates the median absolute deviation of its search results.", "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-median-absolute-deviation-aggregation.html", "name": "median_absolute_deviation", "required": false, "type": { @@ -54792,7 +52545,7 @@ { "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-min-aggregation.html", "name": "min", "required": false, "type": { @@ -54806,7 +52559,7 @@ { "description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-min-bucket-aggregation.html", "name": "min_bucket", "required": false, "type": { @@ -54820,7 +52573,7 @@ { "description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).", "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-missing-aggregation.html", "name": "missing", "required": false, "type": { @@ -54845,7 +52598,7 @@ { "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.", "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-moving-percentiles-aggregation.html", "name": "moving_percentiles", "required": false, "type": { @@ -54859,7 +52612,7 @@ { "description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.", "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-movfn-aggregation.html", "name": "moving_fn", "required": false, "type": { @@ -54873,7 +52626,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.", "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-multi-terms-aggregation.html", "name": "multi_terms", "required": false, "type": { @@ -54887,7 +52640,7 @@ { "description": "A special single bucket aggregation that enables aggregating nested documents.", "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-nested-aggregation.html", "name": "nested", "required": false, "type": { @@ -54901,7 +52654,7 @@ { "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.", "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-normalize-aggregation.html", "name": "normalize", "required": false, "type": { @@ -54915,7 +52668,7 @@ { "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.", "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-parent-aggregation.html", "name": "parent", "required": false, "type": { @@ -54929,7 +52682,7 @@ { "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-rank-aggregation.html", "name": "percentile_ranks", "required": false, "type": { @@ -54943,7 +52696,7 @@ { "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-percentile-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-aggregation.html", "name": "percentiles", "required": false, "type": { @@ -54957,7 +52710,7 @@ { "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-percentiles-bucket-aggregation.html", "name": "percentiles_bucket", "required": false, "type": { @@ -54971,7 +52724,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-range-aggregation.html", "name": "range", "required": false, "type": { @@ -54985,7 +52738,7 @@ { "description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.", "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-rare-terms-aggregation.html", "name": "rare_terms", "required": false, "type": { @@ -54999,7 +52752,7 @@ { "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.", "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-rate-aggregation.html", "name": "rate", "required": false, "type": { @@ -55013,7 +52766,7 @@ { "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.", "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-reverse-nested-aggregation.html", "name": "reverse_nested", "required": false, "type": { @@ -55033,7 +52786,7 @@ }, "description": "A single bucket aggregation that randomly includes documents in the aggregated results.\nSampling provides significant speed improvement at the cost of accuracy.", "extDocId": "search-aggregations-random-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-random-sampler-aggregation.html", "name": "random_sampler", "required": false, "type": { @@ -55047,7 +52800,7 @@ { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.", "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-sampler-aggregation.html", "name": "sampler", "required": false, "type": { @@ -55061,7 +52814,7 @@ { "description": "A metric aggregation that uses scripts to provide a metric output.", "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-scripted-metric-aggregation.html", "name": "scripted_metric", "required": false, "type": { @@ -55075,7 +52828,7 @@ { "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.", "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-serialdiff-aggregation.html", "name": "serial_diff", "required": false, "type": { @@ -55089,7 +52842,7 @@ { "description": "Returns interesting or unusual occurrences of terms in a set.", "extDocId": "search-aggregations-bucket-significantterms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html", "name": "significant_terms", "required": false, "type": { @@ -55103,7 +52856,7 @@ { "description": "Returns interesting or unusual occurrences of free-text terms in a set.", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "name": "significant_text", "required": false, "type": { @@ -55117,7 +52870,7 @@ { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-stats-aggregation.html", "name": "stats", "required": false, "type": { @@ -55131,7 +52884,7 @@ { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-stats-bucket-aggregation.html", "name": "stats_bucket", "required": false, "type": { @@ -55145,7 +52898,7 @@ { "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-string-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-string-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-string-stats-aggregation.html", "name": "string_stats", "required": false, "type": { @@ -55159,7 +52912,7 @@ { "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-sum-aggregation.html", "name": "sum", "required": false, "type": { @@ -55173,7 +52926,7 @@ { "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-sum-bucket-aggregation.html", "name": "sum_bucket", "required": false, "type": { @@ -55187,7 +52940,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-terms-aggregation.html", "name": "terms", "required": false, "type": { @@ -55209,7 +52962,7 @@ }, "description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.", "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-time-series-aggregation.html", "name": "time_series", "required": false, "type": { @@ -55223,7 +52976,7 @@ { "description": "A metric aggregation that returns the top matching documents per bucket.", "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-hits-aggregation.html", "name": "top_hits", "required": false, "type": { @@ -55237,7 +52990,7 @@ { "description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-ttest-aggregation.html", "name": "t_test", "required": false, "type": { @@ -55251,7 +53004,7 @@ { "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.", "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-metrics.html", "name": "top_metrics", "required": false, "type": { @@ -55265,7 +53018,7 @@ { "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-valuecount-aggregation.html", "name": "value_count", "required": false, "type": { @@ -55279,7 +53032,7 @@ { "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-weight-avg-aggregation.html", "name": "weighted_avg", "required": false, "type": { @@ -55293,7 +53046,7 @@ { "description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-variablewidthhistogram-aggregation.html", "name": "variable_width_histogram", "required": false, "type": { @@ -55439,7 +53192,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", "inherits": { "generics": [ { @@ -55478,7 +53231,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -55625,7 +53378,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -55642,7 +53395,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -55660,7 +53413,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -55878,7 +53631,7 @@ "kind": "interface", "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html", "inherits": { "type": { "name": "BucketPathAggregation", @@ -56005,7 +53758,7 @@ "kind": "interface", "description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.", "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html", "inherits": { "type": { "name": "BucketPathAggregation", @@ -56109,7 +53862,7 @@ { "description": "Path to the buckets that contain one set of values to correlate.", "docId": "search-aggregations-pipeline-bucket-path", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#buckets-path-syntax", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#buckets-path-syntax", "name": "buckets_path", "required": false, "type": { @@ -56126,7 +53879,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -56156,7 +53909,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -56186,7 +53939,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html", "inherits": { "type": { "name": "Aggregation", @@ -56213,7 +53966,7 @@ { "description": "The policy to apply when gaps are found in the data.", "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy", "name": "gap_policy", "required": false, "serverDefault": "skip", @@ -56240,7 +53993,7 @@ { "description": "The list of fields to sort on.", "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -56532,7 +54285,7 @@ "kind": "interface", "description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.", "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html", "inherits": { "type": { "name": "Aggregation", @@ -56745,7 +54498,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -56854,7 +54607,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-composite-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-composite-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -57282,7 +55035,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -57299,7 +55052,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -57365,7 +55118,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html", "inherits": { "generics": [ { @@ -57665,7 +55418,7 @@ "kind": "interface", "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html", "inherits": { "type": { "name": "RangeAggregate", @@ -57820,7 +55573,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -57876,7 +55629,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -58119,7 +55872,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html", "inherits": { "type": { "name": "StatsAggregate", @@ -58483,7 +56236,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -58501,7 +56254,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filters-aggregation.html", "inherits": { "generics": [ { @@ -58700,7 +56453,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html", "name": { "name": "FrequentItemSetsAggregation", "namespace": "_types.aggregations" @@ -58900,7 +56653,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -58930,7 +56683,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", "inherits": { "type": { "name": "MetricAggregationBase", @@ -58961,7 +56714,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geocentroid-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -59041,7 +56794,7 @@ "kind": "interface", "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geodistance-aggregation.html", "inherits": { "type": { "name": "RangeAggregate", @@ -59165,7 +56918,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohashgrid-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -59330,7 +57083,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geo-line.html", "inherits": { "type": { "name": "AggregateBase", @@ -59494,7 +57247,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geotilegrid-aggregation.html", "inherits": { "generics": [ { @@ -59710,7 +57463,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-global-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -59819,7 +57572,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-histogram-aggregation.html", "inherits": { "generics": [ { @@ -60275,7 +58028,7 @@ } ], "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-inference-bucket-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -60542,7 +58295,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-ipprefix-aggregation.html", "inherits": { "generics": [ { @@ -60723,7 +58476,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-iprange-aggregation.html", "inherits": { "generics": [ { @@ -61180,7 +58933,7 @@ { "kind": "interface", "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-matrix-stats-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -61373,7 +59126,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-max-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -61406,7 +59159,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-max-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -61439,7 +59192,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-median-absolute-deviation-aggregation.html", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -61515,7 +59268,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-min-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -61548,7 +59301,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-min-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -61637,7 +59390,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-missing-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -61814,7 +59567,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-movfn-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -61869,7 +59622,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-moving-percentiles-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -62052,7 +59805,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-multi-terms-aggregation.html", "inherits": { "generics": [ { @@ -62291,7 +60044,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-nested-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -62337,7 +60090,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-normalize-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -62405,7 +60158,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-parent-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -62460,7 +60213,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-rank-aggregation.html", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -62687,7 +60440,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-percentiles-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -62745,7 +60498,7 @@ { "description": "Policy to apply when gaps are found in the data.", "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline.html#gap-policy", "name": "gap_policy", "required": false, "serverDefault": "skip", @@ -62763,7 +60516,7 @@ { "kind": "interface", "extDocId": "search-aggregations-random-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-random-sampler-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -62822,7 +60575,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-range-aggregation.html", "inherits": { "generics": [ { @@ -63013,7 +60766,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-rare-terms-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -63116,7 +60869,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-rate-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -63219,7 +60972,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-reverse-nested-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -63284,7 +61037,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-sampler-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -63358,7 +61111,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-scripted-metric-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -63467,7 +61220,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-serialdiff-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63618,7 +61371,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "generics": [ { "name": "T", @@ -63673,7 +61426,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -63913,7 +61666,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64522,7 +62275,7 @@ "kind": "interface", "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-stats-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -64691,7 +62444,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-stats-bucket-aggregation.html", "inherits": { "type": { "name": "StatsAggregate", @@ -65053,7 +62806,7 @@ "kind": "interface", "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-sum-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -65086,7 +62839,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-sum-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -65157,7 +62910,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-ttest-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -65338,7 +63091,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-terms-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -65808,7 +63561,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-time-series-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -65892,7 +63645,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-hits-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -66222,7 +63975,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-metrics.html", "inherits": { "type": { "name": "MetricAggregationBase", @@ -66412,7 +64165,7 @@ "kind": "interface", "description": "Value count aggregation result. `value` is always present.", "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-valuecount-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -66510,7 +64263,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-variablewidthhistogram-aggregation.html", "name": { "name": "VariableWidthHistogramAggregation", "namespace": "_types.aggregations" @@ -66776,7 +64529,7 @@ "kind": "interface", "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-weight-avg-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -66797,7 +64550,7 @@ "name": "Analyzer", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/analyzers.ts#L359-L413", + "specLocation": "_types/analysis/analyzers.ts#L437-L491", "type": { "kind": "union_of", "items": [ @@ -67212,7 +64965,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L61-L66" + "specLocation": "_types/analysis/analyzers.ts#L82-L87" }, { "kind": "interface", @@ -67266,7 +65019,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L68-L73" + "specLocation": "_types/analysis/analyzers.ts#L89-L94" }, { "kind": "interface", @@ -67364,7 +65117,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L75-L80" + "specLocation": "_types/analysis/analyzers.ts#L96-L101" }, { "kind": "interface", @@ -67418,7 +65171,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L82-L87" + "specLocation": "_types/analysis/analyzers.ts#L103-L108" }, { "kind": "interface", @@ -67458,7 +65211,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L89-L93" + "specLocation": "_types/analysis/analyzers.ts#L110-L114" }, { "kind": "interface", @@ -67512,7 +65265,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L95-L100" + "specLocation": "_types/analysis/analyzers.ts#L116-L121" }, { "kind": "interface", @@ -67566,7 +65319,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L102-L107" + "specLocation": "_types/analysis/analyzers.ts#L123-L128" }, { "kind": "type_alias", @@ -67575,7 +65328,7 @@ "definition" ], "extDocId": "analysis-charfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html", "name": { "name": "CharFilter", "namespace": "_types.analysis" @@ -67762,7 +65515,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L109-L113" + "specLocation": "_types/analysis/analyzers.ts#L130-L134" }, { "kind": "interface", @@ -67802,7 +65555,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L115-L119" + "specLocation": "_types/analysis/analyzers.ts#L136-L140" }, { "kind": "interface", @@ -68256,7 +66009,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L121-L126" + "specLocation": "_types/analysis/analyzers.ts#L142-L147" }, { "kind": "interface", @@ -68296,7 +66049,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L128-L132" + "specLocation": "_types/analysis/analyzers.ts#L149-L153" }, { "kind": "enum", @@ -68439,7 +66192,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L134-L139" + "specLocation": "_types/analysis/analyzers.ts#L155-L160" }, { "kind": "enum", @@ -68727,7 +66480,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L141-L146" + "specLocation": "_types/analysis/analyzers.ts#L162-L167" }, { "kind": "interface", @@ -68767,7 +66520,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L148-L152" + "specLocation": "_types/analysis/analyzers.ts#L169-L173" }, { "kind": "interface", @@ -68785,6 +66538,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -68796,8 +66553,10 @@ } }, { + "description": "The maximum token size to emit. Tokens larger than this size will be discarded.\nDefaults to `255`", "name": "max_output_size", - "required": true, + "required": false, + "serverDefault": 255, "type": { "kind": "instance_of", "type": { @@ -68807,19 +66566,9 @@ } }, { - "name": "preserve_original", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { + "description": "The character to use to concatenate the terms.\nDefaults to a space.", "name": "separator", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -68829,8 +66578,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -68840,6 +66591,7 @@ } }, { + "description": "The path to a file containing stop words.", "name": "stopwords_path", "required": false, "type": { @@ -68851,7 +66603,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L37-L45" + "specLocation": "_types/analysis/analyzers.ts#L37-L64" }, { "kind": "interface", @@ -68951,7 +66703,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L154-L159" + "specLocation": "_types/analysis/analyzers.ts#L175-L180" }, { "kind": "interface", @@ -69005,7 +66757,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L161-L166" + "specLocation": "_types/analysis/analyzers.ts#L182-L187" }, { "kind": "interface", @@ -69059,7 +66811,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L168-L173" + "specLocation": "_types/analysis/analyzers.ts#L189-L194" }, { "kind": "interface", @@ -69113,7 +66865,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L175-L180" + "specLocation": "_types/analysis/analyzers.ts#L196-L201" }, { "kind": "interface", @@ -69153,7 +66905,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L182-L186" + "specLocation": "_types/analysis/analyzers.ts#L203-L207" }, { "kind": "interface", @@ -69207,7 +66959,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L188-L193" + "specLocation": "_types/analysis/analyzers.ts#L209-L214" }, { "kind": "interface", @@ -69299,7 +67051,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L195-L200" + "specLocation": "_types/analysis/analyzers.ts#L216-L221" }, { "kind": "interface", @@ -69962,7 +67714,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L202-L207" + "specLocation": "_types/analysis/analyzers.ts#L223-L228" }, { "kind": "interface", @@ -70016,7 +67768,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L209-L214" + "specLocation": "_types/analysis/analyzers.ts#L230-L235" }, { "kind": "interface", @@ -70070,7 +67822,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L216-L221" + "specLocation": "_types/analysis/analyzers.ts#L237-L242" }, { "kind": "interface", @@ -70237,6 +67989,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -70248,7 +68004,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L47-L50" + "specLocation": "_types/analysis/analyzers.ts#L66-L70" }, { "kind": "interface", @@ -70814,6 +68570,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -70872,7 +68632,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L52-L59" + "specLocation": "_types/analysis/analyzers.ts#L72-L80" }, { "kind": "interface", @@ -70926,7 +68686,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L223-L228" + "specLocation": "_types/analysis/analyzers.ts#L244-L249" }, { "kind": "interface", @@ -71105,7 +68865,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L230-L235" + "specLocation": "_types/analysis/analyzers.ts#L251-L256" }, { "kind": "interface", @@ -71445,6 +69205,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -71492,7 +69256,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L312-L318" + "specLocation": "_types/analysis/analyzers.ts#L333-L340" }, { "kind": "enum", @@ -71625,7 +69389,7 @@ { "kind": "type_alias", "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html", "name": { "name": "Normalizer", "namespace": "_types.analysis" @@ -71708,7 +69472,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L237-L242" + "specLocation": "_types/analysis/analyzers.ts#L258-L263" }, { "kind": "interface", @@ -71832,6 +69596,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -71843,6 +69611,7 @@ } }, { + "description": "Java regular expression flags. Flags should be pipe-separated, eg \"CASE_INSENSITIVE|COMMENTS\".", "name": "flags", "required": false, "type": { @@ -71854,8 +69623,10 @@ } }, { + "description": "Should terms be lowercased or not.\nDefaults to `true`.", "name": "lowercase", "required": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -71865,8 +69636,10 @@ } }, { + "description": "A Java regular expression.\nDefaults to `\\W+`.", "name": "pattern", - "required": true, + "required": false, + "serverDefault": "\\W+", "type": { "kind": "instance_of", "type": { @@ -71876,8 +69649,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -71885,9 +69660,21 @@ "namespace": "_types.analysis" } } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/analysis/analyzers.ts#L320-L327" + "specLocation": "_types/analysis/analyzers.ts#L342-L375" }, { "kind": "interface", @@ -72167,7 +69954,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L244-L248" + "specLocation": "_types/analysis/analyzers.ts#L265-L269" }, { "kind": "enum", @@ -72477,7 +70264,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L250-L255" + "specLocation": "_types/analysis/analyzers.ts#L271-L276" }, { "kind": "interface", @@ -72614,7 +70401,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L257-L262" + "specLocation": "_types/analysis/analyzers.ts#L278-L283" }, { "kind": "interface", @@ -72668,7 +70455,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L264-L269" + "specLocation": "_types/analysis/analyzers.ts#L285-L290" }, { "kind": "interface", @@ -72722,7 +70509,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L271-L276" + "specLocation": "_types/analysis/analyzers.ts#L292-L297" }, { "kind": "interface", @@ -72854,6 +70641,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -72865,7 +70656,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L329-L332" + "specLocation": "_types/analysis/analyzers.ts#L377-L381" }, { "kind": "interface", @@ -72953,6 +70744,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -72986,7 +70781,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L334-L339" + "specLocation": "_types/analysis/analyzers.ts#L384-L390" }, { "kind": "enum", @@ -73151,7 +70946,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L278-L283" + "specLocation": "_types/analysis/analyzers.ts#L299-L304" }, { "kind": "interface", @@ -73205,7 +71000,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L285-L290" + "specLocation": "_types/analysis/analyzers.ts#L306-L311" }, { "kind": "interface", @@ -73223,8 +71018,10 @@ } }, { + "description": "The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals.\nDefaults to `255`.", "name": "max_token_length", "required": false, + "serverDefault": 255, "type": { "kind": "instance_of", "type": { @@ -73234,8 +71031,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -73243,9 +71042,21 @@ "namespace": "_types.analysis" } } + }, + { + "description": "The path to a file containing stop words.", + "name": "stopwords_path", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "_types/analysis/analyzers.ts#L341-L345" + "specLocation": "_types/analysis/analyzers.ts#L392-L412" }, { "kind": "interface", @@ -73385,6 +71196,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -73396,8 +71211,10 @@ } }, { + "description": "A pre-defined stop words list like `_english_` or an array containing a list of stop words.\nDefaults to `_none_`.", "name": "stopwords", "required": false, + "serverDefault": "_none_", "type": { "kind": "instance_of", "type": { @@ -73407,6 +71224,7 @@ } }, { + "description": "The path to a file containing stop words.", "name": "stopwords_path", "required": false, "type": { @@ -73418,7 +71236,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L347-L352" + "specLocation": "_types/analysis/analyzers.ts#L414-L429" }, { "kind": "interface", @@ -73571,7 +71389,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L292-L297" + "specLocation": "_types/analysis/analyzers.ts#L313-L318" }, { "kind": "enum", @@ -73857,7 +71675,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L306-L310" + "specLocation": "_types/analysis/analyzers.ts#L327-L331" }, { "kind": "interface", @@ -73918,7 +71736,7 @@ "definition" ], "extDocId": "analysis-tokenfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenfilters.html", "name": { "name": "TokenFilter", "namespace": "_types.analysis" @@ -74319,7 +72137,7 @@ "definition" ], "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenizers.html", "name": { "name": "Tokenizer", "namespace": "_types.analysis" @@ -74621,7 +72439,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L299-L304" + "specLocation": "_types/analysis/analyzers.ts#L320-L325" }, { "kind": "interface", @@ -74733,6 +72551,10 @@ } }, { + "deprecation": { + "description": "", + "version": "7.14.0" + }, "name": "version", "required": false, "type": { @@ -74744,7 +72566,7 @@ } } ], - "specLocation": "_types/analysis/analyzers.ts#L354-L357" + "specLocation": "_types/analysis/analyzers.ts#L431-L435" }, { "kind": "interface", @@ -75225,7 +73047,7 @@ } } ], - "specLocation": "_types/mapping/complex.ts#L58-L63" + "specLocation": "_types/mapping/complex.ts#L51-L56" }, { "kind": "interface", @@ -75657,41 +73479,6 @@ ], "specLocation": "_types/mapping/core.ts#L45-L48" }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "PropertyBase", - "namespace": "_types.mapping" - } - }, - "name": { - "name": "CountedKeywordProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "literal_value", - "value": "counted_keyword" - } - }, - { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/mapping/specialized.ts#L55-L62" - }, { "kind": "interface", "name": { @@ -76807,7 +74594,7 @@ } } ], - "specLocation": "_types/mapping/specialized.ts#L64-L67" + "specLocation": "_types/mapping/specialized.ts#L55-L58" }, { "kind": "interface", @@ -76918,9 +74705,6 @@ { "name": "object" }, - { - "name": "passthrough" - }, { "name": "version" }, @@ -76999,9 +74783,6 @@ { "name": "constant_keyword" }, - { - "name": "counted_keyword" - }, { "name": "aggregate_metric_double" }, @@ -77025,7 +74806,7 @@ "name": "FieldType", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/Property.ts#L191-L240" + "specLocation": "_types/mapping/Property.ts#L166-L213" }, { "kind": "interface", @@ -77329,7 +75110,7 @@ "kind": "interface", "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", "docId": "geo-shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geo-shape.html", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -77491,7 +75272,7 @@ } } ], - "specLocation": "_types/mapping/specialized.ts#L69-L72" + "specLocation": "_types/mapping/specialized.ts#L60-L63" }, { "kind": "interface", @@ -77693,7 +75474,7 @@ } } ], - "specLocation": "_types/mapping/specialized.ts#L103-L127" + "specLocation": "_types/mapping/specialized.ts#L94-L118" }, { "kind": "interface", @@ -77905,7 +75686,7 @@ } } ], - "specLocation": "_types/mapping/specialized.ts#L74-L88" + "specLocation": "_types/mapping/specialized.ts#L65-L79" }, { "kind": "interface", @@ -78258,7 +76039,7 @@ { "description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.", "docId": "multi-fields", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-fields.html", "name": "fields", "required": false, "type": { @@ -78283,7 +76064,7 @@ { "description": "Metadata about the field.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "meta", "required": false, "type": { @@ -78358,7 +76139,7 @@ } } ], - "specLocation": "_types/mapping/specialized.ts#L90-L92" + "specLocation": "_types/mapping/specialized.ts#L81-L83" }, { "kind": "interface", @@ -78602,63 +76383,6 @@ }, "specLocation": "_types/mapping/core.ts#L137-L140" }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "CorePropertyBase", - "namespace": "_types.mapping" - } - }, - "name": { - "name": "PassthroughObjectProperty", - "namespace": "_types.mapping" - }, - "properties": [ - { - "name": "type", - "required": false, - "type": { - "kind": "literal_value", - "value": "passthrough" - } - }, - { - "name": "enabled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "priority", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "time_series_dimension", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "_types/mapping/complex.ts#L51-L56" - }, { "kind": "interface", "inherits": { @@ -78746,7 +76470,7 @@ "name": "Property", "namespace": "_types.mapping" }, - "specLocation": "_types/mapping/Property.ts#L119-L189", + "specLocation": "_types/mapping/Property.ts#L96-L164", "type": { "kind": "union_of", "items": [ @@ -78890,13 +76614,6 @@ "namespace": "_types.mapping" } }, - { - "kind": "instance_of", - "type": { - "name": "PassthroughObjectProperty", - "namespace": "_types.mapping" - } - }, { "kind": "instance_of", "type": { @@ -78925,13 +76642,6 @@ "namespace": "_types.mapping" } }, - { - "kind": "instance_of", - "type": { - "name": "CountedKeywordProperty", - "namespace": "_types.mapping" - } - }, { "kind": "instance_of", "type": { @@ -79126,7 +76836,7 @@ { "description": "Metadata about the field.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "meta", "required": false, "type": { @@ -79213,20 +76923,9 @@ } } } - }, - { - "name": "synthetic_source_keep", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SyntheticSourceKeepEnum", - "namespace": "_types.mapping" - } - } } ], - "specLocation": "_types/mapping/Property.ts#L86-L97" + "specLocation": "_types/mapping/Property.ts#L84-L94" }, { "kind": "interface", @@ -79416,7 +77115,7 @@ { "description": "A custom format for `date` type runtime fields.", "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html", "name": "format", "required": false, "type": { @@ -79822,7 +77521,7 @@ "kind": "interface", "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", "docId": "shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -80137,28 +77836,6 @@ ], "specLocation": "_types/mapping/specialized.ts#L43-L48" }, - { - "kind": "enum", - "members": [ - { - "description": "Synthetic source diverges from the original source (default)", - "name": "none" - }, - { - "description": "Arrays of the corresponding field or object preserve the original element ordering and duplicate elements.\nThe synthetic source fragment for such arrays is not guaranteed to match the original source exactly,\ne.g. array [1, 2, [5], [[4, [3]]], 5] may appear as-is or in an equivalent format like [1, 2, 5, 4, 3, 5].\nThe exact format may change in the future, in an effort to reduce the storage overhead of this option.", - "name": "arrays" - }, - { - "description": "The source for both singleton instances and arrays of the corresponding field or object gets recorded.\nWhen applied to objects, the source of all sub-objects and sub-fields gets captured.\nFurthermore, the original source of arrays gets captured and appears in synthetic source with no modifications.", - "name": "all" - } - ], - "name": { - "name": "SyntheticSourceKeepEnum", - "namespace": "_types.mapping" - }, - "specLocation": "_types/mapping/Property.ts#L99-L117" - }, { "kind": "enum", "members": [ @@ -80537,7 +78214,7 @@ } } ], - "specLocation": "_types/mapping/specialized.ts#L94-L101" + "specLocation": "_types/mapping/specialized.ts#L85-L92" }, { "kind": "interface", @@ -80642,7 +78319,7 @@ }, { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -80886,7 +78563,7 @@ { "kind": "interface", "extDocId": "query-dsl-bool-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "inherits": { "type": { "name": "QueryBase", @@ -80928,7 +78605,7 @@ { "description": "Specifies the number or percentage of `should` clauses returned documents must match.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -81026,7 +78703,7 @@ { "kind": "interface", "extDocId": "query-dsl-boosting-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html", "inherits": { "type": { "name": "QueryBase", @@ -81116,7 +78793,7 @@ "name": "CombinedFieldsOperator", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L513-L516" + "specLocation": "_types/query_dsl/abstractions.ts#L512-L515" }, { "kind": "interface", @@ -81187,7 +78864,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "extDocId": "query-dsl-minimum-should-match", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -81212,7 +78889,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L466-L500" + "specLocation": "_types/query_dsl/abstractions.ts#L465-L499" }, { "kind": "enum", @@ -81230,7 +78907,7 @@ "name": "CombinedFieldsZeroTerms", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L518-L527" + "specLocation": "_types/query_dsl/abstractions.ts#L517-L526" }, { "kind": "interface", @@ -81318,7 +78995,7 @@ { "kind": "interface", "extDocId": "query-dsl-constant-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html", "inherits": { "type": { "name": "QueryBase", @@ -81666,7 +79343,7 @@ { "kind": "interface", "extDocId": "query-dsl-dis-max-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html", "inherits": { "type": { "name": "QueryBase", @@ -81717,7 +79394,7 @@ "date" ], "extDocId": "query-dsl-distance-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html", "name": { "name": "DistanceFeatureQuery", "namespace": "_types.query_dsl" @@ -81822,7 +79499,7 @@ { "kind": "interface", "extDocId": "query-dsl-exists-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "inherits": { "type": { "name": "QueryBase", @@ -81858,7 +79535,7 @@ }, "properties": [ { - "description": "A wildcard pattern. The request returns values for field names matching this pattern.", + "description": "Wildcard pattern. The request returns values for field names matching this pattern.", "name": "field", "required": true, "type": { @@ -81870,7 +79547,7 @@ } }, { - "description": "The format in which the values are returned.", + "description": "Format in which the values are returned.", "name": "format", "required": false, "type": { @@ -81894,7 +79571,7 @@ } ], "shortcutProperty": "field", - "specLocation": "_types/query_dsl/abstractions.ts#L529-L543" + "specLocation": "_types/query_dsl/abstractions.ts#L528-L542" }, { "kind": "interface", @@ -81952,7 +79629,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L430-L447" + "specLocation": "_types/query_dsl/abstractions.ts#L429-L446" }, { "kind": "enum", @@ -82244,7 +79921,7 @@ { "kind": "interface", "extDocId": "query-dsl-function-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82340,7 +80017,7 @@ { "kind": "interface", "extDocId": "query-dsl-fuzzy-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82381,7 +80058,7 @@ { "description": "Number of beginning characters left unchanged when creating expansions.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "rewrite", "required": false, "serverDefault": "constant_score", @@ -82409,7 +80086,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -82489,7 +80166,7 @@ } ], "extDocId": "query-dsl-geo-bounding-box-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82644,7 +80321,7 @@ } ], "extDocId": "query-dsl-geo-distance-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82659,7 +80336,7 @@ { "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.", "docId": "distance-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#distance-units", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#distance-units", "name": "distance", "required": true, "type": { @@ -82790,7 +80467,7 @@ "version": "7.12.0" }, "extDocId": "query-dsl-geo-polygon-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-polygon-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82908,7 +80585,7 @@ } ], "extDocId": "query-dsl-geo-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82960,7 +80637,7 @@ { "kind": "interface", "extDocId": "query-dsl-has-child-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html", "inherits": { "type": { "name": "QueryBase", @@ -82988,7 +80665,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inner-hits.html", "name": "inner_hits", "required": false, "type": { @@ -83066,7 +80743,7 @@ { "kind": "interface", "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html", "inherits": { "type": { "name": "QueryBase", @@ -83094,7 +80771,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inner-hits.html", "name": "inner_hits", "required": false, "type": { @@ -83148,7 +80825,7 @@ { "kind": "interface", "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "inherits": { "type": { "name": "QueryBase", @@ -83491,7 +81168,7 @@ { "description": "Analyzer used to normalize the term.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -83578,7 +81255,7 @@ { "description": "Analyzer used to analyze terms in the query.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -83664,7 +81341,7 @@ { "description": "Analyzer used to analyze the `prefix`.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -83705,7 +81382,7 @@ { "kind": "interface", "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-intervals-query.html", "inherits": { "type": { "name": "QueryBase", @@ -83744,7 +81421,7 @@ { "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzzy", "required": false, "type": { @@ -83851,7 +81528,7 @@ ], "description": "Text that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html#_document_input_parameters", "name": { "name": "Like", "namespace": "_types.query_dsl" @@ -83993,7 +81670,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "inherits": { "type": { "name": "QueryBase", @@ -84010,7 +81687,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-bool-prefix-query.html", "inherits": { "type": { "name": "QueryBase", @@ -84025,7 +81702,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -84039,7 +81716,7 @@ { "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -84053,7 +81730,7 @@ { "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "fuzzy_rewrite", "required": false, "type": { @@ -84093,7 +81770,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -84149,7 +81826,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html#query-dsl-match-none-query", "inherits": { "type": { "name": "QueryBase", @@ -84166,7 +81843,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase-prefix.html", "inherits": { "type": { "name": "QueryBase", @@ -84181,7 +81858,7 @@ { "description": "Analyzer used to convert text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -84250,7 +81927,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html", "inherits": { "type": { "name": "QueryBase", @@ -84265,7 +81942,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -84321,7 +81998,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "inherits": { "type": { "name": "QueryBase", @@ -84336,7 +82013,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -84378,7 +82055,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -84392,7 +82069,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "fuzzy_rewrite", "required": false, "type": { @@ -84445,7 +82122,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -84533,7 +82210,7 @@ { "kind": "interface", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html", "inherits": { "type": { "name": "QueryBase", @@ -84548,7 +82225,7 @@ { "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -84694,7 +82371,7 @@ { "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -84810,7 +82487,7 @@ { "kind": "interface", "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html", "inherits": { "type": { "name": "QueryBase", @@ -84825,7 +82502,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -84879,7 +82556,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -84893,7 +82570,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "fuzzy_rewrite", "required": false, "type": { @@ -84946,7 +82623,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -85079,7 +82756,7 @@ { "kind": "interface", "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html", "inherits": { "type": { "name": "QueryBase", @@ -85107,7 +82784,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inner-hits.html", "name": "inner_hits", "required": false, "type": { @@ -85241,7 +82918,7 @@ { "kind": "interface", "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-parent-id-query.html", "inherits": { "type": { "name": "QueryBase", @@ -85296,7 +82973,7 @@ { "kind": "interface", "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-percolate-query.html", "inherits": { "type": { "name": "QueryBase", @@ -85436,7 +83113,7 @@ { "description": "The index that contains the document.", "name": "_index", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -85451,7 +83128,7 @@ { "kind": "interface", "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-pinned-query.html", "inherits": { "type": { "name": "QueryBase", @@ -85515,7 +83192,7 @@ { "kind": "interface", "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "inherits": { "type": { "name": "QueryBase", @@ -85530,7 +83207,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "rewrite", "required": false, "type": { @@ -85609,13 +83286,12 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L453-L464" + "specLocation": "_types/query_dsl/abstractions.ts#L452-L463" }, { "kind": "interface", - "description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "name": { "name": "QueryContainer", "namespace": "_types.query_dsl" @@ -85624,7 +83300,7 @@ { "description": "matches documents matching boolean combinations of other queries.", "extDocId": "query-dsl-bool-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "name": "bool", "required": false, "type": { @@ -85638,7 +83314,7 @@ { "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", "extDocId": "query-dsl-boosting-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html", "name": "boosting", "required": false, "type": { @@ -85684,7 +83360,7 @@ }, "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", "extDocId": "query-dsl-combined-fields-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-combined-fields-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-combined-fields-query.html", "name": "combined_fields", "required": false, "type": { @@ -85698,7 +83374,7 @@ { "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", "extDocId": "query-dsl-constant-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html", "name": "constant_score", "required": false, "type": { @@ -85712,7 +83388,7 @@ { "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.", "extDocId": "query-dsl-dis-max-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html", "name": "dis_max", "required": false, "type": { @@ -85726,7 +83402,7 @@ { "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.", "extDocId": "query-dsl-distance-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html", "name": "distance_feature", "required": false, "type": { @@ -85740,7 +83416,7 @@ { "description": "Returns documents that contain an indexed value for a field.", "extDocId": "query-dsl-exists-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "name": "exists", "required": false, "type": { @@ -85754,7 +83430,7 @@ { "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", "extDocId": "query-dsl-function-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html", "name": "function_score", "required": false, "type": { @@ -85768,7 +83444,7 @@ { "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", "extDocId": "query-dsl-fuzzy-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html", "name": "fuzzy", "required": false, "type": { @@ -85793,7 +83469,7 @@ { "description": "Matches geo_point and geo_shape values that intersect a bounding box.", "extDocId": "query-dsl-geo-bounding-box-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html", "name": "geo_bounding_box", "required": false, "type": { @@ -85807,7 +83483,7 @@ { "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", "extDocId": "query-dsl-geo-distance-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html", "name": "geo_distance", "required": false, "type": { @@ -85836,7 +83512,7 @@ { "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", "extDocId": "query-dsl-geo-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html", "name": "geo_shape", "required": false, "type": { @@ -85850,7 +83526,7 @@ { "description": "Returns parent documents whose joined child documents match a provided query.", "extDocId": "query-dsl-has-child-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html", "name": "has_child", "required": false, "type": { @@ -85864,7 +83540,7 @@ { "description": "Returns child documents whose joined parent document matches a provided query.", "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html", "name": "has_parent", "required": false, "type": { @@ -85878,7 +83554,7 @@ { "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "name": "ids", "required": false, "type": { @@ -85892,7 +83568,7 @@ { "description": "Returns documents based on the order and proximity of matching terms.", "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-intervals-query.html", "name": "intervals", "required": false, "type": { @@ -85917,7 +83593,7 @@ { "description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", "name": "knn", "required": false, "type": { @@ -85931,7 +83607,7 @@ { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "name": "match", "required": false, "type": { @@ -85956,7 +83632,7 @@ { "description": "Matches all documents, giving them all a `_score` of 1.0.", "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "name": "match_all", "required": false, "type": { @@ -85970,7 +83646,7 @@ { "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.", "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-bool-prefix-query.html", "name": "match_bool_prefix", "required": false, "type": { @@ -85995,7 +83671,7 @@ { "description": "Matches no documents.", "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html#query-dsl-match-none-query", "name": "match_none", "required": false, "type": { @@ -86009,7 +83685,7 @@ { "description": "Analyzes the text and creates a phrase query out of the analyzed text.", "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html", "name": "match_phrase", "required": false, "type": { @@ -86034,7 +83710,7 @@ { "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.", "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase-prefix.html", "name": "match_phrase_prefix", "required": false, "type": { @@ -86059,7 +83735,7 @@ { "description": "Returns documents that are \"like\" a given set of documents.", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html", "name": "more_like_this", "required": false, "type": { @@ -86073,7 +83749,7 @@ { "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.", "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html", "name": "multi_match", "required": false, "type": { @@ -86087,7 +83763,7 @@ { "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.", "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html", "name": "nested", "required": false, "type": { @@ -86101,7 +83777,7 @@ { "description": "Returns child documents joined to a specific parent document.", "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-parent-id-query.html", "name": "parent_id", "required": false, "type": { @@ -86115,7 +83791,7 @@ { "description": "Matches queries stored in an index.", "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-percolate-query.html", "name": "percolate", "required": false, "type": { @@ -86129,7 +83805,7 @@ { "description": "Promotes selected documents to rank higher than those matching a given query.", "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-pinned-query.html", "name": "pinned", "required": false, "type": { @@ -86143,7 +83819,7 @@ { "description": "Returns documents that contain a specific prefix in a provided field.", "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "name": "prefix", "required": false, "type": { @@ -86168,7 +83844,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a strict syntax.", "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-query-string-query.html", "name": "query_string", "required": false, "type": { @@ -86182,7 +83858,7 @@ { "description": "Returns documents that contain terms within a provided range.", "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "name": "range", "required": false, "type": { @@ -86207,7 +83883,7 @@ { "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.", "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html", "name": "rank_feature", "required": false, "type": { @@ -86221,7 +83897,7 @@ { "description": "Returns documents that contain terms matching a regular expression.", "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html", "name": "regexp", "required": false, "type": { @@ -86257,7 +83933,7 @@ { "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.", "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html", "name": "script", "required": false, "type": { @@ -86271,7 +83947,7 @@ { "description": "Uses a script to provide a custom score for returned documents.", "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html", "name": "script_score", "required": false, "type": { @@ -86303,7 +83979,7 @@ { "description": "Queries documents that contain fields indexed using the `shape` type.", "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html", "name": "shape", "required": false, "type": { @@ -86317,7 +83993,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "name": "simple_query_string", "required": false, "type": { @@ -86331,7 +84007,7 @@ { "description": "Returns matches which enclose another span query.", "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html", "name": "span_containing", "required": false, "type": { @@ -86345,7 +84021,7 @@ { "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.", "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html", "name": "span_field_masking", "required": false, "type": { @@ -86359,7 +84035,7 @@ { "description": "Matches spans near the beginning of a field.", "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html", "name": "span_first", "required": false, "type": { @@ -86373,7 +84049,7 @@ { "description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.", "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-multi-term-query.html", "name": "span_multi", "required": false, "type": { @@ -86387,7 +84063,7 @@ { "description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.", "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-near-query.html", "name": "span_near", "required": false, "type": { @@ -86401,7 +84077,7 @@ { "description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.", "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-not-query.html", "name": "span_not", "required": false, "type": { @@ -86415,7 +84091,7 @@ { "description": "Matches the union of its span clauses.", "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-or-query.html", "name": "span_or", "required": false, "type": { @@ -86429,7 +84105,7 @@ { "description": "Matches spans containing a term.", "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-term-query.html", "name": "span_term", "required": false, "type": { @@ -86454,7 +84130,7 @@ { "description": "Returns matches which are enclosed inside another span query.", "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-within-query.html", "name": "span_within", "required": false, "type": { @@ -86474,7 +84150,7 @@ }, "description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.", "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-sparse-vector-query.html", "name": "sparse_vector", "required": false, "type": { @@ -86488,7 +84164,7 @@ { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "name": "term", "required": false, "type": { @@ -86513,7 +84189,7 @@ { "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "name": "terms", "required": false, "type": { @@ -86527,7 +84203,7 @@ { "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.", "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html", "name": "terms_set", "required": false, "type": { @@ -86562,7 +84238,7 @@ }, "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.", "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html", "name": "text_expansion", "required": false, "type": { @@ -86597,7 +84273,7 @@ }, "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-weighted-tokens-query.html", "name": "weighted_tokens", "required": false, "type": { @@ -86622,7 +84298,7 @@ { "description": "Returns documents that contain terms matching a wildcard pattern.", "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "name": "wildcard", "required": false, "type": { @@ -86647,7 +84323,7 @@ { "description": "A query that accepts any other query as base64 encoded string.", "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html", "name": "wrapper", "required": false, "type": { @@ -86674,7 +84350,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L102-L428", + "specLocation": "_types/query_dsl/abstractions.ts#L102-L427", "variants": { "kind": "container", "nonExhaustive": true @@ -86683,7 +84359,7 @@ { "kind": "interface", "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-query-string-query.html", "inherits": { "type": { "name": "QueryBase", @@ -86711,7 +84387,7 @@ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -86816,7 +84492,7 @@ { "description": "Maximum edit distance allowed for fuzzy matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -86856,7 +84532,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "fuzzy_rewrite", "required": false, "type": { @@ -86909,7 +84585,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -86972,7 +84648,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "rewrite", "required": false, "type": { @@ -87076,7 +84752,7 @@ "term" ], "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "name": { "name": "RangeQuery", "namespace": "_types.query_dsl" @@ -87405,7 +85081,7 @@ { "kind": "interface", "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87483,7 +85159,7 @@ { "kind": "interface", "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87517,7 +85193,7 @@ { "description": "Enables optional operators for the regular expression.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html", "name": "flags", "required": false, "type": { @@ -87544,7 +85220,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "rewrite", "required": false, "type": { @@ -87558,7 +85234,7 @@ { "description": "Regular expression for terms you wish to find in the provided field.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/regexp-syntax.html", "name": "value", "required": true, "type": { @@ -87576,7 +85252,7 @@ { "kind": "interface", "extDocId": "query-dsl-rule-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rule-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87626,7 +85302,7 @@ { "kind": "interface", "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87678,7 +85354,7 @@ { "kind": "interface", "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87732,7 +85408,7 @@ { "kind": "interface", "extDocId": "query-dsl-semantic-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-semantic-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-semantic-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87851,7 +85527,7 @@ } ], "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87944,7 +85620,7 @@ "kind": "type_alias", "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", "docId": "supported-flags", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html#supported-flags", "name": { "name": "SimpleQueryStringFlags", "namespace": "_types.query_dsl" @@ -87970,7 +85646,7 @@ { "kind": "interface", "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "inherits": { "type": { "name": "QueryBase", @@ -87985,7 +85661,7 @@ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -88117,7 +85793,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -88158,7 +85834,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88200,7 +85876,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88240,7 +85916,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88309,7 +85985,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-multi-term-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88339,7 +86015,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-near-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88396,7 +86072,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-not-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88476,7 +86152,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-or-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88644,7 +86320,7 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L158-L200", + "specLocation": "_types/query_dsl/span.ts#L159-L201", "variants": { "kind": "container", "nonExhaustive": true @@ -88653,7 +86329,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-term-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88666,24 +86342,27 @@ }, "properties": [ { + "aliases": [ + "term" + ], "name": "value", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FieldValue", + "namespace": "_types" } } } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/span.ts#L134-L140" + "specLocation": "_types/query_dsl/span.ts#L134-L141" }, { "kind": "interface", "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-within-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88720,12 +86399,12 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L142-L156" + "specLocation": "_types/query_dsl/span.ts#L143-L157" }, { "kind": "interface", "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-sparse-vector-query.html", "inherits": { "type": { "name": "QueryBase", @@ -88851,7 +86530,7 @@ { "kind": "interface", "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89010,7 +86689,7 @@ } ], "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89061,7 +86740,7 @@ { "kind": "interface", "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89136,7 +86815,7 @@ { "kind": "interface", "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89403,7 +87082,7 @@ { "kind": "interface", "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-weighted-tokens-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89456,7 +87135,7 @@ { "kind": "interface", "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89489,7 +87168,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html", "name": "rewrite", "required": false, "type": { @@ -89531,7 +87210,7 @@ { "kind": "interface", "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html", "inherits": { "type": { "name": "QueryBase", @@ -89556,7 +87235,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L502-L511" + "specLocation": "_types/query_dsl/abstractions.ts#L501-L510" }, { "kind": "enum", @@ -89590,7 +87269,7 @@ }, "properties": [ { - "description": "Partial aggregations results, coming from the shards that have already completed running the query.", + "description": "Partial aggregations results, coming from the shards that have already completed the execution of the query.", "name": "aggregations", "required": false, "type": { @@ -89839,7 +87518,7 @@ } } ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L52-L56" + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L50-L54" }, { "kind": "interface", @@ -89872,7 +87551,7 @@ } }, { - "description": "Indicates whether the search is still running or has completed.\n\n> info\n> If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", + "description": "Indicates whether the search is still running or has completed.\nNOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.", "name": "is_running", "required": true, "type": { @@ -89947,7 +87626,7 @@ } }, { - "description": "Indicates when the async search completed.\nIt is present only when the search has completed.", + "description": "Indicates when the async search completed. Only present\nwhen the search has completed.", "name": "completion_time", "required": false, "type": { @@ -89979,7 +87658,7 @@ } } ], - "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L51" + "specLocation": "async_search/_types/AsyncSearchResponseBase.ts#L24-L49" }, { "kind": "request", @@ -90015,7 +87694,7 @@ } ], "query": [], - "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L46" + "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L40" }, { "kind": "response", @@ -90070,7 +87749,7 @@ ], "query": [ { - "description": "The length of time that the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", + "description": "Specifies how long the async search should be available in the cluster.\nWhen not specified, the `keep_alive` set with the corresponding submit async request will be used.\nOtherwise, it is possible to override the value and extend the validity of the request.\nWhen this period expires, the search, if still running, is cancelled.\nIf the search is completed, its saved results are deleted.", "name": "keep_alive", "required": false, "type": { @@ -90106,7 +87785,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L63" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L57" }, { "kind": "response", @@ -90149,7 +87828,7 @@ "body": { "kind": "no_body" }, - "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", + "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "inherits": { "type": { "name": "RequestBase", @@ -90176,7 +87855,7 @@ ], "query": [ { - "description": "The length of time that the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", + "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", "name": "keep_alive", "required": false, "serverDefault": "5d", @@ -90189,7 +87868,7 @@ } } ], - "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L24-L58" + "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L24-L48" }, { "kind": "response", @@ -90223,7 +87902,7 @@ }, "properties": [ { - "description": "The number of shards that have run the query so far.", + "description": "Indicates how many shards have run the query so far.", "name": "_shards", "required": true, "type": { @@ -90235,7 +87914,7 @@ } }, { - "description": "Metadata about clusters involved in the cross-cluster search.\nIt is not shown for local-only searches.", + "description": "Metadata about clusters involved in the cross-cluster search.\nNot shown for local-only searches.", "name": "_clusters", "required": false, "type": { @@ -90247,7 +87926,7 @@ } }, { - "description": "If the async search completed, this field shows the status code of the search.\nFor example, `200` indicates that the async search was successfully completed.\n`503` indicates that the async search was completed with an error.", + "description": "If the async search completed, this field shows the status code of the search.\nFor example, 200 indicates that the async search was successfully completed.\n503 indicates that the async search was completed with an error.", "name": "completion_status", "required": false, "type": { @@ -90579,7 +88258,7 @@ }, { "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -90783,19 +88462,6 @@ } } }, - { - "description": "Specifies how long the async search needs to be available.\nOngoing async searches and any saved search results are deleted after this period.", - "name": "keep_alive", - "required": false, - "serverDefault": "5d", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "description": "If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.", "name": "keep_on_completion", @@ -91311,7 +88977,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L54-L294" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L54-L278" }, { "kind": "response", @@ -91370,7 +89036,7 @@ { "description": "Decider settings.", "extDocId": "autoscaling-deciders", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-deciders.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-deciders.html", "name": "deciders", "required": true, "type": { @@ -91452,7 +89118,7 @@ } } ], - "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L24-L54" + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L24-L48" }, { "kind": "response", @@ -91699,7 +89365,7 @@ } } ], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L23-L57" + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L23-L51" }, { "kind": "response", @@ -91784,7 +89450,7 @@ } } ], - "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L24-L50" + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L24-L44" }, { "kind": "response", @@ -91873,7 +89539,7 @@ } } ], - "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L25-L57" + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L25-L51" }, { "kind": "response", @@ -93254,7 +90920,7 @@ "body": { "kind": "no_body" }, - "description": "Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", + "description": "Get aliases.\nRetrieves the cluster’s index aliases, including filter and routing information.\nThe API does not return data stream aliases.\n\nCAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "inherits": { "type": { "name": "CatRequestBase", @@ -93281,7 +90947,7 @@ ], "query": [ { - "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`.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, "type": { @@ -93291,22 +90957,9 @@ "namespace": "_types" } } - }, - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicated that the request should never timeout, you can set it to `-1`.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/aliases/CatAliasesRequest.ts#L24-L67" + "specLocation": "cat/aliases/CatAliasesRequest.ts#L23-L43" }, { "kind": "response", @@ -93687,7 +91340,7 @@ "body": { "kind": "no_body" }, - "description": "Get shard allocation information.\n\nGet a snapshot of the number of shards allocated to each data node and their disk space.\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.", + "description": "Get shard allocation information.\nGet a snapshot of the number of shards allocated to each data node and their disk space.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "inherits": { "type": { "name": "CatRequestBase", @@ -93700,7 +91353,7 @@ }, "path": [ { - "description": "A comma-separated list of node identifiers or names used to limit the returned information.", + "description": "Comma-separated list of node identifiers or names used to limit the returned information.", "name": "node_id", "required": false, "type": { @@ -93737,22 +91390,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/allocation/CatAllocationRequest.ts#L24-L68" + "specLocation": "cat/allocation/CatAllocationRequest.ts#L23-L50" }, { "kind": "response", @@ -93797,23 +91437,11 @@ "name": "version", "required": true, "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ] + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } }, { @@ -93883,7 +91511,7 @@ "body": { "kind": "no_body" }, - "description": "Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", + "description": "Get component templates.\nReturns information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", "inherits": { "type": { "name": "CatRequestBase", @@ -93896,7 +91524,7 @@ }, "path": [ { - "description": "The name of the component template.\nIt accepts wildcard expressions.\nIf it is omitted, all component templates are returned.", + "description": "The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.", "name": "name", "required": false, "type": { @@ -93921,22 +91549,9 @@ "namespace": "_builtins" } } - }, - { - "description": "The period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L23-L70" + "specLocation": "cat/component_templates/CatComponentTemplatesRequest.ts#L22-L49" }, { "kind": "response", @@ -94046,7 +91661,7 @@ "body": { "kind": "no_body" }, - "description": "Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", + "description": "Get a document count.\nProvides quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", "inherits": { "type": { "name": "CatRequestBase", @@ -94059,7 +91674,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams, indices, and aliases used to limit the request.\nIt supports wildcards (`*`).\nTo target all data streams and indices, omit this parameter or use `*` or `_all`.", + "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.", "name": "index", "required": false, "type": { @@ -94072,7 +91687,7 @@ } ], "query": [], - "specLocation": "cat/count/CatCountRequest.ts#L23-L56" + "specLocation": "cat/count/CatCountRequest.ts#L23-L44" }, { "kind": "response", @@ -94195,7 +91810,7 @@ "body": { "kind": "no_body" }, - "description": "Get field data cache information.\n\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", + "description": "Get field data cache information.\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "inherits": { "type": { "name": "CatRequestBase", @@ -94246,7 +91861,7 @@ } } ], - "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L60" + "specLocation": "cat/fielddata/CatFielddataRequest.ts#L23-L48" }, { "kind": "response", @@ -94551,7 +92166,7 @@ "body": { "kind": "no_body" }, - "description": "Get the cluster health status.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", + "description": "Get the cluster health status.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "inherits": { "type": { "name": "CatRequestBase", @@ -94590,7 +92205,7 @@ } } ], - "specLocation": "cat/health/CatHealthRequest.ts#L23-L59" + "specLocation": "cat/health/CatHealthRequest.ts#L23-L52" }, { "kind": "response", @@ -94613,31 +92228,71 @@ }, "specLocation": "cat/health/CatHealthResponse.ts#L22-L24" }, + { + "kind": "interface", + "name": { + "name": "HelpRecord", + "namespace": "cat.help" + }, + "properties": [ + { + "name": "endpoint", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "cat/help/types.ts#L20-L22" + }, { "kind": "request", + "attachedBehaviors": [ + "CommonCatQueryParameters", + "CommonQueryParameters" + ], "body": { "kind": "no_body" }, - "description": "Get CAT help.\n\nGet help for the CAT APIs.", + "description": "Get CAT help.\nReturns help for the CAT APIs.", + "inherits": { + "type": { + "name": "CatRequestBase", + "namespace": "cat._types" + } + }, "name": { "name": "Request", "namespace": "cat.help" }, "path": [], "query": [], - "specLocation": "cat/help/CatHelpRequest.ts#L20-L36" + "specLocation": "cat/help/CatHelpRequest.ts#L22-L30" }, { "kind": "response", "body": { - "kind": "properties", - "properties": [] + "kind": "value", + "value": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "HelpRecord", + "namespace": "cat.help" + } + } + } }, "name": { "name": "Response", "namespace": "cat.help" }, - "specLocation": "cat/help/CatHelpResponse.ts#L20-L25" + "specLocation": "cat/help/CatHelpResponse.ts#L22-L24" }, { "kind": "interface", @@ -96730,7 +94385,7 @@ "body": { "kind": "no_body" }, - "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", + "description": "Get index information.\nReturns high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "inherits": { "type": { "name": "CatRequestBase", @@ -96829,22 +94484,9 @@ "namespace": "_types" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L93" + "specLocation": "cat/indices/CatIndicesRequest.ts#L24-L77" }, { "kind": "response", @@ -96940,7 +94582,7 @@ "body": { "kind": "no_body" }, - "description": "Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\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. For application consumption, use the nodes info API.", + "description": "Get master node information.\nGet information about the master node, including the ID, bound IP address, and name.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -96965,22 +94607,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/master/CatMasterRequest.ts#L23-L57" + "specLocation": "cat/master/CatMasterRequest.ts#L22-L43" }, { "kind": "response", @@ -97269,7 +94898,7 @@ "body": { "kind": "no_body" }, - "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", + "description": "Get data frame analytics jobs.\nReturns configuration and usage information about data frame analytics jobs.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -97351,13 +94980,13 @@ "type": { "kind": "instance_of", "type": { - "name": "TimeUnit", + "name": "Duration", "namespace": "_types" } } } ], - "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L70" + "specLocation": "cat/ml_data_frame_analytics/CatDataFrameAnalyticsRequest.ts#L24-L59" }, { "kind": "response", @@ -97585,7 +95214,7 @@ "body": { "kind": "no_body" }, - "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", + "description": "Get datafeeds.\nReturns configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -97662,7 +95291,7 @@ } } ], - "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L85" + "specLocation": "cat/ml_datafeeds/CatDatafeedsRequest.ts#L24-L74" }, { "kind": "response", @@ -98656,7 +96285,7 @@ "body": { "kind": "no_body" }, - "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", + "description": "Get anomaly detection jobs.\nReturns configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -98745,7 +96374,7 @@ } } ], - "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L89" + "specLocation": "cat/ml_jobs/CatJobsRequest.ts#L24-L78" }, { "kind": "response", @@ -98777,7 +96406,7 @@ "body": { "kind": "no_body" }, - "description": "Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", + "description": "Get trained models.\nReturns configuration and usage information about inference trained models.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -98875,21 +96504,9 @@ "namespace": "_types" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L25-L80" + "specLocation": "cat/ml_trained_models/CatTrainedModelsRequest.ts#L24-L64" }, { "kind": "response", @@ -99324,7 +96941,7 @@ "body": { "kind": "no_body" }, - "description": "Get node attribute information.\n\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get node attribute information.\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -99349,22 +96966,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L23-L56" + "specLocation": "cat/nodeattrs/CatNodeAttributesRequest.ts#L22-L43" }, { "kind": "response", @@ -100911,7 +98515,7 @@ "body": { "kind": "no_body" }, - "description": "Get node information.\n\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get node information.\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -100973,34 +98577,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/nodes/CatNodesRequest.ts#L24-L67" + "specLocation": "cat/nodes/CatNodesRequest.ts#L23-L50" }, { "kind": "response", @@ -101102,7 +98681,7 @@ "body": { "kind": "no_body" }, - "description": "Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", + "description": "Get pending task information.\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", "inherits": { "type": { "name": "CatRequestBase", @@ -101127,34 +98706,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L23-L60" + "specLocation": "cat/pending_tasks/CatPendingTasksRequest.ts#L22-L43" }, { "kind": "response", @@ -101283,7 +98837,7 @@ "body": { "kind": "no_body" }, - "description": "Get plugin information.\n\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get plugin information.\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -101296,19 +98850,6 @@ }, "path": [], "query": [ - { - "description": "Include bootstrap plugins in the response", - "name": "include_bootstrap", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "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.", "name": "local", @@ -101321,22 +98862,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/plugins/CatPluginsRequest.ts#L23-L61" + "specLocation": "cat/plugins/CatPluginsRequest.ts#L22-L43" }, { "kind": "response", @@ -101789,7 +99317,7 @@ "body": { "kind": "no_body" }, - "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", + "description": "Get shard recovery information.\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "inherits": { "type": { "name": "CatRequestBase", @@ -101852,21 +99380,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/recovery/CatRecoveryRequest.ts#L24-L76" + "specLocation": "cat/recovery/CatRecoveryRequest.ts#L23-L60" }, { "kind": "response", @@ -101938,7 +99454,7 @@ "body": { "kind": "no_body" }, - "description": "Get snapshot repository information.\n\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", + "description": "Get snapshot repository information.\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", "inherits": { "type": { "name": "CatRequestBase", @@ -101950,35 +99466,8 @@ "namespace": "cat.repositories" }, "path": [], - "query": [ - { - "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.", - "name": "local", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L23-L56" + "query": [], + "specLocation": "cat/repositories/CatRepositoriesRequest.ts#L22-L32" }, { "kind": "response", @@ -102010,7 +99499,7 @@ "body": { "kind": "no_body" }, - "description": "Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", + "description": "Get segment information.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", "inherits": { "type": { "name": "CatRequestBase", @@ -102060,22 +99549,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/segments/CatSegmentsRequest.ts#L24-L75" + "specLocation": "cat/segments/CatSegmentsRequest.ts#L23-L58" }, { "kind": "response", @@ -102347,7 +99823,7 @@ "body": { "kind": "no_body" }, - "description": "Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "Get shard information.\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "inherits": { "type": { "name": "CatRequestBase", @@ -102384,34 +99860,9 @@ "namespace": "_types" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/shards/CatShardsRequest.ts#L24-L71" + "specLocation": "cat/shards/CatShardsRequest.ts#L23-L50" }, { "kind": "response", @@ -103724,7 +101175,7 @@ "body": { "kind": "no_body" }, - "description": "Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", + "description": "Get snapshot information\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", "inherits": { "type": { "name": "CatRequestBase", @@ -103762,34 +101213,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } } ], - "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L24-L72" + "specLocation": "cat/snapshots/CatSnapshotsRequest.ts#L23-L51" }, { "kind": "response", @@ -104067,7 +101493,7 @@ "body": { "kind": "no_body" }, - "description": "Get task information.\n\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", + "description": "Get task information.\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", "inherits": { "type": { "name": "CatRequestBase", @@ -104110,7 +101536,7 @@ }, { "description": "Unique node identifiers, which are used to limit the response.", - "name": "nodes", + "name": "node_id", "required": false, "type": { "kind": "array_of", @@ -104134,47 +101560,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Unit used to display time values.", - "name": "time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TimeUnit", - "namespace": "_types" - } - } - }, - { - "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "If `true`, the request blocks until the task has completed.", - "name": "wait_for_completion", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "cat/tasks/CatTasksRequest.ts#L23-L71" + "specLocation": "cat/tasks/CatTasksRequest.ts#L22-L48" }, { "kind": "response", @@ -104452,7 +101840,7 @@ "body": { "kind": "no_body" }, - "description": "Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", + "description": "Get index template information.\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", "inherits": { "type": { "name": "CatRequestBase", @@ -104490,22 +101878,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/templates/CatTemplatesRequest.ts#L24-L69" + "specLocation": "cat/templates/CatTemplatesRequest.ts#L23-L52" }, { "kind": "response", @@ -104635,7 +102010,7 @@ "body": { "kind": "no_body" }, - "description": "Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", + "description": "Get thread pool statistics.\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "inherits": { "type": { "name": "CatRequestBase", @@ -104685,22 +102060,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L73" + "specLocation": "cat/thread_pool/CatThreadPoolRequest.ts#L24-L57" }, { "kind": "response", @@ -105090,7 +102452,7 @@ "body": { "kind": "no_body" }, - "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", + "description": "Get transform information.\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "inherits": { "type": { "name": "CatRequestBase", @@ -105193,7 +102555,7 @@ } } ], - "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L89" + "specLocation": "cat/transforms/CatTransformsRequest.ts#L25-L78" }, { "kind": "response", @@ -105769,7 +103131,6 @@ }, "properties": [ { - "description": "The name of the follower index.", "name": "index", "required": true, "type": { @@ -105781,7 +103142,6 @@ } }, { - "description": "An array of shard-level following task statistics.", "name": "shards", "required": true, "type": { @@ -105796,7 +103156,7 @@ } } ], - "specLocation": "ccr/_types/FollowIndexStats.ts#L30-L35" + "specLocation": "ccr/_types/FollowIndexStats.ts#L30-L33" }, { "kind": "interface", @@ -105806,7 +103166,6 @@ }, "properties": [ { - "description": "The exception that caused the read to fail.", "name": "exception", "required": true, "type": { @@ -105818,7 +103177,6 @@ } }, { - "description": "The starting sequence number of the batch requested from the leader.", "name": "from_seq_no", "required": true, "type": { @@ -105830,7 +103188,6 @@ } }, { - "description": "The number of times the batch has been retried.", "name": "retries", "required": true, "type": { @@ -105842,7 +103199,7 @@ } } ], - "specLocation": "ccr/_types/FollowIndexStats.ts#L111-L118" + "specLocation": "ccr/_types/FollowIndexStats.ts#L71-L75" }, { "kind": "interface", @@ -105852,7 +103209,6 @@ }, "properties": [ { - "description": "The total of transferred bytes read from the leader.\nThis is only an estimate and does not account for compression if enabled.", "name": "bytes_read", "required": true, "type": { @@ -105864,7 +103220,6 @@ } }, { - "description": "The number of failed reads.", "name": "failed_read_requests", "required": true, "type": { @@ -105876,7 +103231,6 @@ } }, { - "description": "The number of failed bulk write requests on the follower.", "name": "failed_write_requests", "required": true, "type": { @@ -105899,7 +103253,6 @@ } }, { - "description": "The index aliases version the follower is synced up to.", "name": "follower_aliases_version", "required": true, "type": { @@ -105911,7 +103264,6 @@ } }, { - "description": "The current global checkpoint on the follower.\nThe difference between the `leader_global_checkpoint` and the `follower_global_checkpoint` is an indication of how much the follower is lagging the leader.", "name": "follower_global_checkpoint", "required": true, "type": { @@ -105923,7 +103275,6 @@ } }, { - "description": "The name of the follower index.", "name": "follower_index", "required": true, "type": { @@ -105935,7 +103286,6 @@ } }, { - "description": "The mapping version the follower is synced up to.", "name": "follower_mapping_version", "required": true, "type": { @@ -105947,7 +103297,6 @@ } }, { - "description": "The current maximum sequence number on the follower.", "name": "follower_max_seq_no", "required": true, "type": { @@ -105959,7 +103308,6 @@ } }, { - "description": "The index settings version the follower is synced up to.", "name": "follower_settings_version", "required": true, "type": { @@ -105971,7 +103319,6 @@ } }, { - "description": "The starting sequence number of the last batch of operations requested from the leader.", "name": "last_requested_seq_no", "required": true, "type": { @@ -105983,7 +103330,6 @@ } }, { - "description": "The current global checkpoint on the leader known to the follower task.", "name": "leader_global_checkpoint", "required": true, "type": { @@ -105995,7 +103341,6 @@ } }, { - "description": "The name of the index in the leader cluster being followed.", "name": "leader_index", "required": true, "type": { @@ -106007,7 +103352,6 @@ } }, { - "description": "The current maximum sequence number on the leader known to the follower task.", "name": "leader_max_seq_no", "required": true, "type": { @@ -106019,7 +103363,6 @@ } }, { - "description": "The total number of operations read from the leader.", "name": "operations_read", "required": true, "type": { @@ -106031,7 +103374,6 @@ } }, { - "description": "The number of operations written on the follower.", "name": "operations_written", "required": true, "type": { @@ -106043,7 +103385,6 @@ } }, { - "description": "The number of active read requests from the follower.", "name": "outstanding_read_requests", "required": true, "type": { @@ -106055,7 +103396,6 @@ } }, { - "description": "The number of active bulk write requests on the follower.", "name": "outstanding_write_requests", "required": true, "type": { @@ -106067,7 +103407,6 @@ } }, { - "description": "An array of objects representing failed reads.", "name": "read_exceptions", "required": true, "type": { @@ -106082,7 +103421,6 @@ } }, { - "description": "The remote cluster containing the leader index.", "name": "remote_cluster", "required": true, "type": { @@ -106094,7 +103432,6 @@ } }, { - "description": "The numerical shard ID, with values from 0 to one less than the number of replicas.", "name": "shard_id", "required": true, "type": { @@ -106106,7 +103443,6 @@ } }, { - "description": "The number of successful fetches.", "name": "successful_read_requests", "required": true, "type": { @@ -106118,7 +103454,6 @@ } }, { - "description": "The number of bulk write requests run on the follower.", "name": "successful_write_requests", "required": true, "type": { @@ -106141,7 +103476,6 @@ } }, { - "description": "The number of milliseconds since a read request was sent to the leader.\nWhen the follower is caught up to the leader, this number will increase up to the configured `read_poll_timeout` at which point another read request will be sent to the leader.", "name": "time_since_last_read_millis", "required": true, "type": { @@ -106173,7 +103507,6 @@ } }, { - "description": "The total time reads spent running on the remote cluster.", "name": "total_read_remote_exec_time_millis", "required": true, "type": { @@ -106205,7 +103538,6 @@ } }, { - "description": "The total time reads were outstanding, measured from the time a read was sent to the leader to the time a reply was returned to the follower.", "name": "total_read_time_millis", "required": true, "type": { @@ -106237,7 +103569,6 @@ } }, { - "description": "The total time spent writing on the follower.", "name": "total_write_time_millis", "required": true, "type": { @@ -106258,7 +103589,6 @@ } }, { - "description": "The number of write operations queued on the follower.", "name": "write_buffer_operation_count", "required": true, "type": { @@ -106270,7 +103600,6 @@ } }, { - "description": "The total number of bytes of operations currently queued for writing.", "name": "write_buffer_size_in_bytes", "required": true, "type": { @@ -106282,7 +103611,7 @@ } } ], - "specLocation": "ccr/_types/FollowIndexStats.ts#L37-L109" + "specLocation": "ccr/_types/FollowIndexStats.ts#L35-L69" }, { "kind": "request", @@ -106292,7 +103621,7 @@ "body": { "kind": "no_body" }, - "description": "Delete auto-follow patterns.\n\nDelete a collection of cross-cluster replication auto-follow patterns.", + "description": "Delete auto-follow patterns.\nDelete a collection of cross-cluster replication auto-follow patterns.", "inherits": { "type": { "name": "RequestBase", @@ -106305,7 +103634,7 @@ }, "path": [ { - "description": "The auto-follow pattern collection to delete.", + "description": "The name of the auto follow pattern.", "name": "name", "required": true, "type": { @@ -106317,22 +103646,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L24-L54" + "query": [], + "specLocation": "ccr/delete_auto_follow_pattern/DeleteAutoFollowPatternRequest.ts#L23-L35" }, { "kind": "response", @@ -106556,19 +103871,6 @@ } ], "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "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.", "name": "wait_for_active_shards", @@ -106582,7 +103884,7 @@ } } ], - "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L124" + "specLocation": "ccr/follow/CreateFollowIndexRequest.ts#L26-L113" }, { "kind": "response", @@ -106638,7 +103940,6 @@ }, "properties": [ { - "description": "The name of the follower index.", "name": "follower_index", "required": true, "type": { @@ -106650,7 +103951,6 @@ } }, { - "description": "The name of the index in the leader cluster that is followed.", "name": "leader_index", "required": true, "type": { @@ -106662,7 +103962,6 @@ } }, { - "description": "An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.", "name": "parameters", "required": false, "type": { @@ -106674,7 +103973,6 @@ } }, { - "description": "The remote cluster that contains the leader index.", "name": "remote_cluster", "required": true, "type": { @@ -106686,7 +103984,6 @@ } }, { - "description": "The status of the index following: `active` or `paused`.", "name": "status", "required": true, "type": { @@ -106698,7 +103995,7 @@ } } ], - "specLocation": "ccr/follow_info/types.ts#L24-L35" + "specLocation": "ccr/follow_info/types.ts#L24-L30" }, { "kind": "interface", @@ -106828,7 +104125,7 @@ } } ], - "specLocation": "ccr/follow_info/types.ts#L42-L88" + "specLocation": "ccr/follow_info/types.ts#L37-L83" }, { "kind": "enum", @@ -106844,7 +104141,7 @@ "name": "FollowerIndexStatus", "namespace": "ccr.follow_info" }, - "specLocation": "ccr/follow_info/types.ts#L37-L40" + "specLocation": "ccr/follow_info/types.ts#L32-L35" }, { "kind": "request", @@ -106854,7 +104151,7 @@ "body": { "kind": "no_body" }, - "description": "Get follower information.\n\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", + "description": "Get follower information.\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "inherits": { "type": { "name": "RequestBase", @@ -106867,7 +104164,7 @@ }, "path": [ { - "description": "A comma-delimited list of follower index patterns.", + "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", "name": "index", "required": true, "type": { @@ -106879,22 +104176,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L24-L55" + "query": [], + "specLocation": "ccr/follow_info/FollowInfoRequest.ts#L23-L36" }, { "kind": "response", @@ -106931,7 +104214,7 @@ "body": { "kind": "no_body" }, - "description": "Get follower stats.\n\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", + "description": "Get follower stats.\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "inherits": { "type": { "name": "RequestBase", @@ -106944,7 +104227,7 @@ }, "path": [ { - "description": "A comma-delimited list of index patterns.", + "description": "A comma-separated list of index patterns; use `_all` to perform the operation on all indices", "name": "index", "required": true, "type": { @@ -106956,22 +104239,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L24-L54" + "query": [], + "specLocation": "ccr/follow_stats/FollowIndexStatsRequest.ts#L23-L36" }, { "kind": "response", @@ -106979,7 +104248,6 @@ "kind": "properties", "properties": [ { - "description": "An array of follower index statistics.", "name": "indices", "required": true, "type": { @@ -106999,7 +104267,7 @@ "name": "Response", "namespace": "ccr.follow_stats" }, - "specLocation": "ccr/follow_stats/FollowIndexStatsResponse.ts#L22-L27" + "specLocation": "ccr/follow_stats/FollowIndexStatsResponse.ts#L22-L24" }, { "kind": "request", @@ -107080,22 +104348,8 @@ } } ], - "query": [ - { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L24-L65" + "query": [], + "specLocation": "ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L51" }, { "kind": "response", @@ -107248,7 +104502,7 @@ "body": { "kind": "no_body" }, - "description": "Get auto-follow patterns.\n\nGet cross-cluster replication auto-follow patterns.", + "description": "Get auto-follow patterns.\nGet cross-cluster replication auto-follow patterns.", "inherits": { "type": { "name": "RequestBase", @@ -107261,7 +104515,7 @@ }, "path": [ { - "description": "The auto-follow pattern collection that you want to retrieve.\nIf you do not specify a name, the API returns information for all collections.", + "description": "Specifies the auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.", "name": "name", "required": false, "type": { @@ -107273,22 +104527,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts#L24-L60" + "query": [], + "specLocation": "ccr/get_auto_follow_pattern/GetAutoFollowPatternRequest.ts#L23-L36" }, { "kind": "response", @@ -107325,7 +104565,7 @@ "body": { "kind": "no_body" }, - "description": "Pause an auto-follow pattern.\n\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", + "description": "Pause an auto-follow pattern.\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "inherits": { "type": { "name": "RequestBase", @@ -107338,7 +104578,7 @@ }, "path": [ { - "description": "The name of the auto-follow pattern to pause.", + "description": "The name of the auto follow pattern that should pause discovering new indices to follow.", "name": "name", "required": true, "type": { @@ -107350,22 +104590,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts#L24-L60" + "query": [], + "specLocation": "ccr/pause_auto_follow_pattern/PauseAutoFollowPatternRequest.ts#L23-L41" }, { "kind": "response", @@ -107393,7 +104619,7 @@ "body": { "kind": "no_body" }, - "description": "Pause a follower.\n\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", + "description": "Pause a follower.\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "inherits": { "type": { "name": "RequestBase", @@ -107406,7 +104632,7 @@ }, "path": [ { - "description": "The name of the follower index.", + "description": "The name of the follower index that should pause following its leader index.", "name": "index", "required": true, "type": { @@ -107418,22 +104644,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L24-L56" + "query": [], + "specLocation": "ccr/pause_follow/PauseFollowIndexRequest.ts#L23-L37" }, { "kind": "response", @@ -107464,7 +104676,7 @@ { "description": "The remote cluster containing the leader indices to match against.", "docId": "modules-remote-clusters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-remote-clusters.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-remote-clusters.html", "name": "remote_cluster", "required": true, "type": { @@ -107687,22 +104899,8 @@ } } ], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L133" + "query": [], + "specLocation": "ccr/put_auto_follow_pattern/PutAutoFollowPatternRequest.ts#L27-L120" }, { "kind": "response", @@ -107730,7 +104928,7 @@ "body": { "kind": "no_body" }, - "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", + "description": "Resume an auto-follow pattern.\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "inherits": { "type": { "name": "RequestBase", @@ -107743,7 +104941,7 @@ }, "path": [ { - "description": "The name of the auto-follow pattern to resume.", + "description": "The name of the auto follow pattern to resume discovering new indices to follow.", "name": "name", "required": true, "type": { @@ -107755,22 +104953,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L24-L56" + "query": [], + "specLocation": "ccr/resume_auto_follow_pattern/ResumeAutoFollowPatternRequest.ts#L23-L37" }, { "kind": "response", @@ -107935,22 +105119,8 @@ } } ], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L65" + "query": [], + "specLocation": "ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L52" }, { "kind": "response", @@ -107992,7 +105162,6 @@ } }, { - "description": "The number of indices that the auto-follow coordinator failed to automatically follow.\nThe causes of recent failures are captured in the logs of the elected master node and in the `auto_follow_stats.recent_auto_follow_errors` field.", "name": "number_of_failed_follow_indices", "required": true, "type": { @@ -108004,7 +105173,6 @@ } }, { - "description": "The number of times that the auto-follow coordinator failed to retrieve the cluster state from a remote cluster registered in a collection of auto-follow patterns.", "name": "number_of_failed_remote_cluster_state_requests", "required": true, "type": { @@ -108016,7 +105184,6 @@ } }, { - "description": "The number of indices that the auto-follow coordinator successfully followed.", "name": "number_of_successful_follow_indices", "required": true, "type": { @@ -108028,7 +105195,6 @@ } }, { - "description": "An array of objects representing failures by the auto-follow coordinator.", "name": "recent_auto_follow_errors", "required": true, "type": { @@ -108043,7 +105209,7 @@ } } ], - "specLocation": "ccr/stats/types.ts.ts#L32-L47" + "specLocation": "ccr/stats/types.ts.ts#L32-L38" }, { "kind": "interface", @@ -108119,7 +105285,7 @@ } } ], - "specLocation": "ccr/stats/types.ts.ts#L49-L51" + "specLocation": "ccr/stats/types.ts.ts#L40-L42" }, { "kind": "request", @@ -108129,7 +105295,7 @@ "body": { "kind": "no_body" }, - "description": "Get cross-cluster replication stats.\n\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", + "description": "Get cross-cluster replication stats.\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "inherits": { "type": { "name": "RequestBase", @@ -108141,35 +105307,8 @@ "namespace": "ccr.stats" }, "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/stats/CcrStatsRequest.ts#L23-L53" + "query": [], + "specLocation": "ccr/stats/CcrStatsRequest.ts#L22-L29" }, { "kind": "response", @@ -108177,7 +105316,6 @@ "kind": "properties", "properties": [ { - "description": "Statistics for the auto-follow coordinator.", "name": "auto_follow_stats", "required": true, "type": { @@ -108189,7 +105327,6 @@ } }, { - "description": "Shard-level statistics for follower indices.", "name": "follow_stats", "required": true, "type": { @@ -108206,7 +105343,7 @@ "name": "Response", "namespace": "ccr.stats" }, - "specLocation": "ccr/stats/CcrStatsResponse.ts#L22-L29" + "specLocation": "ccr/stats/CcrStatsResponse.ts#L22-L27" }, { "kind": "request", @@ -108216,7 +105353,7 @@ "body": { "kind": "no_body" }, - "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", + "description": "Unfollow an index.\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\nNOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "inherits": { "type": { "name": "RequestBase", @@ -108229,7 +105366,7 @@ }, "path": [ { - "description": "The name of the follower index.", + "description": "The name of the follower index that should be turned into a regular index.", "name": "index", "required": true, "type": { @@ -108241,22 +105378,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L24-L59" + "query": [], + "specLocation": "ccr/unfollow/UnfollowIndexRequest.ts#L23-L39" }, { "kind": "response", @@ -108339,7 +105462,7 @@ }, { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -108349,20 +105472,9 @@ "namespace": "_types" } } - }, - { - "name": "deprecated", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" + "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L37" }, { "kind": "interface", @@ -108373,7 +105485,7 @@ "properties": [ { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -108471,7 +105583,7 @@ } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" + "specLocation": "cluster/_types/ComponentTemplate.ts#L39-L51" }, { "kind": "interface", @@ -109199,22 +106311,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L25-L79" + "specLocation": "cluster/allocation_explain/ClusterAllocationExplainRequest.ts#L24-L66" }, { "kind": "interface", @@ -109753,7 +106852,7 @@ "body": { "kind": "no_body" }, - "description": "Delete component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", + "description": "Delete component templates.\nDeletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "inherits": { "type": { "name": "RequestBase", @@ -109806,7 +106905,7 @@ } } ], - "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L61" + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L56" }, { "kind": "response", @@ -109847,19 +106946,6 @@ }, "path": [], "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "description": "Specifies whether to wait for all excluded nodes to be removed from the\ncluster before clearing the voting configuration exclusions list.\nDefaults to true, meaning that all excluded nodes must be removed from\nthe cluster before this API takes any action. If set to false then the\nvoting configuration exclusions list is cleared even if some excluded\nnodes are still in the cluster.", "name": "wait_for_removal", @@ -109874,7 +106960,7 @@ } } ], - "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts#L23-L55" + "specLocation": "cluster/delete_voting_config_exclusions/ClusterDeleteVotingConfigExclusionsRequest.ts#L22-L43" }, { "kind": "response", @@ -109948,7 +107034,7 @@ } } ], - "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L62" + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L56" }, { "kind": "response", @@ -109969,7 +107055,7 @@ "body": { "kind": "no_body" }, - "description": "Get component templates.\nGet information about component templates.", + "description": "Get component templates.\nRetrieves information about component templates.", "inherits": { "type": { "name": "RequestBase", @@ -110057,7 +107143,7 @@ } } ], - "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L77" + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L67" }, { "kind": "response", @@ -110160,7 +107246,7 @@ } } ], - "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L63" + "specLocation": "cluster/get_settings/ClusterGetSettingsRequest.ts#L23-L57" }, { "kind": "response", @@ -110612,7 +107698,7 @@ "body": { "kind": "no_body" }, - "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", + "description": "Get the cluster health status.\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", "inherits": { "type": { "name": "RequestBase", @@ -110790,7 +107876,7 @@ } } ], - "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L118" + "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L107" }, { "kind": "response", @@ -110948,7 +108034,7 @@ } ], "query": [], - "specLocation": "cluster/info/ClusterInfoRequest.ts#L23-L42" + "specLocation": "cluster/info/ClusterInfoRequest.ts#L23-L36" }, { "kind": "response", @@ -111168,7 +108254,7 @@ } } ], - "specLocation": "cluster/pending_tasks/ClusterPendingTasksRequest.ts#L23-L56" + "specLocation": "cluster/pending_tasks/ClusterPendingTasksRequest.ts#L23-L50" }, { "kind": "response", @@ -111242,19 +108328,6 @@ } } }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "description": "When adding a voting configuration exclusion, the API waits for the\nspecified nodes to be excluded from the voting configuration before\nreturning. If the timeout expires before the appropriate condition\nis satisfied, the request fails and returns an error.", "name": "timeout", @@ -111269,7 +108342,7 @@ } } ], - "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts#L24-L80" + "specLocation": "cluster/post_voting_config_exclusions/ClusterPostVotingConfigExclusionsRequest.ts#L24-L69" }, { "kind": "response", @@ -111315,7 +108388,7 @@ } }, { - "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.", + "description": "Optional user metadata about the component template.\nMay 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.", "name": "_meta", "required": false, "type": { @@ -111340,7 +108413,7 @@ } ] }, - "description": "Create or update a component template.\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.", + "description": "Create or update a component template.\nCreates or updates a component template.\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.", "inherits": { "type": { "name": "RequestBase", @@ -111393,7 +108466,7 @@ } } ], - "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L105" + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L95" }, { "kind": "response", @@ -111459,7 +108532,7 @@ } ] }, - "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.", + "description": "Update the cluster settings.\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.", "inherits": { "type": { "name": "RequestBase", @@ -111511,7 +108584,7 @@ } } ], - "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L68" + "specLocation": "cluster/put_settings/ClusterPutSettingsRequest.ts#L25-L61" }, { "kind": "response", @@ -111612,7 +108685,6 @@ }, "properties": [ { - "description": "The connection mode for the remote cluster.", "name": "mode", "required": true, "type": { @@ -111621,7 +108693,6 @@ } }, { - "description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.", "name": "connected", "required": true, "type": { @@ -111633,7 +108704,6 @@ } }, { - "description": "The initial connect timeout for remote cluster connections.", "name": "initial_connect_timeout", "required": true, "type": { @@ -111645,8 +108715,6 @@ } }, { - "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", - "extDocId": "modules-cross-cluster-optional", "name": "skip_unavailable", "required": true, "type": { @@ -111658,7 +108726,6 @@ } }, { - "description": "The address for remote connections when proxy mode is configured.", "name": "proxy_address", "required": true, "type": { @@ -111681,7 +108748,6 @@ } }, { - "description": "The number of open socket connections to the remote cluster when proxy mode is configured.", "name": "num_proxy_sockets_connected", "required": true, "type": { @@ -111693,7 +108759,6 @@ } }, { - "description": "The maximum number of socket connections to the remote cluster when proxy mode is configured.", "name": "max_proxy_socket_connections", "required": true, "type": { @@ -111703,21 +108768,9 @@ "namespace": "_types" } } - }, - { - "description": "This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.", - "name": "cluster_credentials", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } } ], - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L58-L83" + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L42-L51" }, { "kind": "interface", @@ -111727,7 +108780,6 @@ }, "properties": [ { - "description": "The connection mode for the remote cluster.", "name": "mode", "required": true, "type": { @@ -111736,7 +108788,6 @@ } }, { - "description": "If it is `true`, there is at least one open connection to the remote cluster.\nIf it is `false`, it means that the cluster no longer has an open connection to the remote cluster.\nIt does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.", "name": "connected", "required": true, "type": { @@ -111748,7 +108799,6 @@ } }, { - "description": "The maximum number of connections maintained for the remote cluster when sniff mode is configured.", "name": "max_connections_per_cluster", "required": true, "type": { @@ -111760,7 +108810,6 @@ } }, { - "description": "The number of connected nodes in the remote cluster when sniff mode is configured.", "name": "num_nodes_connected", "required": true, "type": { @@ -111772,7 +108821,6 @@ } }, { - "description": "The initial connect timeout for remote cluster connections.", "name": "initial_connect_timeout", "required": true, "type": { @@ -111784,8 +108832,6 @@ } }, { - "description": "If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.", - "extDocId": "modules-cross-cluster-optional", "name": "skip_unavailable", "required": true, "type": { @@ -111797,7 +108843,6 @@ } }, { - "description": "The initial seed transport addresses of the remote cluster when sniff mode is configured.", "name": "seeds", "required": true, "type": { @@ -111812,7 +108857,7 @@ } } ], - "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L56" + "specLocation": "cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L40" }, { "kind": "request", @@ -111822,7 +108867,7 @@ "body": { "kind": "no_body" }, - "description": "Get remote cluster information.\n\nGet information about configured remote clusters.\nThe API returns connection and endpoint information keyed by the configured remote cluster alias.\n\n> info\n> This API returns information that reflects current state on the local cluster.\n> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.\n> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.\n> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster).", + "description": "Get remote cluster information.\nGet all of the configured remote cluster information.\nThis API returns connection and endpoint information keyed by the configured remote cluster alias.", "inherits": { "type": { "name": "RequestBase", @@ -111835,7 +108880,7 @@ }, "path": [], "query": [], - "specLocation": "cluster/remote_info/ClusterRemoteInfoRequest.ts#L22-L46" + "specLocation": "cluster/remote_info/ClusterRemoteInfoRequest.ts#L22-L30" }, { "kind": "response", @@ -111994,7 +109039,7 @@ { "kind": "interface", "docId": "modules-cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cluster.html", "name": { "name": "CommandAllocateReplicaAction", "namespace": "cluster.reroute" @@ -112263,7 +109308,7 @@ } } ], - "specLocation": "cluster/reroute/ClusterRerouteRequest.ts#L25-L91" + "specLocation": "cluster/reroute/ClusterRerouteRequest.ts#L25-L85" }, { "kind": "interface", @@ -112624,7 +109669,7 @@ } } ], - "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L89" + "specLocation": "cluster/state/ClusterStateRequest.ts#L29-L75" }, { "kind": "response", @@ -112874,7 +109919,7 @@ { "description": "Contains statistics about the field data cache of selected nodes.", "docId": "modules-fielddata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-fielddata.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-fielddata.html", "name": "fielddata", "required": true, "type": { @@ -112948,7 +109993,7 @@ { "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", "docId": "analyzer-anatomy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analyzer-anatomy.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html", "name": "versions", "required": false, "type": { @@ -113559,7 +110604,7 @@ { "description": "Contains statistics about the discovery types used by selected nodes.", "docId": "modules-discovery-hosts-providers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-hosts-providers.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-discovery-hosts-providers.html", "name": "discovery_types", "required": true, "type": { @@ -114730,7 +111775,7 @@ } } ], - "specLocation": "cluster/stats/ClusterStatsRequest.ts#L24-L60" + "specLocation": "cluster/stats/ClusterStatsRequest.ts#L24-L50" }, { "kind": "response", @@ -114983,7 +112028,7 @@ { "description": "Contains statistics about nodes selected by the request’s node filters.", "docId": "cluster-nodes", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes", "name": "nodes", "required": true, "type": { @@ -115072,17 +112117,6 @@ } } }, - { - "name": "deleted", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "name": "description", "required": false, @@ -115393,7 +112427,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L252-L284" + "specLocation": "connector/_types/Connector.ts#L237-L268" }, { "kind": "interface", @@ -115650,7 +112684,6 @@ }, "properties": [ { - "description": "Indicates whether document-level security is enabled.", "name": "document_level_security", "required": false, "type": { @@ -115662,7 +112695,6 @@ } }, { - "description": "Indicates whether incremental syncs are enabled.", "name": "incremental_sync", "required": false, "type": { @@ -115674,7 +112706,6 @@ } }, { - "description": "Indicates whether managed connector API keys are enabled.", "name": "native_connector_api_keys", "required": false, "type": { @@ -115697,7 +112728,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L230-L244" + "specLocation": "connector/_types/Connector.ts#L224-L229" }, { "kind": "enum", @@ -116821,7 +113852,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L246-L250" + "specLocation": "connector/_types/Connector.ts#L231-L235" }, { "kind": "interface", @@ -116992,7 +114023,6 @@ }, "properties": [ { - "description": "Indicates whether advanced sync rules are enabled.", "name": "advanced", "required": false, "type": { @@ -117004,7 +114034,6 @@ } }, { - "description": "Indicates whether basic sync rules are enabled.", "name": "basic", "required": false, "type": { @@ -117016,7 +114045,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L219-L228" + "specLocation": "connector/_types/Connector.ts#L219-L222" }, { "kind": "enum", @@ -117135,7 +114164,7 @@ } ], "query": [], - "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L44" + "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L38" }, { "kind": "response", @@ -117206,22 +114235,9 @@ "namespace": "_builtins" } } - }, - { - "description": "A flag indicating if the connector should be hard deleted.", - "name": "hard", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } } ], - "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L58" + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L47" }, { "kind": "response", @@ -117274,22 +114290,8 @@ } } ], - "query": [ - { - "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", - "name": "include_deleted", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L51" + "query": [], + "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L38" }, { "kind": "response", @@ -117473,7 +114475,7 @@ } ], "query": [], - "specLocation": "connector/last_sync/ConnectorUpdateLastSyncRequest.ts#L26-L66" + "specLocation": "connector/last_sync/ConnectorUpdateLastSyncRequest.ts#L26-L60" }, { "kind": "response", @@ -117580,19 +114582,6 @@ } } }, - { - "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", - "name": "include_deleted", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "description": "A wildcard query string that filters connectors with matching name, description or index name", "name": "query", @@ -117606,7 +114595,7 @@ } } ], - "specLocation": "connector/list/ConnectorListRequest.ts#L23-L70" + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L59" }, { "kind": "response", @@ -117735,7 +114724,7 @@ }, "path": [], "query": [], - "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L52" + "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L46" }, { "kind": "response", @@ -117874,7 +114863,7 @@ } ], "query": [], - "specLocation": "connector/put/ConnectorPutRequest.ts#L22-L58" + "specLocation": "connector/put/ConnectorPutRequest.ts#L22-L48" }, { "kind": "response", @@ -117945,7 +114934,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L45" + "specLocation": "connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L39" }, { "kind": "response", @@ -117971,124 +114960,6 @@ }, "specLocation": "connector/sync_job_cancel/SyncJobCancelResponse.ts#L22-L26" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Check in a connector sync job.\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "connector.sync_job_check_in" - }, - "path": [ - { - "description": "The unique identifier of the connector sync job to be checked in.", - "name": "connector_sync_job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "connector/sync_job_check_in/SyncJobCheckInRequest.ts#L22-L45" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [] - }, - "name": { - "name": "Response", - "namespace": "connector.sync_job_check_in" - }, - "specLocation": "connector/sync_job_check_in/SyncJobCheckInResponse.ts#L20-L22" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The cursor object from the last incremental sync job.\nThis should reference the `sync_cursor` field in the connector state for which the job runs.", - "name": "sync_cursor", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "description": "The host name of the current system that will run the job.", - "name": "worker_hostname", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Claim a connector sync job.\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "connector.sync_job_claim" - }, - "path": [ - { - "description": "The unique identifier of the connector sync job.", - "name": "connector_sync_job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "connector/sync_job_claim/SyncJobClaimRequest.ts#L23-L61" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [] - }, - "name": { - "name": "Response", - "namespace": "connector.sync_job_claim" - }, - "specLocation": "connector/sync_job_claim/SyncJobClaimResponse.ts#L20-L22" - }, { "kind": "request", "attachedBehaviors": [ @@ -118123,7 +114994,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L45" + "specLocation": "connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L39" }, { "kind": "response", @@ -118143,68 +115014,6 @@ }, "specLocation": "connector/sync_job_delete/SyncJobDeleteResponse.ts#L22-L24" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The error for the connector sync job error field.", - "name": "error", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Set a connector sync job error.\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "connector.sync_job_error" - }, - "path": [ - { - "description": "The unique identifier for the connector sync job.", - "name": "connector_sync_job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "connector/sync_job_error/SyncJobErrorRequest.ts#L23-L52" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [] - }, - "name": { - "name": "Response", - "namespace": "connector.sync_job_error" - }, - "specLocation": "connector/sync_job_error/SyncJobErrorResponse.ts#L20-L22" - }, { "kind": "request", "attachedBehaviors": [ @@ -118239,7 +115048,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_get/SyncJobGetRequest.ts#L22-L42" + "specLocation": "connector/sync_job_get/SyncJobGetRequest.ts#L22-L36" }, { "kind": "response", @@ -118356,7 +115165,7 @@ } } ], - "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L63" + "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L57" }, { "kind": "response", @@ -118453,7 +115262,7 @@ }, "path": [], "query": [], - "specLocation": "connector/sync_job_post/SyncJobPostRequest.ts#L23-L51" + "specLocation": "connector/sync_job_post/SyncJobPostRequest.ts#L23-L45" }, { "kind": "response", @@ -118479,128 +115288,6 @@ }, "specLocation": "connector/sync_job_post/SyncJobPostResponse.ts#L22-L26" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The number of documents the sync job deleted.", - "name": "deleted_document_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The number of documents the sync job indexed.", - "name": "indexed_document_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The total size of the data (in MiB) the sync job indexed.", - "name": "indexed_document_volume", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The timestamp to use in the `last_seen` property for the connector sync job.", - "name": "last_seen", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The connector-specific metadata.", - "name": "metadata", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } - }, - { - "description": "The total number of documents in the target index after the sync job finished.", - "name": "total_document_count", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "description": "Set the connector sync job stats.\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "connector.sync_job_update_stats" - }, - "path": [ - { - "description": "The unique identifier of the connector sync job.", - "name": "connector_sync_job_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "connector/sync_job_update_stats/SyncJobUpdateStatsRequest.ts#L24-L78" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [] - }, - "name": { - "name": "Response", - "namespace": "connector.sync_job_update_stats" - }, - "specLocation": "connector/sync_job_update_stats/SyncJobUpdateStatsResponse.ts#L20-L22" - }, { "kind": "request", "attachedBehaviors": [ @@ -118635,7 +115322,7 @@ } ], "query": [], - "specLocation": "connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L44" + "specLocation": "connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L38" }, { "kind": "response", @@ -118719,7 +115406,7 @@ } ], "query": [], - "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L53" + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L47" }, { "kind": "response", @@ -118810,7 +115497,7 @@ } ], "query": [], - "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L55" + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L49" }, { "kind": "response", @@ -118892,7 +115579,7 @@ } ], "query": [], - "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L54" + "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L48" }, { "kind": "response", @@ -118918,79 +115605,6 @@ }, "specLocation": "connector/update_error/ConnectorUpdateErrorResponse.ts#L22-L26" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "features", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ConnectorFeatures", - "namespace": "connector._types" - } - } - } - ] - }, - "description": "Update the connector features.\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "connector.update_features" - }, - "path": [ - { - "description": "The unique identifier of the connector to be updated.", - "name": "connector_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "connector/update_features/ConnectorUpdateFeaturesRequest.ts#L23-L61" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "result", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Result", - "namespace": "_types" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "connector.update_features" - }, - "specLocation": "connector/update_features/ConnectorUpdateFeaturesResponse.ts#L22-L26" - }, { "kind": "request", "attachedBehaviors": [ @@ -119066,7 +115680,7 @@ } ], "query": [], - "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L60" + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L54" }, { "kind": "response", @@ -119139,7 +115753,7 @@ } ], "query": [], - "specLocation": "connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L48" + "specLocation": "connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L42" }, { "kind": "response", @@ -119221,7 +115835,7 @@ } ], "query": [], - "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L51" + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L45" }, { "kind": "response", @@ -119305,7 +115919,7 @@ } ], "query": [], - "specLocation": "connector/update_name/ConnectorUpdateNameRequest.ts#L22-L49" + "specLocation": "connector/update_name/ConnectorUpdateNameRequest.ts#L22-L43" }, { "kind": "response", @@ -119378,7 +115992,7 @@ } ], "query": [], - "specLocation": "connector/update_native/ConnectorUpdateNativeRequest.ts#L22-L48" + "specLocation": "connector/update_native/ConnectorUpdateNativeRequest.ts#L22-L42" }, { "kind": "response", @@ -119451,7 +116065,7 @@ } ], "query": [], - "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L52" + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L46" }, { "kind": "response", @@ -119524,7 +116138,7 @@ } ], "query": [], - "specLocation": "connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts#L23-L50" + "specLocation": "connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts#L23-L44" }, { "kind": "response", @@ -119597,7 +116211,7 @@ } ], "query": [], - "specLocation": "connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts#L22-L48" + "specLocation": "connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts#L22-L42" }, { "kind": "response", @@ -119670,7 +116284,7 @@ } ], "query": [], - "specLocation": "connector/update_status/ConnectorUpdateStatusRequest.ts#L23-L49" + "specLocation": "connector/update_status/ConnectorUpdateStatusRequest.ts#L23-L43" }, { "kind": "response", @@ -119704,7 +116318,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a dangling index.\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", + "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "inherits": { "type": { "name": "RequestBase", @@ -119767,7 +116381,7 @@ } } ], - "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L55" + "specLocation": "dangling_indices/delete_dangling_index/DeleteDanglingIndexRequest.ts#L24-L48" }, { "kind": "response", @@ -119858,7 +116472,7 @@ } } ], - "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L57" + "specLocation": "dangling_indices/import_dangling_index/ImportDanglingIndexRequest.ts#L24-L49" }, { "kind": "response", @@ -119962,7 +116576,7 @@ }, "path": [], "query": [], - "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L42" + "specLocation": "dangling_indices/list_dangling_indices/ListDanglingIndicesRequest.ts#L22-L33" }, { "kind": "response", @@ -120151,22 +116765,8 @@ } } ], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L24-L52" + "query": [], + "specLocation": "enrich/delete_policy/DeleteEnrichPolicyRequest.ts#L23-L37" }, { "kind": "response", @@ -120263,19 +116863,6 @@ } ], "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, { "description": "If `true`, the request blocks other enrich policy execution requests until complete.", "name": "wait_for_completion", @@ -120290,7 +116877,7 @@ } } ], - "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L24-L57" + "specLocation": "enrich/execute_policy/ExecuteEnrichPolicyRequest.ts#L23-L45" }, { "kind": "response", @@ -120360,22 +116947,8 @@ } } ], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L24-L57" + "query": [], + "specLocation": "enrich/get_policy/GetEnrichPolicyRequest.ts#L23-L38" }, { "kind": "response", @@ -120475,22 +117048,8 @@ } } ], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L25-L67" + "query": [], + "specLocation": "enrich/put_policy/PutEnrichPolicyRequest.ts#L24-L53" }, { "kind": "response", @@ -120743,22 +117302,8 @@ "namespace": "enrich.stats" }, "path": [], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "enrich/stats/EnrichStatsRequest.ts#L23-L45" + "query": [], + "specLocation": "enrich/stats/EnrichStatsRequest.ts#L22-L29" }, { "kind": "response", @@ -120876,7 +117421,7 @@ { "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-sequences", "name": "sequences", "required": false, "type": { @@ -121004,24 +117549,9 @@ "namespace": "eql._types" } } - }, - { - "description": "Contains information about shard failures (if any), in case allow_partial_search_results=true", - "name": "shard_failures", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ShardFailure", - "namespace": "_types" - } - } - } } ], - "specLocation": "eql/_types/EqlSearchResponseBase.ts#L25-L54" + "specLocation": "eql/_types/EqlSearchResponseBase.ts#L24-L49" }, { "kind": "interface", @@ -121075,7 +117605,7 @@ { "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.", "docId": "eql-missing-events", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-missing-events", "name": "missing", "required": false, "type": { @@ -121150,7 +117680,7 @@ { "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-sequences", "name": "join_keys", "required": false, "type": { @@ -121197,7 +117727,7 @@ } ], "query": [], - "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L47" + "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L40" }, { "kind": "response", @@ -121276,7 +117806,7 @@ } } ], - "specLocation": "eql/get/EqlGetRequest.ts#L24-L57" + "specLocation": "eql/get/EqlGetRequest.ts#L24-L51" }, { "kind": "response", @@ -121345,7 +117875,7 @@ } ], "query": [], - "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L42" + "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L36" }, { "kind": "response", @@ -121461,7 +117991,7 @@ { "description": "EQL query you wish to run.", "docId": "eql-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html", "name": "query", "required": true, "type": { @@ -121499,7 +118029,7 @@ { "description": "Field used to sort hits with the same timestamp in ascending order", "docId": "sort-tiebreaker", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html#eql-search-specify-a-sort-tiebreaker", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker", "name": "tiebreaker_field", "required": false, "type": { @@ -121595,36 +118125,10 @@ } } }, - { - "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", - "name": "allow_partial_search_results", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "allow_partial_sequence_results", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "docId": "eql-basic-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-basic-syntax", "name": "size", "required": false, "type": { @@ -121744,32 +118248,6 @@ } } }, - { - "description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.", - "name": "allow_partial_search_results", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "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.", - "name": "allow_partial_sequence_results", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, { "name": "expand_wildcards", "required": false, @@ -121834,7 +118312,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L161" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L129" }, { "kind": "response", @@ -121887,40 +118365,6 @@ }, "specLocation": "eql/search/types.ts#L20-L32" }, - { - "kind": "enum", - "members": [ - { - "name": "csv" - }, - { - "name": "json" - }, - { - "name": "tsv" - }, - { - "name": "txt" - }, - { - "name": "yaml" - }, - { - "name": "cbor" - }, - { - "name": "smile" - }, - { - "name": "arrow" - } - ], - "name": { - "name": "EsqlFormat", - "namespace": "esql._types" - }, - "specLocation": "esql/_types/QueryParameters.ts#L20-L29" - }, { "kind": "interface", "name": { @@ -122111,448 +118555,79 @@ } }, { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results.", - "name": "columnar", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.", - "name": "filter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "name": "locale", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", - "docId": "esql-query-params", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params", - "name": "params", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } - } - } - }, - { - "description": "If provided and `true` the response will include an extra `profile` object\nwith information on how the query was executed. This information is for human debugging\nand its format can change at any time but it can give some insight into the performance\nof each part of the query.", - "name": "profile", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.", - "name": "query", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Tables to use with the LOOKUP operation. The top level key is the table\nname and the next level key is the column name.", - "name": "tables", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "TableValuesContainer", - "namespace": "esql._types" - } - } - } - } - } - ] - }, - "description": "Run an async ES|QL query.\nAsynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.\n\nThe API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "esql.async_query" - }, - "path": [], - "query": [ + "kind": "enum", + "members": [ { - "description": "The character to use between values within a CSV row.\nIt is valid only for the CSV format.", - "name": "delimiter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "name": "csv" }, { - "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", - "name": "drop_null_columns", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "json" }, { - "description": "A short version of the Accept header, for example `json` or `yaml`.", - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "EsqlFormat", - "namespace": "esql._types" - } - } + "name": "tsv" }, { - "description": "The period for which the query and its results are stored in the cluster.\nThe default period is five days.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.\nIf the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value.", - "name": "keep_alive", - "required": false, - "serverDefault": "5d", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "txt" }, { - "description": "Indicates whether the query and its results are stored in the cluster.\nIf false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter.", - "name": "keep_on_completion", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "yaml" }, { - "description": "The period to wait for the request to finish.\nBy default, the request waits for 1 second for the query results.\nIf the query completes during this period, results are returned\nOtherwise, a query ID is returned that can later be used to retrieve the results.", - "name": "wait_for_completion_timeout", - "required": false, - "serverDefault": "1s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "esql/async_query/AsyncQueryRequest.ts#L28-L118" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "EsqlResult", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "esql.async_query" - }, - "specLocation": "esql/async_query/AsyncQueryResponse.ts#L22-L24" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Delete an async ES|QL query.\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "esql.async_query_delete" - }, - "path": [ - { - "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "esql/async_query_delete/AsyncQueryDeleteRequest.ts#L23-L46" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "esql.async_query_delete" - }, - "specLocation": "esql/async_query_delete/AsyncQueryDeleteResponse.ts#L22-L24" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get async ES|QL query results.\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "esql.async_query_get" - }, - "path": [ - { - "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", - "name": "drop_null_columns", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } + "name": "cbor" }, { - "description": "The period for which the query and its results are stored in the cluster.\nWhen this period expires, the query and its results are deleted, even if the query is still ongoing.", - "name": "keep_alive", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "smile" }, { - "description": "The period to wait for the request to finish.\nBy default, the request waits for complete query results.\nIf the request completes during the period specified in this parameter, complete query results are returned.\nOtherwise, the response returns an `is_running` value of `true` and no results.", - "name": "wait_for_completion_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } + "name": "arrow" } ], - "specLocation": "esql/async_query_get/AsyncQueryGetRequest.ts#L24-L62" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "EsqlResult", - "namespace": "_types" - } - } - }, "name": { - "name": "Response", - "namespace": "esql.async_query_get" + "name": "EsqlFormat", + "namespace": "esql.query" }, - "specLocation": "esql/async_query_get/AsyncQueryGetResponse.ts#L22-L24" + "specLocation": "esql/query/QueryRequest.ts#L93-L102" }, { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Stop async ES|QL query.\n\nThis API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, + "kind": "type_alias", "name": { - "name": "Request", - "namespace": "esql.async_query_stop" + "name": "EsqlQueryParameters", + "namespace": "esql.query" }, - "path": [ - { - "description": "The unique identifier of the query.\nA query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time.\nA query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "specLocation": "esql/query/types.ts#L23-L25", + "type": { + "kind": "union_of", + "items": [ + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } } - } - } - ], - "query": [ - { - "description": "Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.\nIf `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.", - "name": "drop_null_columns", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + }, + { + "kind": "dictionary_of", + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "singleKey": true, + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } } } - } - ], - "specLocation": "esql/async_query_stop/AsyncQueryStopRequest.ts#L23-L50" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "EsqlResult", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "esql.async_query_stop" - }, - "specLocation": "esql/async_query_stop/AsyncQueryStopResponse.ts#L22-L24" + ] + } }, { "kind": "request", @@ -122600,17 +118675,14 @@ { "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "docId": "esql-query-params", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-rest-params", "name": "params", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "FieldValue", - "namespace": "_types" - } + "kind": "instance_of", + "type": { + "name": "EsqlQueryParameters", + "namespace": "esql.query" } } }, @@ -122695,7 +118767,7 @@ "kind": "instance_of", "type": { "name": "EsqlFormat", - "namespace": "esql._types" + "namespace": "esql.query" } } }, @@ -122725,7 +118797,7 @@ } } ], - "specLocation": "esql/query/QueryRequest.ts#L27-L98" + "specLocation": "esql/query/QueryRequest.ts#L26-L91" }, { "kind": "response", @@ -122734,7 +118806,7 @@ "value": { "kind": "instance_of", "type": { - "name": "EsqlResult", + "name": "EsqlColumns", "namespace": "_types" } } @@ -122797,22 +118869,8 @@ "namespace": "features.get_features" }, "path": [], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "features/get_features/GetFeaturesRequest.ts#L23-L53" + "query": [], + "specLocation": "features/get_features/GetFeaturesRequest.ts#L22-L37" }, { "kind": "response", @@ -122861,22 +118919,8 @@ "namespace": "features.reset_features" }, "path": [], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "features/reset_features/ResetFeaturesRequest.ts#L23-L60" + "query": [], + "specLocation": "features/reset_features/ResetFeaturesRequest.ts#L22-L44" }, { "kind": "response", @@ -122928,7 +118972,7 @@ "body": { "kind": "no_body" }, - "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", + "description": "Get global checkpoints.\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "inherits": { "type": { "name": "RequestBase", @@ -123022,7 +119066,7 @@ } } ], - "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L74" + "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L66" }, { "kind": "response", @@ -123134,7 +119178,7 @@ { "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "docId": "ccs-network-delays", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/modules-cross-cluster-search.html#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -123287,7 +119331,7 @@ } } ], - "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L126" + "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L115" }, { "kind": "response", @@ -123616,7 +119660,7 @@ }, { "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -124319,7 +120363,7 @@ } } ], - "specLocation": "fleet/search/SearchRequest.ts#L54-L266" + "specLocation": "fleet/search/SearchRequest.ts#L54-L259" }, { "kind": "response", @@ -124645,7 +120689,7 @@ { "description": "Filters associated terms so only those that are significantly associated with your query are included.", "docId": "search-aggregations-bucket-significantterms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html", "name": "use_significance", "required": true, "type": { @@ -124681,7 +120725,7 @@ { "description": "An optional guiding query that constrains the Graph API as it explores connected terms.", "name": "query", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -124894,7 +120938,7 @@ "properties": [ { "name": "boost", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -124915,7 +120959,8 @@ } } ], - "specLocation": "graph/_types/Vertex.ts#L61-L64" + "shortcutProperty": "term", + "specLocation": "graph/_types/Vertex.ts#L61-L65" }, { "kind": "request", @@ -125029,7 +121074,7 @@ } } ], - "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L84" + "specLocation": "graph/explore/GraphExploreRequest.ts#L28-L78" }, { "kind": "response", @@ -125276,7 +121321,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L39-L93" + "specLocation": "ilm/_types/Phase.ts#L42-L96" }, { "kind": "interface", @@ -125374,7 +121419,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L133-L139" + "specLocation": "ilm/_types/Phase.ts#L136-L142" }, { "kind": "interface", @@ -125395,7 +121440,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L149-L151" + "specLocation": "ilm/_types/Phase.ts#L152-L154" }, { "kind": "interface", @@ -125427,7 +121472,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L112-L115" + "specLocation": "ilm/_types/Phase.ts#L115-L118" }, { "kind": "interface", @@ -125459,7 +121504,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L123-L126" + "specLocation": "ilm/_types/Phase.ts#L126-L129" }, { "kind": "interface", @@ -125480,7 +121525,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L141-L143" + "specLocation": "ilm/_types/Phase.ts#L144-L146" }, { "kind": "interface", @@ -125501,18 +121546,31 @@ } }, { + "esQuirk": "output as a millis number in XPack usage stats, which cannot roundtrip with a Duration as it requires a unit.", "name": "min_age", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + ] } } ], - "specLocation": "ilm/_types/Phase.ts#L26-L29" + "specLocation": "ilm/_types/Phase.ts#L26-L32" }, { "kind": "interface", @@ -125577,7 +121635,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L31-L37" + "specLocation": "ilm/_types/Phase.ts#L34-L40" }, { "kind": "interface", @@ -125598,7 +121656,6 @@ } }, { - "description": "Arbitrary metadata that is not automatically generated or used by Elasticsearch.", "name": "_meta", "required": false, "type": { @@ -125610,7 +121667,7 @@ } } ], - "specLocation": "ilm/_types/Policy.ts#L23-L29" + "specLocation": "ilm/_types/Policy.ts#L23-L26" }, { "kind": "interface", @@ -125730,7 +121787,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L99-L110" + "specLocation": "ilm/_types/Phase.ts#L102-L113" }, { "kind": "interface", @@ -125762,7 +121819,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L128-L131" + "specLocation": "ilm/_types/Phase.ts#L131-L134" }, { "kind": "interface", @@ -125783,7 +121840,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L95-L97" + "specLocation": "ilm/_types/Phase.ts#L98-L100" }, { "kind": "interface", @@ -125826,7 +121883,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L117-L121" + "specLocation": "ilm/_types/Phase.ts#L120-L124" }, { "kind": "interface", @@ -125847,7 +121904,7 @@ } } ], - "specLocation": "ilm/_types/Phase.ts#L145-L147" + "specLocation": "ilm/_types/Phase.ts#L148-L150" }, { "kind": "request", @@ -125911,7 +121968,7 @@ } } ], - "specLocation": "ilm/delete_lifecycle/DeleteLifecycleRequest.ts#L24-L58" + "specLocation": "ilm/delete_lifecycle/DeleteLifecycleRequest.ts#L24-L51" }, { "kind": "response", @@ -126425,9 +122482,22 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } } ], - "specLocation": "ilm/explain_lifecycle/ExplainLifecycleRequest.ts#L24-L64" + "specLocation": "ilm/explain_lifecycle/ExplainLifecycleRequest.ts#L24-L62" }, { "kind": "response", @@ -126569,7 +122639,7 @@ } } ], - "specLocation": "ilm/get_lifecycle/GetLifecycleRequest.ts#L24-L61" + "specLocation": "ilm/get_lifecycle/GetLifecycleRequest.ts#L24-L50" }, { "kind": "response", @@ -126608,7 +122678,7 @@ "body": { "kind": "no_body" }, - "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", + "description": "Get the ILM status.\nGet the current index lifecycle management status.", "inherits": { "type": { "name": "RequestBase", @@ -126621,7 +122691,7 @@ }, "path": [], "query": [], - "specLocation": "ilm/get_status/GetIlmStatusRequest.ts#L22-L38" + "specLocation": "ilm/get_status/GetIlmStatusRequest.ts#L22-L29" }, { "kind": "response", @@ -126706,7 +122776,7 @@ } } ], - "specLocation": "ilm/migrate_to_data_tiers/Request.ts#L22-L61" + "specLocation": "ilm/migrate_to_data_tiers/Request.ts#L22-L54" }, { "kind": "response", @@ -126725,7 +122795,6 @@ } }, { - "description": "The name of the legacy index template that was deleted.\nThis information is missing if no legacy index templates were deleted.", "name": "removed_legacy_template", "required": true, "type": { @@ -126737,7 +122806,6 @@ } }, { - "description": "The ILM policies that were updated.", "name": "migrated_ilm_policies", "required": true, "type": { @@ -126752,7 +122820,6 @@ } }, { - "description": "The indices that were migrated to tier preference routing.", "name": "migrated_indices", "required": true, "type": { @@ -126764,7 +122831,6 @@ } }, { - "description": "The legacy index templates that were updated to not contain custom routing settings for the provided data attribute.", "name": "migrated_legacy_templates", "required": true, "type": { @@ -126779,7 +122845,6 @@ } }, { - "description": "The composable index templates that were updated to not contain custom routing settings for the provided data attribute.", "name": "migrated_composable_templates", "required": true, "type": { @@ -126794,7 +122859,6 @@ } }, { - "description": "The component templates that were updated to not contain custom routing settings for the provided data attribute.", "name": "migrated_component_templates", "required": true, "type": { @@ -126814,7 +122878,7 @@ "name": "Response", "namespace": "ilm.migrate_to_data_tiers" }, - "specLocation": "ilm/migrate_to_data_tiers/Response.ts#L22-L51" + "specLocation": "ilm/migrate_to_data_tiers/Response.ts#L22-L32" }, { "kind": "request", @@ -126825,7 +122889,6 @@ "kind": "properties", "properties": [ { - "description": "The step that the index is expected to be in.", "name": "current_step", "required": true, "type": { @@ -126837,7 +122900,6 @@ } }, { - "description": "The step that you want to run.", "name": "next_step", "required": true, "type": { @@ -126876,7 +122938,7 @@ } ], "query": [], - "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L64" + "specLocation": "ilm/move_to_step/MoveToStepRequest.ts#L24-L51" }, { "kind": "response", @@ -126904,7 +122966,6 @@ }, "properties": [ { - "description": "The optional action to which the index will be moved.", "name": "action", "required": false, "type": { @@ -126916,7 +122977,6 @@ } }, { - "description": "The optional step name to which the index will be moved.", "name": "name", "required": false, "type": { @@ -126939,7 +122999,7 @@ } } ], - "specLocation": "ilm/move_to_step/types.ts#L20-L31" + "specLocation": "ilm/move_to_step/types.ts#L20-L25" }, { "kind": "request", @@ -127016,7 +123076,7 @@ } } ], - "specLocation": "ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L66" + "specLocation": "ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L59" }, { "kind": "response", @@ -127070,7 +123130,7 @@ } ], "query": [], - "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L42" + "specLocation": "ilm/remove_policy/RemovePolicyRequest.ts#L23-L35" }, { "kind": "response", @@ -127144,7 +123204,7 @@ } ], "query": [], - "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L43" + "specLocation": "ilm/retry/RetryIlmRequest.ts#L23-L36" }, { "kind": "response", @@ -127186,10 +123246,8 @@ "path": [], "query": [ { - "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.", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -127199,10 +123257,8 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -127212,7 +123268,7 @@ } } ], - "specLocation": "ilm/start/StartIlmRequest.ts#L23-L52" + "specLocation": "ilm/start/StartIlmRequest.ts#L23-L37" }, { "kind": "response", @@ -127254,10 +123310,8 @@ "path": [], "query": [ { - "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.", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -127267,10 +123321,8 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -127280,7 +123332,7 @@ } } ], - "specLocation": "ilm/stop/StopIlmRequest.ts#L23-L54" + "specLocation": "ilm/stop/StopIlmRequest.ts#L23-L39" }, { "kind": "response", @@ -127493,7 +123545,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L413-L415" + "specLocation": "indices/_types/IndexSettings.ts#L407-L409" }, { "kind": "interface", @@ -127505,7 +123557,7 @@ { "description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -128716,7 +124768,7 @@ } ], "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings", "name": { "name": "IndexSettings", "namespace": "indices._types" @@ -129610,7 +125662,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L325-L331" + "specLocation": "indices/_types/IndexSettings.ts#L319-L325" }, { "kind": "interface", @@ -129701,34 +125753,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are\napplicable for an index).", - "name": "prefer_ilm", - "required": false, - "serverDefault": "true", - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ] - } } ], - "specLocation": "indices/_types/IndexSettings.ts#L276-L315" + "specLocation": "indices/_types/IndexSettings.ts#L276-L309" }, { "kind": "interface", @@ -129750,7 +125777,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L317-L323" + "specLocation": "indices/_types/IndexSettings.ts#L311-L317" }, { "kind": "interface", @@ -129782,7 +125809,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L333-L336" + "specLocation": "indices/_types/IndexSettings.ts#L327-L330" }, { "kind": "interface", @@ -129955,7 +125982,7 @@ { "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -130192,7 +126219,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L567-L569" + "specLocation": "indices/_types/IndexSettings.ts#L550-L552" }, { "kind": "interface", @@ -130214,7 +126241,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L571-L578" + "specLocation": "indices/_types/IndexSettings.ts#L554-L561" }, { "kind": "interface", @@ -130268,7 +126295,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L580-L585" + "specLocation": "indices/_types/IndexSettings.ts#L563-L568" }, { "kind": "interface", @@ -130280,7 +126307,7 @@ { "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", "docId": "index-modules-slowlog-slowlog", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#index-slow-log", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-slowlog.html#index-slow-log", "name": "index", "required": false, "type": { @@ -130292,7 +126319,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L587-L594" + "specLocation": "indices/_types/IndexSettings.ts#L570-L577" }, { "kind": "enum", @@ -130320,7 +126347,7 @@ "kind": "interface", "description": "Mapping Limit Settings", "docId": "mapping-settings-limit", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-settings-limit.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html", "name": { "name": "MappingLimitSettings", "namespace": "indices._types" @@ -130404,41 +126431,18 @@ } }, { - "name": "source", + "name": "ignore_malformed", "required": false, "type": { "kind": "instance_of", "type": { - "name": "MappingLimitSettingsSourceFields", - "namespace": "indices._types" + "name": "boolean", + "namespace": "_builtins" } } - }, - { - "name": "ignore_malformed", - "required": false, - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ] - } } ], - "specLocation": "indices/_types/IndexSettings.ts#L417-L431" + "specLocation": "indices/_types/IndexSettings.ts#L411-L424" }, { "kind": "interface", @@ -130461,7 +126465,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L452-L459" + "specLocation": "indices/_types/IndexSettings.ts#L445-L452" }, { "kind": "interface", @@ -130483,7 +126487,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L489-L495" + "specLocation": "indices/_types/IndexSettings.ts#L482-L488" }, { "kind": "interface", @@ -130505,7 +126509,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L480-L487" + "specLocation": "indices/_types/IndexSettings.ts#L473-L480" }, { "kind": "interface", @@ -130528,7 +126532,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L461-L469" + "specLocation": "indices/_types/IndexSettings.ts#L454-L462" }, { "kind": "interface", @@ -130551,28 +126555,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L471-L478" - }, - { - "kind": "interface", - "name": { - "name": "MappingLimitSettingsSourceFields", - "namespace": "indices._types" - }, - "properties": [ - { - "name": "mode", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceMode", - "namespace": "indices._types" - } - } - } - ], - "specLocation": "indices/_types/IndexSettings.ts#L497-L499" + "specLocation": "indices/_types/IndexSettings.ts#L464-L471" }, { "kind": "interface", @@ -130632,7 +126615,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L433-L450" + "specLocation": "indices/_types/IndexSettings.ts#L426-L443" }, { "kind": "interface", @@ -130653,7 +126636,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L338-L340" + "specLocation": "indices/_types/IndexSettings.ts#L332-L334" }, { "kind": "interface", @@ -130703,7 +126686,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L342-L345" + "specLocation": "indices/_types/IndexSettings.ts#L336-L339" }, { "kind": "interface", @@ -130761,7 +126744,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L409-L411" + "specLocation": "indices/_types/IndexSettings.ts#L403-L405" }, { "kind": "interface", @@ -131406,7 +127389,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L507-L512" + "specLocation": "indices/_types/IndexSettings.ts#L490-L495" }, { "kind": "interface", @@ -131460,7 +127443,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L519-L524" + "specLocation": "indices/_types/IndexSettings.ts#L502-L507" }, { "kind": "interface", @@ -131492,7 +127475,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L514-L517" + "specLocation": "indices/_types/IndexSettings.ts#L497-L500" }, { "kind": "interface", @@ -131529,25 +127512,6 @@ ], "specLocation": "indices/_types/IndexSettings.ts#L50-L63" }, - { - "kind": "enum", - "members": [ - { - "name": "DISABLED" - }, - { - "name": "STORED" - }, - { - "name": "SYNTHETIC" - } - ], - "name": { - "name": "SourceMode", - "namespace": "indices._types" - }, - "specLocation": "indices/_types/IndexSettings.ts#L501-L505" - }, { "kind": "interface", "name": { @@ -131579,7 +127543,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L526-L535" + "specLocation": "indices/_types/IndexSettings.ts#L509-L518" }, { "kind": "enum", @@ -131606,7 +127570,7 @@ "name": "StorageType", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L537-L565" + "specLocation": "indices/_types/IndexSettings.ts#L520-L548" }, { "kind": "interface", @@ -131763,7 +127727,7 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L347-L369" + "specLocation": "indices/_types/IndexSettings.ts#L341-L363" }, { "kind": "enum", @@ -131787,7 +127751,7 @@ "name": "TranslogDurability", "namespace": "indices._types" }, - "specLocation": "indices/_types/IndexSettings.ts#L371-L386" + "specLocation": "indices/_types/IndexSettings.ts#L365-L380" }, { "kind": "interface", @@ -131823,25 +127787,21 @@ } } ], - "specLocation": "indices/_types/IndexSettings.ts#L388-L407" + "specLocation": "indices/_types/IndexSettings.ts#L382-L401" }, { "kind": "enum", "members": [ { - "description": "Disable metadata changes, such as closing the index.", "name": "metadata" }, { - "description": "Disable read operations.", "name": "read" }, { - "description": "Disable write operations and metadata changes.", "name": "read_only" }, { - "description": "Disable write operations. However, metadata changes are still allowed.", "name": "write" } ], @@ -131849,7 +127809,7 @@ "name": "IndicesBlockOptions", "namespace": "indices.add_block" }, - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L91-L100" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L45-L50" }, { "kind": "interface", @@ -131891,7 +127851,7 @@ "body": { "kind": "no_body" }, - "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", + "description": "Add an index block.\nLimits the operations allowed on an index by blocking specific operation types.", "inherits": { "type": { "name": "RequestBase", @@ -131904,7 +127864,7 @@ }, "path": [ { - "description": "A comma-separated list or wildcard expression of index names used to limit the request.\nBy default, you must explicitly name the indices you are adding blocks to.\nTo allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nYou can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.", + "description": "A comma separated list of indices to add a block to", "name": "index", "required": true, "type": { @@ -131916,7 +127876,7 @@ } }, { - "description": "The block type to add to the index.", + "description": "The block to add (one of read, write, read_only or metadata)", "name": "block", "required": true, "type": { @@ -131930,10 +127890,9 @@ ], "query": [ { - "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.\nFor example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)", "name": "allow_no_indices", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -131943,10 +127902,9 @@ } }, { - "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`.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "name": "expand_wildcards", "required": false, - "serverDefault": "open", "type": { "kind": "instance_of", "type": { @@ -131956,10 +127914,9 @@ } }, { - "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)", "name": "ignore_unavailable", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -131969,10 +127926,9 @@ } }, { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "description": "Specify timeout for connection to master", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131982,10 +127938,9 @@ } }, { - "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nIt can also be set to `-1` to indicate that the request should never timeout.", + "description": "Explicit operation timeout", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -131995,7 +127950,7 @@ } } ], - "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L89" + "specLocation": "indices/add_block/IndicesAddBlockRequest.ts#L24-L43" }, { "kind": "response", @@ -132410,7 +128365,7 @@ { "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.", "docId": "analysis-analyzers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html", "name": "analyzer", "required": false, "type": { @@ -132439,7 +128394,7 @@ { "description": "Array of character filters used to preprocess characters before the tokenizer.", "docId": "analysis-charfilters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html", "name": "char_filter", "required": false, "type": { @@ -132481,7 +128436,7 @@ { "description": "Array of token filters used to apply after the tokenizer.", "docId": "analysis-tokenfilters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenfilters.html", "name": "filter", "required": false, "type": { @@ -132498,7 +128453,7 @@ { "description": "Normalizer to use to convert text into a single token.", "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html", "name": "normalizer", "required": false, "type": { @@ -132524,7 +128479,7 @@ { "description": "Tokenizer to use to convert text into tokens.", "docId": "analysis-tokenizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenizers.html", "name": "tokenizer", "required": false, "type": { @@ -132537,7 +128492,7 @@ } ] }, - "description": "Get tokens from text analysis.\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "inherits": { "type": { "name": "RequestBase", @@ -132552,7 +128507,7 @@ { "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "docId": "analysis-standard-analyzer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-analyzer.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-standard-analyzer.html", "name": "index", "required": false, "type": { @@ -132565,7 +128520,7 @@ } ], "query": [], - "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L110" + "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L93" }, { "kind": "response", @@ -132678,61 +128633,7 @@ "body": { "kind": "no_body" }, - "description": "Cancel a migration reindex operation.\n\nCancel a migration reindex attempt for a data stream or index.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "indices.cancel_migrate_reindex" - }, - "path": [ - { - "description": "The index or data stream name", - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "indices/cancel_migrate_reindex/MigrateCancelReindexRequest.ts#L23-L38" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "indices.cancel_migrate_reindex" - }, - "specLocation": "indices/cancel_migrate_reindex/MigrateCancelReindexResponse.ts#L22-L24" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter.", + "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -132846,7 +128747,7 @@ } } ], - "specLocation": "indices/clear_cache/IndicesClearCacheRequest.ts#L23-L94" + "specLocation": "indices/clear_cache/IndicesIndicesClearCacheRequest.ts#L23-L78" }, { "kind": "response", @@ -132900,7 +128801,7 @@ { "description": "Configuration options for the target index.", "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html#index-modules-settings", "name": "settings", "required": false, "type": { @@ -132920,7 +128821,7 @@ } ] }, - "description": "Clone an index.\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.", + "description": "Clone an index.\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.", "inherits": { "type": { "name": "RequestBase", @@ -132947,7 +128848,7 @@ { "description": "Name of the target index to create.", "docId": "indices-clone-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html", "name": "target", "required": true, "type": { @@ -133000,7 +128901,7 @@ } } ], - "specLocation": "indices/clone/IndicesCloneRequest.ts#L27-L127" + "specLocation": "indices/clone/IndicesCloneRequest.ts#L27-L98" }, { "kind": "response", @@ -133228,7 +129129,7 @@ } } ], - "specLocation": "indices/close/CloseIndexRequest.ts#L24-L101" + "specLocation": "indices/close/CloseIndexRequest.ts#L24-L94" }, { "kind": "response", @@ -133321,7 +129222,7 @@ { "description": "Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters", "docId": "mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html", "name": "mappings", "required": false, "type": { @@ -133346,7 +129247,7 @@ } ] }, - "description": "Create an index.\nYou can use the create index API to add a new index to an Elasticsearch cluster.\nWhen creating an index, you can specify the following:\n\n* Settings for the index.\n* Mappings for fields in the index.\n* Index aliases\n\n**Wait for active shards**\n\nBy default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.\nThe index creation response will indicate what happened.\nFor example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out.\nNote that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful.\nThese values simply indicate whether the operation completed before the timeout.\nIf `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.\nIf `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).\n\nYou can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.\nNote that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.", + "description": "Create an index.\nCreates a new index.", "inherits": { "type": { "name": "RequestBase", @@ -133412,7 +129313,7 @@ } } ], - "specLocation": "indices/create/IndicesCreateRequest.ts#L28-L108" + "specLocation": "indices/create/IndicesCreateRequest.ts#L28-L82" }, { "kind": "response", @@ -133468,7 +129369,7 @@ "body": { "kind": "no_body" }, - "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", "inherits": { "type": { "name": "RequestBase", @@ -133521,7 +129422,7 @@ } } ], - "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L24-L65" + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L24-L58" }, { "kind": "response", @@ -133541,155 +129442,6 @@ }, "specLocation": "indices/create_data_stream/IndicesCreateDataStreamResponse.ts#L22-L24" }, - { - "kind": "interface", - "name": { - "name": "CreateFrom", - "namespace": "indices.create_from" - }, - "properties": [ - { - "description": "Mappings overrides to be applied to the destination index (optional)", - "name": "mappings_override", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "description": "Settings overrides to be applied to the destination index (optional)", - "name": "settings_override", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - }, - { - "description": "If index blocks should be removed when creating destination index (optional)", - "name": "remove_index_blocks", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L46-L60" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "codegenName": "create_from", - "value": { - "kind": "instance_of", - "type": { - "name": "CreateFrom", - "namespace": "indices.create_from" - } - } - }, - "description": "Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "indices.create_from" - }, - "path": [ - { - "description": "The source index or data stream name", - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "description": "The destination index or data stream name", - "name": "dest", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "indices/create_from/MigrateCreateFromRequest.ts#L25-L44" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "shards_acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "indices.create_from" - }, - "specLocation": "indices/create_from/MigrateCreateFromResponse.ts#L22-L28" - }, { "kind": "interface", "name": { @@ -133777,7 +129529,7 @@ "body": { "kind": "no_body" }, - "description": "Get data stream stats.\n\nGet statistics for one or more data streams.", + "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -133817,7 +129569,7 @@ } } ], - "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L61" + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L49" }, { "kind": "response", @@ -133915,7 +129667,7 @@ "body": { "kind": "no_body" }, - "description": "Delete indices.\nDeleting an index deletes its documents, shards, and metadata.\nIt does not delete related Kibana components, such as data views, visualizations, or dashboards.\n\nYou cannot delete the current write index of a data stream.\nTo delete the index, you must roll over the data stream so a new write index is created.\nYou can then use the delete index API to delete the previous write index.", + "description": "Delete indices.\nDeletes one or more indices.", "inherits": { "type": { "name": "RequestBase", @@ -134007,7 +129759,7 @@ } } ], - "specLocation": "indices/delete/IndicesDeleteRequest.ts#L24-L87" + "specLocation": "indices/delete/IndicesDeleteRequest.ts#L24-L74" }, { "kind": "response", @@ -134100,7 +129852,7 @@ } } ], - "specLocation": "indices/delete_alias/IndicesDeleteAliasRequest.ts#L24-L70" + "specLocation": "indices/delete_alias/IndicesDeleteAliasRequest.ts#L24-L58" }, { "kind": "response", @@ -134191,7 +129943,7 @@ } } ], - "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L47" + "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L40" }, { "kind": "response", @@ -134272,7 +130024,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L59" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L51" }, { "kind": "response", @@ -134353,7 +130105,7 @@ } } ], - "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L60" + "specLocation": "indices/delete_index_template/IndicesDeleteIndexTemplateRequest.ts#L24-L53" }, { "kind": "response", @@ -134381,7 +130133,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a legacy index template.", + "description": "Deletes a legacy index template.", "inherits": { "type": { "name": "RequestBase", @@ -134434,7 +130186,7 @@ } } ], - "specLocation": "indices/delete_template/IndicesDeleteTemplateRequest.ts#L24-L59" + "specLocation": "indices/delete_template/IndicesDeleteTemplateRequest.ts#L24-L52" }, { "kind": "response", @@ -134462,7 +130214,7 @@ "body": { "kind": "no_body" }, - "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.", + "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.", "inherits": { "type": { "name": "RequestBase", @@ -134554,7 +130306,7 @@ } } ], - "specLocation": "indices/disk_usage/IndicesDiskUsageRequest.ts#L23-L84" + "specLocation": "indices/disk_usage/IndicesDiskUsageRequest.ts#L23-L74" }, { "kind": "response", @@ -134624,7 +130376,7 @@ } ], "query": [], - "specLocation": "indices/downsample/Request.ts#L24-L58" + "specLocation": "indices/downsample/Request.ts#L24-L51" }, { "kind": "response", @@ -134648,7 +130400,7 @@ "body": { "kind": "no_body" }, - "description": "Check indices.\nCheck if one or more indices, index aliases, or data streams exist.", + "description": "Check indices.\nChecks if one or more indices, index aliases, or data streams exist.", "inherits": { "type": { "name": "RequestBase", @@ -134753,7 +130505,7 @@ } } ], - "specLocation": "indices/exists/IndicesExistsRequest.ts#L23-L80" + "specLocation": "indices/exists/IndicesExistsRequest.ts#L23-L73" }, { "kind": "response", @@ -134774,7 +130526,7 @@ "body": { "kind": "no_body" }, - "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", + "description": "Check aliases.\nChecks if one or more data stream or index aliases exist.", "inherits": { "type": { "name": "RequestBase", @@ -134865,7 +130617,7 @@ } } ], - "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L24-L82" + "specLocation": "indices/exists_alias/IndicesExistsAliasRequest.ts#L24-L70" }, { "kind": "response", @@ -134886,7 +130638,7 @@ "body": { "kind": "no_body" }, - "description": "Check index templates.\n\nCheck whether index templates exist.", + "description": "Check index templates.\nCheck whether index templates exist.", "inherits": { "type": { "name": "RequestBase", @@ -134926,7 +130678,7 @@ } } ], - "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L51" + "specLocation": "indices/exists_index_template/IndicesExistsIndexTemplateRequest.ts#L24-L43" }, { "kind": "response", @@ -134947,7 +130699,7 @@ "body": { "kind": "no_body" }, - "description": "Check existence of index templates.\nGet information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", + "description": "Check existence of index templates.\nReturns information about whether a particular index template exists.", "inherits": { "type": { "name": "RequestBase", @@ -134960,7 +130712,7 @@ }, "path": [ { - "description": "A comma-separated list of index template names used to limit the request.\nWildcard (`*`) expressions are supported.", + "description": "The comma separated names of the index templates", "name": "name", "required": true, "type": { @@ -134974,10 +130726,9 @@ ], "query": [ { - "description": "Indicates whether to use a flat format for the response.", + "description": "Return settings in flat format (default: false)", "name": "flat_settings", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -134987,10 +130738,9 @@ } }, { - "description": "Indicates whether to get information from the local node only.", + "description": "Return local information, do not retrieve the state from master node (default: false)", "name": "local", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -135000,10 +130750,9 @@ } }, { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -135013,7 +130762,7 @@ } } ], - "specLocation": "indices/exists_template/IndicesExistsTemplateRequest.ts#L24-L69" + "specLocation": "indices/exists_template/IndicesExistsTemplateRequest.ts#L24-L39" }, { "kind": "response", @@ -135212,7 +130961,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L47" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L39" }, { "kind": "response", @@ -135494,7 +131243,7 @@ "body": { "kind": "no_body" }, - "description": "Get field usage stats.\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.\n\nThe response body reports the per-shard usage count of the data structures that back the fields in the index.\nA given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.", + "description": "Get field usage stats.\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.", "inherits": { "type": { "name": "RequestBase", @@ -135569,6 +131318,32 @@ } } }, + { + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, { "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`).", "name": "wait_for_active_shards", @@ -135583,7 +131358,7 @@ } } ], - "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts#L28-L84" + "specLocation": "indices/field_usage_stats/IndicesFieldUsageStatsRequest.ts#L29-L87" }, { "kind": "response", @@ -135833,7 +131608,7 @@ } } ], - "specLocation": "indices/flush/IndicesFlushRequest.ts#L23-L92" + "specLocation": "indices/flush/IndicesFlushRequest.ts#L23-L81" }, { "kind": "response", @@ -135861,7 +131636,7 @@ "body": { "kind": "no_body" }, - "description": "Force a merge.\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", + "description": "Force a merge.\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.", "inherits": { "type": { "name": "RequestBase", @@ -135972,7 +131747,7 @@ } } ], - "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L108" + "specLocation": "indices/forcemerge/IndicesForceMergeRequest.ts#L24-L56" }, { "kind": "response", @@ -136037,7 +131812,7 @@ "name": "Feature", "namespace": "indices.get" }, - "specLocation": "indices/get/IndicesGetRequest.ts#L98-L102" + "specLocation": "indices/get/IndicesGetRequest.ts#L91-L95" }, { "kind": "type_alias", @@ -136045,7 +131820,7 @@ "name": "Features", "namespace": "indices.get" }, - "specLocation": "indices/get/IndicesGetRequest.ts#L103-L103", + "specLocation": "indices/get/IndicesGetRequest.ts#L96-L96", "type": { "kind": "union_of", "items": [ @@ -136077,7 +131852,7 @@ "body": { "kind": "no_body" }, - "description": "Get index information.\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", + "description": "Get index information.\nReturns information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -136214,7 +131989,7 @@ } } ], - "specLocation": "indices/get/IndicesGetRequest.ts#L24-L96" + "specLocation": "indices/get/IndicesGetRequest.ts#L24-L89" }, { "kind": "response", @@ -136376,7 +132151,7 @@ } } ], - "specLocation": "indices/get_alias/IndicesGetAliasRequest.ts#L24-L93" + "specLocation": "indices/get_alias/IndicesGetAliasRequest.ts#L24-L73" }, { "kind": "response", @@ -136476,7 +132251,7 @@ "body": { "kind": "no_body" }, - "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -136542,7 +132317,7 @@ } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L68" + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L60" }, { "kind": "response", @@ -136571,52 +132346,6 @@ }, "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleResponse.ts#L23-L25" }, - { - "kind": "interface", - "name": { - "name": "DataStreamStats", - "namespace": "indices.get_data_lifecycle_stats" - }, - "properties": [ - { - "description": "The count of the backing indices for the data stream.", - "name": "backing_indices_in_error", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The count of the backing indices for the data stream that have encountered an error.", - "name": "backing_indices_in_total", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The name of the data stream.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DataStreamName", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsResponse.ts#L46-L59" - }, { "kind": "request", "attachedBehaviors": [ @@ -136625,112 +132354,7 @@ "body": { "kind": "no_body" }, - "description": "Get data stream lifecycle stats.\nGet statistics about the data streams that are managed by a data stream lifecycle.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "indices.get_data_lifecycle_stats" - }, - "path": [], - "query": [], - "specLocation": "indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsRequest.ts#L22-L38" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "The count of data streams currently being managed by the data stream lifecycle.", - "name": "data_stream_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Information about the data streams that are managed by the data stream lifecycle.", - "name": "data_streams", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DataStreamStats", - "namespace": "indices.get_data_lifecycle_stats" - } - } - } - }, - { - "description": "The duration of the last data stream lifecycle execution.", - "name": "last_run_duration_in_millis", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The time that passed between the start of the last two data stream lifecycle executions.\nThis value should amount approximately to `data_streams.lifecycle.poll_interval`.", - "name": "time_between_starts_in_millis", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "indices.get_data_lifecycle_stats" - }, - "specLocation": "indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsResponse.ts#L24-L44" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get data streams.\n\nGet information about one or more data streams.", + "description": "Get data streams.\nRetrieves information about one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -136818,7 +132442,7 @@ } } ], - "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L78" + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L66" }, { "kind": "response", @@ -136855,7 +132479,7 @@ "body": { "kind": "no_body" }, - "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.\n\nThis API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -136868,7 +132492,7 @@ }, "path": [ { - "description": "Comma-separated list or wildcard expression of fields used to limit returned information.\nSupports wildcards (`*`).", + "description": "Comma-separated list or wildcard expression of fields used to limit returned information.", "name": "fields", "required": true, "type": { @@ -136959,7 +132583,7 @@ } } ], - "specLocation": "indices/get_field_mapping/IndicesGetFieldMappingRequest.ts#L23-L89" + "specLocation": "indices/get_field_mapping/IndicesGetFieldMappingRequest.ts#L23-L74" }, { "kind": "response", @@ -137062,7 +132686,7 @@ "body": { "kind": "no_body" }, - "description": "Get index templates.\nGet information about one or more index templates.", + "description": "Get index templates.\nReturns information about one or more index templates.", "inherits": { "type": { "name": "RequestBase", @@ -137150,7 +132774,7 @@ } } ], - "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L72" + "specLocation": "indices/get_index_template/IndicesGetIndexTemplateRequest.ts#L24-L61" }, { "kind": "response", @@ -137219,7 +132843,7 @@ "body": { "kind": "no_body" }, - "description": "Get mapping definitions.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", + "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more indices.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -137311,7 +132935,7 @@ } } ], - "specLocation": "indices/get_mapping/IndicesGetMappingRequest.ts#L24-L84" + "specLocation": "indices/get_mapping/IndicesGetMappingRequest.ts#L24-L73" }, { "kind": "response", @@ -137350,256 +132974,7 @@ "body": { "kind": "no_body" }, - "description": "Get the migration reindexing status.\n\nGet the status of a migration reindex attempt for a data stream or index.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "indices.get_migrate_reindex_status" - }, - "path": [ - { - "description": "The index or data stream name.", - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Indices", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusRequest.ts#L23-L38" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "start_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "name": "start_time_millis", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "name": "complete", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "total_indices_in_data_stream", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "total_indices_requiring_upgrade", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "successes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "in_progress", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "StatusInProgress", - "namespace": "indices.get_migrate_reindex_status" - } - } - } - }, - { - "name": "pending", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "errors", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "StatusError", - "namespace": "indices.get_migrate_reindex_status" - } - } - } - }, - { - "name": "exception", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "indices.get_migrate_reindex_status" - }, - "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusResponse.ts#L23-L36" - }, - { - "kind": "interface", - "name": { - "name": "StatusError", - "namespace": "indices.get_migrate_reindex_status" - }, - "properties": [ - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "message", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusResponse.ts#L44-L47" - }, - { - "kind": "interface", - "name": { - "name": "StatusInProgress", - "namespace": "indices.get_migrate_reindex_status" - }, - "properties": [ - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "total_doc_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "name": "reindexed_doc_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/get_migrate_reindex_status/MigrateGetReindexStatusResponse.ts#L38-L42" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get index settings.\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices.", + "description": "Get index settings.\nReturns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -137729,7 +133104,7 @@ } } ], - "specLocation": "indices/get_settings/IndicesGetSettingsRequest.ts#L24-L111" + "specLocation": "indices/get_settings/IndicesGetSettingsRequest.ts#L24-L92" }, { "kind": "response", @@ -137768,7 +133143,7 @@ "body": { "kind": "no_body" }, - "description": "Get index templates.\nGet information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", + "description": "Get index templates.\nRetrieves information about one or more index templates.", "inherits": { "type": { "name": "RequestBase", @@ -137834,7 +133209,7 @@ } } ], - "specLocation": "indices/get_template/IndicesGetTemplateRequest.ts#L24-L72" + "specLocation": "indices/get_template/IndicesGetTemplateRequest.ts#L24-L57" }, { "kind": "response", @@ -137865,123 +133240,6 @@ }, "specLocation": "indices/get_template/IndicesGetTemplateResponse.ts#L23-L26" }, - { - "kind": "interface", - "name": { - "name": "MigrateReindex", - "namespace": "indices.migrate_reindex" - }, - "properties": [ - { - "description": "Reindex mode. Currently only 'upgrade' is supported.", - "name": "mode", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ModeEnum", - "namespace": "indices.migrate_reindex" - } - } - }, - { - "description": "The source index or data stream (only data streams are currently supported).", - "name": "source", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SourceIndex", - "namespace": "indices.migrate_reindex" - } - } - } - ], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L39-L48" - }, - { - "kind": "enum", - "members": [ - { - "name": "upgrade" - } - ], - "name": { - "name": "ModeEnum", - "namespace": "indices.migrate_reindex" - }, - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L54-L56" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "codegenName": "reindex", - "value": { - "kind": "instance_of", - "type": { - "name": "MigrateReindex", - "namespace": "indices.migrate_reindex" - } - } - }, - "description": "Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "indices.migrate_reindex" - }, - "path": [], - "query": [], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L23-L37" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "indices.migrate_reindex" - }, - "specLocation": "indices/migrate_reindex/MigrateReindexResponse.ts#L22-L24" - }, - { - "kind": "interface", - "name": { - "name": "SourceIndex", - "namespace": "indices.migrate_reindex" - }, - "properties": [ - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ], - "specLocation": "indices/migrate_reindex/MigrateReindexRequest.ts#L50-L52" - }, { "kind": "request", "attachedBehaviors": [ @@ -138043,7 +133301,7 @@ } } ], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L65" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L59" }, { "kind": "response", @@ -138172,7 +133430,7 @@ }, "path": [], "query": [], - "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L44" + "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L38" }, { "kind": "response", @@ -138200,7 +133458,7 @@ "body": { "kind": "no_body" }, - "description": "Open a closed index.\nFor data streams, the API opens any closed backing indices.\n\nA closed index is blocked for read/write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nThis allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behavior can be turned off by using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nThis setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.\n\nBecause opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.", + "description": "Opens a closed index.\nFor data streams, the API opens any closed backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -138215,7 +133473,7 @@ { "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nBy default, you must explicitly name the indices you using to limit the request.\nTo limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false.\nYou can update this setting in the `elasticsearch.yml` file or using the cluster update settings API.", "docId": "cluster-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html", "name": "index", "required": true, "type": { @@ -138307,7 +133565,7 @@ } } ], - "specLocation": "indices/open/IndicesOpenRequest.ts#L24-L111" + "specLocation": "indices/open/IndicesOpenRequest.ts#L24-L82" }, { "kind": "response", @@ -138392,7 +133650,7 @@ } } ], - "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L57" + "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L50" }, { "kind": "response", @@ -138505,7 +133763,7 @@ { "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.", "docId": "api-date-math-index-names", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-date-math-index-names", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-date-math-index-names", "name": "name", "required": true, "type": { @@ -138545,7 +133803,7 @@ } } ], - "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L102" + "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L92" }, { "kind": "response", @@ -138647,7 +133905,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L74" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L67" }, { "kind": "response", @@ -138742,7 +134000,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L158-L180" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L121-L143" }, { "kind": "request", @@ -138816,7 +134074,7 @@ } }, { - "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.", + "description": "Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.", "name": "version", "required": false, "type": { @@ -138828,9 +134086,9 @@ } }, { - "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", + "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -138882,7 +134140,7 @@ } ] }, - "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.", "inherits": { "type": { "name": "RequestBase", @@ -138947,7 +134205,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L156" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L119" }, { "kind": "response", @@ -139161,7 +134419,7 @@ } ] }, - "description": "Update field mappings.\nAdd new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", + "description": "Update field mappings.\nAdds new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields.\nFor data streams, these changes are applied to all backing indices by default.", "inherits": { "type": { "name": "RequestBase", @@ -139266,7 +134524,7 @@ } } ], - "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L41-L183" + "specLocation": "indices/put_mapping/IndicesPutMappingRequest.ts#L41-L149" }, { "kind": "response", @@ -139302,7 +134560,7 @@ } } }, - "description": "Update index settings.\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", + "description": "Update index settings.\nChanges dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "inherits": { "type": { "name": "RequestBase", @@ -139420,7 +134678,7 @@ } } ], - "specLocation": "indices/put_settings/IndicesPutSettingsRequest.ts#L25-L118" + "specLocation": "indices/put_settings/IndicesPutSettingsRequest.ts#L25-L93" }, { "kind": "response", @@ -139535,7 +134793,7 @@ } }, { - "description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.", + "description": "Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.", "name": "version", "required": false, "type": { @@ -139548,7 +134806,7 @@ } ] }, - "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.", + "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.", "inherits": { "type": { "name": "RequestBase", @@ -139624,7 +134882,7 @@ } } ], - "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L123" + "specLocation": "indices/put_template/IndicesPutTemplateRequest.ts#L29-L106" }, { "kind": "response", @@ -140246,7 +135504,7 @@ "body": { "kind": "no_body" }, - "description": "Get index recovery information.\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nAll recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", + "description": "Get index recovery information.\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", "inherits": { "type": { "name": "RequestBase", @@ -140299,7 +135557,7 @@ } } ], - "specLocation": "indices/recovery/IndicesRecoveryRequest.ts#L23-L84" + "specLocation": "indices/recovery/IndicesRecoveryRequest.ts#L23-L70" }, { "kind": "response", @@ -140708,7 +135966,7 @@ "body": { "kind": "no_body" }, - "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.\n\nBy default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.\nYou can change this default interval with the `index.refresh_interval` setting.\n\nRefresh requests are synchronous and do not return a response until the refresh operation completes.\n\nRefreshes are resource-intensive.\nTo ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.\n\nIf your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.\nThis option ensures the indexing operation waits for a periodic refresh before running the search.", + "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -140774,7 +136032,7 @@ } } ], - "specLocation": "indices/refresh/IndicesRefreshRequest.ts#L23-L84" + "specLocation": "indices/refresh/IndicesRefreshRequest.ts#L23-L61" }, { "kind": "response", @@ -140949,7 +136207,7 @@ } } ], - "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L59" + "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L51" }, { "kind": "response", @@ -140977,7 +136235,7 @@ "body": { "kind": "no_body" }, - "description": "Resolve the cluster.\n\nResolve the specified index expressions to return information about each cluster, including the local \"querying\" cluster, if included.\nIf no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.\n\nThis endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.\n\nYou use the same index expression with this endpoint as you would for cross-cluster search.\nIndex and cluster exclusions are also supported with this endpoint.\n\nFor each cluster in the index expression, information is returned about:\n\n* Whether the querying (\"local\") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.\n* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.\n* Whether there are any indices, aliases, or data streams on that cluster that match the index expression.\n* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).\n* Cluster version information, including the Elasticsearch server version.\n\nFor example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.\nEach cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.\n\n## Note on backwards compatibility\nThe ability to query without an index expression was added in version 8.18, so when\nquerying remote clusters older than that, the local cluster will send the index\nexpression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference\nto that index expression even though you didn't request it. If it causes a problem, you can\ninstead include an index expression like `*:*` to bypass the issue.\n\n## Advantages of using this endpoint before a cross-cluster search\n\nYou may want to exclude a cluster or index from a search when:\n\n* A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.\n* A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.\n* The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the \"error\" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)\n* A remote cluster is an older version that does not support the feature you want to use in your search.\n\n## Test availability of remote clusters\n\nThe `remote/info` endpoint is commonly used to test whether the \"local\" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.\nThe remote cluster may be available, while the local cluster is not currently connected to it.\n\nYou can use the `_resolve/cluster` API to attempt to reconnect to remote clusters.\nFor example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`.\nThe `connected` field in the response will indicate whether it was successful.\nIf a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.", + "description": "Resolve the cluster.\nResolve the specified index expressions to return information about each cluster, including the local cluster, if included.\nMultiple patterns and remote clusters are supported.\n\nThis endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.\n\nYou use the same index expression with this endpoint as you would for cross-cluster search.\nIndex and cluster exclusions are also supported with this endpoint.\n\nFor each cluster in the index expression, information is returned about:\n\n* Whether the querying (\"local\") cluster is currently connected to each remote cluster in the index expression scope.\n* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.\n* Whether there are any indices, aliases, or data streams on that cluster that match the index expression.\n* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).\n* Cluster version information, including the Elasticsearch server version.", "inherits": { "type": { "name": "RequestBase", @@ -140990,9 +136248,9 @@ }, "path": [ { - "description": "A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the ``:`` syntax.\nIndex and cluster exclusions (e.g., `-cluster1:*`) are also supported.\nIf no index expression is specified, information about all remote clusters configured on the local cluster\nis returned without doing any index matching", + "description": "Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the ``:`` syntax.", "name": "name", - "required": false, + "required": true, "type": { "kind": "instance_of", "type": { @@ -141004,10 +136262,9 @@ ], "query": [ { - "description": "If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing\nor closed indices. This behavior applies even if the request targets other open indices. For example, a request\ntargeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.", + "description": "If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing\nor closed indices. This behavior applies even if the request targets other open indices. For example, a request\ntargeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.", "name": "allow_no_indices", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -141017,7 +136274,7 @@ } }, { - "description": "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.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.", + "description": "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.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", "name": "expand_wildcards", "required": false, "serverDefault": "open", @@ -141030,14 +136287,9 @@ } }, { - "deprecation": { - "description": "", - "version": "7.16.0" - }, - "description": "If true, concrete, expanded, or aliased indices are ignored when frozen.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.", + "description": "If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false.", "name": "ignore_throttled", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -141047,10 +136299,9 @@ } }, { - "description": "If false, the request returns an error if it targets a missing or closed index.\nNOTE: This option is only supported when specifying an index expression. You will get an error if you specify index\noptions to the `_resolve/cluster` API endpoint that takes no index expression.", + "description": "If false, the request returns an error if it targets a missing or closed index. Defaults to false.", "name": "ignore_unavailable", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -141058,21 +136309,9 @@ "namespace": "_builtins" } } - }, - { - "description": "The maximum time to wait for remote clusters to respond.\nIf a remote cluster does not respond within this timeout period, the API response\nwill show the cluster as not connected and include an error message that the\nrequest timed out.\n\nThe default timeout is unset and the query can take\nas long as the networking layer is configured to wait for remote clusters that are\nnot responding (typically 30 seconds).", - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "indices/resolve_cluster/ResolveClusterRequest.ts#L24-L144" + "specLocation": "indices/resolve_cluster/ResolveClusterRequest.ts#L23-L76" }, { "kind": "interface", @@ -141095,7 +136334,7 @@ } }, { - "description": "The `skip_unavailable` setting for a remote cluster.", + "description": "The skip_unavailable setting for a remote cluster.", "name": "skip_unavailable", "required": true, "type": { @@ -141119,7 +136358,7 @@ } }, { - "description": "Provides error messages that are likely to occur if you do a search with this index expression\non the specified cluster (for example, lack of security privileges to query an index).", + "description": "Provides error messages that are likely to occur if you do a search with this index expression\non the specified cluster (e.g., lack of security privileges to query an index).", "name": "error", "required": false, "type": { @@ -141248,7 +136487,7 @@ } } ], - "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L69" + "specLocation": "indices/resolve_index/ResolveIndexRequest.ts#L23-L61" }, { "kind": "interface", @@ -141516,7 +136755,7 @@ } ] }, - "description": "Roll over to a new index.\nTIP: It is recommended to use the index lifecycle rollover action to automate rollovers.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named ``.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.", + "description": "Roll over to a new index.\nCreates a new index for a data stream or index alias.", "inherits": { "type": { "name": "RequestBase", @@ -141607,7 +136846,7 @@ } } ], - "specLocation": "indices/rollover/IndicesRolloverRequest.ts#L29-L147" + "specLocation": "indices/rollover/IndicesRolloverRequest.ts#L29-L100" }, { "kind": "response", @@ -142015,7 +137254,7 @@ } } ], - "specLocation": "indices/segments/IndicesSegmentsRequest.ts#L23-L73" + "specLocation": "indices/segments/IndicesSegmentsRequest.ts#L23-L61" }, { "kind": "response", @@ -142423,7 +137662,7 @@ } } ], - "specLocation": "indices/shard_stores/IndicesShardStoresRequest.ts#L24-L82" + "specLocation": "indices/shard_stores/IndicesShardStoresRequest.ts#L24-L71" }, { "kind": "response", @@ -142855,7 +138094,7 @@ } } ], - "specLocation": "indices/shrink/IndicesShrinkRequest.ts#L27-L113" + "specLocation": "indices/shrink/IndicesShrinkRequest.ts#L27-L107" }, { "kind": "response", @@ -142911,7 +138150,7 @@ "body": { "kind": "no_body" }, - "description": "Simulate an index.\nGet the index configuration that would be applied to the specified index from an existing index template.", + "description": "Simulate an index.\nReturns the index configuration that would be applied to the specified index from an existing index template.", "inherits": { "type": { "name": "RequestBase", @@ -142973,7 +138212,7 @@ } } ], - "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L58" + "specLocation": "indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L24-L50" }, { "kind": "response", @@ -143071,7 +138310,7 @@ { "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "docId": "avoid-index-pattern-collisions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html#avoid-index-pattern-collisions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html#avoid-index-pattern-collisions", "name": "index_patterns", "required": false, "type": { @@ -143148,7 +138387,7 @@ { "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html", "name": "_meta", "required": false, "type": { @@ -143188,7 +138427,7 @@ } ] }, - "description": "Simulate an index template.\nGet the index configuration that would be applied by a particular index template.", + "description": "Simulate an index template.\nReturns the index configuration that would be applied by a particular index template.", "inherits": { "type": { "name": "RequestBase", @@ -143263,7 +138502,7 @@ } } ], - "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L131" + "specLocation": "indices/simulate_template/IndicesSimulateTemplateRequest.ts#L27-L120" }, { "kind": "response", @@ -143409,7 +138648,7 @@ } ] }, - "description": "Split an index.\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.", + "description": "Split an index.\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.", "inherits": { "type": { "name": "RequestBase", @@ -143487,7 +138726,7 @@ } } ], - "specLocation": "indices/split/IndicesSplitRequest.ts#L27-L113" + "specLocation": "indices/split/IndicesSplitRequest.ts#L27-L98" }, { "kind": "response", @@ -144111,7 +139350,7 @@ } } ], - "specLocation": "indices/stats/IndicesStatsRequest.ts#L29-L113" + "specLocation": "indices/stats/IndicesStatsRequest.ts#L29-L94" }, { "kind": "response", @@ -145002,6 +140241,156 @@ ], "specLocation": "indices/stats/types.ts#L182-L184" }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Unfreeze an index.\nWhen a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "indices.unfreeze" + }, + "path": [ + { + "description": "Identifier for the index.", + "name": "index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.\nThis behavior applies even if the request targets other open indices.", + "name": "allow_no_indices", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "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.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "If `false`, the request returns an error if it targets a missing or closed index.", + "name": "ignore_unavailable", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "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`).", + "name": "wait_for_active_shards", + "required": false, + "serverDefault": "1", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/unfreeze/IndicesUnfreezeRequest.ts#L24-L77" + }, + { + "kind": "response", + "body": { + "kind": "properties", + "properties": [ + { + "name": "acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "shards_acknowledged", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ] + }, + "name": { + "name": "Response", + "namespace": "indices.unfreeze" + }, + "specLocation": "indices/unfreeze/IndicesUnfreezeResponse.ts#L20-L25" + }, { "kind": "interface", "name": { @@ -145408,7 +140797,7 @@ } } ], - "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L58" + "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L52" }, { "kind": "response", @@ -145684,7 +141073,7 @@ } } ], - "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L122" + "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L112" }, { "kind": "response", @@ -145797,7 +141186,7 @@ } } ], - "specLocation": "inference/_types/Results.ts#L92-L97" + "specLocation": "inference/_types/Results.ts#L91-L96" }, { "kind": "type_alias", @@ -145947,20 +141336,6 @@ } } }, - { - "name": "text_embedding_bits", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TextEmbeddingByteResult", - "namespace": "inference._types" - } - } - } - }, { "name": "text_embedding", "required": false, @@ -146018,7 +141393,7 @@ } } ], - "specLocation": "inference/_types/Results.ts#L79-L90", + "specLocation": "inference/_types/Results.ts#L79-L89", "variants": { "kind": "container" } @@ -146236,7 +141611,7 @@ } }, { - "description": "The inference identifier.", + "description": "The inference Id", "name": "inference_id", "required": true, "type": { @@ -146250,7 +141625,7 @@ ], "query": [ { - "description": "When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.", + "description": "When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned", "name": "dry_run", "required": false, "serverDefault": false, @@ -146263,7 +141638,7 @@ } }, { - "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.", + "description": "When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields", "name": "force", "required": false, "serverDefault": false, @@ -146276,7 +141651,7 @@ } } ], - "specLocation": "inference/delete/DeleteRequest.ts#L24-L66" + "specLocation": "inference/delete/DeleteRequest.ts#L24-L55" }, { "kind": "response", @@ -146342,7 +141717,7 @@ } ], "query": [], - "specLocation": "inference/get/GetRequest.ts#L24-L56" + "specLocation": "inference/get/GetRequest.ts#L24-L41" }, { "kind": "response", @@ -146380,7 +141755,7 @@ "kind": "properties", "properties": [ { - "description": "The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.", + "description": "Query input, required for rerank task.\nNot required for other tasks.", "name": "query", "required": false, "type": { @@ -146392,7 +141767,7 @@ } }, { - "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.", + "description": "Inference input.\nEither a string or an array of strings.", "name": "input", "required": true, "type": { @@ -146419,7 +141794,7 @@ } }, { - "description": "Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.", + "description": "Optional task settings", "name": "task_settings", "required": false, "type": { @@ -146432,7 +141807,7 @@ } ] }, - "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "description": "Perform inference on the service", "inherits": { "type": { "name": "RequestBase", @@ -146445,7 +141820,7 @@ }, "path": [ { - "description": "The type of inference task that the model performs.", + "description": "The task type", "name": "task_type", "required": false, "type": { @@ -146457,7 +141832,7 @@ } }, { - "description": "The unique identifier for the inference endpoint.", + "description": "The inference Id", "name": "inference_id", "required": true, "type": { @@ -146471,7 +141846,7 @@ ], "query": [ { - "description": "The amount of time to wait for the inference request to complete.", + "description": "Specifies the amount of time to wait for the inference request to complete.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -146484,7 +141859,7 @@ } } ], - "specLocation": "inference/inference/InferenceRequest.ts#L26-L89" + "specLocation": "inference/inference/InferenceRequest.ts#L26-L66" }, { "kind": "response", @@ -146520,7 +141895,7 @@ } } }, - "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "description": "Create an inference endpoint", "inherits": { "type": { "name": "RequestBase", @@ -146558,7 +141933,7 @@ } ], "query": [], - "specLocation": "inference/put/PutRequest.ts#L25-L65" + "specLocation": "inference/put/PutRequest.ts#L25-L44" }, { "kind": "response", @@ -146578,754 +141953,6 @@ }, "specLocation": "inference/put/PutResponse.ts#L22-L24" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\nNOTE: Inference endpoints for the completion task type currently only support a single string as input.", - "name": "input", - "required": true, - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - } - } - ] - }, - "description": "Perform streaming inference.\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "inference.stream_inference" - }, - "path": [ - { - "description": "The unique identifier for the inference endpoint.", - "name": "inference_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "The type of task that the model performs.", - "name": "task_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskType", - "namespace": "inference._types" - } - } - } - ], - "query": [], - "specLocation": "inference/stream_inference/StreamInferenceRequest.ts#L24-L67" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "StreamResult", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "inference.stream_inference" - }, - "specLocation": "inference/stream_inference/StreamInferenceResponse.ts#L22-L24" - }, - { - "kind": "interface", - "description": "A list of tools that the model can call.", - "name": { - "name": "CompletionTool", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The type of tool.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The function definition.", - "name": "function", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "CompletionToolFunction", - "namespace": "inference.unified_inference" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L223-L235" - }, - { - "kind": "interface", - "description": "Controls which tool is called by the model.", - "name": { - "name": "CompletionToolChoice", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The type of the tool.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The tool choice function.", - "name": "function", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "CompletionToolChoiceFunction", - "namespace": "inference.unified_inference" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L186-L198" - }, - { - "kind": "interface", - "description": "The tool choice function.", - "name": { - "name": "CompletionToolChoiceFunction", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The name of the function to call.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L175-L184" - }, - { - "kind": "interface", - "description": "The completion tool function definition.", - "name": { - "name": "CompletionToolFunction", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "A description of what the function does.\nThis is used by the model to choose when and how to call the function.", - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of the function.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The parameters the functional accepts. This should be formatted as a JSON object.", - "name": "parameters", - "required": false, - "type": { - "kind": "user_defined_value" - } - }, - { - "description": "Whether to enable schema adherence when generating the function call.", - "name": "strict", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L200-L221" - }, - { - "kind": "type_alias", - "codegenNames": [ - "string", - "object" - ], - "name": { - "name": "CompletionToolType", - "namespace": "inference.unified_inference" - }, - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L97-L100", - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "CompletionToolChoice", - "namespace": "inference.unified_inference" - } - } - ] - } - }, - { - "kind": "interface", - "description": "An object style representation of a single portion of a conversation.", - "name": { - "name": "ContentObject", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The text content.", - "name": "text", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The type of content.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L102-L114" - }, - { - "kind": "interface", - "description": "An object representing part of the conversation.", - "name": { - "name": "Message", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The content of the message.", - "name": "content", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "MessageContent", - "namespace": "inference.unified_inference" - } - } - }, - { - "description": "The role of the message author.", - "name": "role", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The tool call that this message is responding to.", - "name": "tool_call_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "The tool calls generated by the model.", - "name": "tool_calls", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ToolCall", - "namespace": "inference.unified_inference" - } - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L153-L173" - }, - { - "kind": "type_alias", - "codegenNames": [ - "string", - "object" - ], - "name": { - "name": "MessageContent", - "namespace": "inference.unified_inference" - }, - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L148-L151", - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "ContentObject", - "namespace": "inference.unified_inference" - } - } - } - ] - } - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "A list of objects representing the conversation.", - "name": "messages", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Message", - "namespace": "inference.unified_inference" - } - } - } - }, - { - "description": "The ID of the model to use.", - "name": "model", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The upper bound limit for the number of tokens that can be generated for a completion request.", - "name": "max_completion_tokens", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "A sequence of strings to control when the model should stop generating additional tokens.", - "name": "stop", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "The sampling temperature to use.", - "name": "temperature", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - }, - { - "description": "Controls which tool is called by the model.", - "name": "tool_choice", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "CompletionToolType", - "namespace": "inference.unified_inference" - } - } - }, - { - "description": "A list of tools that the model can call.", - "name": "tools", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "CompletionTool", - "namespace": "inference.unified_inference" - } - } - } - }, - { - "description": "Nucleus sampling, an alternative to sampling with temperature.", - "name": "top_p", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - } - ] - }, - "description": "Perform inference on the service using the Unified Schema", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "inference.unified_inference" - }, - "path": [ - { - "description": "The task type", - "name": "task_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskType", - "namespace": "inference._types" - } - } - }, - { - "description": "The inference Id", - "name": "inference_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Specifies the amount of time to wait for the inference request to complete.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L27-L95" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "StreamResult", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "inference.unified_inference" - }, - "specLocation": "inference/unified_inference/UnifiedResponse.ts#L22-L24" - }, - { - "kind": "interface", - "description": "A tool call generated by the model.", - "name": { - "name": "ToolCall", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The identifier of the tool call.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "The function that the model called.", - "name": "function", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ToolCallFunction", - "namespace": "inference.unified_inference" - } - } - }, - { - "description": "The type of the tool call.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L130-L146" - }, - { - "kind": "interface", - "description": "The function that the model called.", - "name": { - "name": "ToolCallFunction", - "namespace": "inference.unified_inference" - }, - "properties": [ - { - "description": "The arguments to call the function with in JSON format.", - "name": "arguments", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of the function to call.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "inference/unified_inference/UnifiedRequest.ts#L116-L128" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "codegenName": "inference_config", - "value": { - "kind": "instance_of", - "type": { - "name": "InferenceEndpoint", - "namespace": "inference._types" - } - } - }, - "description": "Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "inference.update" - }, - "path": [ - { - "description": "The unique identifier of the inference endpoint.", - "name": "inference_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "The type of inference task that the model performs.", - "name": "task_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TaskType", - "namespace": "inference._types" - } - } - } - ], - "query": [], - "specLocation": "inference/update/UpdateInferenceRequest.ts#L25-L61" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "InferenceEndpointInfo", - "namespace": "inference._types" - } - } - }, - "name": { - "name": "Response", - "namespace": "inference.update" - }, - "specLocation": "inference/update/UpdateInferenceResponse.ts#L22-L24" - }, { "kind": "interface", "inherits": { @@ -147384,7 +142011,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L328-L343" + "specLocation": "ingest/_types/Processors.ts#L329-L344" }, { "kind": "interface", @@ -147504,7 +142131,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L345-L386" + "specLocation": "ingest/_types/Processors.ts#L346-L387" }, { "kind": "interface", @@ -147558,7 +142185,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L555-L571" + "specLocation": "ingest/_types/Processors.ts#L556-L572" }, { "kind": "interface", @@ -147635,7 +142262,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L573-L596" + "specLocation": "ingest/_types/Processors.ts#L574-L597" }, { "kind": "interface", @@ -147794,7 +142421,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L598-L659" + "specLocation": "ingest/_types/Processors.ts#L599-L660" }, { "kind": "interface", @@ -147860,7 +142487,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L672-L692" + "specLocation": "ingest/_types/Processors.ts#L673-L693" }, { "kind": "enum", @@ -147894,7 +142521,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L661-L670" + "specLocation": "ingest/_types/Processors.ts#L662-L671" }, { "kind": "interface", @@ -147992,18 +142619,16 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L694-L727" + "specLocation": "ingest/_types/Processors.ts#L695-L728" }, { "kind": "interface", - "description": "The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported providers are `maxmind` and `ipinfo`, and the `maxmind` provider requires that an `account_id` (string) is configured.\nA provider (either `maxmind` or `ipinfo`) must be specified. The web and local providers can be returned as read only configurations.", "name": { "name": "DatabaseConfiguration", "namespace": "ingest._types" }, "properties": [ { - "containerProperty": true, "description": "The provider-assigned name of the IP geolocation database to download.", "name": "name", "required": true, @@ -148016,78 +142641,9 @@ } }, { + "description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading.\nAt present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.", "name": "maxmind", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Maxmind", - "namespace": "ingest._types" - } - } - }, - { - "name": "ipinfo", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ipinfo", - "namespace": "ingest._types" - } - } - } - ], - "specLocation": "ingest/_types/Database.ts#L22-L37", - "variants": { - "kind": "container" - } - }, - { - "kind": "interface", - "name": { - "name": "DatabaseConfigurationFull", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "web", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Web", - "namespace": "ingest._types" - } - } - }, - { - "name": "local", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Local", - "namespace": "ingest._types" - } - } - }, - { - "containerProperty": true, - "description": "The provider-assigned name of the IP geolocation database to download.", - "name": "name", "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "maxmind", - "required": false, "type": { "kind": "instance_of", "type": { @@ -148095,23 +142651,9 @@ "namespace": "ingest._types" } } - }, - { - "name": "ipinfo", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ipinfo", - "namespace": "ingest._types" - } - } } ], - "specLocation": "ingest/_types/Database.ts#L39-L53", - "variants": { - "kind": "container" - } + "specLocation": "ingest/_types/Database.ts#L22-L29" }, { "kind": "interface", @@ -148129,7 +142671,7 @@ { "description": "An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.\nCan be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.", "name": "date_formats", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -148217,7 +142759,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L729-L767" + "specLocation": "ingest/_types/Processors.ts#L730-L768" }, { "kind": "interface", @@ -148312,7 +142854,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L769-L802" + "specLocation": "ingest/_types/Processors.ts#L770-L803" }, { "kind": "interface", @@ -148378,189 +142920,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L804-L823" - }, - { - "kind": "interface", - "name": { - "name": "Document", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.", - "name": "_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Name of the index containing the document.", - "name": "_index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "description": "JSON body for the document.", - "name": "_source", - "required": true, - "type": { - "kind": "user_defined_value" - } - } - ], - "specLocation": "ingest/_types/Simulation.ts#L62-L76" - }, - { - "kind": "interface", - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "meta": { - "description": "Additional metadata", - "fieldname": "metadata" - }, - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "description": "The simulated document, with optional metadata.", - "name": { - "name": "DocumentSimulation", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "Unique identifier for the document. This ID must be unique within the `_index`.", - "name": "_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Name of the index containing the document.", - "name": "_index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "name": "_ingest", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Ingest", - "namespace": "ingest._types" - } - } - }, - { - "description": "Value used to send the document to a specific primary shard.", - "name": "_routing", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "JSON body for the document.", - "name": "_source", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "", - "name": "_version", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - ], - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "name": "_version_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionType", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Simulation.ts#L78-L108" + "specLocation": "ingest/_types/Processors.ts#L805-L824" }, { "kind": "interface", @@ -148613,7 +142973,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L825-L843" + "specLocation": "ingest/_types/Processors.ts#L826-L844" }, { "kind": "interface", @@ -148628,7 +142988,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L845-L845" + "specLocation": "ingest/_types/Processors.ts#L846-L846" }, { "kind": "interface", @@ -148732,7 +143092,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L847-L886" + "specLocation": "ingest/_types/Processors.ts#L848-L887" }, { "kind": "interface", @@ -148760,7 +143120,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L888-L894" + "specLocation": "ingest/_types/Processors.ts#L889-L895" }, { "kind": "enum", @@ -148790,7 +143150,7 @@ "name": "FingerprintDigest", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L896-L902" + "specLocation": "ingest/_types/Processors.ts#L897-L903" }, { "kind": "interface", @@ -148869,7 +143229,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L904-L932" + "specLocation": "ingest/_types/Processors.ts#L905-L933" }, { "kind": "interface", @@ -148922,7 +143282,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L934-L948" + "specLocation": "ingest/_types/Processors.ts#L935-L949" }, { "kind": "interface", @@ -149049,7 +143409,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L388-L429" + "specLocation": "ingest/_types/Processors.ts#L389-L430" }, { "kind": "enum", @@ -149065,7 +143425,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L437-L440" + "specLocation": "ingest/_types/Processors.ts#L438-L441" }, { "kind": "enum", @@ -149084,7 +143444,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L431-L435" + "specLocation": "ingest/_types/Processors.ts#L432-L436" }, { "kind": "interface", @@ -149191,7 +143551,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L442-L476" + "specLocation": "ingest/_types/Processors.ts#L443-L477" }, { "kind": "interface", @@ -149296,7 +143656,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L950-L981" + "specLocation": "ingest/_types/Processors.ts#L951-L982" }, { "kind": "interface", @@ -149374,7 +143734,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L983-L1007" + "specLocation": "ingest/_types/Processors.ts#L984-L1008" }, { "kind": "interface", @@ -149428,7 +143788,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1009-L1025" + "specLocation": "ingest/_types/Processors.ts#L1010-L1026" }, { "kind": "interface", @@ -149462,7 +143822,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1048-L1060", + "specLocation": "ingest/_types/Processors.ts#L1049-L1061", "variants": { "kind": "container" } @@ -149539,7 +143899,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1075-L1101" + "specLocation": "ingest/_types/Processors.ts#L1076-L1102" }, { "kind": "interface", @@ -149575,7 +143935,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1062-L1073" + "specLocation": "ingest/_types/Processors.ts#L1063-L1074" }, { "kind": "interface", @@ -149647,56 +144007,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1027-L1046" - }, - { - "kind": "interface", - "name": { - "name": "Ingest", - "namespace": "ingest._types" - }, - "properties": [ - { - "availability": { - "serverless": {}, - "stack": { - "since": "8.16.0" - } - }, - "name": "_redact", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Redact", - "namespace": "ingest._types" - } - } - }, - { - "name": "timestamp", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DateTime", - "namespace": "_types" - } - } - }, - { - "name": "pipeline", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Simulation.ts#L29-L37" + "specLocation": "ingest/_types/Processors.ts#L1028-L1047" }, { "kind": "interface", @@ -149803,16 +144114,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L478-L512" - }, - { - "kind": "interface", - "name": { - "name": "Ipinfo", - "namespace": "ingest._types" - }, - "properties": [], - "specLocation": "ingest/_types/Database.ts#L59-L59" + "specLocation": "ingest/_types/Processors.ts#L479-L513" }, { "kind": "interface", @@ -149865,7 +144167,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1103-L1118" + "specLocation": "ingest/_types/Processors.ts#L1104-L1119" }, { "kind": "interface", @@ -149944,7 +144246,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1120-L1149" + "specLocation": "ingest/_types/Processors.ts#L1121-L1150" }, { "kind": "enum", @@ -149962,7 +144264,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1151-L1156" + "specLocation": "ingest/_types/Processors.ts#L1152-L1157" }, { "kind": "interface", @@ -150119,28 +144421,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1158-L1210" - }, - { - "kind": "interface", - "name": { - "name": "Local", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ingest/_types/Database.ts#L63-L65" + "specLocation": "ingest/_types/Processors.ts#L1159-L1211" }, { "kind": "interface", @@ -150194,7 +144475,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1212-L1228" + "specLocation": "ingest/_types/Processors.ts#L1213-L1229" }, { "kind": "interface", @@ -150215,7 +144496,7 @@ } } ], - "specLocation": "ingest/_types/Database.ts#L55-L57" + "specLocation": "ingest/_types/Database.ts#L31-L33" }, { "kind": "interface", @@ -150310,7 +144591,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1230-L1264" + "specLocation": "ingest/_types/Processors.ts#L1231-L1265" }, { "kind": "interface", @@ -150489,94 +144770,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1266-L1277" - }, - { - "kind": "interface", - "name": { - "name": "PipelineSimulation", - "namespace": "ingest._types" - }, - "properties": [ - { - "name": "doc", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "DocumentSimulation", - "namespace": "ingest._types" - } - } - }, - { - "name": "tag", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "processor_type", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "status", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ActionStatusOptions", - "namespace": "watcher._types" - } - } - }, - { - "name": "description", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "ignored_error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - } - }, - { - "name": "error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Simulation.ts#L52-L60" + "specLocation": "ingest/_types/Processors.ts#L1267-L1278" }, { "kind": "interface", @@ -150604,8 +144798,8 @@ "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Script", + "namespace": "_types" } } }, @@ -150649,7 +144843,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L303-L326" + "specLocation": "ingest/_types/Processors.ts#L304-L327" }, { "kind": "interface", @@ -150661,7 +144855,7 @@ { "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.", "docId": "append-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/append-processor.html", "name": "append", "required": false, "type": { @@ -150675,7 +144869,7 @@ { "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.", "docId": "attachment", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/attachment.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/attachment.html", "name": "attachment", "required": false, "type": { @@ -150689,7 +144883,7 @@ { "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", "docId": "bytes-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/bytes-processor.html", "name": "bytes", "required": false, "type": { @@ -150703,7 +144897,7 @@ { "description": "Converts circle definitions of shapes to regular polygons which approximate them.", "docId": "ingest-circle-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest-circle-processor.html", "name": "circle", "required": false, "type": { @@ -150717,7 +144911,7 @@ { "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.", "docId": "community-id-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/community-id-processor.html", "name": "community_id", "required": false, "type": { @@ -150731,7 +144925,7 @@ { "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", "docId": "convert-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/convert-processor.html", "name": "convert", "required": false, "type": { @@ -150745,7 +144939,7 @@ { "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.", "docId": "csv-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/csv-processor.html", "name": "csv", "required": false, "type": { @@ -150759,7 +144953,7 @@ { "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", "docId": "data-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html", "name": "date", "required": false, "type": { @@ -150773,7 +144967,7 @@ { "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.", "docId": "date-index-name-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html", "name": "date_index_name", "required": false, "type": { @@ -150787,7 +144981,7 @@ { "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", "docId": "dissect-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dissect-processor.html", "name": "dissect", "required": false, "type": { @@ -150801,7 +144995,7 @@ { "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.", "docId": "dot-expand-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dot-expand-processor.html", "name": "dot_expander", "required": false, "type": { @@ -150815,7 +145009,7 @@ { "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.", "docId": "drop-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/drop-processor.html", "name": "drop", "required": false, "type": { @@ -150829,7 +145023,7 @@ { "description": "The `enrich` processor can enrich documents with data from another index.", "docId": "enrich-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-processor.html", "name": "enrich", "required": false, "type": { @@ -150843,7 +145037,7 @@ { "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.", "docId": "fail-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fail-processor.html", "name": "fail", "required": false, "type": { @@ -150857,7 +145051,7 @@ { "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.", "docId": "fingerprint-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fingerprint-processor.html", "name": "fingerprint", "required": false, "type": { @@ -150871,7 +145065,7 @@ { "description": "Runs an ingest processor on each element of an array or object.", "docId": "foreach-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/foreach-processor.html", "name": "foreach", "required": false, "type": { @@ -150897,7 +145091,7 @@ { "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", "docId": "geo-grid-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-geo-grid-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest-geo-grid-processor.html", "name": "geo_grid", "required": false, "type": { @@ -150911,7 +145105,7 @@ { "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.", "docId": "geoip-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/geoip-processor.html", "name": "geoip", "required": false, "type": { @@ -150925,7 +145119,7 @@ { "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok-processor.html", "name": "grok", "required": false, "type": { @@ -150939,7 +145133,7 @@ { "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.", "docId": "gsub-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/gsub-processor.html", "name": "gsub", "required": false, "type": { @@ -150966,7 +145160,7 @@ { "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.", "docId": "inference-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/inference-processor.html", "name": "inference", "required": false, "type": { @@ -150980,7 +145174,7 @@ { "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.", "docId": "join-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/join-processor.html", "name": "join", "required": false, "type": { @@ -150994,7 +145188,7 @@ { "description": "Converts a JSON string into a structured JSON object.", "docId": "json-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/json-processor.html", "name": "json", "required": false, "type": { @@ -151008,7 +145202,7 @@ { "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.", "docId": "kv-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/kv-processor.html", "name": "kv", "required": false, "type": { @@ -151022,7 +145216,7 @@ { "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", "docId": "lowercase-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html", "name": "lowercase", "required": false, "type": { @@ -151036,7 +145230,7 @@ { "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.", "docId": "network-direction-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/network-direction-processor.html", "name": "network_direction", "required": false, "type": { @@ -151050,7 +145244,7 @@ { "description": "Executes another pipeline.", "docId": "pipeline-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pipeline-processor.html", "name": "pipeline", "required": false, "type": { @@ -151064,7 +145258,7 @@ { "description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.", "docId": "redact-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/redact-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/redact-processor.html", "name": "redact", "required": false, "type": { @@ -151078,7 +145272,7 @@ { "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.", "docId": "registered-domain-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/registered-domain-processor.html", "name": "registered_domain", "required": false, "type": { @@ -151092,7 +145286,7 @@ { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remove-processor.html", "name": "remove", "required": false, "type": { @@ -151106,7 +145300,7 @@ { "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.", "docId": "rename-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rename-processor.html", "name": "rename", "required": false, "type": { @@ -151120,7 +145314,7 @@ { "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.", "docId": "reroute-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reroute-processor.html", "name": "reroute", "required": false, "type": { @@ -151134,7 +145328,7 @@ { "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", "docId": "script-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/script-processor.html", "name": "script", "required": false, "type": { @@ -151148,7 +145342,7 @@ { "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", "docId": "set-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html", "name": "set", "required": false, "type": { @@ -151176,7 +145370,7 @@ { "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.", "docId": "sort-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html", "name": "sort", "required": false, "type": { @@ -151190,7 +145384,7 @@ { "description": "Splits a field into an array using a separator character.\nOnly works on string fields.", "docId": "split-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/split-processor.html", "name": "split", "required": false, "type": { @@ -151204,7 +145398,7 @@ { "description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.", "docId": "terminate-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/terminate-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/terminate-processor.html", "name": "terminate", "required": false, "type": { @@ -151218,7 +145412,7 @@ { "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", "docId": "trim-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html", "name": "trim", "required": false, "type": { @@ -151232,7 +145426,7 @@ { "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", "docId": "uppercase-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/uppercase-processor.html", "name": "uppercase", "required": false, "type": { @@ -151246,7 +145440,7 @@ { "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.", "docId": "urldecode-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/urldecode-processor.html", "name": "urldecode", "required": false, "type": { @@ -151273,7 +145467,7 @@ { "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.", "docId": "user-agent-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-agent-processor.html", "name": "user_agent", "required": false, "type": { @@ -151285,34 +145479,12 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L301", + "specLocation": "ingest/_types/Processors.ts#L28-L302", "variants": { "kind": "container", "nonExhaustive": true } }, - { - "kind": "interface", - "name": { - "name": "Redact", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "indicates if document has been redacted", - "name": "_is_redacted", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "ingest/_types/Simulation.ts#L39-L44" - }, { "kind": "interface", "inherits": { @@ -151447,7 +145619,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1279-L1320" + "specLocation": "ingest/_types/Processors.ts#L1280-L1321" }, { "kind": "interface", @@ -151500,7 +145672,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1322-L1338" + "specLocation": "ingest/_types/Processors.ts#L1323-L1339" }, { "kind": "interface", @@ -151553,7 +145725,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1340-L1354" + "specLocation": "ingest/_types/Processors.ts#L1341-L1355" }, { "kind": "interface", @@ -151606,7 +145778,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1356-L1372" + "specLocation": "ingest/_types/Processors.ts#L1357-L1373" }, { "kind": "interface", @@ -151688,7 +145860,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1374-L1402" + "specLocation": "ingest/_types/Processors.ts#L1375-L1403" }, { "kind": "interface", @@ -151760,7 +145932,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1404-L1424" + "specLocation": "ingest/_types/Processors.ts#L1405-L1425" }, { "kind": "interface", @@ -151846,7 +146018,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1426-L1460" + "specLocation": "ingest/_types/Processors.ts#L1427-L1461" }, { "kind": "interface", @@ -151889,7 +146061,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1462-L1471" + "specLocation": "ingest/_types/Processors.ts#L1463-L1472" }, { "kind": "enum", @@ -151905,53 +146077,60 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1473-L1476" + "specLocation": "ingest/_types/Processors.ts#L1474-L1477" }, { "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, "name": { - "name": "SimulateDocumentResult", + "name": "SortProcessor", "namespace": "ingest._types" }, "properties": [ { - "name": "doc", - "required": false, + "description": "The field to be sorted.", + "name": "field", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "DocumentSimulation", - "namespace": "ingest._types" + "name": "Field", + "namespace": "_types" } } }, { - "name": "error", + "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", + "name": "order", "required": false, + "serverDefault": "asc", "type": { "kind": "instance_of", "type": { - "name": "ErrorCause", + "name": "SortOrder", "namespace": "_types" } } }, { - "name": "processor_results", + "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", + "name": "target_field", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "PipelineSimulation", - "namespace": "ingest._types" - } + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" } } } ], - "specLocation": "ingest/_types/Simulation.ts#L46-L50" + "specLocation": "ingest/_types/Processors.ts#L1479-L1495" }, { "kind": "interface", @@ -151962,12 +146141,12 @@ } }, "name": { - "name": "SortProcessor", + "name": "SplitProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to be sorted.", + "description": "The field to split.", "name": "field", "required": true, "type": { @@ -151979,22 +146158,48 @@ } }, { - "description": "The sort order to use.\nAccepts `\"asc\"` or `\"desc\"`.", - "name": "order", + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "name": "ignore_missing", "required": false, - "serverDefault": "asc", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The field to assign the sorted value to.\nBy default, the field is updated in-place.", + "description": "Preserves empty trailing fields, if any.", + "name": "preserve_trailing", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "A regex which matches the separator, for example, `,` or `\\s+`.", + "name": "separator", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", "name": "target_field", "required": false, + "serverDefault": "field", "type": { "kind": "instance_of", "type": { @@ -152004,7 +146209,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1478-L1494" + "specLocation": "ingest/_types/Processors.ts#L1497-L1522" }, { "kind": "interface", @@ -152015,12 +146220,27 @@ } }, "name": { - "name": "SplitProcessor", + "name": "TerminateProcessor", + "namespace": "ingest._types" + }, + "properties": [], + "specLocation": "ingest/_types/Processors.ts#L1524-L1524" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "TrimProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to split.", + "description": "The string-valued field to trim whitespace from.", "name": "field", "required": true, "type": { @@ -152045,8 +146265,49 @@ } }, { - "description": "Preserves empty trailing fields, if any.", - "name": "preserve_trailing", + "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", + "name": "target_field", + "required": false, + "serverDefault": "field", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1526-L1542" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "UppercaseProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "The field to make uppercase.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "name": "ignore_missing", "required": false, "serverDefault": false, "type": { @@ -152058,22 +146319,90 @@ } }, { - "description": "A regex which matches the separator, for example, `,` or `\\s+`.", - "name": "separator", + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "name": "target_field", + "required": false, + "serverDefault": "field", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1544-L1560" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "UriPartsProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Field containing the URI string.", + "name": "field", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The field to assign the split value to.\nBy default, the field is updated in-place.", + "description": "If `true`, the processor copies the unparsed URI to `.original`.", + "name": "keep_original", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the processor removes the `field` after parsing the URI string.\nIf parsing fails, the processor does not remove the `field`.", + "name": "remove_if_successful", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Output field for the URI object.", "name": "target_field", "required": false, - "serverDefault": "field", + "serverDefault": "url", "type": { "kind": "instance_of", "type": { @@ -152083,7 +146412,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1496-L1521" + "specLocation": "ingest/_types/Processors.ts#L1580-L1606" }, { "kind": "interface", @@ -152094,11 +146423,50 @@ } }, "name": { - "name": "TerminateProcessor", + "name": "UrlDecodeProcessor", "namespace": "ingest._types" }, - "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1523-L1523" + "properties": [ + { + "description": "The field to decode.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", + "name": "target_field", + "required": false, + "serverDefault": "field", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1562-L1578" }, { "kind": "interface", @@ -152109,254 +146477,12 @@ } }, "name": { - "name": "TrimProcessor", + "name": "UserAgentProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The string-valued field to trim whitespace from.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The field to assign the trimmed value to.\nBy default, the field is updated in-place.", - "name": "target_field", - "required": false, - "serverDefault": "field", - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L1525-L1541" - }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "name": { - "name": "UppercaseProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "The field to make uppercase.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", - "name": "target_field", - "required": false, - "serverDefault": "field", - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L1543-L1559" - }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "name": { - "name": "UriPartsProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "Field containing the URI string.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "If `true` and `field` does not exist, the processor quietly exits without modifying the document.", - "name": "ignore_missing", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the processor copies the unparsed URI to `.original`.", - "name": "keep_original", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the processor removes the `field` after parsing the URI string.\nIf parsing fails, the processor does not remove the `field`.", - "name": "remove_if_successful", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Output field for the URI object.", - "name": "target_field", - "required": false, - "serverDefault": "url", - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L1579-L1605" - }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "name": { - "name": "UrlDecodeProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "The field to decode.", - "name": "field", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", - "name": "ignore_missing", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The field to assign the converted value to.\nBy default, the field is updated in-place.", - "name": "target_field", - "required": false, - "serverDefault": "field", - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/_types/Processors.ts#L1561-L1577" - }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "ProcessorBase", - "namespace": "ingest._types" - } - }, - "name": { - "name": "UserAgentProcessor", - "namespace": "ingest._types" - }, - "properties": [ - { - "description": "The field containing the user agent string.", + "description": "The field containing the user agent string.", "name": "field", "required": true, "type": { @@ -152453,7 +146579,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L514-L545" + "specLocation": "ingest/_types/Processors.ts#L515-L546" }, { "kind": "enum", @@ -152478,16 +146604,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L547-L553" - }, - { - "kind": "interface", - "name": { - "name": "Web", - "namespace": "ingest._types" - }, - "properties": [], - "specLocation": "ingest/_types/Database.ts#L61-L61" + "specLocation": "ingest/_types/Processors.ts#L548-L554" }, { "kind": "request", @@ -152497,7 +146614,7 @@ "body": { "kind": "no_body" }, - "description": "Delete GeoIP database configurations.\n\nDelete one or more IP geolocation database configurations.", + "description": "Delete GeoIP database configurations.\nDelete one or more IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -152524,7 +146641,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -152537,7 +146654,7 @@ } }, { - "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -152550,7 +146667,7 @@ } } ], - "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L57" + "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseRequest.ts#L24-L49" }, { "kind": "response", @@ -152570,87 +146687,6 @@ }, "specLocation": "ingest/delete_geoip_database/DeleteGeoipDatabaseResponse.ts#L22-L24" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Delete IP geolocation database configurations.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "ingest.delete_ip_location_database" - }, - "path": [ - { - "description": "A comma-separated list of IP location database configurations.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Ids", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/delete_ip_location_database/DeleteIpLocationDatabaseRequest.ts#L24-L60" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "ingest.delete_ip_location_database" - }, - "specLocation": "ingest/delete_ip_location_database/DeleteIpLocationDatabaseResponse.ts#L22-L24" - }, { "kind": "request", "attachedBehaviors": [ @@ -152712,7 +146748,7 @@ } } ], - "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L61" + "specLocation": "ingest/delete_pipeline/DeletePipelineRequest.ts#L24-L54" }, { "kind": "response", @@ -152907,7 +146943,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L38" + "specLocation": "ingest/geo_ip_stats/IngestGeoIpStatsRequest.ts#L22-L31" }, { "kind": "response", @@ -153028,7 +147064,7 @@ "body": { "kind": "no_body" }, - "description": "Get GeoIP database configurations.\n\nGet information about one or more IP geolocation database configurations.", + "description": "Get GeoIP database configurations.\nGet information about one or more IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -153039,152 +147075,6 @@ "name": "Request", "namespace": "ingest.get_geoip_database" }, - "path": [ - { - "description": "A comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", - "name": "id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Ids", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L23-L51" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "databases", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "DatabaseConfigurationMetadata", - "namespace": "ingest.get_geoip_database" - } - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "ingest.get_geoip_database" - }, - "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseResponse.ts#L25-L27" - }, - { - "kind": "interface", - "name": { - "name": "DatabaseConfigurationMetadata", - "namespace": "ingest.get_ip_location_database" - }, - "properties": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "version", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - }, - { - "name": "modified_date_millis", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "name": "modified_date", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "EpochTime", - "namespace": "_types" - } - } - }, - { - "name": "database", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DatabaseConfigurationFull", - "namespace": "ingest._types" - } - } - } - ], - "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseResponse.ts#L28-L34" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get IP geolocation database configurations.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "ingest.get_ip_location_database" - }, "path": [ { "description": "Comma-separated list of database configuration IDs to retrieve.\nWildcard (`*`) expressions are supported.\nTo get all database configurations, omit this parameter or use `*`.", @@ -153201,7 +147091,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -153214,7 +147104,7 @@ } } ], - "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseRequest.ts#L24-L59" + "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseRequest.ts#L24-L47" }, { "kind": "response", @@ -153230,7 +147120,7 @@ "kind": "instance_of", "type": { "name": "DatabaseConfigurationMetadata", - "namespace": "ingest.get_ip_location_database" + "namespace": "ingest.get_geoip_database" } } } @@ -153239,9 +147129,9 @@ }, "name": { "name": "Response", - "namespace": "ingest.get_ip_location_database" + "namespace": "ingest.get_geoip_database" }, - "specLocation": "ingest/get_ip_location_database/GetIpLocationDatabaseResponse.ts#L24-L26" + "specLocation": "ingest/get_geoip_database/GetGeoipDatabaseResponse.ts#L25-L27" }, { "kind": "request", @@ -153251,7 +147141,7 @@ "body": { "kind": "no_body" }, - "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", + "description": "Get pipelines.\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -153304,7 +147194,7 @@ } } ], - "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L64" + "specLocation": "ingest/get_pipeline/GetPipelineRequest.ts#L24-L52" }, { "kind": "response", @@ -153356,7 +147246,7 @@ }, "path": [], "query": [], - "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L40" + "specLocation": "ingest/processor_grok/GrokProcessorPatternsRequest.ts#L22-L33" }, { "kind": "response", @@ -153427,7 +147317,7 @@ } ] }, - "description": "Create or update a GeoIP database configuration.\n\nRefer to the create or update IP geolocation database configuration API.", + "description": "Create or update GeoIP database configurations.\nCreate or update IP geolocation database configurations.", "inherits": { "type": { "name": "RequestBase", @@ -153480,7 +147370,7 @@ } } ], - "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L66" + "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseRequest.ts#L25-L58" }, { "kind": "response", @@ -153500,95 +147390,6 @@ }, "specLocation": "ingest/put_geoip_database/PutGeoipDatabaseResponse.ts#L22-L24" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "codegenName": "configuration", - "value": { - "kind": "instance_of", - "type": { - "name": "DatabaseConfiguration", - "namespace": "ingest._types" - } - } - }, - "description": "Create or update an IP geolocation database configuration.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "ingest.put_ip_location_database" - }, - "path": [ - { - "description": "The database configuration identifier.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nA value of `-1` indicates that the request should never time out.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged.\nA value of `-1` indicates that the request should never time out.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "ingest/put_ip_location_database/PutIpLocationDatabaseRequest.ts#L25-L62" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "AcknowledgedResponseBase", - "namespace": "_types" - } - } - }, - "name": { - "name": "Response", - "namespace": "ingest.put_ip_location_database" - }, - "specLocation": "ingest/put_ip_location_database/PutIpLocationDatabaseResponse.ts#L22-L24" - }, { "kind": "request", "attachedBehaviors": [ @@ -153743,7 +147544,7 @@ } } ], - "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L90" + "specLocation": "ingest/put_pipeline/PutPipelineRequest.ts#L25-L84" }, { "kind": "response", @@ -153763,6 +147564,346 @@ }, "specLocation": "ingest/put_pipeline/PutPipelineResponse.ts#L22-L24" }, + { + "kind": "interface", + "name": { + "name": "Document", + "namespace": "ingest.simulate" + }, + "properties": [ + { + "description": "Unique identifier for the document.\nThis ID must be unique within the `_index`.", + "name": "_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "Name of the index containing the document.", + "name": "_index", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "description": "JSON body for the document.", + "name": "_source", + "required": true, + "type": { + "kind": "user_defined_value" + } + } + ], + "specLocation": "ingest/simulate/types.ts#L62-L76" + }, + { + "kind": "interface", + "attachedBehaviors": [ + "AdditionalProperties" + ], + "behaviors": [ + { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + ], + "meta": { + "description": "Additional metadata", + "fieldname": "metadata" + }, + "type": { + "name": "AdditionalProperties", + "namespace": "_spec_utils" + } + } + ], + "description": "The simulated document, with optional metadata.", + "name": { + "name": "DocumentSimulation", + "namespace": "ingest.simulate" + }, + "properties": [ + { + "description": "Unique identifier for the document. This ID must be unique within the `_index`.", + "name": "_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + }, + { + "description": "Name of the index containing the document.", + "name": "_index", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "IndexName", + "namespace": "_types" + } + } + }, + { + "name": "_ingest", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Ingest", + "namespace": "ingest.simulate" + } + } + }, + { + "description": "Value used to send the document to a specific primary shard.", + "name": "_routing", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "JSON body for the document.", + "name": "_source", + "required": true, + "type": { + "kind": "dictionary_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "singleKey": false, + "value": { + "kind": "user_defined_value" + } + } + }, + { + "description": "", + "name": "_version", + "required": false, + "type": { + "kind": "instance_of", + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "VersionNumber", + "namespace": "_types" + } + } + ], + "type": { + "name": "Stringified", + "namespace": "_spec_utils" + } + } + }, + { + "name": "_version_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "VersionType", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/simulate/types.ts#L78-L108" + }, + { + "kind": "interface", + "name": { + "name": "Ingest", + "namespace": "ingest.simulate" + }, + "properties": [ + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.16.0" + } + }, + "name": "_redact", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Redact", + "namespace": "ingest.simulate" + } + } + }, + { + "name": "timestamp", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DateTime", + "namespace": "_types" + } + } + }, + { + "name": "pipeline", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/simulate/types.ts#L29-L37" + }, + { + "kind": "interface", + "name": { + "name": "PipelineSimulation", + "namespace": "ingest.simulate" + }, + "properties": [ + { + "name": "doc", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DocumentSimulation", + "namespace": "ingest.simulate" + } + } + }, + { + "name": "tag", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "processor_type", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "status", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ActionStatusOptions", + "namespace": "watcher._types" + } + } + }, + { + "name": "description", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "name": "ignored_error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + }, + { + "name": "error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + } + ], + "specLocation": "ingest/simulate/types.ts#L52-L60" + }, + { + "kind": "interface", + "name": { + "name": "Redact", + "namespace": "ingest.simulate" + }, + "properties": [ + { + "description": "indicates if document has been redacted", + "name": "_is_redacted", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/simulate/types.ts#L39-L44" + }, { "kind": "request", "attachedBehaviors": [ @@ -153781,13 +147922,13 @@ "kind": "instance_of", "type": { "name": "Document", - "namespace": "ingest._types" + "namespace": "ingest.simulate" } } } }, { - "description": "The pipeline to test.\nIf you don't specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", + "description": "Pipeline to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "name": "pipeline", "required": false, "type": { @@ -153800,7 +147941,7 @@ } ] }, - "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", + "description": "Simulate a pipeline.\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "inherits": { "type": { "name": "RequestBase", @@ -153813,7 +147954,7 @@ }, "path": [ { - "description": "The pipeline to test.\nIf you don't specify a `pipeline` in the request body, this parameter is required.", + "description": "Pipeline to test.\nIf you don’t specify a `pipeline` in the request body, this parameter is required.", "name": "id", "required": false, "type": { @@ -153839,7 +147980,7 @@ } } ], - "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L72" + "specLocation": "ingest/simulate/SimulatePipelineRequest.ts#L25-L59" }, { "kind": "response", @@ -153855,7 +147996,7 @@ "kind": "instance_of", "type": { "name": "SimulateDocumentResult", - "namespace": "ingest._types" + "namespace": "ingest.simulate" } } } @@ -153868,6 +148009,52 @@ }, "specLocation": "ingest/simulate/SimulatePipelineResponse.ts#L22-L24" }, + { + "kind": "interface", + "name": { + "name": "SimulateDocumentResult", + "namespace": "ingest.simulate" + }, + "properties": [ + { + "name": "doc", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DocumentSimulation", + "namespace": "ingest.simulate" + } + } + }, + { + "name": "error", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "ErrorCause", + "namespace": "_types" + } + } + }, + { + "name": "processor_results", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "PipelineSimulation", + "namespace": "ingest.simulate" + } + } + } + } + ], + "specLocation": "ingest/simulate/types.ts#L46-L50" + }, { "kind": "interface", "name": { @@ -154094,7 +148281,7 @@ "body": { "kind": "no_body" }, - "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", + "description": "Delete the license.\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "inherits": { "type": { "name": "RequestBase", @@ -154106,35 +148293,8 @@ "namespace": "license.delete" }, "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "license/delete/DeleteLicenseRequest.ts#L23-L54" + "query": [], + "specLocation": "license/delete/DeleteLicenseRequest.ts#L22-L32" }, { "kind": "response", @@ -154355,7 +148515,7 @@ "body": { "kind": "no_body" }, - "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", + "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "inherits": { "type": { "name": "RequestBase", @@ -154399,7 +148559,7 @@ } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L56" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L47" }, { "kind": "response", @@ -154446,7 +148606,7 @@ }, "path": [], "query": [], - "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L36" + "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L28" }, { "kind": "response", @@ -154493,7 +148653,7 @@ }, "path": [], "query": [], - "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L36" + "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L28" }, { "kind": "response", @@ -154590,7 +148750,7 @@ } ] }, - "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", + "description": "Update the license.\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "inherits": { "type": { "name": "RequestBase", @@ -154615,35 +148775,9 @@ "namespace": "_builtins" } } - }, - { - "description": "The period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "license/post/PostLicenseRequest.ts#L24-L70" + "specLocation": "license/post/PostLicenseRequest.ts#L23-L51" }, { "kind": "response", @@ -154699,7 +148833,7 @@ "body": { "kind": "no_body" }, - "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", + "description": "Start a basic license.\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "inherits": { "type": { "name": "RequestBase", @@ -154723,35 +148857,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L23-L59" + "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L22-L40" }, { "kind": "response", @@ -154890,22 +148998,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L23-L52" + "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L22-L39" }, { "kind": "response", @@ -154972,7 +149067,7 @@ }, "properties": [ { - "description": "A description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", + "description": "Description of the pipeline.\nThis description is not used by Elasticsearch or Logstash.", "name": "description", "required": true, "type": { @@ -154984,7 +149079,7 @@ } }, { - "description": "The date the pipeline was last updated.\nIt must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", + "description": "Date the pipeline was last updated.\nMust be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.", "name": "last_modified", "required": true, "type": { @@ -154996,59 +149091,59 @@ } }, { - "description": "The configuration for the pipeline.", - "extDocId": "logstash-configuration-file-structure", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html", - "name": "pipeline", + "description": "Optional metadata about the pipeline.\nMay have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", + "name": "pipeline_metadata", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineMetadata", + "namespace": "logstash._types" } } }, { - "description": "Optional metadata about the pipeline, which can have any contents.\nThis metadata is not generated or used by Elasticsearch or Logstash.", - "name": "pipeline_metadata", + "description": "User who last updated the pipeline.", + "name": "username", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineMetadata", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", - "extDocId": "logstash-logstash-settings-file", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", - "name": "pipeline_settings", + "description": "Configuration for the pipeline.", + "docId": "logstash-configuration-file-structure", + "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html", + "name": "pipeline", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineSettings", - "namespace": "logstash._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The user who last updated the pipeline.", - "name": "username", + "description": "Settings for the pipeline.\nSupports only flat keys in dot notation.", + "docId": "logstash-logstash-settings-file", + "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", + "name": "pipeline_settings", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "PipelineSettings", + "namespace": "logstash._types" } } } ], - "specLocation": "logstash/_types/Pipeline.ts#L60-L91" + "specLocation": "logstash/_types/Pipeline.ts#L60-L92" }, { "kind": "interface", @@ -155092,7 +149187,7 @@ { "description": "The number of workers that will, in parallel, execute the filter and output stages of the pipeline.", "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", "name": "pipeline.workers", "required": true, "type": { @@ -155130,7 +149225,7 @@ { "description": "The internal queuing model to use for event buffering.", "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "docUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-settings-file.html", "name": "queue.type", "required": true, "type": { @@ -155188,7 +149283,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", + "description": "Deletes a pipeline used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -155201,7 +149296,7 @@ }, "path": [ { - "description": "An identifier for the pipeline.", + "description": "Identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -155214,7 +149309,7 @@ } ], "query": [], - "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L47" + "specLocation": "logstash/delete_pipeline/LogstashDeletePipelineRequest.ts#L23-L37" }, { "kind": "response", @@ -155235,7 +149330,7 @@ "body": { "kind": "no_body" }, - "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", + "description": "Retrieves pipelines used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -155248,7 +149343,7 @@ }, "path": [ { - "description": "A comma-separated list of pipeline identifiers.", + "description": "Comma-separated list of pipeline identifiers.", "name": "id", "required": false, "type": { @@ -155261,7 +149356,7 @@ } ], "query": [], - "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L50" + "specLocation": "logstash/get_pipeline/LogstashGetPipelineRequest.ts#L23-L37" }, { "kind": "response", @@ -155308,7 +149403,7 @@ } } }, - "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", + "description": "Creates or updates a pipeline used for Logstash Central Management.", "inherits": { "type": { "name": "RequestBase", @@ -155321,7 +149416,7 @@ }, "path": [ { - "description": "An identifier for the pipeline.", + "description": "Identifier for the pipeline.", "name": "id", "required": true, "type": { @@ -155334,7 +149429,7 @@ } ], "query": [], - "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L51" + "specLocation": "logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L39" }, { "kind": "response", @@ -155355,7 +149450,6 @@ }, "properties": [ { - "description": "Optional details about the deprecation warning.", "name": "details", "required": false, "type": { @@ -155379,7 +149473,6 @@ } }, { - "description": "Descriptive information about the deprecation warning.", "name": "message", "required": true, "type": { @@ -155391,7 +149484,6 @@ } }, { - "description": "A link to the breaking change documentation, where you can find more information about this change.", "name": "url", "required": true, "type": { @@ -155432,7 +149524,7 @@ } } ], - "specLocation": "migration/deprecations/types.ts#L32-L47" + "specLocation": "migration/deprecations/types.ts#L32-L40" }, { "kind": "enum", @@ -155466,7 +149558,7 @@ "body": { "kind": "no_body" }, - "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", + "description": "Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.", "inherits": { "type": { "name": "RequestBase", @@ -155492,7 +149584,7 @@ } ], "query": [], - "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L49" + "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L32" }, { "kind": "response", @@ -155500,7 +149592,6 @@ "kind": "properties", "properties": [ { - "description": "Cluster-level deprecation warnings.", "name": "cluster_settings", "required": true, "type": { @@ -155515,7 +149606,6 @@ } }, { - "description": "Index warnings are sectioned off per index and can be filtered using an index-pattern in the query.\nThis section includes warnings for the backing indices of data streams specified in the request path.", "name": "index_settings", "required": true, "type": { @@ -155566,7 +149656,6 @@ } }, { - "description": "Node-level deprecation warnings.\nSince only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected.", "name": "node_settings", "required": true, "type": { @@ -155581,7 +149670,6 @@ } }, { - "description": "Machine learning-related deprecation warnings.", "name": "ml_settings", "required": true, "type": { @@ -155594,58 +149682,6 @@ } } } - }, - { - "description": "Template warnings are sectioned off per template and include deprecations for both component templates and\nindex templates.", - "name": "templates", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Deprecation", - "namespace": "migration.deprecations" - } - } - } - } - }, - { - "description": "ILM policy warnings are sectioned off per policy.", - "name": "ilm_policies", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Deprecation", - "namespace": "migration.deprecations" - } - } - } - } } ] }, @@ -155653,7 +149689,7 @@ "name": "Response", "namespace": "migration.deprecations" }, - "specLocation": "migration/deprecations/DeprecationInfoResponse.ts#L23-L54" + "specLocation": "migration/deprecations/DeprecationInfoResponse.ts#L23-L31" }, { "kind": "interface", @@ -155785,7 +149821,7 @@ "body": { "kind": "no_body" }, - "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", + "description": "Find out whether system features need to be upgraded or not", "inherits": { "type": { "name": "RequestBase", @@ -155798,7 +149834,7 @@ }, "path": [], "query": [], - "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L42" + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L27" }, { "kind": "response", @@ -155867,7 +149903,7 @@ "body": { "kind": "no_body" }, - "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", + "description": "Begin upgrades for system features", "inherits": { "type": { "name": "RequestBase", @@ -155880,7 +149916,7 @@ }, "path": [], "query": [], - "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L43" + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L27" }, { "kind": "response", @@ -157543,7 +151579,7 @@ { "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.", "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenizers.html", "name": "tokenizer", "required": false, "type": { @@ -157830,7 +151866,7 @@ { "description": "Specifies the maximum number of feature importance values per document.", "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html", "name": "num_top_feature_importance_values", "required": false, "serverDefault": 0, @@ -158397,7 +152433,7 @@ }, { "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "name": "query", "required": true, "type": { @@ -159261,7 +153297,7 @@ { "description": "An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.", "name": "includes", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -159276,7 +153312,7 @@ { "description": "An array of strings that defines the fields that will be included in the analysis.", "name": "excludes", - "required": true, + "required": false, "type": { "kind": "array_of", "value": { @@ -159342,7 +153378,7 @@ { "description": "The configuration information necessary to perform classification.", "docId": "ml-classification", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-classification.html", "name": "classification", "required": false, "type": { @@ -159356,7 +153392,7 @@ { "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", "docId": "ml-classification", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-classification.html", "name": "outlier_detection", "required": false, "type": { @@ -159370,7 +153406,7 @@ { "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", "docId": "ml-regression", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-regression.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-regression.html", "name": "regression", "required": false, "type": { @@ -160187,7 +154223,7 @@ { "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "name": "query", "required": false, "type": { @@ -161631,7 +155667,7 @@ { "description": "The analysis function that is used.\nFor example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.", "docId": "ml-functions", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-functions.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-functions.html", "name": "function", "required": true, "type": { @@ -162309,7 +156345,7 @@ { "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", "docId": "ml-regression-loss", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-regression-lossfunction.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/dfa-regression-lossfunction.html", "name": "absolute_importance", "required": false, "type": { @@ -163579,7 +157615,7 @@ { "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", "docId": "ml-put-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-job.html", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -165698,7 +159734,7 @@ { "description": "Specifies the maximum number of feature importance values per document.", "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-feature-importance.html", "name": "num_top_feature_importance_values", "required": false, "serverDefault": 0, @@ -167888,7 +161924,7 @@ { "description": "The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "cache_miss_count", "required": true, "type": { @@ -168103,7 +162139,7 @@ { "description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.", "docId": "cluster-nodes-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", "name": "ingest", "required": false, "type": { @@ -168465,7 +162501,7 @@ "body": { "kind": "no_body" }, - "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "inherits": { "type": { "name": "RequestBase", @@ -168491,7 +162527,7 @@ } ], "query": [], - "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L23-L50" + "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -168566,7 +162602,7 @@ } ] }, - "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "description": "Close anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "inherits": { "type": { "name": "RequestBase", @@ -168632,7 +162668,7 @@ } } ], - "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L85" + "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L78" }, { "kind": "response", @@ -168666,7 +162702,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", + "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", "inherits": { "type": { "name": "RequestBase", @@ -168692,7 +162728,7 @@ } ], "query": [], - "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L45" + "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L38" }, { "kind": "response", @@ -168758,7 +162794,7 @@ } ], "query": [], - "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts#L23-L49" + "specLocation": "ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts#L23-L43" }, { "kind": "response", @@ -168824,7 +162860,7 @@ } ], "query": [], - "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts#L23-L50" + "specLocation": "ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts#L23-L44" }, { "kind": "response", @@ -168936,7 +162972,7 @@ } } ], - "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts#L24-L58" + "specLocation": "ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts#L24-L52" }, { "kind": "response", @@ -169003,7 +163039,7 @@ } } ], - "specLocation": "ml/delete_datafeed/MlDeleteDatafeedRequest.ts#L23-L55" + "specLocation": "ml/delete_datafeed/MlDeleteDatafeedRequest.ts#L23-L49" }, { "kind": "response", @@ -169058,7 +163094,7 @@ } ] }, - "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", + "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "inherits": { "type": { "name": "RequestBase", @@ -169110,7 +163146,7 @@ } } ], - "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L85" + "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L73" }, { "kind": "response", @@ -169144,7 +163180,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "inherits": { "type": { "name": "RequestBase", @@ -169170,7 +163206,7 @@ } ], "query": [], - "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L48" + "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L40" }, { "kind": "response", @@ -169198,7 +163234,7 @@ "body": { "kind": "no_body" }, - "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "inherits": { "type": { "name": "RequestBase", @@ -169263,7 +163299,7 @@ } } ], - "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L78" + "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L66" }, { "kind": "response", @@ -169291,7 +163327,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "inherits": { "type": { "name": "RequestBase", @@ -169356,7 +163392,7 @@ } } ], - "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L72" + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L64" }, { "kind": "response", @@ -169384,7 +163420,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "inherits": { "type": { "name": "RequestBase", @@ -169422,7 +163458,7 @@ } ], "query": [], - "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L53" + "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L45" }, { "kind": "response", @@ -169450,7 +163486,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -169487,22 +163523,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L57" + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L23-L43" }, { "kind": "response", @@ -169530,7 +163553,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "inherits": { "type": { "name": "RequestBase", @@ -169568,7 +163591,7 @@ } ], "query": [], - "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L53" + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L45" }, { "kind": "response", @@ -169656,7 +163679,7 @@ } ] }, - "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "inherits": { "type": { "name": "RequestBase", @@ -169669,7 +163692,7 @@ }, "path": [], "query": [], - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L71" + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L63" }, { "kind": "response", @@ -170362,7 +164385,7 @@ { "description": "A query clause that retrieves a subset of data from the source index.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "name": "query", "required": false, "type": { @@ -170375,7 +164398,7 @@ } ] }, - "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "inherits": { "type": { "name": "RequestBase", @@ -170388,7 +164411,7 @@ }, "path": [], "query": [], - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L61" + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L53" }, { "kind": "response", @@ -170396,7 +164419,6 @@ "kind": "properties", "properties": [ { - "description": "Evaluation results for a classification analysis.\nIt outputs a prediction that identifies to which of the classes each document belongs.", "name": "classification", "required": false, "type": { @@ -170408,7 +164430,6 @@ } }, { - "description": "Evaluation results for an outlier detection analysis.\nIt outputs the probability that each document is an outlier.", "name": "outlier_detection", "required": false, "type": { @@ -170420,7 +164441,6 @@ } }, { - "description": "Evaluation results for a regression analysis which outputs a prediction of values.", "name": "regression", "required": false, "type": { @@ -170437,7 +164457,7 @@ "name": "Response", "namespace": "ml.evaluate_data_frame" }, - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameResponse.ts#L26-L44" + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameResponse.ts#L26-L33" }, { "kind": "request", @@ -170498,7 +164518,7 @@ { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "model_memory_limit", "required": false, "serverDefault": "1gb", @@ -170538,7 +164558,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -170552,7 +164572,7 @@ } ] }, - "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "inherits": { "type": { "name": "RequestBase", @@ -170578,7 +164598,7 @@ } ], "query": [], - "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L120" + "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L108" }, { "kind": "response", @@ -170777,7 +164797,7 @@ } } ], - "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L107" + "specLocation": "ml/flush_job/MlFlushJobRequest.ts#L24-L100" }, { "kind": "response", @@ -170930,7 +164950,7 @@ } } ], - "specLocation": "ml/forecast/MlForecastJobRequest.ts#L24-L95" + "specLocation": "ml/forecast/MlForecastJobRequest.ts#L24-L88" }, { "kind": "response", @@ -171235,7 +165255,7 @@ } } ], - "specLocation": "ml/get_buckets/MlGetBucketsRequest.ts#L26-L145" + "specLocation": "ml/get_buckets/MlGetBucketsRequest.ts#L26-L134" }, { "kind": "response", @@ -171372,7 +165392,7 @@ } } ], - "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L61" + "specLocation": "ml/get_calendar_events/MlGetCalendarEventsRequest.ts#L25-L54" }, { "kind": "response", @@ -171536,7 +165556,7 @@ } } ], - "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L63" + "specLocation": "ml/get_calendars/MlGetCalendarsRequest.ts#L25-L52" }, { "kind": "response", @@ -171675,7 +165695,7 @@ } } ], - "specLocation": "ml/get_categories/MlGetCategoriesRequest.ts#L25-L82" + "specLocation": "ml/get_categories/MlGetCategoriesRequest.ts#L25-L71" }, { "kind": "response", @@ -171802,7 +165822,7 @@ } } ], - "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L89" + "specLocation": "ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts#L24-L78" }, { "kind": "response", @@ -171930,7 +165950,7 @@ } } ], - "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L84" + "specLocation": "ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts#L24-L73" }, { "kind": "response", @@ -172018,7 +166038,7 @@ } } ], - "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L72" + "specLocation": "ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts#L23-L61" }, { "kind": "response", @@ -172118,7 +166138,7 @@ } } ], - "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L78" + "specLocation": "ml/get_datafeeds/MlGetDatafeedsRequest.ts#L23-L67" }, { "kind": "response", @@ -172219,7 +166239,7 @@ } } ], - "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L63" + "specLocation": "ml/get_filters/MlGetFiltersRequest.ts#L24-L52" }, { "kind": "response", @@ -172411,7 +166431,7 @@ } } ], - "specLocation": "ml/get_influencers/MlGetInfluencersRequest.ts#L26-L105" + "specLocation": "ml/get_influencers/MlGetInfluencersRequest.ts#L26-L98" }, { "kind": "response", @@ -172500,7 +166520,7 @@ } } ], - "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L68" + "specLocation": "ml/get_job_stats/MlGetJobStatsRequest.ts#L23-L57" }, { "kind": "response", @@ -172601,7 +166621,7 @@ } } ], - "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L78" + "specLocation": "ml/get_jobs/MlGetJobsRequest.ts#L23-L67" }, { "kind": "response", @@ -173063,6 +167083,18 @@ } ], "query": [ + { + "description": "Specify this query parameter to include the fields with units in the response. Otherwise only\nthe `_in_bytes` sizes are returned in the response.", + "name": "human", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "Period to wait for a connection to the master node. If no response is received before the timeout\nexpires, the request fails and returns an error.", "name": "master_timeout", @@ -173090,7 +167122,7 @@ } } ], - "specLocation": "ml/get_memory_stats/MlGetMemoryStatsRequest.ts#L24-L66" + "specLocation": "ml/get_memory_stats/MlGetMemoryStatsRequest.ts#L24-L60" }, { "kind": "response", @@ -173208,7 +167240,7 @@ } } ], - "specLocation": "ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts#L23-L65" + "specLocation": "ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts#L23-L58" }, { "kind": "response", @@ -173432,7 +167464,7 @@ } } ], - "specLocation": "ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts#L26-L108" + "specLocation": "ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts#L26-L97" }, { "kind": "response", @@ -173707,7 +167739,7 @@ } } ], - "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L153" + "specLocation": "ml/get_overall_buckets/MlGetOverallBucketsRequest.ts#L25-L146" }, { "kind": "response", @@ -173978,7 +168010,7 @@ } } ], - "specLocation": "ml/get_records/MlGetAnomalyRecordsRequest.ts#L26-L135" + "specLocation": "ml/get_records/MlGetAnomalyRecordsRequest.ts#L26-L128" }, { "kind": "response", @@ -174173,7 +168205,7 @@ } } ], - "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L110" + "specLocation": "ml/get_trained_models/MlGetTrainedModelRequest.ts#L25-L99" }, { "kind": "response", @@ -174288,7 +168320,7 @@ } } ], - "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L77" + "specLocation": "ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts#L24-L66" }, { "kind": "response", @@ -174414,7 +168446,7 @@ } } ], - "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L72" + "specLocation": "ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L60" }, { "kind": "response", @@ -174666,7 +168698,7 @@ "body": { "kind": "no_body" }, - "description": "Get machine learning information.\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", + "description": "Return ML defaults and limits.\nReturns defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "inherits": { "type": { "name": "RequestBase", @@ -174679,7 +168711,7 @@ }, "path": [], "query": [], - "specLocation": "ml/info/MlInfoRequest.ts#L22-L44" + "specLocation": "ml/info/MlInfoRequest.ts#L22-L36" }, { "kind": "response", @@ -174761,7 +168793,7 @@ } ] }, - "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "inherits": { "type": { "name": "RequestBase", @@ -174801,7 +168833,7 @@ } } ], - "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L67" + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L59" }, { "kind": "response", @@ -174890,7 +168922,7 @@ } ], "query": [], - "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L48" + "specLocation": "ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L41" }, { "kind": "response", @@ -174999,7 +169031,7 @@ } } ], - "specLocation": "ml/post_data/MlPostJobDataRequest.ts#L24-L76" + "specLocation": "ml/post_data/MlPostJobDataRequest.ts#L24-L69" }, { "kind": "response", @@ -175342,7 +169374,7 @@ { "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", "docId": "put-dfanalytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", "name": "config", "required": false, "type": { @@ -175355,7 +169387,7 @@ } ] }, - "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", + "description": "Preview features used by data frame analytics.\nPreviews the extracted features used by a data frame analytics config.", "inherits": { "type": { "name": "RequestBase", @@ -175381,7 +169413,7 @@ } ], "query": [], - "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L60" + "specLocation": "ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L49" }, { "kind": "response", @@ -175507,7 +169539,7 @@ } } ], - "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L81" + "specLocation": "ml/preview_datafeed/MlPreviewDatafeedRequest.ts#L26-L70" }, { "kind": "response", @@ -175599,7 +169631,7 @@ } ], "query": [], - "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L51" + "specLocation": "ml/put_calendar/MlPutCalendarRequest.ts#L23-L44" }, { "kind": "response", @@ -175696,7 +169728,7 @@ } ], "query": [], - "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L45" + "specLocation": "ml/put_calendar_job/MlPutCalendarJobRequest.ts#L23-L38" }, { "kind": "response", @@ -175758,7 +169790,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -175903,7 +169935,7 @@ } ] }, - "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", + "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "inherits": { "type": { "name": "RequestBase", @@ -175929,7 +169961,7 @@ } ], "query": [], - "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L155" + "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L144" }, { "kind": "response", @@ -176309,7 +170341,7 @@ } ] }, - "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay`) at each interval.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "inherits": { "type": { "name": "RequestBase", @@ -176392,7 +170424,7 @@ } } ], - "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L184" + "specLocation": "ml/put_datafeed/MlPutDatafeedRequest.ts#L37-L175" }, { "kind": "response", @@ -176660,7 +170692,7 @@ } ], "query": [], - "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L58" + "specLocation": "ml/put_filter/MlPutFilterRequest.ts#L23-L51" }, { "kind": "response", @@ -176920,7 +170952,7 @@ } ] }, - "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", + "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.", "inherits": { "type": { "name": "RequestBase", @@ -177003,7 +171035,7 @@ } } ], - "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L157" + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L148" }, { "kind": "response", @@ -177781,7 +171813,7 @@ } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L135" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L128" }, { "kind": "response", @@ -178165,7 +172197,7 @@ } } ], - "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L74" + "specLocation": "ml/put_trained_model_alias/MlPutTrainedModelAliasRequest.ts#L23-L67" }, { "kind": "response", @@ -178269,7 +172301,7 @@ } ], "query": [], - "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L65" + "specLocation": "ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L58" }, { "kind": "response", @@ -178382,7 +172414,7 @@ } ], "query": [], - "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L68" + "specLocation": "ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L61" }, { "kind": "response", @@ -178463,7 +172495,7 @@ } } ], - "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L65" + "specLocation": "ml/reset_job/MlResetJobRequest.ts#L23-L58" }, { "kind": "response", @@ -178558,7 +172590,7 @@ } } ], - "specLocation": "ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L77" + "specLocation": "ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L70" }, { "kind": "response", @@ -178632,7 +172664,7 @@ } } ], - "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L64" + "specLocation": "ml/set_upgrade_mode/MlSetUpgradeModeRequest.ts#L23-L57" }, { "kind": "response", @@ -178700,7 +172732,7 @@ } } ], - "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L68" + "specLocation": "ml/start_data_frame_analytics/MlStartDataFrameAnalyticsRequest.ts#L24-L61" }, { "kind": "response", @@ -178849,7 +172881,7 @@ } } ], - "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L99" + "specLocation": "ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L92" }, { "kind": "response", @@ -179029,7 +173061,7 @@ } } ], - "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L101" + "specLocation": "ml/start_trained_model_deployment/MlStartTrainedModelDeploymentRequest.ts#L29-L94" }, { "kind": "response", @@ -179129,7 +173161,7 @@ } } ], - "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L78" + "specLocation": "ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsRequest.ts#L24-L71" }, { "kind": "response", @@ -179270,7 +173302,7 @@ } } ], - "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L86" + "specLocation": "ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L79" }, { "kind": "response", @@ -179357,7 +173389,7 @@ } } ], - "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L61" + "specLocation": "ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentRequest.ts#L23-L54" }, { "kind": "response", @@ -179406,7 +173438,7 @@ { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "model_memory_limit", "required": false, "serverDefault": "1gb", @@ -179434,7 +173466,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -179474,7 +173506,7 @@ } ], "query": [], - "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L80" + "specLocation": "ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L73" }, { "kind": "response", @@ -179899,7 +173931,7 @@ } } ], - "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L170" + "specLocation": "ml/update_datafeed/MlUpdateDatafeedRequest.ts#L31-L163" }, { "kind": "response", @@ -180182,7 +174214,7 @@ } ], "query": [], - "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L60" + "specLocation": "ml/update_filter/MlUpdateFilterRequest.ts#L23-L53" }, { "kind": "response", @@ -180244,7 +174276,7 @@ { "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-settings.html", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -180350,7 +174382,7 @@ { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-ad-run-jobs.html#ml-ad-model-snapshots", "name": "daily_model_snapshot_retention_after_days", "required": false, "serverDefault": 1, @@ -180365,7 +174397,7 @@ { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "docUrl": "https://www.elastic.co/guide/en/machine-learning/{branch}/ml-ad-run-jobs.html#ml-ad-model-snapshots", "name": "model_snapshot_retention_days", "required": false, "serverDefault": 10, @@ -180471,7 +174503,7 @@ } ], "query": [], - "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L147" + "specLocation": "ml/update_job/MlUpdateJobRequest.ts#L33-L140" }, { "kind": "response", @@ -180822,7 +174854,7 @@ } ], "query": [], - "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L63" + "specLocation": "ml/update_model_snapshot/MlUpdateModelSnapshotRequest.ts#L23-L56" }, { "kind": "response", @@ -180922,7 +174954,7 @@ } } ], - "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L24-L70" + "specLocation": "ml/update_trained_model_deployment/MlUpdateTrainedModelDeploymentRequest.ts#L24-L63" }, { "kind": "response", @@ -180956,7 +174988,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrade a snapshot.\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", + "description": "Upgrade a snapshot.\nUpgrades an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "inherits": { "type": { "name": "RequestBase", @@ -181021,7 +175053,7 @@ } } ], - "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L72" + "specLocation": "ml/upgrade_job_snapshot/MlUpgradeJobSnapshotRequest.ts#L24-L65" }, { "kind": "response", @@ -181169,7 +175201,7 @@ } ] }, - "description": "Validate an anomaly detection job.", + "description": "Validates an anomaly detection job.", "inherits": { "type": { "name": "RequestBase", @@ -181182,7 +175214,7 @@ }, "path": [], "query": [], - "specLocation": "ml/validate/MlValidateJobRequest.ts#L27-L52" + "specLocation": "ml/validate/MlValidateJobRequest.ts#L27-L44" }, { "kind": "response", @@ -181218,7 +175250,7 @@ } } }, - "description": "Validate an anomaly detection job.", + "description": "Validates an anomaly detection detector.", "inherits": { "type": { "name": "RequestBase", @@ -181231,7 +175263,7 @@ }, "path": [], "query": [], - "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L40" + "specLocation": "ml/validate_detector/MlValidateDetectorRequest.ts#L23-L31" }, { "kind": "response", @@ -181305,7 +175337,7 @@ } } }, - "description": "Send monitoring data.\nThis API is used by the monitoring features to send monitoring data.", + "description": "Used by the monitoring features to send monitoring data.", "generics": [ { "name": "TDocument", @@ -181382,7 +175414,7 @@ } } ], - "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L73" + "specLocation": "monitoring/bulk/BulkMonitoringRequest.ts#L24-L59" }, { "kind": "response", @@ -184318,7 +178350,7 @@ "codegenName": "node_stats", "description": "Contains statistics about the number of nodes selected by the request’s node filters.", "docId": "cluster-nodes", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes", "name": "_nodes", "required": false, "type": { @@ -186156,9 +180188,7 @@ }, "path": [ { - "description": "Comma-separated list of node IDs or names used to limit returned information.", - "extDocId": "cluster-nodes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "description": "Comma-separated list of node IDs or names used to limit returned information.\nAll the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).", "name": "node_id", "required": true, "type": { @@ -186170,7 +180200,7 @@ } }, { - "description": "Specifies the maximum `archive_version` to be cleared from the archive.", + "description": "Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive.", "name": "max_archive_version", "required": true, "type": { @@ -186183,7 +180213,7 @@ } ], "query": [], - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L52" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L45" }, { "kind": "response", @@ -186201,7 +180231,7 @@ "name": "Response", "namespace": "nodes.clear_repositories_metering_archive" }, - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L37-L39" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L36-L38" }, { "kind": "interface", @@ -186217,9 +180247,7 @@ }, "properties": [ { - "description": "Name of the cluster. Based on the `cluster.name` setting.", - "extDocId": "cluster-name", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name", + "description": "Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).", "name": "cluster_name", "required": true, "type": { @@ -186254,7 +180282,7 @@ } } ], - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L25-L35" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L25-L34" }, { "kind": "request", @@ -186290,7 +180318,7 @@ } ], "query": [], - "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L49" + "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L42" }, { "kind": "response", @@ -186324,7 +180352,7 @@ }, "properties": [ { - "description": "Name of the cluster. Based on the `cluster.name` setting.", + "description": "Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).", "name": "cluster_name", "required": true, "type": { @@ -186434,6 +180462,19 @@ } } }, + { + "description": "Period to wait for a connection to the master node. If no response\nis received before the timeout expires, the request fails and\nreturns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, { "description": "Specifies the number of hot threads to provide information for.", "name": "threads", @@ -186486,7 +180527,7 @@ } } ], - "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L88" + "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L85" }, { "kind": "response", @@ -186748,7 +180789,7 @@ { "description": "Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.", "docId": "indexing-buffer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indexing-buffer.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indexing-buffer.html", "name": "total_indexing_buffer", "required": false, "type": { @@ -189479,7 +183520,7 @@ "body": { "kind": "no_body" }, - "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes.", + "description": "Get node information.\nBy default, the API returns all attributes and core settings for cluster nodes.", "inherits": { "type": { "name": "RequestBase", @@ -189531,8 +183572,8 @@ } }, { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", + "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.", + "name": "master_timeout", "required": false, "serverDefault": "30s", "type": { @@ -189542,127 +183583,9 @@ "namespace": "_types" } } - } - ], - "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L71" - }, - { - "kind": "response", - "body": { - "kind": "value", - "value": { - "kind": "instance_of", - "type": { - "name": "ResponseBase", - "namespace": "nodes.info" - } - } - }, - "name": { - "name": "Response", - "namespace": "nodes.info" - }, - "specLocation": "nodes/info/NodesInfoResponse.ts#L30-L32" - }, - { - "kind": "interface", - "inherits": { - "type": { - "name": "NodesResponseBase", - "namespace": "nodes._types" - } - }, - "name": { - "name": "ResponseBase", - "namespace": "nodes.info" - }, - "properties": [ - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } }, { - "name": "nodes", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "NodeInfo", - "namespace": "nodes.info" - } - } - } - } - ], - "specLocation": "nodes/info/NodesInfoResponse.ts#L25-L28" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The password for the Elasticsearch keystore.", - "name": "secure_settings_password", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Password", - "namespace": "_types" - } - } - } - ] - }, - "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "nodes.reload_secure_settings" - }, - "path": [ - { - "description": "The names of particular nodes in the cluster to target.", - "name": "node_id", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeIds", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -189675,7 +183598,138 @@ } } ], - "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L70" + "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L57" + }, + { + "kind": "response", + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "ResponseBase", + "namespace": "nodes.info" + } + } + }, + "name": { + "name": "Response", + "namespace": "nodes.info" + }, + "specLocation": "nodes/info/NodesInfoResponse.ts#L30-L32" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "NodesResponseBase", + "namespace": "nodes._types" + } + }, + "name": { + "name": "ResponseBase", + "namespace": "nodes.info" + }, + "properties": [ + { + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "nodes", + "required": true, + "type": { + "kind": "dictionary_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "NodeInfo", + "namespace": "nodes.info" + } + } + } + } + ], + "specLocation": "nodes/info/NodesInfoResponse.ts#L25-L28" + }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "The password for the Elasticsearch keystore.", + "name": "secure_settings_password", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Password", + "namespace": "_types" + } + } + } + ] + }, + "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "nodes.reload_secure_settings" + }, + "path": [ + { + "description": "The names of particular nodes in the cluster to target.", + "name": "node_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeIds", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L59" }, { "kind": "response", @@ -189875,6 +183929,19 @@ } } }, + { + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, { "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", @@ -189917,7 +183984,7 @@ } } ], - "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L99" + "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L78" }, { "kind": "response", @@ -190136,7 +184203,7 @@ } } ], - "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L68" + "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L50" }, { "kind": "response", @@ -190213,7 +184280,6 @@ }, "properties": [ { - "description": "A unique identifier for the rule.", "name": "rule_id", "required": true, "type": { @@ -190225,7 +184291,6 @@ } }, { - "description": "The type of rule.\n`pinned` will identify and pin specific documents to the top of search results.\n`exclude` will exclude specific documents from search results.", "name": "type", "required": true, "type": { @@ -190237,7 +184302,6 @@ } }, { - "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", "name": "criteria", "required": true, "type": { @@ -190264,7 +184328,6 @@ } }, { - "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", "name": "actions", "required": true, "type": { @@ -190287,7 +184350,7 @@ } } ], - "specLocation": "query_rules/_types/QueryRuleset.ts#L36-L58" + "specLocation": "query_rules/_types/QueryRuleset.ts#L36-L42" }, { "kind": "interface", @@ -190297,7 +184360,6 @@ }, "properties": [ { - "description": "The unique document IDs of the documents to apply the rule to.\nOnly one of `ids` or `docs` may be specified and at least one must be specified.", "name": "ids", "required": false, "type": { @@ -190312,7 +184374,6 @@ } }, { - "description": "The documents to apply the rule to.\nOnly one of `ids` or `docs` may be specified and at least one must be specified.\nThere is a maximum value of 100 documents in a rule.\nYou can specify the following attributes for each document:\n\n* `_index`: The index of the document to pin.\n* `_id`: The unique document ID.", "name": "docs", "required": false, "type": { @@ -190327,7 +184388,7 @@ } } ], - "specLocation": "query_rules/_types/QueryRuleset.ts#L110-L126" + "specLocation": "query_rules/_types/QueryRuleset.ts#L70-L73" }, { "kind": "interface", @@ -190337,7 +184398,6 @@ }, "properties": [ { - "description": "The type of criteria. The following criteria types are supported:\n\n* `always`: Matches all queries, regardless of input.\n* `contains`: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values.\n* `exact`: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values.\n* `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values.\n* `gt`: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `gte`: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lt`: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `lte`: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values.\n* `prefix`: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values.\n* `suffix`: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values.", "name": "type", "required": true, "type": { @@ -190349,7 +184409,6 @@ } }, { - "description": "The metadata field to match against.\nThis metadata will be used to match against `match_criteria` sent in the rule.\nIt is required for all criteria types except `always`.", "name": "metadata", "required": false, "type": { @@ -190361,7 +184420,6 @@ } }, { - "description": "The values to match against the `metadata` field.\nOnly one value must match for the criteria to be met.\nIt is required for all criteria types except `always`.", "name": "values", "required": false, "type": { @@ -190372,7 +184430,7 @@ } } ], - "specLocation": "query_rules/_types/QueryRuleset.ts#L65-L93" + "specLocation": "query_rules/_types/QueryRuleset.ts#L49-L53" }, { "kind": "enum", @@ -190418,7 +184476,7 @@ "name": "QueryRuleCriteriaType", "namespace": "query_rules._types" }, - "specLocation": "query_rules/_types/QueryRuleset.ts#L95-L108" + "specLocation": "query_rules/_types/QueryRuleset.ts#L55-L68" }, { "kind": "enum", @@ -190434,7 +184492,7 @@ "name": "QueryRuleType", "namespace": "query_rules._types" }, - "specLocation": "query_rules/_types/QueryRuleset.ts#L60-L63" + "specLocation": "query_rules/_types/QueryRuleset.ts#L44-L47" }, { "kind": "interface", @@ -190444,7 +184502,7 @@ }, "properties": [ { - "description": "A unique identifier for the ruleset.", + "description": "Query Ruleset unique identifier", "name": "ruleset_id", "required": true, "type": { @@ -190456,7 +184514,7 @@ } }, { - "description": "Rules associated with the query ruleset.", + "description": "Rules associated with the query ruleset", "name": "rules", "required": true, "type": { @@ -190481,7 +184539,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a query rule.\nDelete a query rule within a query ruleset.\nThis is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.", + "description": "Delete a query rule.\nDelete a query rule within a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -190519,7 +184577,7 @@ } ], "query": [], - "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L50" + "specLocation": "query_rules/delete_rule/QueryRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -190547,7 +184605,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", + "description": "Delete a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -190573,7 +184631,7 @@ } ], "query": [], - "specLocation": "query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts#L22-L45" + "specLocation": "query_rules/delete_ruleset/QueryRulesetDeleteRequest.ts#L22-L35" }, { "kind": "response", @@ -190639,7 +184697,7 @@ } ], "query": [], - "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L50" + "specLocation": "query_rules/get_rule/QueryRuleGetRequest.ts#L22-L42" }, { "kind": "response", @@ -190693,7 +184751,7 @@ } ], "query": [], - "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L44" + "specLocation": "query_rules/get_ruleset/QueryRulesetGetRequest.ts#L22-L36" }, { "kind": "response", @@ -190721,7 +184779,7 @@ }, "properties": [ { - "description": "A unique identifier for the ruleset.", + "description": "Ruleset unique identifier", "name": "ruleset_id", "required": true, "type": { @@ -190733,7 +184791,7 @@ } }, { - "description": "The number of rules associated with the ruleset.", + "description": "The number of rules associated with this ruleset", "name": "rule_total_count", "required": true, "type": { @@ -190745,7 +184803,7 @@ } }, { - "description": "A map of criteria type (for example, `exact`) to the number of rules of that type.\n\nNOTE: The counts in `rule_criteria_types_counts` may be larger than the value of `rule_total_count` because a rule may have multiple criteria.", + "description": "A map of criteria type (e.g. exact) to the number of rules of that type", "name": "rule_criteria_types_counts", "required": true, "type": { @@ -190768,7 +184826,7 @@ } }, { - "description": "A map of rule type (for example, `pinned`) to the number of rules of that type.", + "description": "A map of rule type (e.g. pinned) to the number of rules of that type", "name": "rule_type_counts", "required": true, "type": { @@ -190791,7 +184849,7 @@ } } ], - "specLocation": "query_rules/list_rulesets/types.ts#L23-L44" + "specLocation": "query_rules/list_rulesets/types.ts#L23-L42" }, { "kind": "request", @@ -190815,10 +184873,9 @@ "path": [], "query": [ { - "description": "The offset from the first result to fetch.", + "description": "Starting offset (default: 0)", "name": "from", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -190828,7 +184885,7 @@ } }, { - "description": "The maximum number of results to retrieve.", + "description": "specifies a max number of results to get", "name": "size", "required": false, "type": { @@ -190840,7 +184897,7 @@ } } ], - "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L49" + "specLocation": "query_rules/list_rulesets/QueryRulesetListRequest.ts#L22-L40" }, { "kind": "response", @@ -190889,7 +184946,6 @@ "kind": "properties", "properties": [ { - "description": "The type of rule.", "name": "type", "required": true, "type": { @@ -190901,7 +184957,6 @@ } }, { - "description": "The criteria that must be met for the rule to be applied.\nIf multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.", "name": "criteria", "required": true, "type": { @@ -190928,7 +184983,6 @@ } }, { - "description": "The actions to take when the rule is matched.\nThe format of this action depends on the rule type.", "name": "actions", "required": true, "type": { @@ -190952,7 +185006,7 @@ } ] }, - "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", + "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -190965,7 +185019,7 @@ }, "path": [ { - "description": "The unique identifier of the query ruleset containing the rule to be created or updated.", + "description": "The unique identifier of the query ruleset containing the rule to be created or updated", "name": "ruleset_id", "required": true, "type": { @@ -190977,7 +185031,7 @@ } }, { - "description": "The unique identifier of the query rule within the specified ruleset to be created or updated.", + "description": "The unique identifier of the query rule within the specified ruleset to be created or updated", "name": "rule_id", "required": true, "type": { @@ -190990,7 +185044,7 @@ } ], "query": [], - "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L79" + "specLocation": "query_rules/put_rule/QueryRulePutRequest.ts#L28-L57" }, { "kind": "response", @@ -191052,7 +185106,7 @@ } ] }, - "description": "Create or update a query ruleset.\nThere is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", + "description": "Create or update a query ruleset.", "inherits": { "type": { "name": "RequestBase", @@ -191065,7 +185119,7 @@ }, "path": [ { - "description": "The unique identifier of the query ruleset to be created or updated.", + "description": "The unique identifier of the query ruleset to be created or updated", "name": "ruleset_id", "required": true, "type": { @@ -191078,7 +185132,7 @@ } ], "query": [], - "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L59" + "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L44" }, { "kind": "response", @@ -191147,7 +185201,6 @@ "kind": "properties", "properties": [ { - "description": "The match criteria to apply to rules in the given query ruleset.\nMatch criteria should match the keys defined in the `criteria.metadata` field of the rule.", "name": "match_criteria", "required": true, "type": { @@ -191193,7 +185246,7 @@ } ], "query": [], - "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L57" + "specLocation": "query_rules/test/QueryRulesetTestRequest.ts#L24-L45" }, { "kind": "response", @@ -191289,7 +185342,7 @@ { "description": "The interval of time buckets to be generated when rolling up.", "docId": "calendar-and-fixed-intervals", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals", "name": "calendar_interval", "required": false, "type": { @@ -191303,7 +185356,7 @@ { "description": "The interval of time buckets to be generated when rolling up.", "docId": "calendar-and-fixed-intervals", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals", "name": "fixed_interval", "required": false, "type": { @@ -191501,11 +185554,7 @@ "body": { "kind": "no_body" }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", + "description": "Deletes an existing rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -191531,7 +185580,7 @@ } ], "query": [], - "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L67" + "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L35" }, { "kind": "response", @@ -191594,7 +185643,7 @@ "name": "IndexingJobState", "namespace": "rollup.get_jobs" }, - "specLocation": "rollup/get_jobs/types.ts#L77-L83" + "specLocation": "rollup/get_jobs/types.ts#L66-L72" }, { "kind": "request", @@ -191604,11 +185653,7 @@ "body": { "kind": "no_body" }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", + "description": "Retrieves the configuration, stats, and status of rollup jobs.", "inherits": { "type": { "name": "RequestBase", @@ -191634,7 +185679,7 @@ } ], "query": [], - "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L54" + "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L36" }, { "kind": "response", @@ -191671,7 +185716,6 @@ }, "properties": [ { - "description": "The rollup job configuration.", "name": "config", "required": true, "type": { @@ -191683,7 +185727,6 @@ } }, { - "description": "Transient statistics about the rollup job, such as how many documents have been processed and how many rollup summary docs have been indexed.\nThese stats are not persisted.\nIf a node is restarted, these stats are reset.", "name": "stats", "required": true, "type": { @@ -191695,7 +185738,6 @@ } }, { - "description": "The current status of the indexer for the rollup job.", "name": "status", "required": true, "type": { @@ -191707,7 +185749,7 @@ } } ], - "specLocation": "rollup/get_jobs/types.ts#L28-L43" + "specLocation": "rollup/get_jobs/types.ts#L28-L32" }, { "kind": "interface", @@ -191808,7 +185850,7 @@ } } ], - "specLocation": "rollup/get_jobs/types.ts#L45-L54" + "specLocation": "rollup/get_jobs/types.ts#L34-L43" }, { "kind": "interface", @@ -191977,7 +186019,7 @@ } } ], - "specLocation": "rollup/get_jobs/types.ts#L56-L69" + "specLocation": "rollup/get_jobs/types.ts#L45-L58" }, { "kind": "interface", @@ -192027,7 +186069,7 @@ } } ], - "specLocation": "rollup/get_jobs/types.ts#L71-L75" + "specLocation": "rollup/get_jobs/types.ts#L60-L64" }, { "kind": "request", @@ -192037,11 +186079,7 @@ "body": { "kind": "no_body" }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", + "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", "inherits": { "type": { "name": "RequestBase", @@ -192067,7 +186105,7 @@ } ], "query": [], - "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L57" + "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L36" }, { "kind": "response", @@ -192106,7 +186144,6 @@ }, "properties": [ { - "description": "There can be multiple, independent jobs configured for a single index or index pattern. Each of these jobs may have different configurations, so the API returns a list of all the various configurations available.", "name": "rollup_jobs", "required": true, "type": { @@ -192121,7 +186158,7 @@ } } ], - "specLocation": "rollup/get_rollup_caps/types.ts#L24-L29" + "specLocation": "rollup/get_rollup_caps/types.ts#L24-L26" }, { "kind": "interface", @@ -192189,7 +186226,7 @@ } } ], - "specLocation": "rollup/get_rollup_caps/types.ts#L31-L36" + "specLocation": "rollup/get_rollup_caps/types.ts#L28-L33" }, { "kind": "interface", @@ -192232,7 +186269,7 @@ } } ], - "specLocation": "rollup/get_rollup_caps/types.ts#L38-L42" + "specLocation": "rollup/get_rollup_caps/types.ts#L35-L39" }, { "kind": "interface", @@ -192266,11 +186303,7 @@ "body": { "kind": "no_body" }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", + "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", "inherits": { "type": { "name": "RequestBase", @@ -192296,7 +186329,7 @@ } ], "query": [], - "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L50" + "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L36" }, { "kind": "response", @@ -192547,11 +186580,7 @@ } ] }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", + "description": "Creates a rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -192577,7 +186606,7 @@ } ], "query": [], - "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L27-L105" + "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L27-L89" }, { "kind": "response", @@ -192610,8 +186639,6 @@ "aggs" ], "description": "Specifies aggregations.", - "extDocId": "rollup-agg-limitations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-agg-limitations.html", "name": "aggregations", "required": false, "type": { @@ -192634,9 +186661,7 @@ } }, { - "description": "Specifies a DSL query that is subject to some limitations.", - "extDocId": "rollup-search-limitations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search-limitations.html", + "description": "Specifies a DSL query.", "name": "query", "required": false, "type": { @@ -192661,11 +186686,7 @@ } ] }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\n**Searching both historical rollup and non-rollup data**\n\nThe rollup search API has the capability to search across both \"live\" non-rollup data and the aggregated rollup data.\nThis is done by simply adding the live indices to the URI. For example:\n\n```\nGET sensor-1,sensor_rollup/_rollup_search\n{\n \"size\": 0,\n \"aggregations\": {\n \"max_temperature\": {\n \"max\": {\n \"field\": \"temperature\"\n }\n }\n }\n}\n```\n\nThe rollup search endpoint does two things when the search runs:\n\n* The original request is sent to the non-rollup index unaltered.\n* A rewritten version of the original request is sent to the rollup index.\n\nWhen the two responses are received, the endpoint rewrites the rollup response and merges the two together.\nDuring the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.", + "description": "Enables searching rolled-up data using the standard Query DSL.", "inherits": { "type": { "name": "RequestBase", @@ -192678,7 +186699,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams and indices used to limit the request.\nThis parameter has the following rules:\n\n* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted.\n* Multiple non-rollup indices may be specified.\n* Only one rollup index may be specified. If more than one are supplied, an exception occurs.\n* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.", + "description": "Enables searching rolled-up data using the standard Query DSL.", "name": "index", "required": true, "type": { @@ -192716,7 +186737,7 @@ } } ], - "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L109" + "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L57" }, { "kind": "response", @@ -192831,11 +186852,7 @@ "body": { "kind": "no_body" }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", + "description": "Starts an existing, stopped rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -192861,7 +186878,7 @@ } ], "query": [], - "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L46" + "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L35" }, { "kind": "response", @@ -192895,11 +186912,7 @@ "body": { "kind": "no_body" }, - "deprecation": { - "description": "", - "version": "8.11.0" - }, - "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs.", + "description": "Stops an existing, started rollup job.", "inherits": { "type": { "name": "RequestBase", @@ -192926,7 +186939,7 @@ ], "query": [ { - "description": "If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.\nIf more than `timeout` time has passed, the API throws a timeout exception.\nNOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED.\nThe timeout simply means the API call itself timed out while waiting for the status change.", + "description": "If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop.\nIf more than `timeout` time has passed, the API throws a timeout exception.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -192952,7 +186965,7 @@ } } ], - "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L73" + "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L50" }, { "kind": "response", @@ -193021,28 +187034,6 @@ ], "specLocation": "search_application/_types/BehavioralAnalytics.ts#L29-L31" }, - { - "kind": "enum", - "members": [ - { - "codegenName": "PageView", - "name": "page_view" - }, - { - "codegenName": "Search", - "name": "search" - }, - { - "codegenName": "SearchClick", - "name": "search_click" - } - ], - "name": { - "name": "EventType", - "namespace": "search_application._types" - }, - "specLocation": "search_application/_types/AnalyticsEvent.ts#L22-L26" - }, { "kind": "interface", "inherits": { @@ -193171,7 +187162,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", + "description": "Delete a search application.\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "inherits": { "type": { "name": "RequestBase", @@ -193184,7 +187175,7 @@ }, "path": [ { - "description": "The name of the search application to delete.", + "description": "The name of the search application to delete", "name": "name", "required": true, "type": { @@ -193197,7 +187188,7 @@ } ], "query": [], - "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L46" + "specLocation": "search_application/delete/SearchApplicationsDeleteRequest.ts#L22-L36" }, { "kind": "response", @@ -193251,7 +187242,7 @@ } ], "query": [], - "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L44" + "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L37" }, { "kind": "response", @@ -193305,7 +187296,7 @@ } ], "query": [], - "specLocation": "search_application/get/SearchApplicationsGetRequest.ts#L22-L43" + "specLocation": "search_application/get/SearchApplicationsGetRequest.ts#L22-L35" }, { "kind": "response", @@ -193362,7 +187353,7 @@ } ], "query": [], - "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L47" + "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L36" }, { "kind": "response", @@ -193401,7 +187392,7 @@ "body": { "kind": "no_body" }, - "description": "Get search applications.\nGet information about search applications.", + "description": "Returns the existing search applications.", "inherits": { "type": { "name": "RequestBase", @@ -193452,7 +187443,7 @@ } } ], - "specLocation": "search_application/list/SearchApplicationsListRequest.ts#L22-L53" + "specLocation": "search_application/list/SearchApplicationsListRequest.ts#L22-L44" }, { "kind": "response", @@ -193492,131 +187483,6 @@ }, "specLocation": "search_application/list/SearchApplicationsListResponse.ts#L23-L28" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "value", - "codegenName": "payload", - "value": { - "kind": "user_defined_value" - } - }, - "description": "Create a behavioral analytics collection event.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "search_application.post_behavioral_analytics_event" - }, - "path": [ - { - "description": "The name of the behavioral analytics collection.", - "name": "collection_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "description": "The analytics event type.", - "name": "event_type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "EventType", - "namespace": "search_application._types" - } - } - } - ], - "query": [ - { - "description": "Whether the response type has to include more details", - "name": "debug", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequest.ts#L24-L57" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "accepted", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "event", - "required": false, - "type": { - "kind": "user_defined_value" - } - } - ] - }, - "exceptions": [ - { - "body": { - "kind": "no_body" - }, - "description": "\nEvent has been accepted and will be ingested.", - "statusCodes": [ - 202 - ] - }, - { - "body": { - "kind": "no_body" - }, - "description": "\nEither the event type is unknown or the event payload contains invalid data.", - "statusCodes": [ - 400 - ] - }, - { - "body": { - "kind": "no_body" - }, - "description": "\nAnalytics collection does not exist.", - "statusCodes": [ - 404 - ] - } - ], - "name": { - "name": "Response", - "namespace": "search_application.post_behavioral_analytics_event" - }, - "specLocation": "search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostResponse.ts#L22-L47" - }, { "kind": "request", "attachedBehaviors": [ @@ -193673,7 +187539,7 @@ } } ], - "specLocation": "search_application/put/SearchApplicationsPutRequest.ts#L23-L57" + "specLocation": "search_application/put/SearchApplicationsPutRequest.ts#L23-L48" }, { "kind": "response", @@ -193761,7 +187627,7 @@ } ], "query": [], - "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L43" + "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L36" }, { "kind": "response", @@ -193781,74 +187647,6 @@ }, "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutResponse.ts#L23-L25" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "params", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - } - ] - }, - "description": "Render a search application query.\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "search_application.render_query" - }, - "path": [ - { - "description": "The name of the search application to render teh query for.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "search_application/render_query/SearchApplicationsRenderQueryRequest.ts#L24-L54" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [] - }, - "name": { - "name": "Response", - "namespace": "search_application.render_query" - }, - "specLocation": "search_application/render_query/SearchApplicationsRenderQueryResponse.ts#L20-L22" - }, { "kind": "request", "attachedBehaviors": [ @@ -193924,7 +187722,7 @@ } } ], - "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L61" + "specLocation": "search_application/search/SearchApplicationsSearchRequest.ts#L24-L54" }, { "kind": "response", @@ -194007,7 +187805,7 @@ "body": { "kind": "no_body" }, - "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", + "description": "Retrieve node-level cache statistics about searchable snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -194020,7 +187818,7 @@ }, "path": [ { - "description": "The names of the nodes in the cluster to target.", + "description": "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes", "name": "node_id", "required": false, "type": { @@ -194045,7 +187843,7 @@ } } ], - "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L53" + "specLocation": "searchable_snapshots/cache_stats/Request.ts#L24-L35" }, { "kind": "response", @@ -194188,7 +187986,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", + "description": "Clear the cache of searchable snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -194201,7 +187999,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).", + "description": "A comma-separated list of index names", "name": "index", "required": false, "type": { @@ -194249,9 +188047,31 @@ "namespace": "_builtins" } } + }, + { + "name": "pretty", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "name": "human", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L56" + "specLocation": "searchable_snapshots/clear_cache/SearchableSnapshotsClearCacheRequest.ts#L23-L38" }, { "kind": "response", @@ -194319,7 +188139,6 @@ "kind": "properties", "properties": [ { - "description": "The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.", "name": "index", "required": true, "type": { @@ -194331,7 +188150,6 @@ } }, { - "description": "The name of the index that will be created.", "name": "renamed_index", "required": false, "type": { @@ -194343,7 +188161,6 @@ } }, { - "description": "The settings that should be added to the index when it is mounted.", "name": "index_settings", "required": false, "type": { @@ -194362,7 +188179,6 @@ } }, { - "description": "The names of settings that should be removed from the index when it is mounted.", "name": "ignore_index_settings", "required": false, "type": { @@ -194378,7 +188194,7 @@ } ] }, - "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", + "description": "Mount a snapshot as a searchable index.", "inherits": { "type": { "name": "RequestBase", @@ -194391,7 +188207,7 @@ }, "path": [ { - "description": "The name of the repository containing the snapshot of the index to mount.", + "description": "The name of the repository containing the snapshot of the index to mount", "name": "repository", "required": true, "type": { @@ -194403,7 +188219,7 @@ } }, { - "description": "The name of the snapshot of the index to mount.", + "description": "The name of the snapshot of the index to mount", "name": "snapshot", "required": true, "type": { @@ -194417,7 +188233,7 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -194430,7 +188246,7 @@ } }, { - "description": "If true, the request blocks until the operation is complete.", + "description": "Should this request wait until the operation has completed before returning", "name": "wait_for_completion", "required": false, "serverDefault": false, @@ -194443,7 +188259,7 @@ } }, { - "description": "The mount option for the searchable snapshot index.", + "description": "Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`", "name": "storage", "required": false, "serverDefault": "full_copy", @@ -194456,7 +188272,7 @@ } } ], - "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L92" + "specLocation": "searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L49" }, { "kind": "response", @@ -194490,7 +188306,7 @@ "body": { "kind": "no_body" }, - "description": "Get searchable snapshot statistics.", + "description": "Retrieve shard-level statistics about searchable snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -194503,7 +188319,7 @@ }, "path": [ { - "description": "A comma-separated list of data streams and indices to retrieve statistics for.", + "description": "A comma-separated list of index names", "name": "index", "required": false, "type": { @@ -194529,7 +188345,7 @@ } } ], - "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L52" + "specLocation": "searchable_snapshots/stats/SearchableSnapshotsStatsRequest.ts#L24-L35" }, { "kind": "response", @@ -195464,7 +189280,7 @@ "name": "password" }, { - "description": "In this type of grant, you must supply an access token that was created by the Elasticsearch token service.\nIf you are activating a user profile, you can alternatively supply a JWT (either a JWT `access_token` or a JWT `id_token`).", + "description": "In this type of grant, you must supply an access token that was created by the Elasticsearch token service.", "name": "access_token" } ], @@ -195472,7 +189288,7 @@ "name": "GrantType", "namespace": "security._types" }, - "specLocation": "security/_types/GrantType.ts#L20-L30" + "specLocation": "security/_types/GrantType.ts#L20-L29" }, { "kind": "enum", @@ -195578,8 +189394,8 @@ "properties": [ { "description": "The document fields that the owners of the role have read access to.", - "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "docId": "field-and-document-access-control", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html", "name": "field_security", "required": false, "type": { @@ -195845,8 +189661,8 @@ }, { "description": "The document fields that the owners of the role have read access to.", - "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "docId": "field-and-document-access-control", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html", "name": "field_security", "required": false, "type": { @@ -195988,7 +189804,6 @@ }, "properties": [ { - "description": "A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor.", "name": "workflows", "required": true, "type": { @@ -196003,7 +189818,7 @@ } } ], - "specLocation": "security/_types/RoleDescriptor.ts#L135-L141" + "specLocation": "security/_types/RoleDescriptor.ts#L130-L132" }, { "kind": "enum", @@ -196017,7 +189832,7 @@ "name": "RestrictionWorkflow", "namespace": "security._types" }, - "specLocation": "security/_types/RoleDescriptor.ts#L143-L146" + "specLocation": "security/_types/RoleDescriptor.ts#L134-L137" }, { "kind": "interface", @@ -196085,7 +189900,7 @@ "since": "8.15.0" } }, - "description": "A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.", + "description": "A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions.", "name": "remote_cluster", "required": false, "type": { @@ -196157,9 +189972,9 @@ } }, { - "description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", - "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "description": "A list of users that the API keys can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", + "docId": "run-as-privilege", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/run-as-privilege.html", "name": "run_as", "required": false, "type": { @@ -196216,7 +190031,7 @@ } } ], - "specLocation": "security/_types/RoleDescriptor.ts#L33-L83" + "specLocation": "security/_types/RoleDescriptor.ts#L33-L80" }, { "kind": "interface", @@ -196304,7 +190119,7 @@ "since": "8.15.0" } }, - "description": "A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.", + "description": "A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions.", "name": "remote_cluster", "required": false, "type": { @@ -196377,8 +190192,8 @@ }, { "description": "A list of users that the API keys can impersonate.", - "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "docId": "run-as-privilege", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/run-as-privilege.html", "name": "run_as", "required": false, "type": { @@ -196393,7 +190208,7 @@ } }, { - "description": "An optional description of the role descriptor.", + "description": "Optional description of the role descriptor", "name": "description", "required": false, "type": { @@ -196405,9 +190220,7 @@ } }, { - "description": "A restriction for when the role descriptor is allowed to be effective.", - "extDocId": "role-restriction", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/role-restriction.html", + "description": "Restriction for when the role descriptor is allowed to be effective.", "name": "restriction", "required": false, "type": { @@ -196437,7 +190250,7 @@ } } ], - "specLocation": "security/_types/RoleDescriptor.ts#L85-L133" + "specLocation": "security/_types/RoleDescriptor.ts#L82-L128" }, { "kind": "interface", @@ -196646,7 +190459,7 @@ { "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", "extDocId": "templating-role-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query", "name": "template", "required": false, "type": { @@ -196757,8 +190570,8 @@ "properties": [ { "description": "The document fields that the owners of the role have read access to.", - "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "docId": "field-and-document-access-control", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html", "name": "field_security", "required": false, "type": { @@ -196827,27 +190640,6 @@ ], "specLocation": "security/_types/Privileges.ts#L429-L449" }, - { - "kind": "interface", - "name": { - "name": "SecuritySettings", - "namespace": "security._types" - }, - "properties": [ - { - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - } - ], - "specLocation": "security/_types/SecuritySettings.ts#L22-L24" - }, { "kind": "enum", "members": [ @@ -196987,8 +190779,8 @@ "properties": [ { "description": "The document fields that the owners of the role have read access to.", - "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "docId": "field-and-document-access-control", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html", "name": "field_security", "required": false, "type": { @@ -197350,7 +191142,6 @@ "kind": "properties", "properties": [ { - "description": "The user's Elasticsearch access token or JWT.\nBoth `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.", "name": "access_token", "required": false, "type": { @@ -197362,7 +191153,6 @@ } }, { - "description": "The type of grant.", "name": "grant_type", "required": true, "type": { @@ -197374,7 +191164,6 @@ } }, { - "description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", "name": "password", "required": false, "type": { @@ -197386,7 +191175,6 @@ } }, { - "description": "The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", "name": "username", "required": false, "type": { @@ -197399,7 +191187,7 @@ } ] }, - "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.", + "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", "inherits": { "type": { "name": "RequestBase", @@ -197412,7 +191200,7 @@ }, "path": [], "query": [], - "specLocation": "security/activate_user_profile/Request.ts#L23-L76" + "specLocation": "security/activate_user_profile/Request.ts#L23-L39" }, { "kind": "response", @@ -197485,7 +191273,7 @@ }, "path": [], "query": [], - "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L41" + "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L33" }, { "kind": "response", @@ -197743,7 +191531,7 @@ } } ], - "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L50" + "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L43" }, { "kind": "response", @@ -197859,7 +191647,7 @@ } } ], - "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L52" + "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L45" }, { "kind": "response", @@ -197940,82 +191728,93 @@ "kind": "properties", "properties": [ { - "description": "Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.", - "name": "expiration", + "description": "The new password value. Passwords must be at least 6 characters long.", + "name": "password", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "Password", "namespace": "_types" } } }, { - "description": "The API key identifiers.", - "name": "ids", - "required": true, - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - } - }, - { - "description": "Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.", - "name": "metadata", + "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", + "name": "password_hash", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Metadata", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } - }, - { - "description": "The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.", - "name": "role_descriptors", - "required": false, + } + ] + }, + "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "security.change_password" + }, + "path": [ + { + "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", + "name": "username", + "required": false, + "type": { + "kind": "instance_of", "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "RoleDescriptor", - "namespace": "security._types" - } - } + "name": "Username", + "namespace": "_types" } } - ] + } + ], + "query": [ + { + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", + "name": "refresh", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Refresh", + "namespace": "_types" + } + } + } + ], + "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L54" + }, + { + "kind": "response", + "body": { + "kind": "properties", + "properties": [] + }, + "name": { + "name": "Response", + "namespace": "security.change_password" + }, + "specLocation": "security/change_password/SecurityChangePasswordResponse.ts#L20-L22" + }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" }, - "description": "Bulk update API keys.\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.", + "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "inherits": { "type": { "name": "RequestBase", @@ -198024,11 +191823,24 @@ }, "name": { "name": "Request", - "namespace": "security.bulk_update_api_keys" + "namespace": "security.clear_api_key_cache" }, - "path": [], + "path": [ + { + "description": "Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.", + "name": "ids", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Ids", + "namespace": "_types" + } + } + } + ], "query": [], - "specLocation": "security/bulk_update_api_keys/SecurityBulkUpdateApiKeysRequest.ts#L26-L83" + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -198036,41 +191848,47 @@ "kind": "properties", "properties": [ { - "name": "errors", - "required": false, + "codegenName": "node_stats", + "name": "_nodes", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "BulkError", - "namespace": "security._types" + "name": "NodeStatistics", + "namespace": "_types" } } }, { - "name": "noops", + "name": "cluster_name", "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" } } }, { - "name": "updated", + "name": "nodes", "required": true, "type": { - "kind": "array_of", - "value": { + "kind": "dictionary_of", + "key": { "kind": "instance_of", "type": { "name": "string", "namespace": "_builtins" } + }, + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterNode", + "namespace": "security._types" + } } } } @@ -198078,9 +191896,9 @@ }, "name": { "name": "Response", - "namespace": "security.bulk_update_api_keys" + "namespace": "security.clear_api_key_cache" }, - "specLocation": "security/bulk_update_api_keys/SecurityBulkUpdateApiKeysResponse.ts#L22-L28" + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts#L25-L32" }, { "kind": "request", @@ -198088,35 +191906,9 @@ "CommonQueryParameters" ], "body": { - "kind": "properties", - "properties": [ - { - "description": "The new password value. Passwords must be at least 6 characters long.", - "name": "password", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Password", - "namespace": "_types" - } - } - }, - { - "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", - "name": "password_hash", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] + "kind": "no_body" }, - "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", + "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "inherits": { "type": { "name": "RequestBase", @@ -198125,49 +191917,82 @@ }, "name": { "name": "Request", - "namespace": "security.change_password" + "namespace": "security.clear_cached_privileges" }, "path": [ { - "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", - "name": "username", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Username", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", - "name": "refresh", - "required": false, + "description": "A comma-separated list of application names", + "name": "application", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Refresh", + "name": "Name", "namespace": "_types" } } } ], - "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L65" + "query": [], + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L36" }, { "kind": "response", "body": { "kind": "properties", - "properties": [] + "properties": [ + { + "codegenName": "node_stats", + "name": "_nodes", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "NodeStatistics", + "namespace": "_types" + } + } + }, + { + "name": "cluster_name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Name", + "namespace": "_types" + } + } + }, + { + "name": "nodes", + "required": true, + "type": { + "kind": "dictionary_of", + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "ClusterNode", + "namespace": "security._types" + } + } + } + } + ] }, "name": { "name": "Response", - "namespace": "security.change_password" + "namespace": "security.clear_cached_privileges" }, - "specLocation": "security/change_password/SecurityChangePasswordResponse.ts#L20-L22" + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts#L25-L32" }, { "kind": "request", @@ -198177,7 +192002,7 @@ "body": { "kind": "no_body" }, - "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "inherits": { "type": { "name": "RequestBase", @@ -198186,228 +192011,40 @@ }, "name": { "name": "Request", - "namespace": "security.clear_api_key_cache" + "namespace": "security.clear_cached_realms" }, "path": [ { - "description": "Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.", - "name": "ids", + "description": "Comma-separated list of realms to clear", + "name": "realms", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Ids", + "name": "Names", "namespace": "_types" } } } ], - "query": [], - "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L49" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "codegenName": "node_stats", - "name": "_nodes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeStatistics", - "namespace": "_types" - } - } - }, - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "nodes", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterNode", - "namespace": "security._types" - } - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.clear_api_key_cache" - }, - "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts#L25-L32" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.clear_cached_privileges" - }, - "path": [ - { - "description": "A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.", - "name": "application", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L49" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "codegenName": "node_stats", - "name": "_nodes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "NodeStatistics", - "namespace": "_types" - } - } - }, - { - "name": "cluster_name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - }, - { - "name": "nodes", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ClusterNode", - "namespace": "security._types" - } - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.clear_cached_privileges" - }, - "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts#L25-L32" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.clear_cached_realms" - }, - "path": [ - { - "description": "A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.", - "name": "realms", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.", - "name": "usernames", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ], - "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L60" + "query": [ + { + "description": "Comma-separated list of usernames to clear from the cache", + "name": "usernames", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + } + ], + "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L38" }, { "kind": "response", @@ -198488,7 +192125,7 @@ }, "path": [ { - "description": "A comma-separated list of roles to evict from the role cache.\nTo evict all roles, use an asterisk (`*`).\nIt does not support other wildcard patterns.", + "description": "Role name", "name": "name", "required": true, "type": { @@ -198501,7 +192138,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L48" + "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L35" }, { "kind": "response", @@ -198569,7 +192206,7 @@ "body": { "kind": "no_body" }, - "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", + "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", "inherits": { "type": { "name": "RequestBase", @@ -198582,7 +192219,7 @@ }, "path": [ { - "description": "The namespace, which is a top-level grouping of service accounts.", + "description": "An identifier for the namespace", "name": "namespace", "required": true, "type": { @@ -198594,7 +192231,7 @@ } }, { - "description": "The name of the service, which must be unique within its namespace.", + "description": "An identifier for the service name", "name": "service", "required": true, "type": { @@ -198606,7 +192243,7 @@ } }, { - "description": "A comma-separated list of token names to evict from the service account token caches.\nUse a wildcard (`*`) to evict all tokens that belong to a service account.\nIt does not support other wildcard patterns.", + "description": "A comma-separated list of service token names", "name": "name", "required": true, "type": { @@ -198619,7 +192256,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L58" + "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L38" }, { "kind": "response", @@ -198688,7 +192325,7 @@ "kind": "properties", "properties": [ { - "description": "The expiration time for the API key.\nBy default, API keys never expire.", + "description": "Expiration time for the API key. By default, API keys never expire.", "name": "expiration", "required": false, "type": { @@ -198700,7 +192337,7 @@ } }, { - "description": "A name for the API key.", + "description": "Specifies the name for this API key.", "name": "name", "required": false, "type": { @@ -198712,9 +192349,9 @@ } }, { - "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", - "extDocId": "security-api-put-role", - "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", + "description": "An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.", + "docId": "security-api-put-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role.html", "name": "role_descriptors", "required": false, "type": { @@ -198756,7 +192393,7 @@ } ] }, - "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -198782,7 +192419,7 @@ } } ], - "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L86" + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L60" }, { "kind": "response", @@ -198934,7 +192571,7 @@ }, "path": [], "query": [], - "specLocation": "security/create_cross_cluster_api_key/CreateCrossClusterApiKeyRequest.ts#L25-L80" + "specLocation": "security/create_cross_cluster_api_key/CreateCrossClusterApiKeyRequest.ts#L25-L73" }, { "kind": "response", @@ -199026,7 +192663,7 @@ "body": { "kind": "no_body" }, - "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", + "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -199039,7 +192676,7 @@ }, "path": [ { - "description": "The name of the namespace, which is a top-level grouping of service accounts.", + "description": "An identifier for the namespace", "name": "namespace", "required": true, "type": { @@ -199051,7 +192688,7 @@ } }, { - "description": "The name of the service.", + "description": "An identifier for the service name", "name": "service", "required": true, "type": { @@ -199063,7 +192700,7 @@ } }, { - "description": "The name for the service account token.\nIf omitted, a random name will be generated.\n\nToken names must be at least one and no more than 256 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.\n\nNOTE: Token names must be unique in the context of the associated service account.\nThey must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `//`.", + "description": "An identifier for the token name", "name": "name", "required": false, "type": { @@ -199089,7 +192726,7 @@ } } ], - "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L72" + "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L41" }, { "kind": "response", @@ -199124,7 +192761,7 @@ "name": "Response", "namespace": "security.create_service_token" }, - "specLocation": "security/create_service_token/CreateServiceTokenResponse.ts#L22-L30" + "specLocation": "security/create_service_token/CreateServiceTokenResponse.ts#L22-L27" }, { "kind": "interface", @@ -199158,329 +192795,6 @@ ], "specLocation": "security/create_service_token/types.ts#L22-L25" }, - { - "kind": "interface", - "name": { - "name": "Authentication", - "namespace": "security.delegate_pki" - }, - "properties": [ - { - "name": "username", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "roles", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "full_name", - "required": true, - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ] - } - }, - { - "name": "email", - "required": true, - "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "null", - "namespace": "_builtins" - } - } - ] - } - }, - { - "name": "token", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "metadata", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Metadata", - "namespace": "_types" - } - } - }, - { - "name": "enabled", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "authentication_realm", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AuthenticationRealm", - "namespace": "security.delegate_pki" - } - } - }, - { - "name": "lookup_realm", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "AuthenticationRealm", - "namespace": "security.delegate_pki" - } - } - }, - { - "name": "authentication_type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "api_key", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ], - "specLocation": "security/delegate_pki/SecurityDelegatePkiResponse.ts#L43-L55" - }, - { - "kind": "interface", - "name": { - "name": "AuthenticationRealm", - "namespace": "security.delegate_pki" - }, - "properties": [ - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "domain", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "security/delegate_pki/SecurityDelegatePkiResponse.ts#L57-L61" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The X509Certificate chain, which is represented as an ordered string array.\nEach string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding.\n\nThe first element is the target certificate that contains the subject distinguished name that is requesting access.\nThis may be followed by additional certificates; each subsequent certificate is used to certify the previous one.", - "name": "x509_certificate_chain", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - ] - }, - "description": "Delegate PKI authentication.\n\nThis API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.delegate_pki" - }, - "path": [], - "query": [], - "specLocation": "security/delegate_pki/SecurityDelegatePkiRequest.ts#L22-L57" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "An access token associated with the subject distinguished name of the client's certificate.", - "name": "access_token", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The amount of time (in seconds) before the token expires.", - "name": "expires_in", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The type of token.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "authentication", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Authentication", - "namespace": "security.delegate_pki" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.delegate_pki" - }, - "specLocation": "security/delegate_pki/SecurityDelegatePkiResponse.ts#L24-L41" - }, { "kind": "interface", "name": { @@ -199510,7 +192824,7 @@ "body": { "kind": "no_body" }, - "description": "Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", + "description": "Delete application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -199523,7 +192837,7 @@ }, "path": [ { - "description": "The name of the application.\nApplication privileges are always associated with exactly one application.", + "description": "Application name", "name": "application", "required": true, "type": { @@ -199535,7 +192849,7 @@ } }, { - "description": "The name of the privilege.", + "description": "Privilege name", "name": "name", "required": true, "type": { @@ -199561,7 +192875,7 @@ } } ], - "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L58" + "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L38" }, { "kind": "response", @@ -199611,7 +192925,7 @@ "body": { "kind": "no_body" }, - "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", + "description": "Delete roles.\n\nDelete roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -199624,7 +192938,7 @@ }, "path": [ { - "description": "The name of the role.", + "description": "Role name", "name": "name", "required": true, "type": { @@ -199650,7 +192964,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L49" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -199658,7 +192972,6 @@ "kind": "properties", "properties": [ { - "description": "If the role is successfully deleted, `found` is `true`.\nOtherwise, `found` is `false`.", "name": "found", "required": true, "type": { @@ -199675,7 +192988,7 @@ "name": "Response", "namespace": "security.delete_role" }, - "specLocation": "security/delete_role/SecurityDeleteRoleResponse.ts#L20-L28" + "specLocation": "security/delete_role/SecurityDeleteRoleResponse.ts#L20-L22" }, { "kind": "request", @@ -199685,7 +192998,7 @@ "body": { "kind": "no_body" }, - "description": "Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", + "description": "Delete role mappings.", "inherits": { "type": { "name": "RequestBase", @@ -199698,7 +193011,7 @@ }, "path": [ { - "description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.", + "description": "Role-mapping name", "name": "name", "required": true, "type": { @@ -199724,7 +193037,7 @@ } } ], - "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L53" + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L36" }, { "kind": "response", @@ -199732,7 +193045,6 @@ "kind": "properties", "properties": [ { - "description": "If the mapping is successfully deleted, `found` is `true`.\nOtherwise, `found` is `false`.", "name": "found", "required": true, "type": { @@ -199749,7 +193061,7 @@ "name": "Response", "namespace": "security.delete_role_mapping" }, - "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingResponse.ts#L20-L28" + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingResponse.ts#L20-L22" }, { "kind": "request", @@ -199772,7 +193084,7 @@ }, "path": [ { - "description": "The namespace, which is a top-level grouping of service accounts.", + "description": "An identifier for the namespace", "name": "namespace", "required": true, "type": { @@ -199784,7 +193096,7 @@ } }, { - "description": "The service name.", + "description": "An identifier for the service name", "name": "service", "required": true, "type": { @@ -199796,7 +193108,7 @@ } }, { - "description": "The name of the service account token.", + "description": "An identifier for the token name", "name": "name", "required": true, "type": { @@ -199822,7 +193134,7 @@ } } ], - "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L58" + "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L41" }, { "kind": "response", @@ -199830,7 +193142,6 @@ "kind": "properties", "properties": [ { - "description": "If the service account token is successfully deleted, the request returns `{\"found\": true}`.\nOtherwise, the response will have status code 404 and `found` is set to `false`.", "name": "found", "required": true, "type": { @@ -199847,7 +193158,7 @@ "name": "Response", "namespace": "security.delete_service_token" }, - "specLocation": "security/delete_service_token/DeleteServiceTokenResponse.ts#L20-L28" + "specLocation": "security/delete_service_token/DeleteServiceTokenResponse.ts#L20-L22" }, { "kind": "request", @@ -199870,7 +193181,7 @@ }, "path": [ { - "description": "An identifier for the user.", + "description": "username", "name": "username", "required": true, "type": { @@ -199896,7 +193207,7 @@ } } ], - "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L48" + "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L37" }, { "kind": "response", @@ -199904,7 +193215,6 @@ "kind": "properties", "properties": [ { - "description": "If the user is successfully deleted, the request returns `{\"found\": true}`.\nOtherwise, `found` is set to `false`.", "name": "found", "required": true, "type": { @@ -199921,7 +193231,7 @@ "name": "Response", "namespace": "security.delete_user" }, - "specLocation": "security/delete_user/SecurityDeleteUserResponse.ts#L20-L28" + "specLocation": "security/delete_user/SecurityDeleteUserResponse.ts#L20-L22" }, { "kind": "request", @@ -199931,7 +193241,7 @@ "body": { "kind": "no_body" }, - "description": "Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.", + "description": "Disable users.\n\nDisable users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -199944,7 +193254,7 @@ }, "path": [ { - "description": "An identifier for the user.", + "description": "The username of the user to disable", "name": "username", "required": true, "type": { @@ -199970,7 +193280,7 @@ } } ], - "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L50" + "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L37" }, { "kind": "response", @@ -199992,7 +193302,7 @@ "body": { "kind": "no_body" }, - "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .", + "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -200019,7 +193329,7 @@ ], "query": [ { - "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.", + "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search, if 'wait_for' then wait for a refresh to make this operation\nvisible to search, if 'false' do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": "false", @@ -200032,7 +193342,7 @@ } } ], - "specLocation": "security/disable_user_profile/Request.ts#L24-L63" + "specLocation": "security/disable_user_profile/Request.ts#L24-L49" }, { "kind": "response", @@ -200060,7 +193370,7 @@ "body": { "kind": "no_body" }, - "description": "Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.", + "description": "Enable users.\n\nEnable users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -200073,7 +193383,7 @@ }, "path": [ { - "description": "An identifier for the user.", + "description": "The username of the user to enable", "name": "username", "required": true, "type": { @@ -200099,7 +193409,7 @@ } } ], - "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L49" + "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L37" }, { "kind": "response", @@ -200121,7 +193431,7 @@ "body": { "kind": "no_body" }, - "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.", + "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -200134,7 +193444,7 @@ }, "path": [ { - "description": "A unique identifier for the user profile.", + "description": "Unique identifier for the user profile.", "name": "uid", "required": true, "type": { @@ -200148,7 +193458,7 @@ ], "query": [ { - "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.", + "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search, if 'wait_for' then wait for a refresh to make this operation\nvisible to search, if 'false' do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": "false", @@ -200161,7 +193471,7 @@ } } ], - "specLocation": "security/enable_user_profile/Request.ts#L24-L64" + "specLocation": "security/enable_user_profile/Request.ts#L24-L49" }, { "kind": "response", @@ -200189,7 +193499,7 @@ "body": { "kind": "no_body" }, - "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.", + "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "inherits": { "type": { "name": "RequestBase", @@ -200202,7 +193512,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_kibana/Request.ts#L22-L40" + "specLocation": "security/enroll_kibana/Request.ts#L22-L29" }, { "kind": "response", @@ -200221,7 +193531,6 @@ } }, { - "description": "The CA certificate used to sign the node certificates that Elasticsearch uses for TLS on the HTTP layer.\nThe certificate is returned as a Base64 encoded string of the ASN.1 DER encoding of the certificate.", "name": "http_ca", "required": true, "type": { @@ -200238,7 +193547,7 @@ "name": "Response", "namespace": "security.enroll_kibana" }, - "specLocation": "security/enroll_kibana/Response.ts#L20-L29" + "specLocation": "security/enroll_kibana/Response.ts#L20-L25" }, { "kind": "interface", @@ -200248,7 +193557,6 @@ }, "properties": [ { - "description": "The name of the bearer token for the `elastic/kibana` service account.", "name": "name", "required": true, "type": { @@ -200260,7 +193568,6 @@ } }, { - "description": "The value of the bearer token for the `elastic/kibana` service account.\nUse this value to authenticate the service account with Elasticsearch.", "name": "value", "required": true, "type": { @@ -200272,7 +193579,7 @@ } } ], - "specLocation": "security/enroll_kibana/Response.ts#L31-L41" + "specLocation": "security/enroll_kibana/Response.ts#L27-L30" }, { "kind": "request", @@ -200282,7 +193589,7 @@ "body": { "kind": "no_body" }, - "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.\n\nThe response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.\nThe response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.", + "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "inherits": { "type": { "name": "RequestBase", @@ -200295,7 +193602,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_node/Request.ts#L22-L40" + "specLocation": "security/enroll_node/Request.ts#L22-L29" }, { "kind": "response", @@ -200303,7 +193610,6 @@ "kind": "properties", "properties": [ { - "description": "The CA private key that can be used by the new node in order to sign its certificate for the HTTP layer, as a Base64 encoded string of the ASN.1 DER encoding of the key.", "name": "http_ca_key", "required": true, "type": { @@ -200315,7 +193621,6 @@ } }, { - "description": "The CA certificate that can be used by the new node in order to sign its certificate for the HTTP layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate.", "name": "http_ca_cert", "required": true, "type": { @@ -200327,7 +193632,6 @@ } }, { - "description": "The CA certificate that is used to sign the TLS certificate for the transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate.", "name": "transport_ca_cert", "required": true, "type": { @@ -200339,7 +193643,6 @@ } }, { - "description": "The private key that the node can use for TLS for its transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the key.", "name": "transport_key", "required": true, "type": { @@ -200351,7 +193654,6 @@ } }, { - "description": "The certificate that the node can use for TLS for its transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate.", "name": "transport_cert", "required": true, "type": { @@ -200363,7 +193665,6 @@ } }, { - "description": "A list of transport addresses in the form of `host:port` for the nodes that are already members of the cluster.", "name": "nodes_addresses", "required": true, "type": { @@ -200383,7 +193684,7 @@ "name": "Response", "namespace": "security.enroll_node" }, - "specLocation": "security/enroll_node/Response.ts#L20-L47" + "specLocation": "security/enroll_node/Response.ts#L20-L29" }, { "kind": "request", @@ -200525,7 +193826,7 @@ } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L95" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L88" }, { "kind": "response", @@ -200575,7 +193876,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L40" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L32" }, { "kind": "response", @@ -200583,7 +193884,6 @@ "kind": "properties", "properties": [ { - "description": "The list of cluster privileges that are understood by this version of Elasticsearch.", "name": "cluster", "required": true, "type": { @@ -200598,7 +193898,6 @@ } }, { - "description": "The list of index privileges that are understood by this version of Elasticsearch.", "name": "index", "required": true, "type": { @@ -200618,7 +193917,6 @@ "since": "8.15.0" } }, - "description": "The list of remote_cluster privileges that are understood by this version of Elasticsearch.", "name": "remote_cluster", "required": true, "type": { @@ -200638,7 +193936,7 @@ "name": "Response", "namespace": "security.get_builtin_privileges" }, - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesResponse.ts#L26-L42" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesResponse.ts#L26-L35" }, { "kind": "request", @@ -200648,7 +193946,7 @@ "body": { "kind": "no_body" }, - "description": "Get application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", + "description": "Get application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -200661,7 +193959,7 @@ }, "path": [ { - "description": "The name of the application.\nApplication privileges are always associated with exactly one application.\nIf you do not specify this parameter, the API returns information about all privileges for all applications.", + "description": "Application name", "name": "application", "required": false, "type": { @@ -200673,7 +193971,7 @@ } }, { - "description": "The name of the privilege.\nIf you do not specify this parameter, the API returns information about all privileges for the requested application.", + "description": "Privilege name", "name": "name", "required": false, "type": { @@ -200686,7 +193984,7 @@ } ], "query": [], - "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L65" + "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L35" }, { "kind": "response", @@ -200726,7 +194024,7 @@ "name": "Response", "namespace": "security.get_privileges" }, - "specLocation": "security/get_privileges/SecurityGetPrivilegesResponse.ts#L23-L29" + "specLocation": "security/get_privileges/SecurityGetPrivilegesResponse.ts#L23-L26" }, { "kind": "request", @@ -200736,7 +194034,7 @@ "body": { "kind": "no_body" }, - "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles.\n\nGet roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -200749,7 +194047,7 @@ }, "path": [ { - "description": "The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.", + "description": "The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles.", "name": "name", "required": false, "type": { @@ -200762,7 +194060,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L54" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L39" }, { "kind": "response", @@ -200791,7 +194089,7 @@ "name": "Response", "namespace": "security.get_role" }, - "specLocation": "security/get_role/SecurityGetRoleResponse.ts#L23-L31" + "specLocation": "security/get_role/SecurityGetRoleResponse.ts#L23-L26" }, { "kind": "interface", @@ -201027,7 +194325,7 @@ } ], "query": [], - "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L53" + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L42" }, { "kind": "response", @@ -201056,7 +194354,7 @@ "name": "Response", "namespace": "security.get_role_mapping" }, - "specLocation": "security/get_role_mapping/SecurityGetRoleMappingResponse.ts#L23-L29" + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingResponse.ts#L23-L26" }, { "kind": "request", @@ -201066,7 +194364,7 @@ "body": { "kind": "no_body" }, - "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", + "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", "inherits": { "type": { "name": "RequestBase", @@ -201079,7 +194377,7 @@ }, "path": [ { - "description": "The name of the namespace.\nOmit this parameter to retrieve information about all service accounts.\nIf you omit this parameter, you must also omit the `service` parameter.", + "description": "Name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must also omit the `service` parameter.", "name": "namespace", "required": false, "type": { @@ -201091,7 +194389,7 @@ } }, { - "description": "The service name.\nOmit this parameter to retrieve information about all service accounts that belong to the specified `namespace`.", + "description": "Name of the service name. Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`.", "name": "service", "required": false, "type": { @@ -201104,7 +194402,7 @@ } ], "query": [], - "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L64" + "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L44" }, { "kind": "response", @@ -201133,7 +194431,7 @@ "name": "Response", "namespace": "security.get_service_accounts" }, - "specLocation": "security/get_service_accounts/GetServiceAccountsResponse.ts#L23-L29" + "specLocation": "security/get_service_accounts/GetServiceAccountsResponse.ts#L23-L26" }, { "kind": "interface", @@ -201233,7 +194531,7 @@ "body": { "kind": "no_body" }, - "description": "Get service account credentials.\n\nTo use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", + "description": "Get service account credentials.", "inherits": { "type": { "name": "RequestBase", @@ -201246,7 +194544,7 @@ }, "path": [ { - "description": "The name of the namespace.", + "description": "Name of the namespace.", "name": "namespace", "required": true, "type": { @@ -201258,7 +194556,7 @@ } }, { - "description": "The service name.", + "description": "Name of the service name.", "name": "service", "required": true, "type": { @@ -201271,7 +194569,7 @@ } ], "query": [], - "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L56" + "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L41" }, { "kind": "response", @@ -201323,7 +194621,7 @@ } }, { - "description": "Service account credentials collected from all nodes of the cluster.", + "description": "Contains service account credentials collected from all nodes of the cluster", "name": "nodes_credentials", "required": true, "type": { @@ -201340,110 +194638,21 @@ "name": "Response", "namespace": "security.get_service_credentials" }, - "specLocation": "security/get_service_credentials/GetServiceCredentialsResponse.ts#L25-L34" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get security index settings.\n\nGet the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.get_settings" - }, - "path": [], - "query": [ - { - "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.", - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "security/get_settings/SecurityGetSettingsRequest.ts#L23-L51" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "Settings for the index used for most security configuration, including native realm users and roles configured with the API.", - "name": "security", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SecuritySettings", - "namespace": "security._types" - } - } - }, - { - "description": "Settings for the index used to store profile information.", - "name": "security-profile", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SecuritySettings", - "namespace": "security._types" - } - } - }, - { - "description": "Settings for the index used to store tokens.", - "name": "security-tokens", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SecuritySettings", - "namespace": "security._types" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.get_settings" - }, - "specLocation": "security/get_settings/SecurityGetSettingsResponse.ts#L21-L36" + "specLocation": "security/get_service_credentials/GetServiceCredentialsResponse.ts#L25-L33" }, { "kind": "enum", "members": [ { - "description": "This grant type implements the Resource Owner Password Credentials Grant of OAuth2.\nIn this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token.\nThe request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters).\nThis grant type is not suitable or designed for the self-service user creation of tokens.", "name": "password" }, { - "description": "This grant type implements the Client Credentials Grant of OAuth2.\nIt is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens.\nIt generates only access tokens that cannot be refreshed.\nThe premise is that the entity that uses `client_credentials` has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.", "name": "client_credentials" }, { - "description": "This grant type is supported internally and implements SPNEGO based Kerberos support.\nThe `_kerberos` grant type may change from version to version.", "name": "_kerberos" }, { - "description": "This grant type implements the Refresh Token Grant of OAuth2.\nIn this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.", "name": "refresh_token" } ], @@ -201451,7 +194660,7 @@ "name": "AccessTokenGrantType", "namespace": "security.get_token" }, - "specLocation": "security/get_token/types.ts#L23-L48" + "specLocation": "security/get_token/types.ts#L23-L28" }, { "kind": "interface", @@ -201511,7 +194720,7 @@ } } ], - "specLocation": "security/get_token/types.ts#L60-L65" + "specLocation": "security/get_token/types.ts#L40-L45" }, { "kind": "interface", @@ -201543,7 +194752,7 @@ } } ], - "specLocation": "security/get_token/types.ts#L55-L58" + "specLocation": "security/get_token/types.ts#L35-L38" }, { "kind": "request", @@ -201554,7 +194763,6 @@ "kind": "properties", "properties": [ { - "description": "The type of grant.\nSupported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`.", "name": "grant_type", "required": false, "type": { @@ -201566,7 +194774,6 @@ } }, { - "description": "The scope of the token.\nCurrently tokens are only issued for a scope of FULL regardless of the value sent with the request.", "name": "scope", "required": false, "type": { @@ -201578,7 +194785,6 @@ } }, { - "description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", "name": "password", "required": false, "type": { @@ -201590,7 +194796,6 @@ } }, { - "description": "The base64 encoded kerberos ticket.\nIf you specify the `_kerberos` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", "name": "kerberos_ticket", "required": false, "type": { @@ -201602,7 +194807,6 @@ } }, { - "description": "The string that was returned when you created the token, which enables you to extend its life.\nIf you specify the `refresh_token` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", "name": "refresh_token", "required": false, "type": { @@ -201614,7 +194818,6 @@ } }, { - "description": "The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nThis parameter is not valid with any other supported grant type.", "name": "username", "required": false, "type": { @@ -201627,7 +194830,7 @@ } ] }, - "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.\nThe tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.\nAlternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting.\nWhen you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.\n\nThe get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.\n\nA successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.\n\nThe tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.\nThat time period is defined by the `xpack.security.authc.token.timeout` setting.\nIf you want to invalidate a token immediately, you can do so by using the invalidate token API.", + "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -201640,7 +194843,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L90" + "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L42" }, { "kind": "response", @@ -201762,7 +194965,7 @@ } } ], - "specLocation": "security/get_token/types.ts#L50-L53" + "specLocation": "security/get_token/types.ts#L30-L33" }, { "kind": "request", @@ -201820,7 +195023,7 @@ "since": "8.5.0" } }, - "description": "Determines whether to retrieve the user profile UID, if it exists, for the users.", + "description": "If true will return the User Profile ID for a user, if any.", "name": "with_profile_uid", "required": false, "serverDefault": false, @@ -201833,7 +195036,7 @@ } } ], - "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L56" + "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L44" }, { "kind": "response", @@ -201862,7 +195065,7 @@ "name": "Response", "namespace": "security.get_user" }, - "specLocation": "security/get_user/SecurityGetUserResponse.ts#L23-L30" + "specLocation": "security/get_user/SecurityGetUserResponse.ts#L23-L26" }, { "kind": "request", @@ -201872,7 +195075,7 @@ "body": { "kind": "no_body" }, - "description": "Get user privileges.\n\nGet the security privileges for the logged in user.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.\nTo check whether a user has a specific list of privileges, use the has privileges API.", + "description": "Get user privileges.", "inherits": { "type": { "name": "RequestBase", @@ -201933,7 +195136,7 @@ } } ], - "specLocation": "security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L49" + "specLocation": "security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L37" }, { "kind": "response", @@ -202069,7 +195272,7 @@ "body": { "kind": "no_body" }, - "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", + "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.", "inherits": { "type": { "name": "RequestBase", @@ -202111,7 +195314,7 @@ ], "query": [ { - "description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content use `data=` to retrieve content nested under the specified ``.\nBy default returns no `data` content.", + "description": "List of filters for the `data` field of the profile document.\nTo return all content use `data=*`. To return a subset of content\nuse `data=` to retrieve content nested under the specified ``.\nBy default returns no `data` content.", "name": "data", "required": false, "type": { @@ -202138,7 +195341,7 @@ } } ], - "specLocation": "security/get_user_profile/Request.ts#L23-L59" + "specLocation": "security/get_user_profile/Request.ts#L23-L48" }, { "kind": "response", @@ -202146,7 +195349,6 @@ "kind": "properties", "properties": [ { - "description": "A successful call returns the JSON representation of the user profile and its internal versioning numbers.\nThe API returns an empty object if no profile document is found for the provided `uid`.\nThe content of the data field is not returned by default to avoid deserializing a potential large payload.", "name": "profiles", "required": true, "type": { @@ -202177,7 +195379,7 @@ "name": "Response", "namespace": "security.get_user_profile" }, - "specLocation": "security/get_user_profile/Response.ts#L23-L33" + "specLocation": "security/get_user_profile/Response.ts#L23-L28" }, { "kind": "enum", @@ -202193,7 +195395,7 @@ "name": "ApiKeyGrantType", "namespace": "security.grant_api_key" }, - "specLocation": "security/grant_api_key/types.ts#L47-L50" + "specLocation": "security/grant_api_key/types.ts#L48-L51" }, { "kind": "interface", @@ -202226,7 +195428,7 @@ } }, { - "description": "The role descriptors for this API key.\nWhen it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token.", + "description": "The role descriptors for this API key.\nThis parameter is optional.\nWhen it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token.", "name": "role_descriptors", "required": false, "type": { @@ -202287,7 +195489,7 @@ } } ], - "specLocation": "security/grant_api_key/types.ts#L25-L45" + "specLocation": "security/grant_api_key/types.ts#L25-L46" }, { "kind": "request", @@ -202298,7 +195500,7 @@ "kind": "properties", "properties": [ { - "description": "The API key.", + "description": "Defines the API key.", "name": "api_key", "required": true, "type": { @@ -202322,7 +195524,7 @@ } }, { - "description": "The user's access token.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.", + "description": "The user’s access token.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.", "name": "access_token", "required": false, "type": { @@ -202346,7 +195548,7 @@ } }, { - "description": "The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", + "description": "The user’s password. If you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.", "name": "password", "required": false, "type": { @@ -202371,7 +195573,7 @@ } ] }, - "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user's credentials.\nThe supported user authentication credential types are:\n\n* username and password\n* Elasticsearch access tokens\n* JWTs\n\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -202384,7 +195586,7 @@ }, "path": [], "query": [], - "specLocation": "security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L92" + "specLocation": "security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L77" }, { "kind": "response", @@ -202483,7 +195685,7 @@ } }, { - "description": "A list of the privileges that you want to check for the specified resources.\nIt may be either application privilege names or the names of actions that are granted by those privileges", + "description": "A list of the privileges that you want to check for the specified resources. May be either application privilege names, or the names of actions that are granted by those privileges", "name": "privileges", "required": true, "type": { @@ -202498,7 +195700,7 @@ } }, { - "description": "A list of resource names against which the privileges should be checked.", + "description": "A list of resource names against which the privileges should be checked", "name": "resources", "required": true, "type": { @@ -202513,7 +195715,7 @@ } } ], - "specLocation": "security/has_privileges/types.ts#L24-L32" + "specLocation": "security/has_privileges/types.ts#L24-L31" }, { "kind": "type_alias", @@ -202521,7 +195723,7 @@ "name": "ApplicationsPrivileges", "namespace": "security.has_privileges" }, - "specLocation": "security/has_privileges/types.ts#L47-L47", + "specLocation": "security/has_privileges/types.ts#L46-L46", "type": { "kind": "dictionary_of", "key": { @@ -202576,7 +195778,7 @@ } }, { - "description": "This needs to be set to `true` (default is `false`) if using wildcards or regexps for patterns that cover restricted indices.\nImplicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false.\nIf restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of `allow_restricted_indices`.", + "description": "This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices.\nImplicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false.\nIf restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of allow_restricted_indices.", "name": "allow_restricted_indices", "required": false, "type": { @@ -202588,7 +195790,7 @@ } } ], - "specLocation": "security/has_privileges/types.ts#L34-L45" + "specLocation": "security/has_privileges/types.ts#L33-L44" }, { "kind": "type_alias", @@ -202596,7 +195798,7 @@ "name": "Privileges", "namespace": "security.has_privileges" }, - "specLocation": "security/has_privileges/types.ts#L49-L49", + "specLocation": "security/has_privileges/types.ts#L48-L48", "type": { "kind": "dictionary_of", "key": { @@ -202669,7 +195871,7 @@ } ] }, - "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", + "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", "inherits": { "type": { "name": "RequestBase", @@ -202695,7 +195897,7 @@ } ], "query": [], - "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L59" + "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L46" }, { "kind": "type_alias", @@ -202703,7 +195905,7 @@ "name": "ResourcePrivileges", "namespace": "security.has_privileges" }, - "specLocation": "security/has_privileges/types.ts#L48-L48", + "specLocation": "security/has_privileges/types.ts#L47-L47", "type": { "kind": "dictionary_of", "key": { @@ -202811,7 +196013,7 @@ "name": "Response", "namespace": "security.has_privileges" }, - "specLocation": "security/has_privileges/SecurityHasPrivilegesResponse.ts#L24-L35" + "specLocation": "security/has_privileges/SecurityHasPrivilegesResponse.ts#L24-L32" }, { "kind": "interface", @@ -202933,7 +196135,6 @@ } }, { - "description": "An object containing all the privileges to be checked.", "name": "privileges", "required": true, "type": { @@ -202946,7 +196147,7 @@ } ] }, - "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", + "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.", "inherits": { "type": { "name": "RequestBase", @@ -202959,7 +196160,7 @@ }, "path": [], "query": [], - "specLocation": "security/has_privileges_user_profile/Request.ts#L24-L55" + "specLocation": "security/has_privileges_user_profile/Request.ts#L24-L42" }, { "kind": "response", @@ -203048,7 +196249,7 @@ } }, { - "description": "Query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.\n\nNOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`.", + "description": "Can be used to query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.", "name": "owner", "required": false, "serverDefault": false, @@ -203073,7 +196274,7 @@ } }, { - "description": "The username of a user.\nThis parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`.", + "description": "The username of a user.\nThis parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`.", "name": "username", "required": false, "type": { @@ -203086,7 +196287,7 @@ } ] }, - "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\n\nTo use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.\nThe `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.\nThe `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.\nThe `manage_own_api_key` only allows deleting REST API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user's identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", + "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", "inherits": { "type": { "name": "RequestBase", @@ -203099,7 +196300,7 @@ }, "path": [], "query": [], - "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L82" + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L69" }, { "kind": "response", @@ -203107,7 +196308,6 @@ "kind": "properties", "properties": [ { - "description": "The number of errors that were encountered when invalidating the API keys.", "name": "error_count", "required": true, "type": { @@ -203119,7 +196319,6 @@ } }, { - "description": "Details about the errors.\nThis field is not present in the response when `error_count` is `0`.", "name": "error_details", "required": false, "type": { @@ -203134,7 +196333,6 @@ } }, { - "description": "The IDs of the API keys that were invalidated as part of this request.", "name": "invalidated_api_keys", "required": true, "type": { @@ -203149,7 +196347,6 @@ } }, { - "description": "The IDs of the API keys that were already invalidated.", "name": "previously_invalidated_api_keys", "required": true, "type": { @@ -203169,7 +196366,7 @@ "name": "Response", "namespace": "security.invalidate_api_key" }, - "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyResponse.ts#L23-L46" + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyResponse.ts#L23-L30" }, { "kind": "request", @@ -203180,7 +196377,6 @@ "kind": "properties", "properties": [ { - "description": "An access token.\nThis parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used.", "name": "token", "required": false, "type": { @@ -203192,7 +196388,6 @@ } }, { - "description": "A refresh token.\nThis parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used.", "name": "refresh_token", "required": false, "type": { @@ -203204,7 +196399,6 @@ } }, { - "description": "The name of an authentication realm.\nThis parameter cannot be used with either `refresh_token` or `token`.", "name": "realm_name", "required": false, "type": { @@ -203216,7 +196410,6 @@ } }, { - "description": "The username of a user.\nThis parameter cannot be used with either `refresh_token` or `token`.", "name": "username", "required": false, "type": { @@ -203229,7 +196422,7 @@ } ] }, - "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours.\nThey can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.\n\nNOTE: While all parameters are optional, at least one of them is required.\nMore specifically, either one of `token` or `refresh_token` parameters is required.\nIf none of these two are specified, then `realm_name` and/or `username` need to be specified.", + "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.", "inherits": { "type": { "name": "RequestBase", @@ -203242,7 +196435,7 @@ }, "path": [], "query": [], - "specLocation": "security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L71" + "specLocation": "security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L43" }, { "kind": "response", @@ -203250,7 +196443,6 @@ "kind": "properties", "properties": [ { - "description": "The number of errors that were encountered when invalidating the tokens.", "name": "error_count", "required": true, "type": { @@ -203262,7 +196454,6 @@ } }, { - "description": "Details about the errors.\nThis field is not present in the response when `error_count` is `0`.", "name": "error_details", "required": false, "type": { @@ -203277,7 +196468,6 @@ } }, { - "description": "The number of the tokens that were invalidated as part of this request.", "name": "invalidated_tokens", "required": true, "type": { @@ -203289,7 +196479,6 @@ } }, { - "description": "The number of tokens that were already invalidated.", "name": "previously_invalidated_tokens", "required": true, "type": { @@ -203306,358 +196495,7 @@ "name": "Response", "namespace": "security.invalidate_token" }, - "specLocation": "security/invalidate_token/SecurityInvalidateTokenResponse.ts#L23-L46" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Associate a client session with an ID token and mitigate replay attacks.\nThis value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call.", - "name": "nonce", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of the OpenID Connect realm.\nThis property is useful in cases where multiple realms are defined.", - "name": "realm", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The URL to which the OpenID Connect Provider redirected the User Agent in response to an authentication request after a successful authentication.\nThis URL must be provided as-is (URL encoded), taken from the body of the response or as the value of a location header in the response from the OpenID Connect Provider.", - "name": "redirect_uri", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Maintain state between the authentication request and the response.\nThis value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call.", - "name": "state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Authenticate OpenID Connect.\n\nExchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.oidc_authenticate" - }, - "path": [], - "query": [], - "specLocation": "security/oidc_authenticate/Request.ts#L22-L61" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "The Elasticsearch access token.", - "name": "access_token", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The duration (in seconds) of the tokens.", - "name": "expires_in", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The Elasticsearch refresh token.", - "name": "refresh_token", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The type of token.", - "name": "type", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.oidc_authenticate" - }, - "specLocation": "security/oidc_authenticate/Response.ts#L22-L41" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The access token to be invalidated.", - "name": "access_token", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The refresh token to be invalidated.", - "name": "refresh_token", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Logout of OpenID Connect.\n\nInvalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.\n\nIf the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.oidc_logout" - }, - "path": [], - "query": [], - "specLocation": "security/oidc_logout/Request.ts#L22-L52" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "A URI that points to the end session endpoint of the OpenID Connect Provider with all the parameters of the logout request as HTTP GET parameters.", - "name": "redirect", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.oidc_logout" - }, - "specLocation": "security/oidc_logout/Response.ts#L20-L27" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request to.\nIt cannot be specified when *realm* is specified.\nOne of *realm* or *iss* is required.", - "name": "iss", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "In the case of a third party initiated single sign on, it is a string value that is included in the authentication request as the *login_hint* parameter.\nThis parameter is not valid when *realm* is specified.", - "name": "login_hint", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The value used to associate a client session with an ID token and to mitigate replay attacks.\nIf the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response.", - "name": "nonce", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of the OpenID Connect realm in Elasticsearch the configuration of which should be used in order to generate the authentication request.\nIt cannot be specified when *iss* is specified.\nOne of *realm* or *iss* is required.", - "name": "realm", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation.\nIf the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response.", - "name": "state", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "description": "Prepare OpenID connect authentication.\n\nCreate an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.\n\nThe response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.oidc_prepare_authentication" - }, - "path": [], - "query": [], - "specLocation": "security/oidc_prepare_authentication/Request.ts#L22-L71" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "nonce", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "realm", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "A URI that points to the authorization endpoint of the OpenID Connect Provider with all the parameters of the authentication request as HTTP GET parameters.", - "name": "redirect", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "state", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.oidc_prepare_authentication" - }, - "specLocation": "security/oidc_prepare_authentication/Response.ts#L20-L30" + "specLocation": "security/invalidate_token/SecurityInvalidateTokenResponse.ts#L23-L30" }, { "kind": "interface", @@ -203754,7 +196592,7 @@ } } }, - "description": "Create or update application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.", + "description": "Create or update application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -203780,7 +196618,7 @@ } } ], - "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L67" + "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L38" }, { "kind": "response", @@ -203820,7 +196658,7 @@ "name": "Response", "namespace": "security.put_privileges" }, - "specLocation": "security/put_privileges/SecurityPutPrivilegesResponse.ts#L23-L28" + "specLocation": "security/put_privileges/SecurityPutPrivilegesResponse.ts#L23-L26" }, { "kind": "request", @@ -203903,7 +196741,7 @@ "since": "8.14.0" } }, - "description": "A list of remote indices permissions entries.\n\nNOTE: Remote indices are effective for remote clusters configured with the API key based model.\nThey have no effect for remote clusters configured with the certificate based model.", + "description": "A list of remote indices permissions entries.", "name": "remote_indices", "required": false, "type": { @@ -203951,8 +196789,8 @@ }, { "description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", - "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "docId": "run-as-privilege", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/run-as-privilege.html", "name": "run_as", "required": false, "type": { @@ -204038,7 +196876,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L32-L111" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L32-L101" }, { "kind": "response", @@ -204046,7 +196884,6 @@ "kind": "properties", "properties": [ { - "description": "When an existing role is updated, `created` is set to `false`.", "name": "role", "required": true, "type": { @@ -204063,7 +196900,7 @@ "name": "Response", "namespace": "security.put_role" }, - "specLocation": "security/put_role/SecurityPutRoleResponse.ts#L22-L29" + "specLocation": "security/put_role/SecurityPutRoleResponse.ts#L22-L24" }, { "kind": "request", @@ -204074,7 +196911,6 @@ "kind": "properties", "properties": [ { - "description": "Mappings that have `enabled` set to `false` are ignored when role mapping is performed.", "name": "enabled", "required": false, "type": { @@ -204086,7 +196922,6 @@ } }, { - "description": "Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "name": "metadata", "required": false, "type": { @@ -204098,7 +196933,6 @@ } }, { - "description": "A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", "name": "roles", "required": false, "type": { @@ -204113,7 +196947,6 @@ } }, { - "description": "A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", "name": "role_templates", "required": false, "type": { @@ -204128,7 +196961,6 @@ } }, { - "description": "The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.", "name": "rules", "required": false, "type": { @@ -204155,7 +196987,7 @@ } ] }, - "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names.", + "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", "inherits": { "type": { "name": "RequestBase", @@ -204168,7 +197000,7 @@ }, "path": [ { - "description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.", + "description": "Role-mapping name", "name": "name", "required": true, "type": { @@ -204194,7 +197026,7 @@ } } ], - "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L103" + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L56" }, { "kind": "response", @@ -204251,7 +197083,6 @@ } }, { - "description": "The email of the user.", "name": "email", "required": false, "type": { @@ -204275,7 +197106,6 @@ } }, { - "description": "The full name of the user.", "name": "full_name", "required": false, "type": { @@ -204299,7 +197129,6 @@ } }, { - "description": "Arbitrary metadata that you want to associate with the user.", "name": "metadata", "required": false, "type": { @@ -204311,7 +197140,6 @@ } }, { - "description": "The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password", "name": "password", "required": false, "type": { @@ -204323,9 +197151,6 @@ } }, { - "description": "A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.", - "extDocId": "security-settings-hashing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings", "name": "password_hash", "required": false, "type": { @@ -204337,7 +197162,6 @@ } }, { - "description": "A set of roles the user has.\nThe roles determine the user's access permissions.\nTo create a user without any roles, specify an empty list (`[]`).", "name": "roles", "required": false, "type": { @@ -204352,10 +197176,8 @@ } }, { - "description": "Specifies whether the user is enabled.", "name": "enabled", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -204366,7 +197188,7 @@ } ] }, - "description": "Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API.", + "description": "Create or update users.\n\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", "inherits": { "type": { "name": "RequestBase", @@ -204379,7 +197201,7 @@ }, "path": [ { - "description": "An identifier for the user.\n\nNOTE: Usernames must be at least 1 and no more than 507 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.\nLeading or trailing whitespace is not allowed.", + "description": "The username of the User", "name": "username", "required": true, "type": { @@ -204393,10 +197215,9 @@ ], "query": [ { - "description": "Valid values are `true`, `false`, and `wait_for`.\nThese values have the same meaning as in the index API, but the default value for this API is true.", + "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "name": "refresh", "required": false, - "serverDefault": "true", "type": { "kind": "instance_of", "type": { @@ -204406,7 +197227,7 @@ } } ], - "specLocation": "security/put_user/SecurityPutUserRequest.ts#L23-L101" + "specLocation": "security/put_user/SecurityPutUserRequest.ts#L23-L48" }, { "kind": "response", @@ -204414,7 +197235,6 @@ "kind": "properties", "properties": [ { - "description": "A successful call returns a JSON structure that shows whether the user has been created or updated.\nWhen an existing user is updated, `created` is set to `false`.", "name": "created", "required": true, "type": { @@ -204431,7 +197251,7 @@ "name": "Response", "namespace": "security.put_user" }, - "specLocation": "security/put_user/SecurityPutUserResponse.ts#L20-L28" + "specLocation": "security/put_user/SecurityPutUserResponse.ts#L20-L22" }, { "kind": "type_alias", @@ -204590,7 +197410,7 @@ { "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", "docId": "search-aggregations-metrics-cardinality-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html", "name": "cardinality", "required": false, "type": { @@ -204616,7 +197436,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", "docId": "search-aggregations-bucket-daterange-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html", "name": "date_range", "required": false, "type": { @@ -204630,7 +197450,7 @@ { "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", "docId": "search-aggregations-bucket-filter-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html", "name": "filter", "required": false, "type": { @@ -204644,7 +197464,7 @@ { "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", "docId": "search-aggregations-bucket-filters-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filters-aggregation.html", "name": "filters", "required": false, "type": { @@ -204669,7 +197489,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", "docId": "search-aggregations-bucket-range-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-range-aggregation.html", "name": "range", "required": false, "type": { @@ -204683,7 +197503,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", "docId": "search-aggregations-bucket-terms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-terms-aggregation.html", "name": "terms", "required": false, "type": { @@ -204697,7 +197517,7 @@ { "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", "docId": "search-aggregations-metrics-valuecount-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-valuecount-aggregation.html", "name": "value_count", "required": false, "type": { @@ -204798,9 +197618,9 @@ }, "properties": [ { - "description": "Matches documents matching boolean combinations of other queries.", + "description": "matches documents matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "name": "bool", "required": false, "type": { @@ -204814,7 +197634,7 @@ { "description": "Returns documents that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "name": "exists", "required": false, "type": { @@ -204828,7 +197648,7 @@ { "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "name": "ids", "required": false, "type": { @@ -204842,7 +197662,7 @@ { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "name": "match", "required": false, "type": { @@ -204867,7 +197687,7 @@ { "description": "Matches all documents, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "name": "match_all", "required": false, "type": { @@ -204881,7 +197701,7 @@ { "description": "Returns documents that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "name": "prefix", "required": false, "type": { @@ -204906,7 +197726,7 @@ { "description": "Returns documents that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "name": "range", "required": false, "type": { @@ -204931,7 +197751,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "name": "simple_query_string", "required": false, "type": { @@ -204945,7 +197765,7 @@ { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "name": "term", "required": false, "type": { @@ -204970,7 +197790,7 @@ { "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "name": "terms", "required": false, "type": { @@ -204984,7 +197804,7 @@ { "description": "Returns documents that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "name": "wildcard", "required": false, "type": { @@ -205048,7 +197868,7 @@ } }, { - "description": "A query to filter which API keys to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following public information associated with an API key: `id`, `type`, `name`,\n`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.\n\nNOTE: The queryable string values associated with API keys are internally mapped as keywords.\nConsequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value.\nSuch a match query is hence equivalent to a `term` query.", + "description": "A query to filter which API keys to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following public information associated with an API key: `id`, `type`, `name`,\n`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`.", "name": "query", "required": false, "type": { @@ -205060,7 +197880,7 @@ } }, { - "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "Starting document offset.\nBy default, you cannot page through more than 10,000 hits using the from and size parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, @@ -205073,9 +197893,9 @@ } }, { - "description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", - "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "description": "Other than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "docId": "sort-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -205087,7 +197907,7 @@ } }, { - "description": "The number of hits to return.\nIt must not be negative.\nThe `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, @@ -205100,9 +197920,7 @@ } }, { - "description": "The search after definition.", - "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "description": "Search after definition", "name": "search_after", "required": false, "type": { @@ -205115,7 +197933,7 @@ } ] }, - "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information.\nYou can optionally filter the results with a query.\n\nTo use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.\nIf you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -205135,7 +197953,7 @@ "since": "8.5.0" } }, - "description": "Return the snapshot of the owner user's role descriptors associated with the API key.\nAn API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).\nAn API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.", + "description": "Return the snapshot of the owner user's role descriptors associated with the API key.\nAn API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.", "name": "with_limited_by", "required": false, "type": { @@ -205153,7 +197971,7 @@ "since": "8.14.0" } }, - "description": "Determines whether to also retrieve the profile UID for the API key owner principal.\nIf it exists, the profile UID is returned under the `profile_uid` response field for each API key.", + "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", "name": "with_profile_uid", "required": false, "serverDefault": false, @@ -205185,7 +198003,7 @@ } } ], - "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L124" + "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L101" }, { "kind": "response", @@ -205310,7 +198128,7 @@ "kind": "properties", "properties": [ { - "description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, and `applications.resources`.", + "description": "A query to filter which roles to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with roles: `name`, `description`, `metadata`,\n`applications.application`, `applications.privileges`, `applications.resources`.", "name": "query", "required": false, "type": { @@ -205322,7 +198140,7 @@ } }, { - "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "Starting document offset.\nBy default, you cannot page through more than 10,000 hits using the from and size parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, @@ -205335,9 +198153,9 @@ } }, { - "description": "The sort definition.\nYou can sort on `username`, `roles`, or `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "description": "All public fields of a role are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -205349,7 +198167,7 @@ } }, { - "description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, @@ -205362,9 +198180,7 @@ } }, { - "description": "The search after definition.", - "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "description": "Search after definition", "name": "search_after", "required": false, "type": { @@ -205377,7 +198193,7 @@ } ] }, - "description": "Find roles with a query.\n\nGet roles in a paginated manner.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe query roles API does not retrieve roles that are defined in roles files, nor built-in ones.\nYou can optionally filter the results with a query.\nAlso, the results can be paginated and sorted.", + "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -205390,7 +198206,7 @@ }, "path": [], "query": [], - "specLocation": "security/query_role/QueryRolesRequest.ts#L25-L85" + "specLocation": "security/query_role/QueryRolesRequest.ts#L25-L69" }, { "kind": "response", @@ -205422,7 +198238,7 @@ } }, { - "description": "A list of roles that match the query.\nThe returned role format is an extension of the role definition format.\nIt adds the `transient_metadata.enabled` and the `_sort` fields.\n`transient_metadata.enabled` is set to `false` in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license.\n`_sort` is present when the search query sorts on some field.\nIt contains the array of values that have been used for sorting.", + "description": "The list of roles.", "name": "roles", "required": true, "type": { @@ -205442,7 +198258,7 @@ "name": "Response", "namespace": "security.query_role" }, - "specLocation": "security/query_role/QueryRolesResponse.ts#L23-L43" + "specLocation": "security/query_role/QueryRolesResponse.ts#L23-L38" }, { "kind": "interface", @@ -205454,7 +198270,7 @@ { "description": "matches roles matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "name": "bool", "required": false, "type": { @@ -205468,7 +198284,7 @@ { "description": "Returns roles that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "name": "exists", "required": false, "type": { @@ -205482,7 +198298,7 @@ { "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "name": "ids", "required": false, "type": { @@ -205496,7 +198312,7 @@ { "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "name": "match", "required": false, "type": { @@ -205521,7 +198337,7 @@ { "description": "Matches all roles, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "name": "match_all", "required": false, "type": { @@ -205535,7 +198351,7 @@ { "description": "Returns roles that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "name": "prefix", "required": false, "type": { @@ -205560,7 +198376,7 @@ { "description": "Returns roles that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "name": "range", "required": false, "type": { @@ -205585,7 +198401,7 @@ { "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "name": "simple_query_string", "required": false, "type": { @@ -205599,7 +198415,7 @@ { "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "name": "term", "required": false, "type": { @@ -205624,7 +198440,7 @@ { "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "name": "terms", "required": false, "type": { @@ -205638,7 +198454,7 @@ { "description": "Returns roles that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "name": "wildcard", "required": false, "type": { @@ -205703,7 +198519,7 @@ "kind": "properties", "properties": [ { - "description": "A query to filter which users to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`.", + "description": "A query to filter which users to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with user: `username`, `roles`, `enabled`", "name": "query", "required": false, "type": { @@ -205715,7 +198531,7 @@ } }, { - "description": "The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "Starting document offset.\nBy default, you cannot page through more than 10,000 hits using the from and size parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "from", "required": false, "serverDefault": 0, @@ -205728,9 +198544,9 @@ } }, { - "description": "The sort definition.\nFields eligible for sorting are: `username`, `roles`, `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", - "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "description": "Fields eligible for sorting are: username, roles, enabled\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", + "docId": "sort-search-results", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html", "name": "sort", "required": false, "type": { @@ -205742,7 +198558,7 @@ } }, { - "description": "The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", + "description": "The number of hits to return.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.", "name": "size", "required": false, "serverDefault": 10, @@ -205755,9 +198571,7 @@ } }, { - "description": "The search after definition", - "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "description": "Search after definition", "name": "search_after", "required": false, "type": { @@ -205770,7 +198584,7 @@ } ] }, - "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.\n\nNOTE: As opposed to the get user API, built-in users are excluded from the result.\nThis API is only for native users.", + "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -205784,10 +198598,9 @@ "path": [], "query": [ { - "description": "Determines whether to retrieve the user profile UID, if it exists, for the users.", + "description": "If true will return the User Profile ID for the users in the query result, if any.", "name": "with_profile_uid", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -205797,7 +198610,7 @@ } } ], - "specLocation": "security/query_user/SecurityQueryUserRequest.ts#L25-L91" + "specLocation": "security/query_user/SecurityQueryUserRequest.ts#L25-L75" }, { "kind": "response", @@ -205829,7 +198642,7 @@ } }, { - "description": "A list of users that match the query.", + "description": "A list of user information.", "name": "users", "required": true, "type": { @@ -205861,7 +198674,7 @@ { "description": "Returns users based on their IDs.\nThis query uses the user document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "name": "ids", "required": false, "type": { @@ -205875,7 +198688,7 @@ { "description": "matches users matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "name": "bool", "required": false, "type": { @@ -205889,7 +198702,7 @@ { "description": "Returns users that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "name": "exists", "required": false, "type": { @@ -205903,7 +198716,7 @@ { "description": "Returns users that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "name": "match", "required": false, "type": { @@ -205928,7 +198741,7 @@ { "description": "Matches all users, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "name": "match_all", "required": false, "type": { @@ -205942,7 +198755,7 @@ { "description": "Returns users that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "name": "prefix", "required": false, "type": { @@ -205967,7 +198780,7 @@ { "description": "Returns users that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "name": "range", "required": false, "type": { @@ -205992,7 +198805,7 @@ { "description": "Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "name": "simple_query_string", "required": false, "type": { @@ -206006,7 +198819,7 @@ { "description": "Returns users that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "name": "term", "required": false, "type": { @@ -206031,7 +198844,7 @@ { "description": "Returns users that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "name": "terms", "required": false, "type": { @@ -206045,7 +198858,7 @@ { "description": "Returns users that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "name": "wildcard", "required": false, "type": { @@ -206083,7 +198896,7 @@ "kind": "properties", "properties": [ { - "description": "The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document.", + "description": "The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document.", "name": "content", "required": true, "type": { @@ -206095,7 +198908,7 @@ } }, { - "description": "A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.", + "description": "A json array with all the valid SAML Request Ids that the caller of the API has for the current user.", "name": "ids", "required": true, "type": { @@ -206120,7 +198933,7 @@ } ] }, - "description": "Authenticate SAML.\n\nSubmit a SAML response message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML message that is submitted can be:\n\n* A response to a SAML authentication request that was previously created using the SAML prepare authentication API.\n* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.\n\nIn either case, the SAML message needs to be a base64 encoded XML document with a root element of ``.\n\nAfter successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\nThis API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.", + "description": "Authenticate SAML.\n\nSubmits a SAML response message to Elasticsearch for consumption.", "inherits": { "type": { "name": "RequestBase", @@ -206133,7 +198946,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_authenticate/Request.ts#L23-L61" + "specLocation": "security/saml_authenticate/Request.ts#L23-L40" }, { "kind": "response", @@ -206141,7 +198954,6 @@ "kind": "properties", "properties": [ { - "description": "The access token that was generated by Elasticsearch.", "name": "access_token", "required": true, "type": { @@ -206153,7 +198965,6 @@ } }, { - "description": "The authenticated user's name.", "name": "username", "required": true, "type": { @@ -206165,7 +198976,6 @@ } }, { - "description": "The amount of time (in seconds) left until the token expires.", "name": "expires_in", "required": true, "type": { @@ -206177,7 +198987,6 @@ } }, { - "description": "The refresh token that was generated by Elasticsearch.", "name": "refresh_token", "required": true, "type": { @@ -206189,7 +198998,6 @@ } }, { - "description": "The name of the realm where the user was authenticated.", "name": "realm", "required": true, "type": { @@ -206206,7 +199014,7 @@ "name": "Response", "namespace": "security.saml_authenticate" }, - "specLocation": "security/saml_authenticate/Response.ts#L22-L45" + "specLocation": "security/saml_authenticate/Response.ts#L22-L30" }, { "kind": "request", @@ -206229,7 +199037,7 @@ } }, { - "description": "A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.", + "description": "A json array with all the valid SAML Request Ids that the caller of the API has for the current user.", "name": "ids", "required": true, "type": { @@ -206266,7 +199074,7 @@ } ] }, - "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.\nThis API verifies the response by ensuring the content is relevant and validating its signature.\nAn empty response is returned if the verification process is successful.\nThe response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.\nThe caller of this API must prepare the request accordingly so that this API can handle either of them.", + "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.", "inherits": { "type": { "name": "RequestBase", @@ -206279,7 +199087,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_complete_logout/Request.ts#L23-L61" + "specLocation": "security/saml_complete_logout/Request.ts#L23-L42" }, { "kind": "response", @@ -206290,7 +199098,7 @@ "name": "Response", "namespace": "security.saml_complete_logout" }, - "specLocation": "security/saml_complete_logout/Response.ts#L22-L27" + "specLocation": "security/saml_complete_logout/Response.ts#L22-L24" }, { "kind": "request", @@ -206301,7 +199109,7 @@ "kind": "properties", "properties": [ { - "description": "The Assertion Consumer Service URL that matches the one of the SAML realm in Elasticsearch that should be used. You must specify either this parameter or the `realm` parameter.", + "description": "The Assertion Consumer Service URL that matches the one of the SAML realm in Elasticsearch that should be used. You must specify either this parameter or the realm parameter.", "name": "acs", "required": false, "type": { @@ -206313,7 +199121,7 @@ } }, { - "description": "The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout.\nThis query should include a single parameter named `SAMLRequest` that contains a SAML logout request that is deflated and Base64 encoded.\nIf the SAML IdP has signed the logout request, the URL should include two extra parameters named `SigAlg` and `Signature` that contain the algorithm used for the signature and the signature value itself.\nIn order for Elasticsearch to be able to verify the IdP's signature, the value of the `query_string` field must be an exact match to the string provided by the browser.\nThe client application must not attempt to parse or process the string in any way.", + "description": "The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout.\nThis query should include a single parameter named SAMLRequest that contains a SAML logout request that is deflated and Base64 encoded.\nIf the SAML IdP has signed the logout request, the URL should include two extra parameters named SigAlg and Signature that contain the algorithm used for the signature and the signature value itself.\nIn order for Elasticsearch to be able to verify the IdP’s signature, the value of the query_string field must be an exact match to the string provided by the browser.\nThe client application must not attempt to parse or process the string in any way.", "name": "query_string", "required": true, "type": { @@ -206325,7 +199133,7 @@ } }, { - "description": "The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the `acs` parameter.", + "description": "The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the acs parameter.", "name": "realm", "required": false, "type": { @@ -206338,7 +199146,7 @@ } ] }, - "description": "Invalidate SAML.\n\nSubmit a SAML LogoutRequest message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe logout request comes from the SAML IdP during an IdP initiated Single Logout.\nThe custom web application can use this API to have Elasticsearch process the `LogoutRequest`.\nAfter successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.\nThus the user can be redirected back to their IdP.", + "description": "Invalidate SAML.\n\nSubmits a SAML LogoutRequest message to Elasticsearch for consumption.", "inherits": { "type": { "name": "RequestBase", @@ -206351,7 +199159,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_invalidate/Request.ts#L22-L61" + "specLocation": "security/saml_invalidate/Request.ts#L22-L45" }, { "kind": "response", @@ -206359,7 +199167,6 @@ "kind": "properties", "properties": [ { - "description": "The number of tokens that were invalidated as part of this logout.", "name": "invalidated", "required": true, "type": { @@ -206371,7 +199178,6 @@ } }, { - "description": "The realm name of the SAML realm in Elasticsearch that authenticated the user.", "name": "realm", "required": true, "type": { @@ -206383,7 +199189,6 @@ } }, { - "description": "A SAML logout response as a parameter so that the user can be redirected back to the SAML IdP.", "name": "redirect", "required": true, "type": { @@ -206400,7 +199205,7 @@ "name": "Response", "namespace": "security.saml_invalidate" }, - "specLocation": "security/saml_invalidate/Response.ts#L22-L37" + "specLocation": "security/saml_invalidate/Response.ts#L22-L28" }, { "kind": "request", @@ -206411,7 +199216,7 @@ "kind": "properties", "properties": [ { - "description": "The access token that was returned as a response to calling the SAML authenticate API.\nAlternatively, the most recent token that was received after refreshing the original one by using a `refresh_token`.", + "description": "The access token that was returned as a response to calling the SAML authenticate API.\nAlternatively, the most recent token that was received after refreshing the original one by using a refresh_token.", "name": "token", "required": true, "type": { @@ -206436,7 +199241,7 @@ } ] }, - "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API invalidates the tokens that were generated for a user by the SAML authenticate API.\nIf the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).", + "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.", "inherits": { "type": { "name": "RequestBase", @@ -206449,7 +199254,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_logout/Request.ts#L22-L57" + "specLocation": "security/saml_logout/Request.ts#L22-L43" }, { "kind": "response", @@ -206457,7 +199262,6 @@ "kind": "properties", "properties": [ { - "description": "A URL that contains a SAML logout request as a parameter.\nYou can use this URL to be redirected back to the SAML IdP and to initiate Single Logout.", "name": "redirect", "required": true, "type": { @@ -206474,7 +199278,7 @@ "name": "Response", "namespace": "security.saml_logout" }, - "specLocation": "security/saml_logout/Response.ts#L20-L28" + "specLocation": "security/saml_logout/Response.ts#L20-L24" }, { "kind": "request", @@ -206485,7 +199289,7 @@ "kind": "properties", "properties": [ { - "description": "The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.\nThe realm is used to generate the authentication request. You must specify either this parameter or the `realm` parameter.", + "description": "The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.\nThe realm is used to generate the authentication request. You must specify either this parameter or the realm parameter.", "name": "acs", "required": false, "type": { @@ -206497,7 +199301,7 @@ } }, { - "description": "The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.\nYou must specify either this parameter or the `acs` parameter.", + "description": "The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.\nYou must specify either this parameter or the acs parameter.", "name": "realm", "required": false, "type": { @@ -206509,7 +199313,7 @@ } }, { - "description": "A string that will be included in the redirect URL that this API returns as the `RelayState` query parameter.\nIf the Authentication Request is signed, this value is used as part of the signature computation.", + "description": "A string that will be included in the redirect URL that this API returns as the RelayState query parameter.\nIf the Authentication Request is signed, this value is used as part of the signature computation.", "name": "relay_state", "required": false, "type": { @@ -206522,7 +199326,7 @@ } ] }, - "description": "Prepare SAML authentication.\n\nCreate a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API returns a URL pointing to the SAML Identity Provider.\nYou can use the URL to redirect the browser of the user in order to continue the authentication process.\nThe URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.\nIf the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.\nThese parameters contain the algorithm used for the signature and the signature value itself.\nIt also returns a random string that uniquely identifies this SAML Authentication request.\nThe caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.", + "description": "Prepare SAML authentication.\n\nCreates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -206535,7 +199339,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_prepare_authentication/Request.ts#L22-L67" + "specLocation": "security/saml_prepare_authentication/Request.ts#L22-L48" }, { "kind": "response", @@ -206543,7 +199347,6 @@ "kind": "properties", "properties": [ { - "description": "A unique identifier for the SAML Request to be stored by the caller of the API.", "name": "id", "required": true, "type": { @@ -206555,7 +199358,6 @@ } }, { - "description": "The name of the Elasticsearch realm that was used to construct the authentication request.", "name": "realm", "required": true, "type": { @@ -206567,7 +199369,6 @@ } }, { - "description": "The URL to redirect the user to.", "name": "redirect", "required": true, "type": { @@ -206584,7 +199385,7 @@ "name": "Response", "namespace": "security.saml_prepare_authentication" }, - "specLocation": "security/saml_prepare_authentication/Response.ts#L22-L37" + "specLocation": "security/saml_prepare_authentication/Response.ts#L22-L28" }, { "kind": "request", @@ -206594,7 +199395,7 @@ "body": { "kind": "no_body" }, - "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.\n\nThe SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.\nThis API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.", + "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.", "inherits": { "type": { "name": "RequestBase", @@ -206620,7 +199421,7 @@ } ], "query": [], - "specLocation": "security/saml_service_provider_metadata/Request.ts#L23-L46" + "specLocation": "security/saml_service_provider_metadata/Request.ts#L23-L36" }, { "kind": "response", @@ -206628,7 +199429,6 @@ "kind": "properties", "properties": [ { - "description": "An XML string that contains a SAML Service Provider's metadata for the realm.", "name": "metadata", "required": true, "type": { @@ -206645,7 +199445,7 @@ "name": "Response", "namespace": "security.saml_service_provider_metadata" }, - "specLocation": "security/saml_service_provider_metadata/Response.ts#L20-L27" + "specLocation": "security/saml_service_provider_metadata/Response.ts#L20-L24" }, { "kind": "interface", @@ -206655,7 +199455,7 @@ }, "properties": [ { - "description": "A list of profile UIDs to match against.", + "description": "A list of Profile UIDs to match against.", "name": "uids", "required": false, "type": { @@ -206719,7 +199519,7 @@ "kind": "properties", "properties": [ { - "description": "A query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.", + "description": "Query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.", "name": "name", "required": false, "type": { @@ -206731,7 +199531,7 @@ } }, { - "description": "The number of profiles to return.", + "description": "Number of profiles to return.", "name": "size", "required": false, "serverDefault": 10, @@ -206744,7 +199544,7 @@ } }, { - "description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=` to retrieve content nested under the specified ``.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.", + "description": "List of filters for the `data` field of the profile document.\nTo return all content use `data=*`. To return a subset of content\nuse `data=` to retrieve content nested under the specified ``.\nBy default returns no `data` content.", "name": "data", "required": false, "type": { @@ -206771,7 +199571,7 @@ } }, { - "description": "Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.", + "description": "Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint don't exclude the profile from the response\nas long as the profile matches the `name` field query.", "name": "hint", "required": false, "type": { @@ -206784,7 +199584,7 @@ } ] }, - "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", + "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.", "inherits": { "type": { "name": "RequestBase", @@ -206798,7 +199598,7 @@ "path": [], "query": [ { - "description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=` to retrieve content nested under the specified ``.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.", + "description": "List of filters for the `data` field of the profile document.\nTo return all content use `data=*`. To return a subset of content\nuse `data=` to retrieve content nested under the specified ``.\nBy default returns no `data` content.", "name": "data", "required": false, "type": { @@ -206825,7 +199625,7 @@ } } ], - "specLocation": "security/suggest_user_profiles/Request.ts#L24-L81" + "specLocation": "security/suggest_user_profiles/Request.ts#L24-L68" }, { "kind": "response", @@ -206833,7 +199633,6 @@ "kind": "properties", "properties": [ { - "description": "Metadata about the number of matching profiles.", "name": "total", "required": true, "type": { @@ -206845,7 +199644,6 @@ } }, { - "description": "The number of milliseconds it took Elasticsearch to run the request.", "name": "took", "required": true, "type": { @@ -206857,7 +199655,6 @@ } }, { - "description": "A list of profile documents, ordered by relevance, that match the search criteria.", "name": "profiles", "required": true, "type": { @@ -206877,7 +199674,7 @@ "name": "Response", "namespace": "security.suggest_user_profiles" }, - "specLocation": "security/suggest_user_profiles/Response.ts#L29-L44" + "specLocation": "security/suggest_user_profiles/Response.ts#L29-L35" }, { "kind": "interface", @@ -206920,7 +199717,9 @@ "kind": "properties", "properties": [ { - "description": "The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.", + "description": "An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.", + "docId": "security-api-put-role", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role.html", "name": "role_descriptors", "required": false, "type": { @@ -206943,7 +199742,7 @@ } }, { - "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.", + "description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.", "name": "metadata", "required": false, "type": { @@ -206955,7 +199754,7 @@ } }, { - "description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.", + "description": "Expiration time for the API key.", "name": "expiration", "required": false, "type": { @@ -206968,7 +199767,7 @@ } ] }, - "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.", + "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "inherits": { "type": { "name": "RequestBase", @@ -206994,7 +199793,7 @@ } ], "query": [], - "specLocation": "security/update_api_key/Request.ts#L26-L91" + "specLocation": "security/update_api_key/Request.ts#L26-L67" }, { "kind": "response", @@ -207002,7 +199801,7 @@ "kind": "properties", "properties": [ { - "description": "If `true`, the API key was updated.\nIf `false`, the API key didn't change because no change was detected.", + "description": "If `true`, the API key was updated.\nIf `false`, the API key didn’t change because no change was detected.", "name": "updated", "required": true, "type": { @@ -207042,7 +199841,7 @@ } }, { - "description": "The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.", + "description": "Expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.", "name": "expiration", "required": false, "type": { @@ -207067,7 +199866,7 @@ } ] }, - "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.", + "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.", "inherits": { "type": { "name": "RequestBase", @@ -207093,7 +199892,7 @@ } ], "query": [], - "specLocation": "security/update_cross_cluster_api_key/UpdateCrossClusterApiKeyRequest.ts#L25-L83" + "specLocation": "security/update_cross_cluster_api_key/UpdateCrossClusterApiKeyRequest.ts#L25-L61" }, { "kind": "response", @@ -207129,117 +199928,7 @@ "kind": "properties", "properties": [ { - "description": "Settings for the index used for most security configuration, including native realm users and roles configured with the API.", - "name": "security", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SecuritySettings", - "namespace": "security._types" - } - } - }, - { - "description": "Settings for the index used to store profile information.", - "name": "security-profile", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SecuritySettings", - "namespace": "security._types" - } - } - }, - { - "description": "Settings for the index used to store tokens.", - "name": "security-tokens", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "SecuritySettings", - "namespace": "security._types" - } - } - } - ] - }, - "description": "Update security index settings.\n\nUpdate the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.\n\nNOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.\n\nIf a specific index is not in use on the system and settings are provided for it, the request will be rejected.\nThis API does not yet support configuring the settings for indices before they are in use.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "security.update_settings" - }, - "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "security/update_settings/SecurityUpdateSettingsRequest.ts#L24-L71" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "security.update_settings" - }, - "specLocation": "security/update_settings/SecurityUpdateSettingsResponse.ts#L20-L24" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).", + "description": "Searchable data that you want to associate with the user profile. This\nfield supports a nested data structure.", "name": "labels", "required": false, "type": { @@ -207258,7 +199947,7 @@ } }, { - "description": "Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).\nThe data object is not searchable, but can be retrieved with the get user profile API.", + "description": "Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.", "name": "data", "required": false, "type": { @@ -207278,7 +199967,7 @@ } ] }, - "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.", + "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.", "inherits": { "type": { "name": "RequestBase", @@ -207329,7 +200018,7 @@ } }, { - "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.", + "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search, if 'wait_for' then wait for a refresh to make this operation\nvisible to search, if 'false' do nothing with refreshes.", "name": "refresh", "required": false, "serverDefault": "false", @@ -207342,7 +200031,7 @@ } } ], - "specLocation": "security/update_user_profile_data/Request.ts#L27-L98" + "specLocation": "security/update_user_profile_data/Request.ts#L27-L72" }, { "kind": "response", @@ -207389,7 +200078,7 @@ "body": { "kind": "no_body" }, - "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", + "description": "Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -207442,7 +200131,7 @@ } } ], - "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L61" + "specLocation": "shutdown/delete_node/ShutdownDeleteNodeRequest.ts#L24-L44" }, { "kind": "response", @@ -207619,7 +200308,7 @@ "body": { "kind": "no_body" }, - "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", + "description": "Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -207657,9 +200346,22 @@ "namespace": "_types" } } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "TimeUnit", + "namespace": "_types" + } + } } ], - "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L24-L59" + "specLocation": "shutdown/get_node/ShutdownGetNodeRequest.ts#L24-L44" }, { "kind": "response", @@ -207805,7 +200507,7 @@ } ] }, - "description": "Prepare a node to be shut down.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", + "description": "Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -207818,7 +200520,7 @@ }, "path": [ { - "description": "The node identifier.\nThis parameter is not validated against the cluster's active nodes.\nThis enables you to register a node for shut down while it is offline.\nNo error is thrown if you specify an invalid node ID.", + "description": "The node id of node to be shut down", "name": "node_id", "required": true, "type": { @@ -207832,7 +200534,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -207845,7 +200547,7 @@ } }, { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -207858,7 +200560,7 @@ } } ], - "specLocation": "shutdown/put_node/ShutdownPutNodeRequest.ts#L25-L108" + "specLocation": "shutdown/put_node/ShutdownPutNodeRequest.ts#L25-L76" }, { "kind": "response", @@ -207878,372 +200580,6 @@ }, "specLocation": "shutdown/put_node/ShutdownPutNodeResponse.ts#L22-L24" }, - { - "kind": "enum", - "members": [ - { - "name": "field" - } - ], - "name": { - "name": "IgnoredFieldKey", - "namespace": "simulate.ingest" - }, - "specLocation": "simulate/ingest/SimulateIngestResponse.ts#L80-L85" - }, - { - "kind": "interface", - "attachedBehaviors": [ - "AdditionalProperties" - ], - "behaviors": [ - { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - ], - "meta": { - "description": "Additional metadata", - "fieldname": "metadata" - }, - "type": { - "name": "AdditionalProperties", - "namespace": "_spec_utils" - } - } - ], - "description": "The results of ingest simulation on a single document. The _source of the document contains\nthe results after running all pipelines listed in executed_pipelines on the document. The\nlist of executed pipelines is derived from the pipelines that would be executed if this\ndocument had been ingested into _index.", - "name": { - "name": "IngestDocumentSimulation", - "namespace": "simulate.ingest" - }, - "properties": [ - { - "description": "Identifier for the document.", - "name": "_id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "description": "Name of the index that the document would be indexed into if this were not a simulation.", - "name": "_index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - }, - { - "description": "JSON body for the document.", - "name": "_source", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "user_defined_value" - } - } - }, - { - "description": "", - "name": "_version", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "VersionNumber", - "namespace": "_types" - } - } - ], - "type": { - "name": "Stringified", - "namespace": "_spec_utils" - } - } - }, - { - "description": "A list of the names of the pipelines executed on this document.", - "name": "executed_pipelines", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "A list of the fields that would be ignored at the indexing step. For example, a field whose\nvalue is larger than the allowed limit would make it through all of the pipelines, but\nwould not be indexed into Elasticsearch.", - "name": "ignored_fields", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "IgnoredFieldKey", - "namespace": "simulate.ingest" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - } - }, - { - "description": "Any error resulting from simulatng ingest on this doc. This can be an error generated by\nexecuting a processor, or a mapping validation error when simulating indexing the resulting\ndoc.", - "name": "error", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ErrorCause", - "namespace": "_types" - } - } - } - ], - "specLocation": "simulate/ingest/SimulateIngestResponse.ts#L35-L78" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "Sample documents to test in the pipeline.", - "name": "docs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Document", - "namespace": "ingest._types" - } - } - } - }, - { - "description": "A map of component template names to substitute component template definition objects.", - "name": "component_template_substitutions", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "ComponentTemplateNode", - "namespace": "cluster._types" - } - } - } - }, - { - "description": "A map of index template names to substitute index template definition objects.", - "name": "index_template_subtitutions", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "IndexTemplate", - "namespace": "indices._types" - } - } - } - }, - { - "name": "mapping_addition", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "description": "Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", - "name": "pipeline_substitutions", - "required": false, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "Pipeline", - "namespace": "ingest._types" - } - } - } - } - ] - }, - "description": "Simulate data ingestion.\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "simulate.ingest" - }, - "path": [ - { - "description": "The index to simulate ingesting into.\nThis value can be overridden by specifying an index on each document.\nIf you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.", - "name": "index", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexName", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "The pipeline to use as the default pipeline.\nThis value can be used to override the default pipeline of the index.", - "name": "pipeline", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "PipelineName", - "namespace": "_types" - } - } - } - ], - "specLocation": "simulate/ingest/SimulateIngestRequest.ts#L29-L100" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "docs", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SimulateIngestDocumentResult", - "namespace": "simulate.ingest" - } - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "simulate.ingest" - }, - "specLocation": "simulate/ingest/SimulateIngestResponse.ts#L27-L29" - }, - { - "kind": "interface", - "name": { - "name": "SimulateIngestDocumentResult", - "namespace": "simulate.ingest" - }, - "properties": [ - { - "name": "doc", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "IngestDocumentSimulation", - "namespace": "simulate.ingest" - } - } - } - ], - "specLocation": "simulate/ingest/SimulateIngestResponse.ts#L31-L33" - }, { "kind": "interface", "name": { @@ -208330,7 +200666,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L109-L139" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L99-L129" }, { "kind": "interface", @@ -208393,7 +200729,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L141-L146" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L131-L136" }, { "kind": "interface", @@ -208425,7 +200761,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L148-L151" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L138-L141" }, { "kind": "interface", @@ -208490,7 +200826,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L86-L92" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L76-L82" }, { "kind": "interface", @@ -208536,7 +200872,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L94-L107" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L84-L97" }, { "kind": "interface", @@ -208579,7 +200915,6 @@ } }, { - "description": "The last time the policy was modified.", "name": "modified_date", "required": false, "type": { @@ -208611,7 +200946,6 @@ } }, { - "description": "The next time the policy will run.", "name": "next_execution", "required": false, "type": { @@ -208654,7 +200988,6 @@ } }, { - "description": "The version of the snapshot policy.\nOnly the latest version is stored and incremented when the policy is updated.", "name": "version", "required": true, "type": { @@ -208677,7 +201010,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L38-L59" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L38-L49" }, { "kind": "interface", @@ -208818,7 +201151,7 @@ } } ], - "specLocation": "slm/_types/SnapshotLifecycle.ts#L61-L84" + "specLocation": "slm/_types/SnapshotLifecycle.ts#L51-L74" }, { "kind": "request", @@ -208828,7 +201161,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a policy.\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", + "description": "Deletes an existing snapshot lifecycle policy.", "inherits": { "type": { "name": "RequestBase", @@ -208853,35 +201186,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L24-L58" + "query": [], + "specLocation": "slm/delete_lifecycle/DeleteSnapshotLifecycleRequest.ts#L23-L32" }, { "kind": "response", @@ -208909,7 +201215,7 @@ "body": { "kind": "no_body" }, - "description": "Run a policy.\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", + "description": "Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.", "inherits": { "type": { "name": "RequestBase", @@ -208934,35 +201240,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L24-L58" + "query": [], + "specLocation": "slm/execute_lifecycle/ExecuteSnapshotLifecycleRequest.ts#L23-L32" }, { "kind": "response", @@ -208996,7 +201275,7 @@ "body": { "kind": "no_body" }, - "description": "Run a retention policy.\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", + "description": "Deletes any snapshots that are expired according to the policy's retention rules.", "inherits": { "type": { "name": "RequestBase", @@ -209008,35 +201287,8 @@ "namespace": "slm.execute_retention" }, "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/execute_retention/ExecuteRetentionRequest.ts#L23-L54" + "query": [], + "specLocation": "slm/execute_retention/ExecuteRetentionRequest.ts#L22-L27" }, { "kind": "response", @@ -209064,7 +201316,7 @@ "body": { "kind": "no_body" }, - "description": "Get policy information.\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.", + "description": "Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "inherits": { "type": { "name": "RequestBase", @@ -209089,35 +201341,8 @@ } } ], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L24-L64" + "query": [], + "specLocation": "slm/get_lifecycle/GetSnapshotLifecycleRequest.ts#L23-L32" }, { "kind": "response", @@ -209156,7 +201381,7 @@ "body": { "kind": "no_body" }, - "description": "Get snapshot lifecycle management statistics.\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.", + "description": "Returns global and policy-level statistics about actions taken by snapshot lifecycle management.", "inherits": { "type": { "name": "RequestBase", @@ -209168,35 +201393,8 @@ "namespace": "slm.get_stats" }, "path": [], - "query": [ - { - "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.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/get_stats/GetSnapshotLifecycleStatsRequest.ts#L23-L51" + "query": [], + "specLocation": "slm/get_stats/GetSnapshotLifecycleStatsRequest.ts#L22-L27" }, { "kind": "response", @@ -209341,7 +201539,7 @@ "body": { "kind": "no_body" }, - "description": "Get the snapshot lifecycle management status.", + "description": "Retrieves the status of snapshot lifecycle management (SLM).", "inherits": { "type": { "name": "RequestBase", @@ -209353,35 +201551,8 @@ "namespace": "slm.get_status" }, "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts#L23-L54" + "query": [], + "specLocation": "slm/get_status/GetSnapshotLifecycleManagementStatusRequest.ts#L22-L27" }, { "kind": "response", @@ -209477,7 +201648,7 @@ } ] }, - "description": "Create or update a policy.\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.", + "description": "Creates or updates a snapshot lifecycle policy.", "inherits": { "type": { "name": "RequestBase", @@ -209490,7 +201661,7 @@ }, "path": [ { - "description": "The identifier for the snapshot lifecycle policy you want to create or update.", + "description": "ID for the snapshot lifecycle policy you want to create or update.", "name": "policy_id", "required": true, "type": { @@ -209504,7 +201675,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -209517,7 +201688,7 @@ } }, { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -209530,7 +201701,7 @@ } } ], - "specLocation": "slm/put_lifecycle/PutSnapshotLifecycleRequest.ts#L26-L89" + "specLocation": "slm/put_lifecycle/PutSnapshotLifecycleRequest.ts#L26-L72" }, { "kind": "response", @@ -209558,7 +201729,7 @@ "body": { "kind": "no_body" }, - "description": "Start snapshot lifecycle management.\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", + "description": "Turns on snapshot lifecycle management (SLM).", "inherits": { "type": { "name": "RequestBase", @@ -209570,35 +201741,8 @@ "namespace": "slm.start" }, "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/start/StartSnapshotLifecycleManagementRequest.ts#L23-L56" + "query": [], + "specLocation": "slm/start/StartSnapshotLifecycleManagementRequest.ts#L22-L27" }, { "kind": "response", @@ -209626,7 +201770,7 @@ "body": { "kind": "no_body" }, - "description": "Stop snapshot lifecycle management.\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.", + "description": "Turns off snapshot lifecycle management (SLM).", "inherits": { "type": { "name": "RequestBase", @@ -209638,35 +201782,8 @@ "namespace": "slm.stop" }, "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "slm/stop/StopSnapshotLifecycleManagementRequest.ts#L23-L60" + "query": [], + "specLocation": "slm/stop/StopSnapshotLifecycleManagementRequest.ts#L22-L27" }, { "kind": "response", @@ -209700,9 +201817,6 @@ }, "properties": [ { - "description": "The Azure repository type.", - "extDocId": "repository-azure", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html", "name": "type", "required": true, "type": { @@ -209711,9 +201825,8 @@ } }, { - "description": "The repository settings.", "name": "settings", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -209723,7 +201836,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L40-L50" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L40-L43" }, { "kind": "interface", @@ -209739,22 +201852,8 @@ }, "properties": [ { - "description": "The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.", - "name": "base_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The name of the Azure repository client to use.", "name": "client", "required": false, - "serverDefault": "default", "type": { "kind": "instance_of", "type": { @@ -209764,10 +201863,8 @@ } }, { - "description": "The Azure container.", "name": "container", "required": false, - "serverDefault": "elasticsearch-snapshots", "type": { "kind": "instance_of", "type": { @@ -209777,23 +201874,8 @@ } }, { - "description": "The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API.", - "name": "delete_objects_max_size", - "required": false, - "serverDefault": 256, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`.", - "name": "location_mode", + "name": "base_path", "required": false, - "serverDefault": "primary_only", "type": { "kind": "instance_of", "type": { @@ -209803,33 +201885,29 @@ } }, { - "description": "The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100.", - "name": "max_concurrent_batch_deletes", + "name": "readonly", "required": false, - "serverDefault": 10, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "readonly", + "name": "location_mode", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L145-L196" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L77-L83" }, { "kind": "interface", @@ -209877,9 +201955,6 @@ }, "properties": [ { - "description": "The Google Cloud Storage repository type.", - "extDocId": "repository-gcs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html", "name": "type", "required": true, "type": { @@ -209888,7 +201963,6 @@ } }, { - "description": "The repository settings.", "name": "settings", "required": true, "type": { @@ -209900,7 +201974,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L52-L62" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L45-L48" }, { "kind": "interface", @@ -209916,7 +201990,6 @@ }, "properties": [ { - "description": "The name of the bucket to be used for snapshots.", "name": "bucket", "required": true, "type": { @@ -209928,12 +202001,7 @@ } }, { - "deprecation": { - "description": "", - "version": "6.3.0" - }, - "description": "The name used by the client when it uses the Google Cloud Storage service.", - "name": "application_name", + "name": "client", "required": false, "type": { "kind": "instance_of", @@ -209944,7 +202012,6 @@ } }, { - "description": "The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket.", "name": "base_path", "required": false, "type": { @@ -209956,33 +202023,29 @@ } }, { - "description": "The name of the client to use to connect to Google Cloud Storage.", - "name": "client", + "name": "readonly", "required": false, - "serverDefault": "default", "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", - "name": "readonly", + "name": "application_name", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L198-L235" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L85-L91" }, { "kind": "interface", @@ -210084,9 +202147,6 @@ }, "properties": [ { - "description": "The read-only URL repository type.", - "extDocId": "repository-read-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html", "name": "type", "required": true, "type": { @@ -210095,7 +202155,6 @@ } }, { - "description": "The repository settings.", "name": "settings", "required": true, "type": { @@ -210107,7 +202166,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L92-L102" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L60-L63" }, { "kind": "interface", @@ -210123,10 +202182,8 @@ }, "properties": [ { - "description": "The maximum number of retries for HTTP and HTTPS URLs.", "name": "http_max_retries", "required": false, - "serverDefault": 5, "type": { "kind": "instance_of", "type": { @@ -210136,10 +202193,8 @@ } }, { - "description": "The maximum wait time for data transfers over a connection.", "name": "http_socket_timeout", "required": false, - "serverDefault": "50s", "type": { "kind": "instance_of", "type": { @@ -210149,10 +202204,8 @@ } }, { - "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", "name": "max_number_of_snapshots", "required": false, - "serverDefault": 2147483647, "type": { "kind": "instance_of", "type": { @@ -210162,7 +202215,6 @@ } }, { - "description": "The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting.", "name": "url", "required": true, "type": { @@ -210174,7 +202226,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L377-L412" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L110-L115" }, { "kind": "type_alias", @@ -210265,7 +202317,6 @@ }, "properties": [ { - "description": "Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type.", "name": "chunk_size", "required": false, "type": { @@ -210277,10 +202328,8 @@ } }, { - "description": "When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default.", "name": "compress", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -210290,7 +202339,6 @@ } }, { - "description": "The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings.", "name": "max_restore_bytes_per_sec", "required": false, "type": { @@ -210302,7 +202350,6 @@ } }, { - "description": "The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings.", "name": "max_snapshot_bytes_per_sec", "required": false, "type": { @@ -210314,7 +202361,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L116-L143" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L70-L75" }, { "kind": "interface", @@ -210330,9 +202377,6 @@ }, "properties": [ { - "description": "The S3 repository type.", - "extDocId": "repository-s3", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html", "name": "type", "required": true, "type": { @@ -210341,7 +202385,6 @@ } }, { - "description": "The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings.", "name": "settings", "required": true, "type": { @@ -210353,7 +202396,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L64-L78" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L50-L53" }, { "kind": "interface", @@ -210369,9 +202412,6 @@ }, "properties": [ { - "description": "The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules.", - "extDocId": "repository-s3-naming", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules", "name": "bucket", "required": true, "type": { @@ -210383,36 +202423,8 @@ } }, { - "description": "The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket.", - "name": "base_path", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller.", - "name": "buffer_size", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects.", - "extDocId": "repository-s3-canned-acl", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl", - "name": "canned_acl", + "name": "client", "required": false, - "serverDefault": "private", "type": { "kind": "instance_of", "type": { @@ -210422,10 +202434,8 @@ } }, { - "description": "The name of the S3 client to use to connect to S3.", - "name": "client", + "name": "base_path", "required": false, - "serverDefault": "default", "type": { "kind": "instance_of", "type": { @@ -210435,66 +202445,8 @@ } }, { - "description": "The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the AWS DeleteObjects API.", - "extDocId": "repository-s3-delete-objects", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html", - "name": "delete_objects_max_size", - "required": false, - "serverDefault": 1000, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The time to wait before trying again if an attempt to read a linearizable register fails.", - "name": "get_register_retry_delay", - "required": false, - "serverDefault": "5s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3.", - "name": "max_multipart_parts", - "required": false, - "serverDefault": 10000, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads.", - "extDocId": "repository-s3-list-multipart", - "extDocUrl": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html", - "name": "max_multipart_upload_cleanup_size", - "required": false, - "serverDefault": 1000, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", "name": "readonly", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -210504,10 +202456,8 @@ } }, { - "description": "When set to `true`, files are encrypted on server side using an AES256 algorithm.", "name": "server_side_encryption", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -210517,60 +202467,40 @@ } }, { - "description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.", - "extDocId": "repository-s3-storage-classes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes", - "name": "storage_class", - "required": false, - "serverDefault": "standard", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms.", - "name": "throttled_delete_retry.delay_increment", + "name": "buffer_size", "required": false, - "serverDefault": "50ms", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "ByteSize", "namespace": "_types" } } }, { - "description": "The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms.", - "name": "throttled_delete_retry.maximum_delay", + "name": "canned_acl", "required": false, - "serverDefault": "5s", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries.", - "name": "throttled_delete_retry.maximum_number_of_retries", + "name": "storage_class", "required": false, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L237-L346" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L93-L102" }, { "kind": "interface", @@ -210580,7 +202510,6 @@ }, "properties": [ { - "description": "The number of shards that initialized, started, and finalized successfully.", "name": "done", "required": true, "type": { @@ -210592,7 +202521,6 @@ } }, { - "description": "The number of shards that failed to be included in the snapshot.", "name": "failed", "required": true, "type": { @@ -210604,7 +202532,6 @@ } }, { - "description": "The number of shards that are finalizing but are not done.", "name": "finalizing", "required": true, "type": { @@ -210616,7 +202543,6 @@ } }, { - "description": "The number of shards that are still initializing.", "name": "initializing", "required": true, "type": { @@ -210628,7 +202554,6 @@ } }, { - "description": "The number of shards that have started but are not finalized.", "name": "started", "required": true, "type": { @@ -210640,7 +202565,6 @@ } }, { - "description": "The total number of shards included in the snapshot.", "name": "total", "required": true, "type": { @@ -210652,29 +202576,29 @@ } } ], - "specLocation": "snapshot/_types/SnapshotShardsStats.ts#L22-L47" + "specLocation": "snapshot/_types/SnapshotShardsStats.ts#L22-L29" }, { "kind": "enum", "members": [ { - "description": "The number of shards in the snapshot that were successfully stored in the repository.", + "description": "Number of shards in the snapshot that were successfully stored in the repository.", "name": "DONE" }, { - "description": "The number of shards in the snapshot that were not successfully stored in the repository.", + "description": "Number of shards in the snapshot that were not successfully stored in the repository.", "name": "FAILURE" }, { - "description": "The number of shards in the snapshot that are in the finalizing stage of being stored in the repository.", + "description": "Number of shards in the snapshot that are in the finalizing stage of being stored in the repository.", "name": "FINALIZE" }, { - "description": "The number of shards in the snapshot that are in the initializing stage of being stored in the repository.", + "description": "Number of shards in the snapshot that are in the initializing stage of being stored in the repository.", "name": "INIT" }, { - "description": "The number of shards in the snapshot that are in the started stage of being stored in the repository.", + "description": "Number of shards in the snapshot that are in the started stage of being stored in the repository.", "name": "STARTED" } ], @@ -210813,9 +202737,6 @@ }, "properties": [ { - "description": "The shared file system repository type.", - "extDocId": "repository-shared-fs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html", "name": "type", "required": true, "type": { @@ -210824,7 +202745,6 @@ } }, { - "description": "The repository settings.", "name": "settings", "required": true, "type": { @@ -210836,7 +202756,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L80-L90" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L55-L58" }, { "kind": "interface", @@ -210852,7 +202772,6 @@ }, "properties": [ { - "description": "The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path.", "name": "location", "required": true, "type": { @@ -210864,10 +202783,8 @@ } }, { - "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", "name": "max_number_of_snapshots", "required": false, - "serverDefault": 2147483647, "type": { "kind": "instance_of", "type": { @@ -210877,10 +202794,8 @@ } }, { - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", "name": "readonly", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -210890,7 +202805,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L348-L375" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L104-L108" }, { "kind": "interface", @@ -211414,7 +203329,6 @@ }, "properties": [ { - "description": "The number and size of files that still need to be copied as part of the incremental snapshot.\nFor completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot.", "name": "incremental", "required": true, "type": { @@ -211426,7 +203340,6 @@ } }, { - "description": "The time, in milliseconds, when the snapshot creation process started.", "name": "start_time_in_millis", "required": true, "type": { @@ -211458,7 +203371,6 @@ } }, { - "description": "The total time, in milliseconds, that it took for the snapshot process to complete.", "name": "time_in_millis", "required": true, "type": { @@ -211479,7 +203391,6 @@ } }, { - "description": "The total number and size of files that are referenced by the snapshot.", "name": "total", "required": true, "type": { @@ -211491,7 +203402,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotStats.ts#L23-L42" + "specLocation": "snapshot/_types/SnapshotStats.ts#L23-L29" }, { "kind": "interface", @@ -211507,9 +203418,6 @@ }, "properties": [ { - "description": "The source-only repository type.", - "extDocId": "repository-source-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html", "name": "type", "required": true, "type": { @@ -211518,7 +203426,6 @@ } }, { - "description": "The repository settings.", "name": "settings", "required": true, "type": { @@ -211530,7 +203437,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L104-L114" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L65-L68" }, { "kind": "interface", @@ -211546,7 +203453,6 @@ }, "properties": [ { - "description": "The delegated repository type. For valid values, refer to the `type` parameter.\nSource repositories can use `settings` properties for its delegated repository type.", "name": "delegate_type", "required": false, "type": { @@ -211558,10 +203464,8 @@ } }, { - "description": "The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`.", "name": "max_number_of_snapshots", "required": false, - "serverDefault": 2147483647, "type": { "kind": "instance_of", "type": { @@ -211574,10 +203478,8 @@ "aliases": [ "readonly" ], - "description": "If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository.", "name": "read_only", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -211587,7 +203489,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotRepository.ts#L414-L441" + "specLocation": "snapshot/_types/SnapshotRepository.ts#L117-L124" }, { "kind": "interface", @@ -211597,7 +203499,6 @@ }, "properties": [ { - "description": "Indicates whether the current cluster state is included in the snapshot.", "name": "include_global_state", "required": true, "type": { @@ -211631,7 +203532,6 @@ } }, { - "description": "The name of the repository that includes the snapshot.", "name": "repository", "required": true, "type": { @@ -211643,7 +203543,6 @@ } }, { - "description": "Statistics for the shards in the snapshot.", "name": "shards_stats", "required": true, "type": { @@ -211655,7 +203554,6 @@ } }, { - "description": "The name of the snapshot.", "name": "snapshot", "required": true, "type": { @@ -211667,7 +203565,6 @@ } }, { - "description": "The current snapshot state:\n\n* `FAILED`: The snapshot finished with an error and failed to store any data.\n* `STARTED`: The snapshot is currently running.\n* `SUCCESS`: The snapshot completed.", "name": "state", "required": true, "type": { @@ -211679,7 +203576,6 @@ } }, { - "description": "Details about the number (`file_count`) and size (`size_in_bytes`) of files included in the snapshot.", "name": "stats", "required": true, "type": { @@ -211691,7 +203587,6 @@ } }, { - "description": "The universally unique identifier (UUID) for the snapshot.", "name": "uuid", "required": true, "type": { @@ -211703,7 +203598,7 @@ } } ], - "specLocation": "snapshot/_types/SnapshotStatus.ts#L26-L60" + "specLocation": "snapshot/_types/SnapshotStatus.ts#L26-L35" }, { "kind": "interface", @@ -211713,7 +203608,7 @@ }, "properties": [ { - "description": "The number of binary large objects (blobs) removed from the snapshot repository during cleanup operations.\nA non-zero value indicates that unreferenced blobs were found and subsequently cleaned up.", + "description": "Number of binary large objects (blobs) removed during cleanup.", "name": "deleted_blobs", "required": true, "type": { @@ -211725,7 +203620,7 @@ } }, { - "description": "The number of bytes freed by cleanup operations.", + "description": "Number of bytes freed by cleanup operations.", "name": "deleted_bytes", "required": true, "type": { @@ -211737,7 +203632,7 @@ } } ], - "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L29-L37" + "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L29-L34" }, { "kind": "request", @@ -211747,7 +203642,7 @@ "body": { "kind": "no_body" }, - "description": "Clean up the snapshot repository.\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", + "description": "Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -211761,7 +203656,7 @@ "path": [ { "codegenName": "name", - "description": "The name of the snapshot repository to clean up.", + "description": "Snapshot repository to clean up.", "name": "repository", "required": true, "type": { @@ -211775,7 +203670,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`", + "description": "Period to wait for a connection to the master node.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -211788,7 +203683,7 @@ } }, { - "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Period to wait for a response.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -211801,7 +203696,7 @@ } } ], - "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts#L24-L63" + "specLocation": "snapshot/cleanup_repository/SnapshotCleanupRepositoryRequest.ts#L24-L49" }, { "kind": "response", @@ -211837,7 +203732,6 @@ "kind": "properties", "properties": [ { - "description": "A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.", "name": "indices", "required": true, "type": { @@ -211850,7 +203744,7 @@ } ] }, - "description": "Clone a snapshot.\nClone part of all of a snapshot into another snapshot in the same repository.", + "description": "Clones indices from one snapshot into another snapshot in the same repository.", "inherits": { "type": { "name": "RequestBase", @@ -211863,7 +203757,7 @@ }, "path": [ { - "description": "The name of the snapshot repository that both source and target snapshot belong to.", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -211875,7 +203769,7 @@ } }, { - "description": "The source snapshot name.", + "description": "The name of the snapshot to clone from", "name": "snapshot", "required": true, "type": { @@ -211887,7 +203781,7 @@ } }, { - "description": "The target snapshot name.", + "description": "The name of the cloned snapshot to create", "name": "target_snapshot", "required": true, "type": { @@ -211901,10 +203795,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -211914,10 +203807,8 @@ } }, { - "description": "The period of time to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -211927,7 +203818,7 @@ } } ], - "specLocation": "snapshot/clone/SnapshotCloneRequest.ts#L24-L76" + "specLocation": "snapshot/clone/SnapshotCloneRequest.ts#L24-L42" }, { "kind": "response", @@ -211956,37 +203847,7 @@ "kind": "properties", "properties": [ { - "description": "Determines how wildcard patterns in the `indices` parameter match data streams and indices.\nIt supports comma-separated values such as `open,hidden`.", - "name": "expand_wildcards", - "required": false, - "serverDefault": "all", - "type": { - "kind": "instance_of", - "type": { - "name": "ExpandWildcards", - "namespace": "_types" - } - } - }, - { - "description": "The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).", - "extDocId": "snapshot-restore-feature-state", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state", - "name": "feature_states", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "If `true`, the request ignores data streams and indices in `indices` that are missing or closed.\nIf `false`, the request returns an error for any data stream or index that is missing or closed.", + "description": "If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed.", "name": "ignore_unavailable", "required": false, "serverDefault": false, @@ -211999,7 +203860,7 @@ } }, { - "description": "If `true`, the current cluster state is included in the snapshot.\nThe cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.\nIt also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).", + "description": "If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).", "name": "include_global_state", "required": false, "serverDefault": true, @@ -212012,7 +203873,7 @@ } }, { - "description": "A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.", + "description": "Data streams and indices to include in the snapshot. Supports multi-target syntax. Includes all data streams and indices by default.", "name": "indices", "required": false, "type": { @@ -212024,7 +203885,22 @@ } }, { - "description": "Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.", + "description": "Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default.", + "name": "feature_states", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Optional metadata for the snapshot. May have any contents. Must be less than 1024 bytes. This map is not automatically generated by Elasticsearch.", "name": "metadata", "required": false, "type": { @@ -212036,7 +203912,7 @@ } }, { - "description": "If `true`, it enables you to restore a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.", + "description": "If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.", "name": "partial", "required": false, "serverDefault": false, @@ -212050,7 +203926,7 @@ } ] }, - "description": "Create a snapshot.\nTake a snapshot of a cluster or of data streams and indices.", + "description": "Creates a snapshot in a repository.", "inherits": { "type": { "name": "RequestBase", @@ -212063,7 +203939,7 @@ }, "path": [ { - "description": "The name of the repository for the snapshot.", + "description": "Repository for the snapshot.", "name": "repository", "required": true, "type": { @@ -212075,7 +203951,7 @@ } }, { - "description": "The name of the snapshot.\nIt supportes date math.\nIt must be unique in the repository.", + "description": "Name of the snapshot. Must be unique in the repository.", "name": "snapshot", "required": true, "type": { @@ -212089,7 +203965,7 @@ ], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -212102,7 +203978,7 @@ } }, { - "description": "If `true`, the request returns a response when the snapshot is complete.\nIf `false`, the request returns a response when the snapshot initializes.", + "description": "If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes.", "name": "wait_for_completion", "required": false, "serverDefault": false, @@ -212115,7 +203991,7 @@ } } ], - "specLocation": "snapshot/create/SnapshotCreateRequest.ts#L24-L126" + "specLocation": "snapshot/create/SnapshotCreateRequest.ts#L24-L81" }, { "kind": "response", @@ -212176,7 +204052,7 @@ } } }, - "description": "Create or update a snapshot repository.\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.", + "description": "Creates a repository.", "inherits": { "type": { "name": "RequestBase", @@ -212190,7 +204066,7 @@ "path": [ { "codegenName": "name", - "description": "The name of the snapshot repository to register or update.", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -212204,10 +204080,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -212217,10 +204092,9 @@ } }, { - "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -212230,10 +204104,9 @@ } }, { - "description": "If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.\nIf `false`, this verification is skipped.\nYou can also perform this verification with the verify snapshot repository API.", + "description": "Whether to verify the repository after creation", "name": "verify", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -212243,7 +204116,7 @@ } } ], - "specLocation": "snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L25-L79" + "specLocation": "snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L25-L42" }, { "kind": "response", @@ -212271,7 +204144,7 @@ "body": { "kind": "no_body" }, - "description": "Delete snapshots.", + "description": "Deletes one or more snapshots.", "inherits": { "type": { "name": "RequestBase", @@ -212284,7 +204157,7 @@ }, "path": [ { - "description": "The name of the repository to delete a snapshot from.", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -212296,7 +204169,7 @@ } }, { - "description": "A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).", + "description": "A comma-separated list of snapshot names", "name": "snapshot", "required": true, "type": { @@ -212310,10 +204183,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -212323,7 +204195,7 @@ } } ], - "specLocation": "snapshot/delete/SnapshotDeleteRequest.ts#L24-L59" + "specLocation": "snapshot/delete/SnapshotDeleteRequest.ts#L24-L37" }, { "kind": "response", @@ -212351,7 +204223,7 @@ "body": { "kind": "no_body" }, - "description": "Delete snapshot repositories.\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", + "description": "Deletes a repository.", "inherits": { "type": { "name": "RequestBase", @@ -212365,7 +204237,7 @@ "path": [ { "codegenName": "name", - "description": "The ame of the snapshot repositories to unregister.\nWildcard (`*`) patterns are supported.", + "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", "name": "repository", "required": true, "type": { @@ -212379,10 +204251,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -212392,10 +204263,9 @@ } }, { - "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -212405,7 +204275,7 @@ } } ], - "specLocation": "snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts#L24-L64" + "specLocation": "snapshot/delete_repository/SnapshotDeleteRepositoryRequest.ts#L24-L38" }, { "kind": "response", @@ -212433,7 +204303,7 @@ "body": { "kind": "no_body" }, - "description": "Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration.", + "description": "Returns information about a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -212446,7 +204316,7 @@ }, "path": [ { - "description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported.", + "description": "Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.", "name": "repository", "required": true, "type": { @@ -212458,7 +204328,7 @@ } }, { - "description": "A comma-separated list of snapshot names to retrieve\nWildcards (`*`) are supported.\n\n* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.\n* To get information about any snapshots that are currently running, use `_current`.", + "description": "Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).\n- To get information about all snapshots in a registered repository, use a wildcard (*) or _all.\n- To get information about any snapshots that are currently running, use _current.", "name": "snapshot", "required": true, "type": { @@ -212472,46 +204342,36 @@ ], "query": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "7.14.0" - } - }, - "description": "An offset identifier to start pagination from as returned by the next field in the response body.", - "name": "after", + "description": "If false, the request returns an error for any snapshots that are unavailable.", + "name": "ignore_unavailable", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "availability": { - "serverless": {}, - "stack": { - "since": "7.16.0" - } - }, - "description": "The value of the current sort column at which to start retrieval.\nIt can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.\nIt can be a millisecond time value or a number when sorting by `index-` or shard count.", - "name": "from_sort_value", + "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.", + "name": "master_timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "If `false`, the request returns an error for any snapshots that are unavailable.", - "name": "ignore_unavailable", + "description": "If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.", + "name": "verbose", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -212527,7 +204387,7 @@ "since": "7.13.0" } }, - "description": "If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.\nThe default is `false`, meaning that this information is omitted.", + "description": "If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted.", "name": "index_details", "required": false, "serverDefault": false, @@ -212546,7 +204406,7 @@ "since": "8.3.0" } }, - "description": "If `true`, the response includes the name of each index in each snapshot.", + "description": "If true, returns the name of each index in each snapshot.", "name": "index_names", "required": false, "serverDefault": true, @@ -212559,7 +204419,7 @@ } }, { - "description": "If `true`, the response includes the repository name in each snapshot.", + "description": "If true, returns the repository name in each snapshot.", "name": "include_repository", "required": false, "serverDefault": true, @@ -212572,15 +204432,21 @@ } }, { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", + "availability": { + "serverless": {}, + "stack": { + "since": "7.14.0" + } + }, + "description": "Allows setting a sort order for the result. Defaults to start_time, i.e. sorting by snapshot start time stamp.", + "name": "sort", "required": false, - "serverDefault": "30s", + "serverDefault": "start_time", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "SnapshotSort", + "namespace": "snapshot._types" } } }, @@ -212591,14 +204457,14 @@ "since": "7.14.0" } }, - "description": "The sort order.\nValid values are `asc` for ascending and `desc` for descending order.\nThe default behavior is ascending order.", - "name": "order", + "description": "Maximum number of snapshots to return. Defaults to 0 which means return all that match the request without limit.", + "name": "size", "required": false, - "serverDefault": "asc", + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "SortOrder", + "name": "integer", "namespace": "_types" } } @@ -212607,17 +204473,17 @@ "availability": { "serverless": {}, "stack": { - "since": "7.15.0" + "since": "7.14.0" } }, - "description": "Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.", - "name": "offset", + "description": "Sort order. Valid values are asc for ascending and desc for descending order. Defaults to asc, meaning ascending order.", + "name": "order", "required": false, - "serverDefault": 0, + "serverDefault": "asc", "type": { "kind": "instance_of", "type": { - "name": "integer", + "name": "SortOrder", "namespace": "_types" } } @@ -212629,15 +204495,14 @@ "since": "7.14.0" } }, - "description": "The maximum number of snapshots to return.\nThe default is 0, which means to return all that match the request without limit.", - "name": "size", + "description": "Offset identifier to start pagination from as returned by the next field in the response body.", + "name": "after", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, @@ -212645,16 +204510,17 @@ "availability": { "serverless": {}, "stack": { - "since": "7.16.0" + "since": "7.15.0" } }, - "description": "Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.", - "name": "slm_policy_filter", + "description": "Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.", + "name": "offset", "required": false, + "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "integer", "namespace": "_types" } } @@ -212663,36 +204529,40 @@ "availability": { "serverless": {}, "stack": { - "since": "7.14.0" + "since": "7.16.0" } }, - "description": "The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.", - "name": "sort", + "description": "Value of the current sort column at which to start retrieval. Can either be a string snapshot- or repository name when sorting by snapshot or repository name, a millisecond time value or a number when sorting by index- or shard count.", + "name": "from_sort_value", "required": false, - "serverDefault": "start_time", "type": { "kind": "instance_of", "type": { - "name": "SnapshotSort", - "namespace": "snapshot._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.", - "name": "verbose", + "availability": { + "serverless": {}, + "stack": { + "since": "7.16.0" + } + }, + "description": "Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Also accepts wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. To include snapshots not created by an SLM policy you can use the special pattern _none that will match all snapshots without an SLM policy.", + "name": "slm_policy_filter", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Name", + "namespace": "_types" } } } ], - "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L158" + "specLocation": "snapshot/get/SnapshotGetRequest.ts#L27-L127" }, { "kind": "response", @@ -212700,20 +204570,30 @@ "kind": "properties", "properties": [ { - "availability": { - "serverless": {}, - "stack": { - "since": "7.15.0" + "name": "responses", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SnapshotResponseItem", + "namespace": "snapshot.get" + } } - }, - "description": "The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the `next` field value.", - "name": "remaining", - "required": true, + } + }, + { + "name": "snapshots", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "SnapshotInfo", + "namespace": "snapshot._types" + } } } }, @@ -212724,7 +204604,7 @@ "since": "7.15.0" } }, - "description": "The total number of snapshots that match the request when ignoring the size limit or `after` query parameter.", + "description": "The total number of snapshots that match the request when ignoring size limit or after query parameter.", "name": "total", "required": true, "type": { @@ -212736,42 +204616,20 @@ } }, { - "description": "If the request contained a size limit and there might be more results, a `next` field will be added to the response.\nIt can be used as the `after` query parameter to fetch additional results.", - "name": "next", - "required": false, + "availability": { + "serverless": {}, + "stack": { + "since": "7.15.0" + } + }, + "description": "The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.", + "name": "remaining", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "responses", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SnapshotResponseItem", - "namespace": "snapshot.get" - } - } - } - }, - { - "name": "snapshots", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "SnapshotInfo", - "namespace": "snapshot._types" - } + "name": "integer", + "namespace": "_types" } } } @@ -212781,7 +204639,7 @@ "name": "Response", "namespace": "snapshot.get" }, - "specLocation": "snapshot/get/SnapshotGetResponse.ts#L25-L47" + "specLocation": "snapshot/get/SnapshotGetResponse.ts#L25-L42" }, { "kind": "interface", @@ -212827,7 +204685,7 @@ } } ], - "specLocation": "snapshot/get/SnapshotGetResponse.ts#L49-L53" + "specLocation": "snapshot/get/SnapshotGetResponse.ts#L44-L48" }, { "kind": "request", @@ -212837,7 +204695,7 @@ "body": { "kind": "no_body" }, - "description": "Get snapshot repository information.", + "description": "Returns information about a repository.", "inherits": { "type": { "name": "RequestBase", @@ -212851,7 +204709,7 @@ "path": [ { "codegenName": "name", - "description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.\n\nTo get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`.", + "description": "A comma-separated list of repository names", "name": "repository", "required": false, "type": { @@ -212865,10 +204723,9 @@ ], "query": [ { - "description": "If `true`, the request gets information from the local node only.\nIf `false`, the request gets information from the master node.", + "description": "Return local information, do not retrieve the state from master node (default: false)", "name": "local", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -212878,10 +204735,9 @@ } }, { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "to 30s", "type": { "kind": "instance_of", "type": { @@ -212891,7 +204747,7 @@ } } ], - "specLocation": "snapshot/get_repository/SnapshotGetRepositoryRequest.ts#L24-L68" + "specLocation": "snapshot/get_repository/SnapshotGetRepositoryRequest.ts#L24-L38" }, { "kind": "response", @@ -212922,567 +204778,6 @@ }, "specLocation": "snapshot/get_repository/SnapshotGetRepositoryResponse.ts#L23-L25" }, - { - "kind": "interface", - "name": { - "name": "BlobDetails", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "description": "The name of the blob.", - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "Indicates whether the blob was overwritten while the read operations were ongoing.\n /**", - "name": "overwritten", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "read_early", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The position, in bytes, at which read operations completed.", - "name": "read_end", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The position, in bytes, at which read operations started.", - "name": "read_start", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "A description of every read operation performed on the blob.", - "name": "reads", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ReadBlobDetails", - "namespace": "snapshot.repository_analyze" - } - } - }, - { - "description": "The size of the blob.", - "name": "size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The size of the blob in bytes.", - "name": "size_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L250-L284" - }, - { - "kind": "interface", - "name": { - "name": "DetailsInfo", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "description": "A description of the blob that was written and read.", - "name": "blob", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "BlobDetails", - "namespace": "snapshot.repository_analyze" - } - } - }, - { - "description": "The elapsed time spent overwriting the blob.\nIf the blob was not overwritten, this information is omitted.", - "name": "overwrite_elapsed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The elapsed time spent overwriting the blob, in nanoseconds.\nIf the blob was not overwritten, this information is omitted.", - "name": "overwrite_elapsed_nanos", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The elapsed time spent writing the blob.", - "name": "write_elapsed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The elapsed time spent writing the blob, in nanoseconds.", - "name": "write_elapsed_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob.", - "name": "write_throttled", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob, in nanoseconds.", - "name": "write_throttled_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The node which wrote the blob and coordinated the read operations.", - "name": "writer_node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SnapshotNodeInfo", - "namespace": "snapshot.repository_analyze" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L286-L321" - }, - { - "kind": "interface", - "name": { - "name": "ReadBlobDetails", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "description": "Indicates whether the read operation may have started before the write operation was complete.", - "name": "before_write_complete", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The length of time spent reading the blob.\nIf the blob was not found, this detail is omitted.", - "name": "elapsed", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The length of time spent reading the blob, in nanoseconds.\nIf the blob was not found, this detail is omitted.", - "name": "elapsed_nanos", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The length of time waiting for the first byte of the read operation to be received.\nIf the blob was not found, this detail is omitted.", - "name": "first_byte_time", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The length of time waiting for the first byte of the read operation to be received, in nanoseconds.\nIf the blob was not found, this detail is omitted.", - "name": "first_byte_time_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether the blob was found by the read operation.\nIf the read was started before the write completed or the write was ended before completion, it might be false.", - "name": "found", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The node that performed the read operation.", - "name": "node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SnapshotNodeInfo", - "namespace": "snapshot.repository_analyze" - } - } - }, - { - "description": "The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob.\nIf the blob was not found, this detail is omitted.", - "name": "throttled", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob, in nanoseconds.\nIf the blob was not found, this detail is omitted.", - "name": "throttled_nanos", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L204-L248" - }, - { - "kind": "interface", - "name": { - "name": "ReadSummaryInfo", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "description": "The number of read operations performed in the test.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum time spent waiting for the first byte of any read request to be received.", - "name": "max_wait", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The maximum time spent waiting for the first byte of any read request to be received, in nanoseconds.", - "name": "max_wait_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The total elapsed time spent on reading blobs in the test.", - "name": "total_elapsed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The total elapsed time spent on reading blobs in the test, in nanoseconds.", - "name": "total_elapsed_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The total size of all the blobs or partial blobs read in the test.", - "name": "total_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The total size of all the blobs or partial blobs read in the test, in bytes.", - "name": "total_size_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles.", - "name": "total_throttled", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles, in nanoseconds.", - "name": "total_throttled_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The total time spent waiting for the first byte of each read request to be received.", - "name": "total_wait", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The total time spent waiting for the first byte of each read request to be received, in nanoseconds.", - "name": "total_wait_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L115-L160" - }, { "kind": "request", "attachedBehaviors": [ @@ -213491,7 +204786,7 @@ "body": { "kind": "no_body" }, - "description": "Analyze a snapshot repository.\nAnalyze the performance characteristics and any incorrect behaviour found in a repository.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nIf successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes.", + "description": "Verifies the integrity of the contents of a snapshot repository", "inherits": { "type": { "name": "RequestBase", @@ -213500,18 +204795,18 @@ }, "name": { "name": "Request", - "namespace": "snapshot.repository_analyze" + "namespace": "snapshot.repository_verify_integrity" }, "path": [ { "codegenName": "name", - "description": "The name of the repository.", + "description": "A repository name", "name": "repository", "required": true, "type": { "kind": "instance_of", "type": { - "name": "Name", + "name": "Names", "namespace": "_types" } } @@ -213519,138 +204814,8 @@ ], "query": [ { - "description": "The total number of blobs to write to the repository during the test.\nFor realistic experiments, you should set it to at least `2000`.", - "name": "blob_count", - "required": false, - "serverDefault": 100, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The number of operations to run concurrently during the test.", - "name": "concurrency", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether to return detailed results, including timing information for every operation performed during the analysis.\nIf false, it returns only a summary of the analysis.", - "name": "detailed", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The number of nodes on which to perform an early read operation while writing each blob.\nEarly read operations are only rarely performed.", - "name": "early_read_node_count", - "required": false, - "serverDefault": 2, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The maximum size of a blob to be written during the test.\nFor realistic experiments, you should set it to at least `2gb`.", - "name": "max_blob_size", - "required": false, - "serverDefault": "10mb", - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "An upper limit on the total size of all the blobs written during the test.\nFor realistic experiments, you should set it to at least `1tb`.", - "name": "max_total_data_size", - "required": false, - "serverDefault": "1gb", - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob.", - "name": "rare_action_probability", - "required": false, - "serverDefault": 0.02, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "description": "Indicates whether to rarely cancel writes before they complete.", - "name": "rarely_abort_writes", - "required": false, - "serverDefault": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The number of nodes on which to read a blob after writing.", - "name": "read_node_count", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The minimum number of linearizable register operations to perform in total.\nFor realistic experiments, you should set it to at least `100`.", - "name": "register_operation_count", - "required": false, - "serverDefault": 10, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The seed for the pseudo-random number generator used to generate the list of operations performed during the test.\nTo repeat the same set of operations in multiple experiments, use the same seed in each experiment.\nNote that the operations are performed concurrently so might not always happen in the same order on each run.", - "name": "seed", + "description": "Number of threads to use for reading metadata", + "name": "meta_thread_pool_concurrency", "required": false, "type": { "kind": "instance_of", @@ -213661,504 +204826,9 @@ } }, { - "description": "The period of time to wait for the test to complete.\nIf no response is received before the timeout expires, the test is cancelled and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryRequest.ts#L25-L202" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "The number of blobs written to the repository during the test.", - "name": "blob_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The path in the repository under which all the blobs were written during the test.", - "name": "blob_path", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The number of write operations performed concurrently during the test.", - "name": "concurrency", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The node that coordinated the analysis and performed the final cleanup.", - "name": "coordinating_node", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SnapshotNodeInfo", - "namespace": "snapshot.repository_analyze" - } - } - }, - { - "description": "The time it took to delete all the blobs in the container.", - "name": "delete_elapsed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The time it took to delete all the blobs in the container, in nanoseconds.", - "name": "delete_elapsed_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "A description of every read and write operation performed during the test.", - "name": "details", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "DetailsInfo", - "namespace": "snapshot.repository_analyze" - } - } - }, - { - "description": "The limit on the number of nodes on which early read operations were performed after writing each blob.", - "name": "early_read_node_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "A list of correctness issues detected, which is empty if the API succeeded.\nIt is included to emphasize that a successful response does not guarantee correct behaviour in future.", - "name": "issues_detected", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "The time it took to retrieve a list of all the blobs in the container.", - "name": "listing_elapsed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The time it took to retrieve a list of all the blobs in the container, in nanoseconds.", - "name": "listing_elapsed_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The limit on the size of a blob written during the test.", - "name": "max_blob_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The limit, in bytes, on the size of a blob written during the test.", - "name": "max_blob_size_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The limit on the total size of all blob written during the test.", - "name": "max_total_data_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The limit, in bytes, on the total size of all blob written during the test.", - "name": "max_total_data_size_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The probability of performing rare actions during the test.", - "name": "rare_action_probability", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "double", - "namespace": "_types" - } - } - }, - { - "description": "The limit on the number of nodes on which read operations were performed after writing each blob.", - "name": "read_node_count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The name of the repository that was the subject of the analysis.", - "name": "repository", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The seed for the pseudo-random number generator used to generate the operations used during the test.", - "name": "seed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "A collection of statistics that summarize the results of the test.", - "name": "summary", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "SummaryInfo", - "namespace": "snapshot.repository_analyze" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "snapshot.repository_analyze" - }, - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L24-L108" - }, - { - "kind": "interface", - "name": { - "name": "SnapshotNodeInfo", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - }, - { - "name": "name", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Name", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L110-L113" - }, - { - "kind": "interface", - "name": { - "name": "SummaryInfo", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "description": "A collection of statistics that summarise the results of the read operations in the test.", - "name": "read", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ReadSummaryInfo", - "namespace": "snapshot.repository_analyze" - } - } - }, - { - "description": "A collection of statistics that summarise the results of the write operations in the test.", - "name": "write", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "WriteSummaryInfo", - "namespace": "snapshot.repository_analyze" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L193-L202" - }, - { - "kind": "interface", - "name": { - "name": "WriteSummaryInfo", - "namespace": "snapshot.repository_analyze" - }, - "properties": [ - { - "description": "The number of write operations performed in the test.", - "name": "count", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "The total elapsed time spent on writing blobs in the test.", - "name": "total_elapsed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The total elapsed time spent on writing blobs in the test, in nanoseconds.", - "name": "total_elapsed_nanos", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitNanos", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - }, - { - "description": "The total size of all the blobs written in the test.", - "name": "total_size", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "ByteSize", - "namespace": "_types" - } - } - }, - { - "description": "The total size of all the blobs written in the test, in bytes.", - "name": "total_size_bytes", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - }, - { - "description": "The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle.", - "name": "total_throttled", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle, in nanoseconds.", - "name": "total_throttled_nanos", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "long", - "namespace": "_types" - } - } - } - ], - "specLocation": "snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L162-L191" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Verify the repository integrity.\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "snapshot.repository_verify_integrity" - }, - "path": [ - { - "codegenName": "name", - "description": "The name of the snapshot repository.", - "name": "repository", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Names", - "namespace": "_types" - } - } - } - ], - "query": [ - { - "description": "If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once.", + "description": "Number of threads to use for reading blob contents", "name": "blob_thread_pool_concurrency", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -214168,10 +204838,9 @@ } }, { - "description": "The maximum number of index snapshots to verify concurrently within each index verification.", - "name": "index_snapshot_verification_concurrency", + "description": "Number of snapshots to verify concurrently", + "name": "snapshot_verification_concurrency", "required": false, - "serverDefault": 1, "type": { "kind": "instance_of", "type": { @@ -214181,10 +204850,9 @@ } }, { - "description": "The number of indices to verify concurrently.\nThe default behavior is to use the entire `snapshot_meta` thread pool.", + "description": "Number of indices to verify concurrently", "name": "index_verification_concurrency", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -214194,23 +204862,9 @@ } }, { - "description": "If `verify_blob_contents` is `true`, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.", - "name": "max_bytes_per_sec", + "description": "Number of snapshots to verify concurrently within each index", + "name": "index_snapshot_verification_concurrency", "required": false, - "serverDefault": "10mb", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage.\nIf your repository contains more than this number of shard snapshot failures, the verification will fail.", - "name": "max_failed_shard_snapshots", - "required": false, - "serverDefault": 10000, "type": { "kind": "instance_of", "type": { @@ -214220,10 +204874,9 @@ } }, { - "description": "The maximum number of snapshot metadata operations to run concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.", - "name": "meta_thread_pool_concurrency", + "description": "Maximum permitted number of failed shard snapshots", + "name": "max_failed_shard_snapshots", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { @@ -214233,33 +204886,31 @@ } }, { - "description": "The number of snapshots to verify concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.", - "name": "snapshot_verification_concurrency", + "description": "Whether to verify the contents of individual blobs", + "name": "verify_blob_contents", "required": false, - "serverDefault": 0, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Indicates whether to verify the checksum of every data blob in the repository.\nIf this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.", - "name": "verify_blob_contents", + "description": "Rate limit for individual blob verification", + "name": "max_bytes_per_sec", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } } ], - "specLocation": "snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts#L24-L126" + "specLocation": "snapshot/repository_verify_integrity/SnapshotRepositoryVerifyIntegrityRequest.ts#L24-L43" }, { "kind": "response", @@ -214284,9 +204935,6 @@ "kind": "properties", "properties": [ { - "description": "The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).", - "extDocId": "snapshot-restore-feature-state", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state", "name": "feature_states", "required": false, "type": { @@ -214301,7 +204949,6 @@ } }, { - "description": "The index settings to not restore from the snapshot.\nYou can't use this option to ignore `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", "name": "ignore_index_settings", "required": false, "type": { @@ -214316,10 +204963,8 @@ } }, { - "description": "If `true`, the request ignores any index or data stream in indices that's missing from the snapshot.\nIf `false`, the request returns an error for any missing index or data stream.", "name": "ignore_unavailable", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214329,10 +204974,8 @@ } }, { - "description": "If `true`, the request restores aliases for any restored data streams and indices.\nIf `false`, the request doesn’t restore aliases.", "name": "include_aliases", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -214342,10 +204985,8 @@ } }, { - "description": "If `true`, restore the cluster state. The cluster state includes:\n\n* Persistent cluster settings\n* Index templates\n* Legacy index templates\n* Ingest pipelines\n* Index lifecycle management (ILM) policies\n* Stored scripts\n* For snapshots taken after 7.12.0, feature states\n\nIf `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot.\nIt completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.\n\nUse the `feature_states` parameter to configure how feature states are restored.\n\nIf `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail.", "name": "include_global_state", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214355,7 +204996,6 @@ } }, { - "description": "Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", "name": "index_settings", "required": false, "type": { @@ -214367,7 +205007,6 @@ } }, { - "description": "A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.", "name": "indices", "required": false, "type": { @@ -214379,10 +205018,8 @@ } }, { - "description": "If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.", "name": "partial", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214392,9 +205029,6 @@ } }, { - "description": "A rename pattern to apply to restored data streams and indices.\nData streams and indices matching the rename pattern will be renamed according to `rename_replacement`.\n\nThe rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic.", - "extDocId": "snapshot-restore-amend-replacement", - "extDocUrl": "https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#appendReplacement-java.lang.StringBuffer-java.lang.String-", "name": "rename_pattern", "required": false, "type": { @@ -214406,7 +205040,6 @@ } }, { - "description": "The rename replacement string that is used with the `rename_pattern`.", "name": "rename_replacement", "required": false, "type": { @@ -214419,7 +205052,7 @@ } ] }, - "description": "Restore a snapshot.\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", + "description": "Restores a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -214432,7 +205065,7 @@ }, "path": [ { - "description": "The name of the repository to restore a snapshot from.", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -214444,7 +205077,7 @@ } }, { - "description": "The name of the snapshot to restore.", + "description": "A snapshot name", "name": "snapshot", "required": true, "type": { @@ -214458,10 +205091,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -214471,10 +205103,9 @@ } }, { - "description": "If `true`, the request returns a response when the restore operation completes.\nThe operation is complete when it finishes all attempts to recover primary shards for restored indices.\nThis applies even if one or more of the recovery attempts fail.\n\nIf `false`, the request returns a response when the restore operation initializes.", + "description": "Should this request wait until the operation has completed before returning", "name": "wait_for_completion", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214484,7 +205115,7 @@ } } ], - "specLocation": "snapshot/restore/SnapshotRestoreRequest.ts#L25-L175" + "specLocation": "snapshot/restore/SnapshotRestoreRequest.ts#L25-L51" }, { "kind": "response", @@ -214575,7 +205206,7 @@ "body": { "kind": "no_body" }, - "description": "Get the snapshot status.\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", + "description": "Returns information about the status of a snapshot.", "inherits": { "type": { "name": "RequestBase", @@ -214588,7 +205219,7 @@ }, "path": [ { - "description": "The snapshot repository name used to limit the request.\nIt supports wildcards (`*`) if `` isn't specified.", + "description": "A repository name", "name": "repository", "required": false, "type": { @@ -214600,7 +205231,7 @@ } }, { - "description": "A comma-separated list of snapshots to retrieve status for.\nThe default is currently running snapshots.\nWildcards (`*`) are not supported.", + "description": "A comma-separated list of snapshot names", "name": "snapshot", "required": false, "type": { @@ -214614,10 +205245,9 @@ ], "query": [ { - "description": "If `false`, the request returns an error for any snapshots that are unavailable.\nIf `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.", + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown", "name": "ignore_unavailable", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -214627,10 +205257,9 @@ } }, { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -214640,7 +205269,7 @@ } } ], - "specLocation": "snapshot/status/SnapshotStatusRequest.ts#L24-L90" + "specLocation": "snapshot/status/SnapshotStatusRequest.ts#L24-L38" }, { "kind": "response", @@ -214677,7 +205306,6 @@ }, "properties": [ { - "description": "A human-readable name for the node.\nYou can set this name using the `node.name` property in `elasticsearch.yml`.\nThe default value is the machine's hostname.", "name": "name", "required": true, "type": { @@ -214689,7 +205317,7 @@ } } ], - "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L33-L40" + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L27-L29" }, { "kind": "request", @@ -214699,7 +205327,7 @@ "body": { "kind": "no_body" }, - "description": "Verify a snapshot repository.\nCheck for common misconfigurations in a snapshot repository.", + "description": "Verifies a repository.", "inherits": { "type": { "name": "RequestBase", @@ -214713,7 +205341,7 @@ "path": [ { "codegenName": "name", - "description": "The name of the snapshot repository to verify.", + "description": "A repository name", "name": "repository", "required": true, "type": { @@ -214727,10 +205355,9 @@ ], "query": [ { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout for connection to master node", "name": "master_timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -214740,10 +205367,9 @@ } }, { - "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", + "description": "Explicit operation timeout", "name": "timeout", "required": false, - "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -214753,7 +205379,7 @@ } } ], - "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts#L24-L63" + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryRequest.ts#L24-L38" }, { "kind": "response", @@ -214761,7 +205387,6 @@ "kind": "properties", "properties": [ { - "description": "Information about the nodes connected to the snapshot repository.\nThe key is the ID of the node.", "name": "nodes", "required": true, "type": { @@ -214789,13 +205414,13 @@ "name": "Response", "namespace": "snapshot.verify_repository" }, - "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L23-L31" + "specLocation": "snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L23-L25" }, { "kind": "interface", "name": { "name": "Column", - "namespace": "sql" + "namespace": "sql._types" }, "properties": [ { @@ -214821,15 +205446,15 @@ } } ], - "specLocation": "sql/types.ts#L23-L26" + "specLocation": "sql/_types/types.ts#L23-L26" }, { "kind": "type_alias", "name": { "name": "Row", - "namespace": "sql" + "namespace": "sql._types" }, - "specLocation": "sql/types.ts#L28-L28", + "specLocation": "sql/_types/types.ts#L28-L28", "type": { "kind": "array_of", "value": { @@ -214872,7 +205497,7 @@ }, "path": [], "query": [], - "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L42" + "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L35" }, { "kind": "response", @@ -214906,7 +205531,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", + "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", "inherits": { "type": { "name": "RequestBase", @@ -214919,7 +205544,7 @@ }, "path": [ { - "description": "The identifier for the search.", + "description": "Identifier for the search.", "name": "id", "required": true, "type": { @@ -214932,7 +205557,7 @@ } ], "query": [], - "specLocation": "sql/delete_async/SqlDeleteAsyncRequest.ts#L23-L51" + "specLocation": "sql/delete_async/SqlDeleteAsyncRequest.ts#L23-L38" }, { "kind": "response", @@ -214960,7 +205585,7 @@ "body": { "kind": "no_body" }, - "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", + "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", "inherits": { "type": { "name": "RequestBase", @@ -214973,7 +205598,7 @@ }, "path": [ { - "description": "The identifier for the search.", + "description": "Identifier for the search.", "name": "id", "required": true, "type": { @@ -214987,7 +205612,7 @@ ], "query": [ { - "description": "The separator for CSV results.\nThe API supports this parameter only for CSV responses.", + "description": "Separator for CSV results. The API only supports this parameter for CSV responses.", "name": "delimiter", "required": false, "serverDefault": ",", @@ -215000,7 +205625,7 @@ } }, { - "description": "The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.", + "description": "Format for the response. You must specify a format using this parameter or the\nAccept HTTP header. If you specify both, the API uses this parameter.", "name": "format", "required": false, "type": { @@ -215012,7 +205637,7 @@ } }, { - "description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.", + "description": "Retention period for the search and its results. Defaults\nto the `keep_alive` period for the original SQL search.", "name": "keep_alive", "required": false, "type": { @@ -215024,7 +205649,7 @@ } }, { - "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.", + "description": "Period to wait for complete results. Defaults to no timeout,\nmeaning the request waits for complete search results.", "name": "wait_for_completion_timeout", "required": false, "type": { @@ -215036,7 +205661,7 @@ } } ], - "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L71" + "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L60" }, { "kind": "response", @@ -215044,7 +205669,7 @@ "kind": "properties", "properties": [ { - "description": "Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", + "description": "Identifier for the search. This value is only returned for async and saved\nsynchronous searches. For CSV, TSV, and TXT responses, this value is returned\nin the `Async-ID` HTTP header.", "name": "id", "required": true, "type": { @@ -215056,7 +205681,134 @@ } }, { - "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "description": "If `true`, the search is still running. If false, the search has finished.\nThis value is only returned for async and saved synchronous searches. For\nCSV, TSV, and TXT responses, this value is returned in the `Async-partial`\nHTTP header.", + "name": "is_running", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout. This value is only returned for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "name": "is_partial", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "Column headings for the search results. Each object is a column.", + "name": "columns", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Column", + "namespace": "sql._types" + } + } + } + }, + { + "description": "Cursor for the next set of paginated results. For CSV, TSV, and\nTXT responses, this value is returned in the `Cursor` HTTP header.", + "name": "cursor", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "Values for the search results.", + "name": "rows", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Row", + "namespace": "sql._types" + } + } + } + } + ] + }, + "name": { + "name": "Response", + "namespace": "sql.get_async" + }, + "specLocation": "sql/get_async/SqlGetAsyncResponse.ts#L23-L60" + }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "sql.get_async_status" + }, + "path": [ + { + "description": "Identifier for the search.", + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "sql/get_async_status/SqlGetAsyncStatusRequest.ts#L23-L37" + }, + { + "kind": "response", + "body": { + "kind": "properties", + "properties": [ + { + "description": "Identifier for the search.", + "name": "id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true`, the search is still running. If `false`, the search has finished.", "name": "is_running", "required": true, "type": { @@ -215068,7 +205820,7 @@ } }, { - "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout.", "name": "is_partial", "required": true, "type": { @@ -215080,99 +205832,8 @@ } }, { - "description": "Column headings for the search results. Each object is a column.", - "name": "columns", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Column", - "namespace": "sql" - } - } - } - }, - { - "description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.", - "name": "cursor", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The values for the search results.", - "name": "rows", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Row", - "namespace": "sql" - } - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "sql.get_async" - }, - "specLocation": "sql/get_async/SqlGetAsyncResponse.ts#L23-L60" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "sql.get_async_status" - }, - "path": [ - { - "description": "The identifier for the search.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" - } - } - } - ], - "query": [], - "specLocation": "sql/get_async_status/SqlGetAsyncStatusRequest.ts#L23-L45" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.", - "name": "expiration_time_in_millis", + "description": "Timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API only returns this property for running searches.", + "name": "start_time_in_millis", "required": true, "type": { "kind": "instance_of", @@ -215192,44 +205853,8 @@ } }, { - "description": "The identifier for the search.", - "name": "id", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the search is still running.\nIf `false`, the search has finished.", - "name": "is_running", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.", - "name": "is_partial", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches.", - "name": "start_time_in_millis", + "description": "Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete\nthe search and its results, even if the search is still running.", + "name": "expiration_time_in_millis", "required": true, "type": { "kind": "instance_of", @@ -215249,7 +205874,7 @@ } }, { - "description": "The HTTP status code for the search.\nThe API returns this property only for completed searches.", + "description": "HTTP status code for the search. The API only returns this property for completed searches.", "name": "completion_status", "required": false, "type": { @@ -215277,20 +205902,7 @@ "kind": "properties", "properties": [ { - "description": "If `true`, the response has partial results when there are shard request timeouts or shard failures.\nIf `false`, the API returns an error with no partial results.", - "name": "allow_partial_search_results", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The default catalog (cluster) for queries.\nIf unspecified, the queries execute on the data in the local cluster only.", + "description": "Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.", "name": "catalog", "required": false, "type": { @@ -215302,9 +205914,7 @@ } }, { - "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", - "extDocId": "sql-rest-columnar", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-columnar.html", + "description": "If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.", "name": "columnar", "required": false, "serverDefault": false, @@ -215317,7 +205927,7 @@ } }, { - "description": "The cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.", + "description": "Cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.", "name": "cursor", "required": false, "type": { @@ -215329,7 +205939,7 @@ } }, { - "description": "The maximum number of rows (or entries) to return in one response.", + "description": "The maximum number of rows (or entries) to return in one response", "name": "fetch_size", "required": false, "serverDefault": 1000, @@ -215342,22 +205952,9 @@ } }, { - "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.", - "name": "field_multi_value_leniency", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The Elasticsearch query DSL for additional filtering.", - "extDocId": "sql-rest-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html", + "description": "Elasticsearch query DSL for additional filtering.", + "docId": "sql-rest-filtering", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html", "name": "filter", "required": false, "serverDefault": "none", @@ -215370,23 +205967,22 @@ } }, { - "description": "If `true`, the search can run on frozen indices.", - "name": "index_using_frozen", + "description": "SQL query to run.", + "name": "query", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The retention period for an async or saved synchronous search.", - "name": "keep_alive", + "description": "The timeout before the request fails.", + "name": "request_timeout", "required": false, - "serverDefault": "5d", + "serverDefault": "90s", "type": { "kind": "instance_of", "type": { @@ -215396,69 +205992,61 @@ } }, { - "description": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.", - "name": "keep_on_completion", + "description": "The timeout before a pagination request fails.", + "name": "page_timeout", "required": false, - "serverDefault": false, + "serverDefault": "45s", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.", - "name": "page_timeout", + "description": "ISO-8601 time zone ID for the search.", + "docUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", + "name": "time_zone", "required": false, - "serverDefault": "45s", + "serverDefault": "Z", "type": { "kind": "instance_of", "type": { - "name": "Duration", + "name": "TimeZone", "namespace": "_types" } } }, { - "description": "The values for parameters in the query.", - "name": "params", + "description": "Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).", + "name": "field_multi_value_leniency", "required": false, + "serverDefault": false, "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "singleKey": false, - "value": { - "kind": "user_defined_value" + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The SQL query to run.", - "extDocId": "sql-spec", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-spec.html", - "name": "query", + "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", + "name": "runtime_mappings", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "RuntimeFields", + "namespace": "_types.mapping" } } }, { - "description": "The timeout before the request fails.", - "name": "request_timeout", + "description": "Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async.", + "name": "wait_for_completion_timeout", "required": false, - "serverDefault": "90s", "type": { "kind": "instance_of", "type": { @@ -215468,41 +206056,56 @@ } }, { - "description": "One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.", - "name": "runtime_mappings", + "description": "Values for parameters in the query.", + "name": "params", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "FieldValue", + "namespace": "_types" + } + } + } + }, + { + "description": "Retention period for an async or saved synchronous search.", + "name": "keep_alive", "required": false, + "serverDefault": "5d", "type": { "kind": "instance_of", "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" + "name": "Duration", + "namespace": "_types" } } }, { - "description": "The ISO-8601 time zone ID for the search.", - "extDocId": "time-zone-id", - "extDocUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", - "name": "time_zone", + "description": "If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.", + "name": "keep_on_completion", "required": false, - "serverDefault": "Z", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "TimeZone", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.", - "name": "wait_for_completion_timeout", + "description": "If true, the search can run on frozen indices. Defaults to false.", + "name": "index_using_frozen", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } } @@ -215522,9 +206125,9 @@ "path": [], "query": [ { - "description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.", - "extDocId": "sql-rest-format", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html", + "description": "Format for the response.", + "docId": "sql-rest-format", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-format.html", "name": "format", "required": false, "type": { @@ -215536,7 +206139,7 @@ } } ], - "specLocation": "sql/query/QuerySqlRequest.ts#L28-L152" + "specLocation": "sql/query/QuerySqlRequest.ts#L27-L123" }, { "kind": "response", @@ -215544,70 +206147,70 @@ "kind": "properties", "properties": [ { - "description": "Column headings for the search results. Each object is a column.", - "name": "columns", + "description": "Identifier for the search. This value is only returned for async and saved\nsynchronous searches. For CSV, TSV, and TXT responses, this value is returned\nin the `Async-ID` HTTP header.", + "name": "id", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Column", - "namespace": "sql" - } + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" } } }, { - "description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.", - "name": "cursor", + "description": "If `true`, the search is still running. If false, the search has finished.\nThis value is only returned for async and saved synchronous searches. For\nCSV, TSV, and TXT responses, this value is returned in the `Async-partial`\nHTTP header.", + "name": "is_running", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", - "name": "id", + "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout. This value is only returned for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "name": "is_partial", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Id", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", - "name": "is_running", + "description": "Column headings for the search results. Each object is a column.", + "name": "columns", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Column", + "namespace": "sql._types" + } } } }, { - "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", - "name": "is_partial", + "description": "Cursor for the next set of paginated results. For CSV, TSV, and\nTXT responses, this value is returned in the `Cursor` HTTP header.", + "name": "cursor", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "The values for the search results.", + "description": "Values for the search results.", "name": "rows", "required": true, "type": { @@ -215616,7 +206219,7 @@ "kind": "instance_of", "type": { "name": "Row", - "namespace": "sql" + "namespace": "sql._types" } } } @@ -215658,7 +206261,7 @@ "name": "SqlFormat", "namespace": "sql.query" }, - "specLocation": "sql/query/QuerySqlRequest.ts#L154-L162" + "specLocation": "sql/query/QuerySqlRequest.ts#L125-L133" }, { "kind": "request", @@ -215682,9 +206285,9 @@ } }, { - "description": "The Elasticsearch query DSL for additional filtering.", - "extDocId": "sql-rest-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html", + "description": "Elasticsearch query DSL for additional filtering.", + "docId": "sql-rest-filtering", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html", "name": "filter", "required": false, "serverDefault": "none", @@ -215697,7 +206300,7 @@ } }, { - "description": "The SQL query to run.", + "description": "SQL query to run.", "name": "query", "required": true, "type": { @@ -215709,9 +206312,8 @@ } }, { - "description": "The ISO-8601 time zone ID for the search.", - "extDocId": "time-zone-id", - "extDocUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", + "description": "ISO-8601 time zone ID for the search.", + "docUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", "name": "time_zone", "required": false, "serverDefault": "Z", @@ -215725,7 +206327,7 @@ } ] }, - "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.", + "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", "inherits": { "type": { "name": "RequestBase", @@ -215738,7 +206340,7 @@ }, "path": [], "query": [], - "specLocation": "sql/translate/TranslateSqlRequest.ts#L25-L65" + "specLocation": "sql/translate/TranslateSqlRequest.ts#L25-L56" }, { "kind": "response", @@ -215841,7 +206443,6 @@ }, "properties": [ { - "description": "If the path refers to a container file (a jks keystore, or a PKCS#12 file), it is the alias of the certificate.\nOtherwise, it is null.", "name": "alias", "required": true, "type": { @@ -215865,7 +206466,6 @@ } }, { - "description": "The ISO formatted date of the certificate's expiry (not-after) date.", "name": "expiry", "required": true, "type": { @@ -215877,7 +206477,6 @@ } }, { - "description": "The format of the file.\nValid values include `jks`, `PKCS12`, and `PEM`.", "name": "format", "required": true, "type": { @@ -215889,7 +206488,6 @@ } }, { - "description": "Indicates whether Elasticsearch has access to the private key for this certificate.", "name": "has_private_key", "required": true, "type": { @@ -215901,7 +206499,6 @@ } }, { - "description": "The Distinguished Name of the certificate's issuer.", "name": "issuer", "required": false, "type": { @@ -215913,7 +206510,6 @@ } }, { - "description": "The path to the certificate, as configured in the `elasticsearch.yml` file.", "name": "path", "required": true, "type": { @@ -215925,7 +206521,6 @@ } }, { - "description": "The hexadecimal representation of the certificate's serial number.", "name": "serial_number", "required": true, "type": { @@ -215937,7 +206532,6 @@ } }, { - "description": "The Distinguished Name of the certificate's subject.", "name": "subject_dn", "required": true, "type": { @@ -215949,7 +206543,7 @@ } } ], - "specLocation": "ssl/certificates/types.ts#L22-L57" + "specLocation": "ssl/certificates/types.ts#L22-L31" }, { "kind": "request", @@ -215972,7 +206566,7 @@ }, "path": [], "query": [], - "specLocation": "ssl/certificates/GetCertificatesRequest.ts#L22-L55" + "specLocation": "ssl/certificates/GetCertificatesRequest.ts#L22-L45" }, { "kind": "response", @@ -216003,7 +206597,7 @@ }, "properties": [ { - "description": "The identifier for the synonym rule.\nIf you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.", + "description": "Synonym Rule identifier", "name": "id", "required": false, "type": { @@ -216015,9 +206609,7 @@ } }, { - "description": "The synonyms that conform the synonym rule in Solr format.", - "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "description": "Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2", "name": "synonyms", "required": true, "type": { @@ -216029,7 +206621,7 @@ } } ], - "specLocation": "synonyms/_types/SynonymRule.ts#L26-L37" + "specLocation": "synonyms/_types/SynonymRule.ts#L26-L35" }, { "kind": "interface", @@ -216072,8 +206664,6 @@ }, { "description": "Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2", - "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", "name": "synonyms", "required": true, "type": { @@ -216085,7 +206675,7 @@ } } ], - "specLocation": "synonyms/_types/SynonymRule.ts#L40-L49" + "specLocation": "synonyms/_types/SynonymRule.ts#L38-L47" }, { "kind": "type_alias", @@ -216110,7 +206700,7 @@ }, "properties": [ { - "description": "The update operation result.", + "description": "Update operation result", "name": "result", "required": true, "type": { @@ -216122,7 +206712,7 @@ } }, { - "description": "Updating synonyms in a synonym set reloads the associated analyzers.\nThis information is the analyzers reloading result.", + "description": "Updating synonyms in a synonym set reloads the associated analyzers.\nThis is the analyzers reloading result", "name": "reload_analyzers_details", "required": true, "type": { @@ -216144,7 +206734,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.", + "description": "Delete a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -216157,7 +206747,7 @@ }, "path": [ { - "description": "The synonyms set identifier to delete.", + "description": "The id of the synonyms set to be deleted", "name": "id", "required": true, "type": { @@ -216170,7 +206760,7 @@ } ], "query": [], - "specLocation": "synonyms/delete_synonym/SynonymsDeleteRequest.ts#L22-L60" + "specLocation": "synonyms/delete_synonym/SynonymsDeleteRequest.ts#L22-L35" }, { "kind": "response", @@ -216211,7 +206801,7 @@ }, "path": [ { - "description": "The ID of the synonym set to update.", + "description": "The id of the synonym set to be updated", "name": "set_id", "required": true, "type": { @@ -216223,7 +206813,7 @@ } }, { - "description": "The ID of the synonym rule to delete.", + "description": "The id of the synonym rule to be deleted", "name": "rule_id", "required": true, "type": { @@ -216236,7 +206826,7 @@ } ], "query": [], - "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L48" + "specLocation": "synonyms/delete_synonym_rule/SynonymRuleDeleteRequest.ts#L22-L41" }, { "kind": "response", @@ -216277,7 +206867,7 @@ }, "path": [ { - "description": "The synonyms set identifier to retrieve.", + "description": "\"The id of the synonyms set to be retrieved", "name": "id", "required": true, "type": { @@ -216291,7 +206881,7 @@ ], "query": [ { - "description": "The starting offset for query rules to retrieve.", + "description": "Starting offset for query rules to be retrieved", "name": "from", "required": false, "serverDefault": 0, @@ -216304,7 +206894,7 @@ } }, { - "description": "The max number of query rules to retrieve.", + "description": "specifies a max number of query rules to retrieve", "name": "size", "required": false, "serverDefault": 10, @@ -216317,7 +206907,7 @@ } } ], - "specLocation": "synonyms/get_synonym/SynonymsGetRequest.ts#L23-L56" + "specLocation": "synonyms/get_synonym/SynonymsGetRequest.ts#L23-L48" }, { "kind": "response", @@ -216325,7 +206915,6 @@ "kind": "properties", "properties": [ { - "description": "The total number of synonyms rules that the synonyms set contains.", "name": "count", "required": true, "type": { @@ -216337,7 +206926,6 @@ } }, { - "description": "Synonym rule details.", "name": "synonyms_set", "required": true, "type": { @@ -216357,7 +206945,7 @@ "name": "Response", "namespace": "synonyms.get_synonym" }, - "specLocation": "synonyms/get_synonym/SynonymsGetResponse.ts#L23-L34" + "specLocation": "synonyms/get_synonym/SynonymsGetResponse.ts#L23-L28" }, { "kind": "request", @@ -216380,7 +206968,7 @@ }, "path": [ { - "description": "The ID of the synonym set to retrieve the synonym rule from.", + "description": "The id of the synonym set to retrieve the synonym rule from", "name": "set_id", "required": true, "type": { @@ -216392,7 +206980,7 @@ } }, { - "description": "The ID of the synonym rule to retrieve.", + "description": "The id of the synonym rule to retrieve", "name": "rule_id", "required": true, "type": { @@ -216405,7 +206993,7 @@ } ], "query": [], - "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L48" + "specLocation": "synonyms/get_synonym_rule/SynonymRuleGetRequest.ts#L22-L41" }, { "kind": "response", @@ -216447,7 +207035,7 @@ "path": [], "query": [ { - "description": "The starting offset for synonyms sets to retrieve.", + "description": "Starting offset", "name": "from", "required": false, "serverDefault": 0, @@ -216460,7 +207048,7 @@ } }, { - "description": "The maximum number of synonyms sets to retrieve.", + "description": "specifies a max number of results to get", "name": "size", "required": false, "serverDefault": 10, @@ -216473,7 +207061,7 @@ } } ], - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L50" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetRequest.ts#L22-L42" }, { "kind": "response", @@ -216481,7 +207069,6 @@ "kind": "properties", "properties": [ { - "description": "The total number of synonyms sets defined.", "name": "count", "required": true, "type": { @@ -216493,7 +207080,6 @@ } }, { - "description": "The identifier and total number of defined synonym rules for each synonyms set.", "name": "results", "required": true, "type": { @@ -216513,7 +207099,7 @@ "name": "Response", "namespace": "synonyms.get_synonyms_sets" }, - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L23-L34" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L23-L28" }, { "kind": "interface", @@ -216547,7 +207133,7 @@ } } ], - "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L36-L45" + "specLocation": "synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L30-L39" }, { "kind": "request", @@ -216558,7 +207144,7 @@ "kind": "properties", "properties": [ { - "description": "The synonym rules definitions for the synonyms set.", + "description": "The synonym set information to update", "name": "synonyms_set", "required": true, "type": { @@ -216586,7 +207172,7 @@ } ] }, - "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", + "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.", "inherits": { "type": { "name": "RequestBase", @@ -216599,7 +207185,7 @@ }, "path": [ { - "description": "The ID of the synonyms set to be created or updated.", + "description": "The id of the synonyms set to be created or updated", "name": "id", "required": true, "type": { @@ -216612,7 +207198,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L55" + "specLocation": "synonyms/put_synonym/SynonymsPutRequest.ts#L23-L44" }, { "kind": "response", @@ -216658,9 +207244,6 @@ "kind": "properties", "properties": [ { - "description": "The synonym rule information definition, which must be in Solr format.", - "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", "name": "synonyms", "required": true, "type": { @@ -216673,7 +207256,7 @@ } ] }, - "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.", + "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.", "inherits": { "type": { "name": "RequestBase", @@ -216686,7 +207269,7 @@ }, "path": [ { - "description": "The ID of the synonym set.", + "description": "The id of the synonym set to be updated with the synonym rule", "name": "set_id", "required": true, "type": { @@ -216698,7 +207281,7 @@ } }, { - "description": "The ID of the synonym rule to be updated or created.", + "description": "The id of the synonym rule to be updated or created", "name": "rule_id", "required": true, "type": { @@ -216711,7 +207294,7 @@ } ], "query": [], - "specLocation": "synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L60" + "specLocation": "synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L48" }, { "kind": "response", @@ -216735,11 +207318,11 @@ "kind": "enum", "members": [ { - "description": "Group tasks by node ID.", + "description": "Node ID", "name": "nodes" }, { - "description": "Group tasks by parent task ID.", + "description": "Parent task ID", "name": "parents" }, { @@ -216936,7 +207519,6 @@ } }, { - "description": "Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.", "name": "description", "required": false, "type": { @@ -217043,7 +207625,7 @@ } }, { - "description": "The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.", + "description": "Task status information can vary wildly from task to task.", "name": "status", "required": false, "type": { @@ -217073,7 +207655,7 @@ } } ], - "specLocation": "tasks/_types/TaskInfo.ts#L32-L58" + "specLocation": "tasks/_types/TaskInfo.ts#L32-L47" }, { "kind": "type_alias", @@ -217201,7 +207783,7 @@ "body": { "kind": "no_body" }, - "description": "Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.", + "description": "Cancels a task, if it can be cancelled through an API.", "inherits": { "type": { "name": "RequestBase", @@ -217214,7 +207796,7 @@ }, "path": [ { - "description": "The task identifier.", + "description": "ID of the task.", "name": "task_id", "required": false, "type": { @@ -217228,7 +207810,7 @@ ], "query": [ { - "description": "A comma-separated list or wildcard expression of actions that is used to limit the request.", + "description": "Comma-separated list or wildcard expression of actions used to limit the request.", "name": "actions", "required": false, "type": { @@ -217255,7 +207837,7 @@ } }, { - "description": "A comma-separated list of node IDs or names that is used to limit the request.", + "description": "Comma-separated list of node IDs or names used to limit the request.", "name": "nodes", "required": false, "type": { @@ -217270,7 +207852,7 @@ } }, { - "description": "A parent task ID that is used to limit the tasks.", + "description": "Parent task ID used to limit the tasks.", "name": "parent_task_id", "required": false, "type": { @@ -217282,10 +207864,9 @@ } }, { - "description": "If true, the request blocks until all found tasks are complete.", + "description": "Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false", "name": "wait_for_completion", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -217295,7 +207876,7 @@ } } ], - "specLocation": "tasks/cancel/CancelTasksRequest.ts#L23-L78" + "specLocation": "tasks/cancel/CancelTasksRequest.ts#L23-L51" }, { "kind": "response", @@ -217323,7 +207904,7 @@ "body": { "kind": "no_body" }, - "description": "Get task information.\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.", + "description": "Get task information.\nReturns information about the tasks currently executing in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -217336,7 +207917,7 @@ }, "path": [ { - "description": "The task identifier.", + "description": "ID of the task.", "name": "task_id", "required": true, "type": { @@ -217350,7 +207931,7 @@ ], "query": [ { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -217376,7 +207957,7 @@ } } ], - "specLocation": "tasks/get/GetTaskRequest.ts#L24-L64" + "specLocation": "tasks/get/GetTaskRequest.ts#L24-L52" }, { "kind": "response", @@ -217439,7 +208020,7 @@ "body": { "kind": "no_body" }, - "description": "Get all tasks.\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n \"tasks\" : {\n \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 45,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1513823752749,\n \"running_time_in_nanos\" : 293139,\n \"cancellable\" : false,\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n },\n \"children\" : [\n {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 46,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1513823752750,\n \"running_time_in_nanos\" : 92133,\n \"cancellable\" : false,\n \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n }\n }\n ]\n }\n }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.", + "description": "The task management API returns information about tasks currently executing on one or more nodes in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -217453,7 +208034,7 @@ "path": [], "query": [ { - "description": "A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.", + "description": "Comma-separated list or wildcard expression of actions used to limit the request.", "name": "actions", "required": false, "type": { @@ -217480,7 +208061,7 @@ } }, { - "description": "If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.", + "description": "If `true`, the response includes detailed information about shard recoveries.", "name": "detailed", "required": false, "serverDefault": false, @@ -217493,7 +208074,7 @@ } }, { - "description": "A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.", + "description": "Key used to group tasks in the response.", "name": "group_by", "required": false, "type": { @@ -217505,7 +208086,7 @@ } }, { - "description": "A comma-separated list of node IDs or names that is used to limit the returned information.", + "description": "Comma-separated list of node IDs or names used to limit returned information.", "name": "nodes", "required": false, "type": { @@ -217517,7 +208098,7 @@ } }, { - "description": "A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.", + "description": "Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`.", "name": "parent_task_id", "required": false, "type": { @@ -217529,7 +208110,20 @@ } }, { - "description": "The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.", + "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.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, "serverDefault": "30s", @@ -217555,7 +208149,7 @@ } } ], - "specLocation": "tasks/list/ListTasksRequest.ts#L25-L138" + "specLocation": "tasks/list/ListTasksRequest.ts#L25-L72" }, { "kind": "response", @@ -217575,27 +208169,11 @@ }, "specLocation": "tasks/list/ListTasksResponse.ts#L22-L24" }, - { - "kind": "enum", - "members": [ - { - "name": "disabled" - }, - { - "name": "v1" - } - ], - "name": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" - }, - "specLocation": "text_structure/_types/Structure.ts#L40-L43" - }, { "kind": "interface", "name": { "name": "FieldStat", - "namespace": "text_structure._types" + "namespace": "text_structure.find_structure" }, "properties": [ { @@ -217629,7 +208207,7 @@ "kind": "instance_of", "type": { "name": "TopHit", - "namespace": "text_structure._types" + "namespace": "text_structure.find_structure" } } } @@ -217701,82 +208279,40 @@ } } ], - "specLocation": "text_structure/_types/Structure.ts#L23-L33" + "specLocation": "text_structure/find_structure/types.ts#L23-L33" }, { - "kind": "enum", - "members": [ - { - "name": "delimited" - }, - { - "name": "ndjson" - }, - { - "name": "semi_structured_text" - }, - { - "name": "xml" - } - ], - "name": { - "name": "FormatType", - "namespace": "text_structure._types" - }, - "specLocation": "text_structure/_types/Structure.ts#L45-L50" - }, - { - "kind": "interface", - "name": { - "name": "TopHit", - "namespace": "text_structure._types" - }, - "properties": [ - { - "name": "count", - "required": true, - "type": { + "kind": "request", + "body": { + "kind": "value", + "codegenName": "text_files", + "value": { + "kind": "array_of", + "value": { "kind": "instance_of", "type": { - "name": "long", - "namespace": "_types" + "name": "TJsonDocument", + "namespace": "text_structure.find_structure.Request" } } - }, - { - "name": "value", - "required": true, - "type": { - "kind": "user_defined_value" - } } - ], - "specLocation": "text_structure/_types/Structure.ts#L35-L38" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" }, - "description": "Find the structure of a text field.\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" + "description": "Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.", + "generics": [ + { + "name": "TJsonDocument", + "namespace": "text_structure.find_structure.Request" } - }, + ], "name": { "name": "Request", - "namespace": "text_structure.find_field_structure" + "namespace": "text_structure.find_structure" }, "path": [], "query": [ { - "description": "If `format` is set to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header row, columns are named \"column1\", \"column2\", \"column3\", for example.", - "name": "column_names", + "description": "The text’s character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, UTF-8, UTF-16LE, windows-1252, or EUC-JP. If this parameter is not specified, the structure finder chooses an appropriate character set.", + "name": "charset", "required": false, "type": { "kind": "instance_of", @@ -217787,8 +208323,8 @@ } }, { - "description": "If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.", - "name": "delimiter", + "description": "If you have set format to delimited, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", etc.", + "name": "column_names", "required": false, "type": { "kind": "instance_of", @@ -217799,33 +208335,31 @@ } }, { - "description": "The number of documents to include in the structural analysis.\nThe minimum value is 2.", - "name": "documents_to_sample", + "description": "If you have set format to delimited, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.", + "name": "delimiter", "required": false, - "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "uint", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.", + "description": "The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled).", "name": "ecs_compatibility", "required": false, - "serverDefault": "disabled", "type": { "kind": "instance_of", "type": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.", + "description": "If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.", "name": "explain", "required": false, "serverDefault": false, @@ -217838,55 +208372,69 @@ } }, { - "description": "The field that should be analyzed.", - "name": "field", - "required": true, + "description": "The high level structure of the text. Valid values are ndjson, xml, delimited, and semi_structured_text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.", + "name": "format", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If you have set format to semi_structured_text, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the timestamp_field parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\". If grok_pattern is not specified, the structure finder creates a Grok pattern.", + "name": "grok_pattern", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "GrokPattern", "namespace": "_types" } } }, { - "description": "The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.", - "name": "format", + "description": "If you have set format to delimited, you can use this parameter to indicate whether the column names are in the first row of the text. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.", + "name": "has_header_row", "required": false, "type": { "kind": "instance_of", "type": { - "name": "FormatType", - "namespace": "text_structure._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.", - "name": "grok_pattern", + "description": "The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.", + "name": "line_merge_size_limit", "required": false, + "serverDefault": 10000, "type": { "kind": "instance_of", "type": { - "name": "GrokPattern", + "name": "uint", "namespace": "_types" } } }, { - "description": "The name of the index that contains the analyzed field.", - "name": "index", - "required": true, + "description": "The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2; If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.", + "name": "lines_to_sample", + "required": false, + "serverDefault": 1000, "type": { "kind": "instance_of", "type": { - "name": "IndexName", + "name": "uint", "namespace": "_types" } } }, { - "description": "If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.", + "description": "If you have set format to delimited, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (\"). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.", "name": "quote", "required": false, "type": { @@ -217898,7 +208446,7 @@ } }, { - "description": "If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.", + "description": "If you have set format to delimited, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (|), the default value is true. Otherwise, the default value is false.", "name": "should_trim_fields", "required": false, "type": { @@ -217910,7 +208458,7 @@ } }, { - "description": "The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.", + "description": "Sets the maximum amount of time that the structure analysis make take. If the analysis is still running when the timeout expires then it will be aborted.", "name": "timeout", "required": false, "serverDefault": "25s", @@ -217923,7 +208471,7 @@ } }, { - "description": "The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.", + "description": "Optional parameter to specify the timestamp field in the file", "name": "timestamp_field", "required": false, "type": { @@ -217935,7 +208483,7 @@ } }, { - "description": "The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.", + "description": "The Java time format of the timestamp field in the text.", "name": "timestamp_format", "required": false, "type": { @@ -217947,7 +208495,7 @@ } } ], - "specLocation": "text_structure/find_field_structure/FindFieldStructureRequest.ts#L26-L184" + "specLocation": "text_structure/find_structure/FindStructureRequest.ts#L24-L75" }, { "kind": "response", @@ -217966,96 +208514,79 @@ } }, { - "name": "ecs_compatibility", + "name": "has_header_row", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" - } - } - }, - { - "name": "field_stats", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "FieldStat", - "namespace": "text_structure._types" - } + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "format", + "name": "has_byte_order_marker", "required": true, "type": { "kind": "instance_of", "type": { - "name": "FormatType", - "namespace": "text_structure._types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "grok_pattern", - "required": false, + "name": "format", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "GrokPattern", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "java_timestamp_formats", - "required": false, + "name": "field_stats", + "required": true, "type": { - "kind": "array_of", + "kind": "dictionary_of", + "key": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + }, + "singleKey": false, "value": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "FieldStat", + "namespace": "text_structure.find_structure" } } } }, { - "name": "joda_timestamp_formats", - "required": false, + "name": "sample_start", + "required": true, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } } }, { - "name": "ingest_pipeline", + "name": "num_messages_analyzed", "required": true, "type": { "kind": "instance_of", "type": { - "name": "PipelineConfig", - "namespace": "ingest._types" + "name": "integer", + "namespace": "_types" } } }, @@ -218071,7 +208602,7 @@ } }, { - "name": "multiline_start_pattern", + "name": "quote", "required": false, "type": { "kind": "instance_of", @@ -218082,29 +208613,29 @@ } }, { - "name": "need_client_timezone", - "required": true, + "name": "delimiter", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "name": "num_lines_analyzed", + "name": "need_client_timezone", "required": true, "type": { "kind": "instance_of", "type": { - "name": "integer", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "name": "num_messages_analyzed", + "name": "num_lines_analyzed", "required": true, "type": { "kind": "instance_of", @@ -218115,47 +208646,22 @@ } }, { - "name": "sample_start", - "required": true, + "name": "column_names", + "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } } } }, { - "name": "timestamp_field", + "name": "explanation", "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "text_structure.find_field_structure" - }, - "specLocation": "text_structure/find_field_structure/FindFieldStructureResponse.ts#L31-L49" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "description": "The list of messages you want to analyze.", - "name": "messages", - "required": true, "type": { "kind": "array_of", "value": { @@ -218166,228 +208672,37 @@ } } } - } - ] - }, - "description": "Find the structure of text messages.\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "text_structure.find_message_structure" - }, - "path": [], - "query": [ - { - "description": "If the format is `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.", - "name": "column_names", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If you the format is `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.", - "name": "delimiter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.", - "name": "ecs_compatibility", - "required": false, - "serverDefault": "disabled", - "type": { - "kind": "instance_of", - "type": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" - } - } - }, - { - "description": "If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.", - "name": "explain", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.", - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "FormatType", - "namespace": "text_structure._types" - } - } - }, - { - "description": "If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.", - "name": "grok_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GrokPattern", - "namespace": "_types" - } - } - }, - { - "description": "If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.", - "name": "quote", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.", - "name": "should_trim_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.", - "name": "timeout", - "required": false, - "serverDefault": "25s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.", - "name": "timestamp_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "description": "The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.", - "name": "timestamp_format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - ], - "specLocation": "text_structure/find_message_structure/FindMessageStructureRequest.ts#L25-L174" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "charset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } }, { - "name": "ecs_compatibility", + "name": "grok_pattern", "required": false, "type": { "kind": "instance_of", "type": { - "name": "EcsCompatibilityType", - "namespace": "text_structure._types" - } - } - }, - { - "name": "field_stats", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "FieldStat", - "namespace": "text_structure._types" - } + "name": "GrokPattern", + "namespace": "_types" } } }, { - "name": "format", - "required": true, + "name": "multiline_start_pattern", + "required": false, "type": { "kind": "instance_of", "type": { - "name": "FormatType", - "namespace": "text_structure._types" + "name": "string", + "namespace": "_builtins" } } }, { - "name": "grok_pattern", + "name": "exclude_lines_pattern", "required": false, "type": { "kind": "instance_of", "type": { - "name": "GrokPattern", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, @@ -218420,41 +208735,19 @@ } }, { - "name": "ingest_pipeline", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "PipelineConfig", - "namespace": "ingest._types" - } - } - }, - { - "name": "mappings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "name": "multiline_start_pattern", + "name": "timestamp_field", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "name": "need_client_timezone", - "required": true, + "name": "should_trim_fields", + "required": false, "type": { "kind": "instance_of", "type": { @@ -218464,46 +208757,13 @@ } }, { - "name": "num_lines_analyzed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "num_messages_analyzed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "name": "sample_start", + "name": "ingest_pipeline", "required": true, "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "timestamp_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" + "name": "PipelineConfig", + "namespace": "ingest._types" } } } @@ -218511,517 +208771,37 @@ }, "name": { "name": "Response", - "namespace": "text_structure.find_message_structure" + "namespace": "text_structure.find_structure" }, - "specLocation": "text_structure/find_message_structure/FindMessageStructureResponse.ts#L31-L49" + "specLocation": "text_structure/find_structure/FindStructureResponse.ts#L27-L52" }, { - "kind": "request", - "body": { - "kind": "value", - "codegenName": "text_files", - "value": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "TJsonDocument", - "namespace": "text_structure.find_structure.Request" - } - } - } - }, - "description": "Find the structure of a text file.\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.", - "generics": [ - { - "name": "TJsonDocument", - "namespace": "text_structure.find_structure.Request" - } - ], + "kind": "interface", "name": { - "name": "Request", + "name": "TopHit", "namespace": "text_structure.find_structure" }, - "path": [], - "query": [ - { - "description": "The text's character set.\nIt must be a character set that is supported by the JVM that Elasticsearch uses.\nFor example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`.\nIf this parameter is not specified, the structure finder chooses an appropriate character set.", - "name": "charset", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If you have set format to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.", - "name": "column_names", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.", - "name": "delimiter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.", - "name": "ecs_compatibility", - "required": false, - "serverDefault": "disabled", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.\nIf the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.", - "name": "explain", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The high level structure of the text.\nValid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.", - "name": "format", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.", - "name": "grok_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GrokPattern", - "namespace": "_types" - } - } - }, - { - "description": "If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text.\nIf this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.", - "name": "has_header_row", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text.\nIf you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.", - "name": "line_merge_size_limit", - "required": false, - "serverDefault": 10000, - "type": { - "kind": "instance_of", - "type": { - "name": "uint", - "namespace": "_types" - } - } - }, - { - "description": "The number of lines to include in the structural analysis, starting from the beginning of the text.\nThe minimum is 2.\nIf the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.\n\nNOTE: The number of lines and the variation of the lines affects the speed of the analysis.\nFor example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample.\nIf possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.", - "name": "lines_to_sample", - "required": false, - "serverDefault": 1000, - "type": { - "kind": "instance_of", - "type": { - "name": "uint", - "namespace": "_types" - } - } - }, - { - "description": "If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.", - "name": "quote", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`.\nOtherwise, the default value is `false`.", - "name": "should_trim_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires then it will be stopped.", - "name": "timeout", - "required": false, - "serverDefault": "25s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, + "properties": [ { - "description": "The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.", - "name": "timestamp_field", - "required": false, + "name": "count", + "required": true, "type": { "kind": "instance_of", "type": { - "name": "Field", + "name": "long", "namespace": "_types" } } }, { - "description": "The Java time format of the timestamp field in the text.\n\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`.\nSpacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text this will result in the structure finder treating the text as single-line messages.", - "name": "timestamp_format", - "required": false, + "name": "value", + "required": true, "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } + "kind": "user_defined_value" } } ], - "specLocation": "text_structure/find_structure/FindStructureRequest.ts#L24-L207" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "description": "The character encoding used to parse the text.", - "name": "charset", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "has_header_row", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "For UTF character encodings, it indicates whether the text begins with a byte order marker.", - "name": "has_byte_order_marker", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "Valid values include `ndjson`, `xml`, `delimited`, and `semi_structured_text`.", - "name": "format", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The most common values of each field, plus basic numeric statistics for the numeric `page_count` field.\nThis information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality.", - "name": "field_stats", - "required": true, - "type": { - "kind": "dictionary_of", - "key": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - }, - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "FieldStat", - "namespace": "text_structure._types" - } - } - } - }, - { - "description": "The first two messages in the text verbatim.\nThis may help diagnose parse errors or accidental uploads of the wrong text.", - "name": "sample_start", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The number of distinct messages the lines contained.\nFor NDJSON, this value is the same as `num_lines_analyzed`.\nFor other text formats, messages can span several lines.", - "name": "num_messages_analyzed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "Some suitable mappings for an index into which the data could be ingested.", - "name": "mappings", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "TypeMapping", - "namespace": "_types.mapping" - } - } - }, - { - "name": "quote", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "delimiter", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "If a timestamp format is detected that does not include a timezone, `need_client_timezone` is `true`.\nThe server that parses the text must therefore be told the correct timezone by the client.", - "name": "need_client_timezone", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "The number of lines of the text that were analyzed.", - "name": "num_lines_analyzed", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - }, - { - "description": "If `format` is `delimited`, the `column_names` field lists the column names in the order they appear in the sample.", - "name": "column_names", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "explanation", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "grok_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "GrokPattern", - "namespace": "_types" - } - } - }, - { - "name": "multiline_start_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "exclude_lines_pattern", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "The Java time formats recognized in the time fields.\nElasticsearch mappings and ingest pipelines use this format.", - "name": "java_timestamp_formats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "Information that is used to tell Logstash how to parse timestamps.", - "name": "joda_timestamp_formats", - "required": false, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "The field considered most likely to be the primary timestamp of each document.", - "name": "timestamp_field", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Field", - "namespace": "_types" - } - } - }, - { - "name": "should_trim_fields", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "name": "ingest_pipeline", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "PipelineConfig", - "namespace": "ingest._types" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "text_structure.find_structure" - }, - "specLocation": "text_structure/find_structure/FindStructureResponse.ts#L27-L97" + "specLocation": "text_structure/find_structure/types.ts#L35-L38" }, { "kind": "interface", @@ -219121,7 +208901,7 @@ "kind": "properties", "properties": [ { - "description": "The Grok pattern to run on the text.", + "description": "Grok pattern to run on the text.", "name": "grok_pattern", "required": true, "type": { @@ -219133,7 +208913,7 @@ } }, { - "description": "The lines of text to run the Grok pattern on.", + "description": "Lines of text to run the Grok pattern on.", "name": "text", "required": true, "type": { @@ -219149,7 +208929,7 @@ } ] }, - "description": "Test a Grok pattern.\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.", + "description": "Tests a Grok pattern on some text.", "inherits": { "type": { "name": "RequestBase", @@ -219163,10 +208943,9 @@ "path": [], "query": [ { - "description": "The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nValid values are `disabled` and `v1`.", + "description": "The mode of compatibility with ECS compliant Grok patterns (disabled or v1, default: disabled).", "name": "ecs_compatibility", "required": false, - "serverDefault": "disabled", "type": { "kind": "instance_of", "type": { @@ -219176,7 +208955,7 @@ } } ], - "specLocation": "text_structure/test_grok_pattern/TestGrokPatternRequest.ts#L23-L59" + "specLocation": "text_structure/test_grok_pattern/TestGrokPatternRequest.ts#L23-L44" }, { "kind": "response", @@ -219665,7 +209444,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a transform.", + "description": "Delete a transform.\nDeletes a transform.", "inherits": { "type": { "name": "RequestBase", @@ -219731,7 +209510,7 @@ } } ], - "specLocation": "transform/delete_transform/DeleteTransformRequest.ts#L24-L64" + "specLocation": "transform/delete_transform/DeleteTransformRequest.ts#L24-L58" }, { "kind": "response", @@ -219759,7 +209538,7 @@ "body": { "kind": "no_body" }, - "description": "Get transforms.\nGet configuration information for transforms.", + "description": "Get transforms.\nRetrieves configuration information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -219838,7 +209617,7 @@ } } ], - "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L84" + "specLocation": "transform/get_transform/GetTransformRequest.ts#L24-L73" }, { "kind": "response", @@ -220238,7 +210017,7 @@ "body": { "kind": "no_body" }, - "description": "Get transform stats.\n\nGet usage information for transforms.", + "description": "Get transform stats.\nRetrieves usage information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -220316,7 +210095,7 @@ } } ], - "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L77" + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L69" }, { "kind": "response", @@ -220933,7 +210712,7 @@ } } ], - "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L119" + "specLocation": "transform/preview_transform/PreviewTransformRequest.ts#L33-L108" }, { "kind": "response", @@ -221163,7 +210942,7 @@ } } ], - "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L130" + "specLocation": "transform/put_transform/PutTransformRequest.ts#L33-L123" }, { "kind": "response", @@ -221191,7 +210970,7 @@ "body": { "kind": "no_body" }, - "description": "Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "inherits": { "type": { "name": "RequestBase", @@ -221229,22 +211008,9 @@ "namespace": "_builtins" } } - }, - { - "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } } ], - "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L24-L62" + "specLocation": "transform/reset_transform/ResetTransformRequest.ts#L23-L49" }, { "kind": "response", @@ -221272,7 +211038,7 @@ "body": { "kind": "no_body" }, - "description": "Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", + "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "inherits": { "type": { "name": "RequestBase", @@ -221312,7 +211078,7 @@ } } ], - "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L57" + "specLocation": "transform/schedule_now_transform/ScheduleNowTransformRequest.ts#L23-L50" }, { "kind": "response", @@ -221340,7 +211106,7 @@ "body": { "kind": "no_body" }, - "description": "Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "inherits": { "type": { "name": "RequestBase", @@ -221392,7 +211158,7 @@ } } ], - "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L72" + "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L66" }, { "kind": "response", @@ -221512,7 +211278,7 @@ } } ], - "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L84" + "specLocation": "transform/stop_transform/StopTransformRequest.ts#L24-L77" }, { "kind": "response", @@ -221703,7 +211469,7 @@ } } ], - "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L113" + "specLocation": "transform/update_transform/UpdateTransformRequest.ts#L31-L106" }, { "kind": "response", @@ -221880,7 +211646,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", + "description": "Upgrades all transforms.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It\nalso cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not\naffect the source and destination indices. The upgrade also does not affect the roles that transforms use when\nElasticsearch security features are enabled; the role used to read source data and write to the destination index\nremains unchanged.", "inherits": { "type": { "name": "RequestBase", @@ -221920,7 +211686,7 @@ } } ], - "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L65" + "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L49" }, { "kind": "response", @@ -222737,7 +212503,7 @@ { "kind": "type_alias", "docId": "cron-expressions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-cron-expressions", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions", "name": { "name": "CronExpression", "namespace": "watcher._types" @@ -222865,26 +212631,14 @@ "name": "bcc", "required": false, "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ] + } } }, { @@ -222902,26 +212656,14 @@ "name": "cc", "required": false, "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ] + } } }, { @@ -222950,26 +212692,14 @@ "name": "reply_to", "required": false, "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ] + } } }, { @@ -222998,26 +212728,14 @@ "name": "to", "required": true, "type": { - "kind": "union_of", - "items": [ - { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" } - ] + } } }, { @@ -223626,7 +213344,6 @@ }, "properties": [ { - "description": "The largest size of the execution thread pool, which indicates the largest number of concurrent running watches.", "name": "max_size", "required": true, "type": { @@ -223638,7 +213355,6 @@ } }, { - "description": "The number of watches that were triggered and are currently queued.", "name": "queue_size", "required": true, "type": { @@ -223650,7 +213366,7 @@ } } ], - "specLocation": "watcher/_types/Execution.ts#L94-L103" + "specLocation": "watcher/_types/Execution.ts#L94-L97" }, { "kind": "interface", @@ -226433,7 +216149,7 @@ "body": { "kind": "no_body" }, - "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", + "description": "Acknowledges a watch, manually throttling the execution of the watch's actions.", "inherits": { "type": { "name": "RequestBase", @@ -226446,7 +216162,7 @@ }, "path": [ { - "description": "The watch identifier.", + "description": "Watch ID", "name": "watch_id", "required": true, "type": { @@ -226458,7 +216174,7 @@ } }, { - "description": "A comma-separated list of the action identifiers to acknowledge.\nIf you omit this parameter, all of the actions of the watch are acknowledged.", + "description": "A comma-separated list of the action ids to be acked", "name": "action_id", "required": false, "type": { @@ -226471,7 +216187,7 @@ } ], "query": [], - "specLocation": "watcher/ack_watch/WatcherAckWatchRequest.ts#L23-L61" + "specLocation": "watcher/ack_watch/WatcherAckWatchRequest.ts#L23-L32" }, { "kind": "response", @@ -226505,7 +216221,7 @@ "body": { "kind": "no_body" }, - "description": "Activate a watch.\nA watch can be either active or inactive.", + "description": "Activates a currently inactive watch.", "inherits": { "type": { "name": "RequestBase", @@ -226518,7 +216234,7 @@ }, "path": [ { - "description": "The watch identifier.", + "description": "Watch ID", "name": "watch_id", "required": true, "type": { @@ -226531,7 +216247,7 @@ } ], "query": [], - "specLocation": "watcher/activate_watch/WatcherActivateWatchRequest.ts#L23-L45" + "specLocation": "watcher/activate_watch/WatcherActivateWatchRequest.ts#L23-L31" }, { "kind": "response", @@ -226565,7 +216281,7 @@ "body": { "kind": "no_body" }, - "description": "Deactivate a watch.\nA watch can be either active or inactive.", + "description": "Deactivates a currently active watch.", "inherits": { "type": { "name": "RequestBase", @@ -226578,7 +216294,7 @@ }, "path": [ { - "description": "The watch identifier.", + "description": "Watch ID", "name": "watch_id", "required": true, "type": { @@ -226591,7 +216307,7 @@ } ], "query": [], - "specLocation": "watcher/deactivate_watch/DeactivateWatchRequest.ts#L23-L45" + "specLocation": "watcher/deactivate_watch/DeactivateWatchRequest.ts#L23-L31" }, { "kind": "response", @@ -226625,7 +216341,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a watch.\nWhen the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.\n\nDeleting a watch does not delete any watch execution records related to this watch from the watch history.\n\nIMPORTANT: Deleting a watch must be done by using only this API.\nDo not delete the watch directly from the `.watches` index using the Elasticsearch delete document API\nWhen Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.", + "description": "Removes a watch from Watcher.", "inherits": { "type": { "name": "RequestBase", @@ -226638,7 +216354,7 @@ }, "path": [ { - "description": "The watch identifier.", + "description": "Watch ID", "name": "id", "required": true, "type": { @@ -226651,7 +216367,7 @@ } ], "query": [], - "specLocation": "watcher/delete_watch/DeleteWatchRequest.ts#L23-L50" + "specLocation": "watcher/delete_watch/DeleteWatchRequest.ts#L23-L31" }, { "kind": "response", @@ -226763,7 +216479,7 @@ } }, { - "description": "When set to `true`, the watch record representing the watch execution result is persisted to the `.watcher-history` index for the current time.\nIn addition, the status of the watch is updated, possibly throttling subsequent runs.\nThis can also be specified as an HTTP parameter.", + "description": "When set to `true`, the watch record representing the watch execution result is persisted to the `.watcher-history` index for the current time. In addition, the status of the watch is updated, possibly throttling subsequent executions. This can also be specified as an HTTP parameter.", "name": "record_execution", "required": false, "serverDefault": false, @@ -226787,7 +216503,7 @@ } }, { - "description": "This structure is parsed as the data of the trigger event that will be used during the watch execution.", + "description": "This structure is parsed as the data of the trigger event that will be used during the watch execution", "name": "trigger_data", "required": false, "type": { @@ -226799,7 +216515,7 @@ } }, { - "description": "When present, this watch is used instead of the one specified in the request.\nThis watch is not persisted to the index and `record_execution` cannot be set.", + "description": "When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set.", "name": "watch", "required": false, "serverDefault": "null", @@ -226813,7 +216529,7 @@ } ] }, - "description": "Run a watch.\nThis API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\n\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs.\nYou can run the watch without running all of its actions or alternatively by simulating them.\nYou can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.\n\nYou can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.\nThis serves as great tool for testing and debugging your watches prior to adding them to Watcher.\n\nWhen Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.\nIf your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.\n\nWhen using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.", + "description": "This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs. You can execute the watch without executing all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after execution.", "inherits": { "type": { "name": "RequestBase", @@ -226826,7 +216542,7 @@ }, "path": [ { - "description": "The watch identifier.", + "description": "Identifier for the watch.", "name": "id", "required": false, "type": { @@ -226853,7 +216569,7 @@ } } ], - "specLocation": "watcher/execute_watch/WatcherExecuteWatchRequest.ts#L28-L105" + "specLocation": "watcher/execute_watch/WatcherExecuteWatchRequest.ts#L28-L79" }, { "kind": "response", @@ -226861,7 +216577,6 @@ "kind": "properties", "properties": [ { - "description": "The watch record identifier as it would be stored in the `.watcher-history` index.", "name": "_id", "required": true, "type": { @@ -226873,7 +216588,6 @@ } }, { - "description": "The watch record document as it would be stored in the `.watcher-history` index.", "name": "watch_record", "required": true, "type": { @@ -226890,7 +216604,7 @@ "name": "Response", "namespace": "watcher.execute_watch" }, - "specLocation": "watcher/execute_watch/WatcherExecuteWatchResponse.ts#L23-L34" + "specLocation": "watcher/execute_watch/WatcherExecuteWatchResponse.ts#L23-L25" }, { "kind": "interface", @@ -227034,67 +216748,7 @@ "body": { "kind": "no_body" }, - "description": "Get Watcher index settings.\nGet settings for the Watcher internal index (`.watches`).\nOnly a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "watcher.get_settings" - }, - "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/get_settings/WatcherGetSettingsRequest.ts#L23-L45" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "index", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "IndexSettings", - "namespace": "indices._types" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "watcher.get_settings" - }, - "specLocation": "watcher/get_settings/WatcherGetSettingsResponse.ts#L22-L26" - }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "no_body" - }, - "description": "Get a watch.", + "description": "Retrieves a watch by its ID.", "inherits": { "type": { "name": "RequestBase", @@ -227107,7 +216761,7 @@ }, "path": [ { - "description": "The watch identifier.", + "description": "Watch ID", "name": "id", "required": true, "type": { @@ -227120,7 +216774,7 @@ } ], "query": [], - "specLocation": "watcher/get_watch/GetWatchRequest.ts#L23-L43" + "specLocation": "watcher/get_watch/GetWatchRequest.ts#L23-L31" }, { "kind": "response", @@ -227221,7 +216875,6 @@ "kind": "properties", "properties": [ { - "description": "The list of actions that will be run if the condition matches.", "name": "actions", "required": false, "type": { @@ -227244,7 +216897,6 @@ } }, { - "description": "The condition that defines if the actions should be run.", "name": "condition", "required": false, "type": { @@ -227256,7 +216908,6 @@ } }, { - "description": "The input that defines the input that loads the data for the watch.", "name": "input", "required": false, "type": { @@ -227268,7 +216919,6 @@ } }, { - "description": "Metadata JSON that will be copied into the history entries.", "name": "metadata", "required": false, "type": { @@ -227280,40 +216930,17 @@ } }, { - "description": "The minimum time between actions being run.\nThe default is 5 seconds.\nThis default can be changed in the config file with the setting `xpack.watcher.throttle.period.default_period`.\nIf both this value and the `throttle_period_in_millis` parameter are specified, Watcher uses the last parameter included in the request.", "name": "throttle_period", "required": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request.", - "name": "throttle_period_in_millis", - "required": false, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" + "name": "string", + "namespace": "_builtins" } } }, { - "description": "The transform that processes the watch payload to prepare it for the watch actions.", "name": "transform", "required": false, "type": { @@ -227325,7 +216952,6 @@ } }, { - "description": "The trigger that defines when the watch should run.", "name": "trigger", "required": false, "type": { @@ -227338,7 +216964,7 @@ } ] }, - "description": "Create or update a watch.\nWhen a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine.\nTypically for the `schedule` trigger, the scheduler is the trigger engine.\n\nIMPORTANT: You must use Kibana or this API to create a watch.\nDo not add a watch directly to the `.watches` index by using the Elasticsearch index API.\nIf Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.\n\nWhen you add a watch you can also define its initial active state by setting the *active* parameter.\n\nWhen Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.\nIf the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.", + "description": "Creates a new watch, or updates an existing one.", "inherits": { "type": { "name": "RequestBase", @@ -227351,7 +216977,7 @@ }, "path": [ { - "description": "The identifier for the watch.", + "description": "Watch ID", "name": "id", "required": true, "type": { @@ -227365,10 +216991,9 @@ ], "query": [ { - "description": "The initial state of the watch.\nThe default value is `true`, which means the watch is active by default.", + "description": "Specify whether the watch is in/active by default", "name": "active", "required": false, - "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -227414,7 +217039,7 @@ } } ], - "specLocation": "watcher/put_watch/WatcherPutWatchRequest.ts#L31-L110" + "specLocation": "watcher/put_watch/WatcherPutWatchRequest.ts#L30-L53" }, { "kind": "response", @@ -227493,7 +217118,7 @@ "kind": "properties", "properties": [ { - "description": "The offset from the first result to fetch.\nIt must be non-negative.", + "description": "The offset from the first result to fetch. Needs to be non-negative.", "name": "from", "required": false, "serverDefault": 0, @@ -227506,7 +217131,7 @@ } }, { - "description": "The number of hits to return.\nIt must be non-negative.", + "description": "The number of hits to return. Needs to be non-negative.", "name": "size", "required": false, "serverDefault": 10, @@ -227519,7 +217144,7 @@ } }, { - "description": "A query that filters the watches to be returned.", + "description": "Optional, query filter watches to be returned.", "name": "query", "required": false, "type": { @@ -227531,9 +217156,7 @@ } }, { - "description": "One or more fields used to sort the search results.", - "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "description": "Optional sort definition.", "name": "sort", "required": false, "type": { @@ -227545,9 +217168,7 @@ } }, { - "description": "Retrieve the next page of hits using a set of sort values from the previous page.", - "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "description": "Optional search After to do pagination using last hit’s sort values.", "name": "search_after", "required": false, "type": { @@ -227560,7 +217181,7 @@ } ] }, - "description": "Query watches.\nGet all registered watches in a paginated manner and optionally filter watches by a query.\n\nNote that only the `_id` and `metadata.*` fields are queryable or sortable.", + "description": "Retrieves stored watches.", "inherits": { "type": { "name": "RequestBase", @@ -227573,7 +217194,7 @@ }, "path": [], "query": [], - "specLocation": "watcher/query_watches/WatcherQueryWatchesRequest.ts#L25-L70" + "specLocation": "watcher/query_watches/WatcherQueryWatchesRequest.ts#L25-L48" }, { "kind": "response", @@ -227581,7 +217202,6 @@ "kind": "properties", "properties": [ { - "description": "The total number of watches found.", "name": "count", "required": true, "type": { @@ -227593,7 +217213,6 @@ } }, { - "description": "A list of watches based on the `from`, `size`, or `search_after` request body parameters.", "name": "watches", "required": true, "type": { @@ -227613,7 +217232,7 @@ "name": "Response", "namespace": "watcher.query_watches" }, - "specLocation": "watcher/query_watches/WatcherQueryWatchesResponse.ts#L23-L34" + "specLocation": "watcher/query_watches/WatcherQueryWatchesResponse.ts#L23-L28" }, { "kind": "request", @@ -227623,7 +217242,7 @@ "body": { "kind": "no_body" }, - "description": "Start the watch service.\nStart the Watcher service if it is not already running.", + "description": "Starts Watcher if it is not already running.", "inherits": { "type": { "name": "RequestBase", @@ -227635,22 +217254,8 @@ "namespace": "watcher.start" }, "path": [], - "query": [ - { - "description": "Period to wait for a connection to the master node.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/start/WatcherStartRequest.ts#L23-L45" + "query": [], + "specLocation": "watcher/start/WatcherStartRequest.ts#L22-L26" }, { "kind": "response", @@ -227678,7 +217283,7 @@ "body": { "kind": "no_body" }, - "description": "Get Watcher statistics.\nThis API always returns basic metrics.\nYou retrieve more metrics by using the metric parameter.", + "description": "Retrieves the current Watcher metrics.", "inherits": { "type": { "name": "RequestBase", @@ -227760,7 +217365,7 @@ } } ], - "specLocation": "watcher/stats/WatcherStatsRequest.ts#L23-L60" + "specLocation": "watcher/stats/WatcherStatsRequest.ts#L23-L45" }, { "kind": "response", @@ -227831,7 +217436,6 @@ }, "properties": [ { - "description": "The time the watch was run.\nThis is just before the input is being run.", "name": "execution_time", "required": true, "type": { @@ -227843,7 +217447,7 @@ } } ], - "specLocation": "watcher/stats/types.ts#L71-L77" + "specLocation": "watcher/stats/types.ts#L50-L52" }, { "kind": "interface", @@ -227859,7 +217463,6 @@ }, "properties": [ { - "description": "The current watch execution phase.", "name": "execution_phase", "required": true, "type": { @@ -227871,7 +217474,6 @@ } }, { - "description": "The time the watch was triggered by the trigger engine.", "name": "triggered_time", "required": true, "type": { @@ -227908,7 +217510,6 @@ } }, { - "description": "The watch record identifier.", "name": "watch_record_id", "required": true, "type": { @@ -227920,7 +217521,7 @@ } } ], - "specLocation": "watcher/stats/types.ts#L79-L94" + "specLocation": "watcher/stats/types.ts#L54-L60" }, { "kind": "enum", @@ -227945,7 +217546,7 @@ "name": "WatcherMetric", "namespace": "watcher.stats" }, - "specLocation": "watcher/stats/types.ts#L63-L69" + "specLocation": "watcher/stats/types.ts#L42-L48" }, { "kind": "interface", @@ -227955,7 +217556,6 @@ }, "properties": [ { - "description": "The current executing watches metric gives insight into the watches that are currently being executed by Watcher.\nAdditional information is shared per watch that is currently executing.\nThis information includes the `watch_id`, the time its execution started and its current execution phase.\nTo include this metric, the `metric` option should be set to `current_watches` or `_all`.\nIn addition you can also specify the `emit_stacktraces=true` parameter, which adds stack traces for each watch that is being run.\nThese stack traces can give you more insight into an execution of a watch.", "name": "current_watches", "required": false, "type": { @@ -227981,7 +217581,6 @@ } }, { - "description": "Watcher moderates the execution of watches such that their execution won't put too much pressure on the node and its resources.\nIf too many watches trigger concurrently and there isn't enough capacity to run them all, some of the watches are queued, waiting for the current running watches to finish.s\nThe queued watches metric gives insight on these queued watches.\n\nTo include this metric, the `metric` option should include `queued_watches` or `_all`.", "name": "queued_watches", "required": false, "type": { @@ -227996,7 +217595,6 @@ } }, { - "description": "The number of watches currently registered.", "name": "watch_count", "required": true, "type": { @@ -228008,7 +217606,6 @@ } }, { - "description": "The current state of Watcher.", "name": "watcher_state", "required": true, "type": { @@ -228031,7 +217628,7 @@ } } ], - "specLocation": "watcher/stats/types.ts#L33-L61" + "specLocation": "watcher/stats/types.ts#L33-L40" }, { "kind": "enum", @@ -228063,7 +217660,7 @@ "body": { "kind": "no_body" }, - "description": "Stop the watch service.\nStop the Watcher service if it is running.", + "description": "Stops Watcher if it is running.", "inherits": { "type": { "name": "RequestBase", @@ -228075,22 +217672,8 @@ "namespace": "watcher.stop" }, "path": [], - "query": [ - { - "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", - "name": "master_timeout", - "required": false, - "serverDefault": "30s", - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/stop/WatcherStopRequest.ts#L23-L47" + "query": [], + "specLocation": "watcher/stop/WatcherStopRequest.ts#L22-L26" }, { "kind": "response", @@ -228110,102 +217693,6 @@ }, "specLocation": "watcher/stop/WatcherStopResponse.ts#L22-L24" }, - { - "kind": "request", - "attachedBehaviors": [ - "CommonQueryParameters" - ], - "body": { - "kind": "properties", - "properties": [ - { - "name": "index.auto_expand_replicas", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "name": "index.number_of_replicas", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "integer", - "namespace": "_types" - } - } - } - ] - }, - "description": "Update Watcher index settings.\nUpdate settings for the Watcher internal index (`.watches`).\nOnly a subset of settings can be modified.\nThis includes `index.auto_expand_replicas` and `index.number_of_replicas`.", - "inherits": { - "type": { - "name": "RequestBase", - "namespace": "_types" - } - }, - "name": { - "name": "Request", - "namespace": "watcher.update_settings" - }, - "path": [], - "query": [ - { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "master_timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - }, - { - "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", - "name": "timeout", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Duration", - "namespace": "_types" - } - } - } - ], - "specLocation": "watcher/update_settings/WatcherUpdateSettingsRequest.ts#L24-L58" - }, - { - "kind": "response", - "body": { - "kind": "properties", - "properties": [ - { - "name": "acknowledged", - "required": true, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - } - ] - }, - "name": { - "name": "Response", - "namespace": "watcher.update_settings" - }, - "specLocation": "watcher/update_settings/WatcherUpdateSettingsResponse.ts#L20-L24" - }, { "kind": "interface", "name": { @@ -228290,7 +217777,7 @@ } } ], - "specLocation": "xpack/info/types.ts#L84-L89" + "specLocation": "xpack/info/types.ts#L85-L90" }, { "kind": "interface", @@ -228408,6 +217895,17 @@ } } }, + { + "name": "frozen_indices", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Feature", + "namespace": "xpack.info" + } + } + }, { "name": "graph", "required": true, @@ -228617,7 +218115,7 @@ } } ], - "specLocation": "xpack/info/types.ts#L42-L82" + "specLocation": "xpack/info/types.ts#L42-L83" }, { "kind": "interface", @@ -228733,7 +218231,7 @@ "body": { "kind": "no_body" }, - "description": "Get information.\nThe information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", + "description": "Provides general information about the installed X-Pack features.", "inherits": { "type": { "name": "RequestBase", @@ -228747,7 +218245,7 @@ "path": [], "query": [ { - "description": "A comma-separated list of the information categories to include in the response.\nFor example, `build,license,features`.", + "description": "A comma-separated list of the information categories to include in the response. For example, `build,license,features`.", "name": "categories", "required": false, "type": { @@ -228774,7 +218272,7 @@ } }, { - "description": "Defines whether additional human-readable information is included in the response.\nIn particular, it adds descriptions and a tag line.", + "description": "Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.", "name": "human", "required": false, "serverDefault": true, @@ -228787,7 +218285,7 @@ } } ], - "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L56" + "specLocation": "xpack/info/XPackInfoRequest.ts#L22-L42" }, { "kind": "response", @@ -228863,7 +218361,7 @@ "name": "XPackCategory", "namespace": "xpack.info" }, - "specLocation": "xpack/info/XPackInfoRequest.ts#L58-L62" + "specLocation": "xpack/info/XPackInfoRequest.ts#L44-L48" }, { "kind": "interface", @@ -228890,7 +218388,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L340-L342" + "specLocation": "xpack/usage/types.ts#L328-L330" }, { "kind": "interface", @@ -228999,7 +218497,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L58-L68" + "specLocation": "xpack/usage/types.ts#L59-L69" }, { "kind": "interface", @@ -229026,7 +218524,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L45-L47" + "specLocation": "xpack/usage/types.ts#L46-L48" }, { "kind": "interface", @@ -229056,7 +218554,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L70-L72" + "specLocation": "xpack/usage/types.ts#L71-L73" }, { "kind": "interface", @@ -229088,7 +218586,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L27-L30" + "specLocation": "xpack/usage/types.ts#L28-L31" }, { "kind": "interface", @@ -229126,7 +218624,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L344-L347" + "specLocation": "xpack/usage/types.ts#L332-L335" }, { "kind": "interface", @@ -229158,7 +218656,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L32-L35" + "specLocation": "xpack/usage/types.ts#L33-L36" }, { "kind": "interface", @@ -229196,7 +218694,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L78-L81" + "specLocation": "xpack/usage/types.ts#L79-L82" }, { "kind": "interface", @@ -229316,7 +218814,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L83-L94" + "specLocation": "xpack/usage/types.ts#L84-L95" }, { "kind": "interface", @@ -229393,7 +218891,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L349-L359" + "specLocation": "xpack/usage/types.ts#L337-L347" }, { "kind": "interface", @@ -229414,7 +218912,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L74-L76" + "specLocation": "xpack/usage/types.ts#L75-L77" }, { "kind": "interface", @@ -229463,7 +218961,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L361-L364" + "specLocation": "xpack/usage/types.ts#L349-L352" }, { "kind": "interface", @@ -229550,7 +219048,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L96-L104" + "specLocation": "xpack/usage/types.ts#L97-L105" }, { "kind": "interface", @@ -229615,7 +219113,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L106-L112" + "specLocation": "xpack/usage/types.ts#L107-L113" }, { "kind": "interface", @@ -229680,7 +219178,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L114-L120" + "specLocation": "xpack/usage/types.ts#L115-L121" }, { "kind": "interface", @@ -229712,7 +219210,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L122-L125" + "specLocation": "xpack/usage/types.ts#L123-L126" }, { "kind": "interface", @@ -229788,7 +219286,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L127-L134" + "specLocation": "xpack/usage/types.ts#L128-L135" }, { "kind": "interface", @@ -229809,7 +219307,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L37-L39" + "specLocation": "xpack/usage/types.ts#L38-L40" }, { "kind": "interface", @@ -229836,7 +219334,34 @@ } } ], - "specLocation": "xpack/usage/types.ts#L366-L368" + "specLocation": "xpack/usage/types.ts#L354-L356" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "Base", + "namespace": "xpack.usage" + } + }, + "name": { + "name": "FrozenIndices", + "namespace": "xpack.usage" + }, + "properties": [ + { + "name": "indices_count", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "long", + "namespace": "_types" + } + } + } + ], + "specLocation": "xpack/usage/types.ts#L358-L360" }, { "kind": "interface", @@ -229863,7 +219388,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L150-L152" + "specLocation": "xpack/usage/types.ts#L151-L153" }, { "kind": "interface", @@ -229898,7 +219423,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L172-L175" + "specLocation": "xpack/usage/types.ts#L160-L163" }, { "kind": "interface", @@ -229925,12 +219450,12 @@ "kind": "instance_of", "type": { "name": "Phases", - "namespace": "xpack.usage" + "namespace": "ilm._types" } } } ], - "specLocation": "xpack/usage/types.ts#L167-L170" + "specLocation": "xpack/usage/types.ts#L155-L158" }, { "kind": "interface", @@ -229951,7 +219476,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L41-L43" + "specLocation": "xpack/usage/types.ts#L42-L44" }, { "kind": "interface", @@ -229983,7 +219508,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L177-L180" + "specLocation": "xpack/usage/types.ts#L165-L168" }, { "kind": "interface", @@ -230059,7 +219584,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L370-L376" + "specLocation": "xpack/usage/types.ts#L362-L368" }, { "kind": "interface", @@ -230153,7 +219678,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L378-L385" + "specLocation": "xpack/usage/types.ts#L370-L377" }, { "kind": "interface", @@ -230174,7 +219699,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L265-L267" + "specLocation": "xpack/usage/types.ts#L253-L255" }, { "kind": "interface", @@ -230228,7 +219753,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L187-L192" + "specLocation": "xpack/usage/types.ts#L175-L180" }, { "kind": "interface", @@ -230271,7 +219796,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L194-L198" + "specLocation": "xpack/usage/types.ts#L182-L186" }, { "kind": "interface", @@ -230292,7 +219817,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L204-L206" + "specLocation": "xpack/usage/types.ts#L192-L194" }, { "kind": "interface", @@ -230313,7 +219838,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L200-L202" + "specLocation": "xpack/usage/types.ts#L188-L190" }, { "kind": "interface", @@ -230373,7 +219898,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L208-L216" + "specLocation": "xpack/usage/types.ts#L196-L204" }, { "kind": "interface", @@ -230427,7 +219952,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L237-L242" + "specLocation": "xpack/usage/types.ts#L225-L230" }, { "kind": "interface", @@ -230448,7 +219973,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L244-L246" + "specLocation": "xpack/usage/types.ts#L232-L234" }, { "kind": "interface", @@ -230502,7 +220027,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L218-L223" + "specLocation": "xpack/usage/types.ts#L206-L211" }, { "kind": "interface", @@ -230545,7 +220070,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L248-L252" + "specLocation": "xpack/usage/types.ts#L236-L240" }, { "kind": "interface", @@ -230616,7 +220141,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L225-L235" + "specLocation": "xpack/usage/types.ts#L213-L223" }, { "kind": "interface", @@ -230714,7 +220239,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L254-L263" + "specLocation": "xpack/usage/types.ts#L242-L251" }, { "kind": "interface", @@ -230746,7 +220271,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L182-L185" + "specLocation": "xpack/usage/types.ts#L170-L173" }, { "kind": "interface", @@ -230795,116 +220320,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L387-L390" - }, - { - "kind": "interface", - "name": { - "name": "Phase", - "namespace": "xpack.usage" - }, - "properties": [ - { - "name": "actions", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "name": "min_age", - "required": true, - "type": { - "kind": "instance_of", - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], - "type": { - "name": "DurationValue", - "namespace": "_types" - } - } - } - ], - "specLocation": "xpack/usage/types.ts#L154-L157" - }, - { - "kind": "interface", - "name": { - "name": "Phases", - "namespace": "xpack.usage" - }, - "properties": [ - { - "name": "cold", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Phase", - "namespace": "xpack.usage" - } - } - }, - { - "name": "delete", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Phase", - "namespace": "xpack.usage" - } - } - }, - { - "name": "frozen", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Phase", - "namespace": "xpack.usage" - } - } - }, - { - "name": "hot", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Phase", - "namespace": "xpack.usage" - } - } - }, - { - "name": "warm", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "Phase", - "namespace": "xpack.usage" - } - } - } - ], - "specLocation": "xpack/usage/types.ts#L159-L165" + "specLocation": "xpack/usage/types.ts#L379-L382" }, { "kind": "interface", @@ -230958,7 +220374,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L269-L274" + "specLocation": "xpack/usage/types.ts#L257-L262" }, { "kind": "interface", @@ -231086,7 +220502,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L423-L432" + "specLocation": "xpack/usage/types.ts#L415-L424" }, { "kind": "interface", @@ -231107,7 +220523,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L276-L278" + "specLocation": "xpack/usage/types.ts#L264-L266" }, { "kind": "request", @@ -231117,7 +220533,7 @@ "body": { "kind": "no_body" }, - "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", + "description": "This API provides information about which features are currently enabled and available under the current license and some usage statistics.", "inherits": { "type": { "name": "RequestBase", @@ -231131,7 +220547,7 @@ "path": [], "query": [ { - "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", + "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.", "name": "master_timeout", "required": false, "serverDefault": "30s", @@ -231144,7 +220560,7 @@ } } ], - "specLocation": "xpack/usage/XPackUsageRequest.ts#L23-L49" + "specLocation": "xpack/usage/XPackUsageRequest.ts#L23-L38" }, { "kind": "response", @@ -231289,6 +220705,17 @@ } } }, + { + "name": "frozen_indices", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "FrozenIndices", + "namespace": "xpack.usage" + } + } + }, { "name": "graph", "required": true, @@ -231471,7 +220898,7 @@ "name": "Response", "namespace": "xpack.usage" }, - "specLocation": "xpack/usage/XPackUsageResponse.ts#L42-L77" + "specLocation": "xpack/usage/XPackUsageResponse.ts#L43-L79" }, { "kind": "interface", @@ -231503,7 +220930,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L280-L283" + "specLocation": "xpack/usage/types.ts#L268-L271" }, { "kind": "interface", @@ -231533,7 +220960,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L285-L287" + "specLocation": "xpack/usage/types.ts#L273-L275" }, { "kind": "interface", @@ -231700,7 +221127,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L289-L304" + "specLocation": "xpack/usage/types.ts#L277-L292" }, { "kind": "interface", @@ -231749,7 +221176,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L434-L438" + "specLocation": "xpack/usage/types.ts#L426-L430" }, { "kind": "interface", @@ -231919,7 +221346,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L440-L453" + "specLocation": "xpack/usage/types.ts#L432-L445" }, { "kind": "interface", @@ -231962,7 +221389,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L306-L310" + "specLocation": "xpack/usage/types.ts#L294-L298" }, { "kind": "interface", @@ -231983,7 +221410,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L318-L320" + "specLocation": "xpack/usage/types.ts#L306-L308" }, { "kind": "interface", @@ -232026,7 +221453,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L322-L326" + "specLocation": "xpack/usage/types.ts#L310-L314" }, { "kind": "interface", @@ -232069,7 +221496,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L328-L332" + "specLocation": "xpack/usage/types.ts#L316-L320" }, { "kind": "interface", @@ -232112,7 +221539,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L312-L316" + "specLocation": "xpack/usage/types.ts#L300-L304" }, { "kind": "interface", @@ -232150,7 +221577,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L455-L458" + "specLocation": "xpack/usage/types.ts#L447-L450" }, { "kind": "interface", @@ -232210,7 +221637,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L392-L395" + "specLocation": "xpack/usage/types.ts#L384-L387" }, { "kind": "interface", @@ -232242,7 +221669,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L397-L400" + "specLocation": "xpack/usage/types.ts#L389-L392" }, { "kind": "interface", @@ -232291,7 +221718,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L460-L464" + "specLocation": "xpack/usage/types.ts#L452-L456" }, { "kind": "interface", @@ -232340,7 +221767,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L466-L470" + "specLocation": "xpack/usage/types.ts#L458-L462" }, { "kind": "interface", @@ -232381,7 +221808,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L418-L421" + "specLocation": "xpack/usage/types.ts#L410-L413" }, { "kind": "interface", @@ -232413,7 +221840,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L402-L404" + "specLocation": "xpack/usage/types.ts#L394-L396" }, { "kind": "interface", @@ -232500,7 +221927,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L406-L411" + "specLocation": "xpack/usage/types.ts#L398-L403" }, { "kind": "interface", @@ -232532,7 +221959,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L413-L416" + "specLocation": "xpack/usage/types.ts#L405-L408" }, { "kind": "interface", @@ -232570,7 +221997,7 @@ } } ], - "specLocation": "xpack/usage/types.ts#L472-L475" + "specLocation": "xpack/usage/types.ts#L464-L467" }, { "kind": "interface", @@ -232590,7 +222017,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L28-L36" + "specLocation": "_spec_utils/behaviors.ts#L29-L37" }, { "kind": "interface", @@ -232610,7 +222037,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L38-L47" + "specLocation": "_spec_utils/behaviors.ts#L39-L48" }, { "kind": "interface", @@ -232687,7 +222114,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L49-L83" + "specLocation": "_spec_utils/behaviors.ts#L50-L84" }, { "kind": "interface", @@ -232735,6 +222162,19 @@ } } }, + { + "description": "Period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, { "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.", "name": "s", @@ -232761,7 +222201,7 @@ } } ], - "specLocation": "_spec_utils/behaviors.ts#L85-L118" + "specLocation": "_spec_utils/behaviors.ts#L86-L124" }, { "kind": "interface", @@ -232777,7 +222217,7 @@ "namespace": "_spec_utils" }, "properties": [], - "specLocation": "_spec_utils/behaviors.ts#L120-L126" + "specLocation": "_spec_utils/behaviors.ts#L126-L132" } ] } \ No newline at end of file diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 6bdccb4e88..d8079f47cf 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -4660,9 +4660,8 @@ export interface AnalysisEstonianAnalyzer { export interface AnalysisFingerprintAnalyzer { type: 'fingerprint' version?: VersionString - max_output_size: integer - preserve_original: boolean - separator: string + max_output_size?: integer + separator?: string stopwords?: AnalysisStopWords stopwords_path?: string } @@ -5026,8 +5025,9 @@ export interface AnalysisPatternAnalyzer { version?: VersionString flags?: string lowercase?: boolean - pattern: string + pattern?: string stopwords?: AnalysisStopWords + stopwords_path?: string } export interface AnalysisPatternCaptureTokenFilter extends AnalysisTokenFilterBase { @@ -5184,6 +5184,7 @@ export interface AnalysisStandardAnalyzer { type: 'standard' max_token_length?: integer stopwords?: AnalysisStopWords + stopwords_path?: string } export interface AnalysisStandardTokenizer extends AnalysisTokenizerBase { @@ -6355,7 +6356,7 @@ export interface QueryDslPercolateQuery extends QueryDslQueryBase { export interface QueryDslPinnedDoc { _id: Id - _index: IndexName + _index?: IndexName } export interface QueryDslPinnedQuery extends QueryDslQueryBase { @@ -6425,7 +6426,7 @@ export interface QueryDslQueryContainer { span_near?: QueryDslSpanNearQuery span_not?: QueryDslSpanNotQuery span_or?: QueryDslSpanOrQuery - span_term?: Partial> + span_term?: Partial> span_within?: QueryDslSpanWithinQuery sparse_vector?: QueryDslSparseVectorQuery term?: Partial> @@ -6627,12 +6628,13 @@ export interface QueryDslSpanQuery { span_near?: QueryDslSpanNearQuery span_not?: QueryDslSpanNotQuery span_or?: QueryDslSpanOrQuery - span_term?: Partial> + span_term?: Partial> span_within?: QueryDslSpanWithinQuery } export interface QueryDslSpanTermQuery extends QueryDslQueryBase { - value: string + value: FieldValue + term: FieldValue } export interface QueryDslSpanWithinQuery extends QueryDslQueryBase { @@ -10764,7 +10766,7 @@ export interface GraphExploreControls { export interface GraphHop { connections?: GraphHop - query: QueryDslQueryContainer + query?: QueryDslQueryContainer vertices: GraphVertexDefinition[] } @@ -10783,14 +10785,14 @@ export interface GraphVertex { export interface GraphVertexDefinition { exclude?: string[] field: Field - include?: GraphVertexInclude[] + include?: (GraphVertexInclude | string)[] min_doc_count?: long shard_min_doc_count?: long size?: integer } export interface GraphVertexInclude { - boost: double + boost?: double term: string } @@ -13233,7 +13235,7 @@ export interface IngestDatabaseConfigurationFull { } export interface IngestDateIndexNameProcessor extends IngestProcessorBase { - date_formats: string[] + date_formats?: string[] date_rounding: string field: Field index_name_format?: string @@ -13494,7 +13496,7 @@ export interface IngestPipelineSimulation { export interface IngestProcessorBase { description?: string - if?: string + if?: Script | string ignore_failure?: boolean on_failure?: IngestProcessorContainer[] tag?: string @@ -14359,8 +14361,8 @@ export interface MlDataframeAnalysis { } export interface MlDataframeAnalysisAnalyzedFields { - includes: string[] - excludes: string[] + includes?: string[] + excludes?: string[] } export interface MlDataframeAnalysisClassification extends MlDataframeAnalysis { @@ -19650,7 +19652,7 @@ export type SlmStopResponse = AcknowledgedResponseBase export interface SnapshotAzureRepository extends SnapshotRepositoryBase { type: 'azure' - settings: SnapshotAzureRepositorySettings + settings?: SnapshotAzureRepositorySettings } export interface SnapshotAzureRepositorySettings extends SnapshotRepositorySettingsBase { diff --git a/specification/_types/analysis/analyzers.ts b/specification/_types/analysis/analyzers.ts index 47da0e68fd..592ad25304 100644 --- a/specification/_types/analysis/analyzers.ts +++ b/specification/_types/analysis/analyzers.ts @@ -36,21 +36,42 @@ export class CustomAnalyzer { export class FingerprintAnalyzer { type: 'fingerprint' + /** @deprecated 7.14.0 */ version?: VersionString - max_output_size: integer - preserve_original: boolean - separator: string - stopwords?: StopWords + /** + * The maximum token size to emit. Tokens larger than this size will be discarded. + * Defaults to `255` + * + * @server_default 255 + */ + max_output_size?: integer + /** + * The character to use to concatenate the terms. + * Defaults to a space. + */ + separator?: string + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ + stopwords?: StopWords + /** + * The path to a file containing stop words. + */ stopwords_path?: string } export class KeywordAnalyzer { type: 'keyword' + /** @deprecated 7.14.0 */ version?: VersionString } export class LanguageAnalyzer { type: 'language' + /** @deprecated 7.14.0 */ version?: VersionString language: Language stem_exclusion: string[] @@ -311,6 +332,7 @@ export class ThaiAnalyzer { export class NoriAnalyzer { type: 'nori' + /** @deprecated 7.14.0 */ version?: VersionString decompound_mode?: NoriDecompoundMode stoptags?: string[] @@ -319,20 +341,49 @@ export class NoriAnalyzer { export class PatternAnalyzer { type: 'pattern' + /** @deprecated 7.14.0 */ version?: VersionString - flags?: string + /** + * Java regular expression flags. Flags should be pipe-separated, eg "CASE_INSENSITIVE|COMMENTS". + */ + flags?: string // TODO: Use PipeSeparatedFlags and proper enum + /** + * Should terms be lowercased or not. + * Defaults to `true`. + * + * @server_default true + */ lowercase?: boolean - pattern: string - stopwords?: StopWords + /** + * A Java regular expression. + * Defaults to `\W+`. + * + * @server_default \W+ + */ + pattern?: string + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ + stopwords?: StopWords + /** + * The path to a file containing stop words. + */ + stopwords_path?: string } export class SimpleAnalyzer { type: 'simple' + /** @deprecated 7.14.0 */ version?: VersionString } +// TODO: This one seems undocumented!? export class SnowballAnalyzer { type: 'snowball' + /** @deprecated 7.14.0 */ version?: VersionString language: SnowballLanguage stopwords?: StopWords @@ -340,19 +391,46 @@ export class SnowballAnalyzer { export class StandardAnalyzer { type: 'standard' + /** + * The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals. + * Defaults to `255`. + * + * @server_default 255 + */ max_token_length?: integer + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ stopwords?: StopWords + /** + * The path to a file containing stop words. + */ + stopwords_path?: string } export class StopAnalyzer { type: 'stop' + /** @deprecated 7.14.0 */ version?: VersionString + /** + * A pre-defined stop words list like `_english_` or an array containing a list of stop words. + * Defaults to `_none_`. + * + * @server_default _none_ + */ stopwords?: StopWords + /** + * The path to a file containing stop words. + */ stopwords_path?: string } export class WhitespaceAnalyzer { type: 'whitespace' + /** @deprecated 7.14.0 */ version?: VersionString } diff --git a/specification/_types/query_dsl/span.ts b/specification/_types/query_dsl/span.ts index 1ca61e1ed2..e719fe6152 100644 --- a/specification/_types/query_dsl/span.ts +++ b/specification/_types/query_dsl/span.ts @@ -18,7 +18,7 @@ */ import { SingleKeyDictionary } from '@spec_utils/Dictionary' -import { Field } from '@_types/common' +import { Field, FieldValue } from '@_types/common' import { integer } from '@_types/Numeric' import { QueryBase, QueryContainer } from './abstractions' @@ -136,7 +136,8 @@ export class SpanOrQuery extends QueryBase { * @ext_doc_id query-dsl-span-term-query */ export class SpanTermQuery extends QueryBase { - value: string + /** @aliases term */ + value: FieldValue } /** diff --git a/specification/_types/query_dsl/specialized.ts b/specification/_types/query_dsl/specialized.ts index 52dd48edf4..081f8a7b75 100644 --- a/specification/_types/query_dsl/specialized.ts +++ b/specification/_types/query_dsl/specialized.ts @@ -274,7 +274,7 @@ export class PinnedDoc { /** * The index that contains the document. */ - _index: IndexName + _index?: IndexName } export class RankFeatureFunction {} diff --git a/specification/graph/_types/Hop.ts b/specification/graph/_types/Hop.ts index c1a0f6071f..2464023039 100644 --- a/specification/graph/_types/Hop.ts +++ b/specification/graph/_types/Hop.ts @@ -28,7 +28,7 @@ export class Hop { /** * An optional guiding query that constrains the Graph API as it explores connected terms. */ - query: QueryContainer + query?: QueryContainer /** * Contains the fields you are interested in. */ diff --git a/specification/graph/_types/Vertex.ts b/specification/graph/_types/Vertex.ts index 05c925aa45..87d664eabc 100644 --- a/specification/graph/_types/Vertex.ts +++ b/specification/graph/_types/Vertex.ts @@ -58,7 +58,8 @@ export class VertexDefinition { size?: integer } +/** @shortcut_property term */ export class VertexInclude { - boost: double + boost?: double term: string } diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts index b507d6deec..43a5bf0496 100644 --- a/specification/ingest/_types/Processors.ts +++ b/specification/ingest/_types/Processors.ts @@ -22,6 +22,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' import { Field, Fields, GrokPattern, Id, Name } from '@_types/common' import { GeoShapeRelation } from '@_types/Geo' import { double, integer, long } from '@_types/Numeric' +import { Script } from '@_types/Scripting' import { SortOrder } from '@_types/sort' /** @@ -309,7 +310,7 @@ export class ProcessorBase { /** * Conditionally execute the processor. */ - if?: string + if?: Script /** * Ignore failures for the processor. */ @@ -731,7 +732,7 @@ export class DateIndexNameProcessor extends ProcessorBase { * An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. * Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. */ - date_formats: string[] + date_formats?: string[] /** * How to round the date when formatting the date into the index name. Valid values are: * `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second). diff --git a/specification/ml/_types/DataframeAnalytics.ts b/specification/ml/_types/DataframeAnalytics.ts index 95d4b3e9db..a55eb45b37 100644 --- a/specification/ml/_types/DataframeAnalytics.ts +++ b/specification/ml/_types/DataframeAnalytics.ts @@ -238,9 +238,9 @@ export class DataframeAnalysisClassification extends DataframeAnalysis { /** @shortcut_property includes */ export class DataframeAnalysisAnalyzedFields { /** An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. */ - includes: string[] + includes?: string[] /** An array of strings that defines the fields that will be included in the analysis. */ - excludes: string[] + excludes?: string[] } /** @variants container */ diff --git a/specification/snapshot/_types/SnapshotRepository.ts b/specification/snapshot/_types/SnapshotRepository.ts index 6f65d4ab8f..fb809ea381 100644 --- a/specification/snapshot/_types/SnapshotRepository.ts +++ b/specification/snapshot/_types/SnapshotRepository.ts @@ -46,7 +46,7 @@ export class AzureRepository extends RepositoryBase { /** * The repository settings. */ - settings: AzureRepositorySettings + settings?: AzureRepositorySettings } export class GcsRepository extends RepositoryBase { diff --git a/specification/sql/types.ts b/specification/sql/_types/types.ts similarity index 100% rename from specification/sql/types.ts rename to specification/sql/_types/types.ts diff --git a/specification/sql/get_async/SqlGetAsyncResponse.ts b/specification/sql/get_async/SqlGetAsyncResponse.ts index 34f9aa2651..827ab45fe7 100644 --- a/specification/sql/get_async/SqlGetAsyncResponse.ts +++ b/specification/sql/get_async/SqlGetAsyncResponse.ts @@ -18,7 +18,7 @@ */ import { Id } from '@_types/common' -import { Column, Row } from '../types' +import { Column, Row } from '../_types/types' export class Response { body: { diff --git a/specification/sql/query/QuerySqlResponse.ts b/specification/sql/query/QuerySqlResponse.ts index 29e6a69e94..d7f8452dc6 100644 --- a/specification/sql/query/QuerySqlResponse.ts +++ b/specification/sql/query/QuerySqlResponse.ts @@ -18,7 +18,7 @@ */ import { Id } from '@_types/common' -import { Column, Row } from '../types' +import { Column, Row } from '../_types/types' export class Response { body: {