diff --git a/compiler-rs/clients_schema_to_openapi/src/lib.rs b/compiler-rs/clients_schema_to_openapi/src/lib.rs index 40861aa403..c4fc22d0df 100644 --- a/compiler-rs/clients_schema_to_openapi/src/lib.rs +++ b/compiler-rs/clients_schema_to_openapi/src/lib.rs @@ -25,7 +25,7 @@ use std::io::{BufWriter, Write}; use std::path::Path; use indexmap::IndexMap; -use clients_schema::{Availabilities, Endpoint, IndexedModel}; +use clients_schema::{Availabilities, Endpoint, IndexedModel, Stability}; use openapiv3::{Components, OpenAPI}; use tracing::warn; @@ -149,7 +149,7 @@ fn info(model: &IndexedModel) -> openapiv3::Info { } } -pub fn availability_as_extension(availabilities: &Option) -> IndexMap { +pub fn availability_as_extensions(availabilities: &Option) -> IndexMap { let mut result = IndexMap::new(); if let Some(avails) = availabilities { @@ -157,7 +157,17 @@ pub fn availability_as_extension(availabilities: &Option) -> Ind for (_, availability) in avails { if let Some(since) = &availability.since { result.insert("x-available-since".to_string(), serde_json::Value::String(since.clone())); - break; + } + if let Some(stability) = &availability.stability { + match stability { + Stability::Beta => { + result.insert("x-beta".to_string(), serde_json::Value::Bool(true)); + } + Stability::Experimental => { + result.insert("x-technical-preview".to_string(), serde_json::Value::Bool(true)); + } + _ => {} + } } } } diff --git a/compiler-rs/clients_schema_to_openapi/src/paths.rs b/compiler-rs/clients_schema_to_openapi/src/paths.rs index 111e76954e..a8ff30812b 100644 --- a/compiler-rs/clients_schema_to_openapi/src/paths.rs +++ b/compiler-rs/clients_schema_to_openapi/src/paths.rs @@ -211,7 +211,7 @@ pub fn add_endpoint( deprecated: endpoint.deprecation.is_some(), security: None, servers: vec![], - extensions: crate::availability_as_extension(&endpoint.availability), + extensions: crate::availability_as_extensions(&endpoint.availability), }; @@ -321,10 +321,8 @@ fn get_path_parameters(template: &str) -> Vec<&str> { fn split_summary_desc(desc: &str) -> SplitDesc{ let segmenter = SentenceSegmenter::new(); - let desc_no_newlines = desc.replace("\n\n",".\n").replace('\n'," "); - let breakpoints: Vec = segmenter - .segment_str(&desc_no_newlines) + .segment_str(&desc) .collect(); if breakpoints.len()<2{ @@ -333,8 +331,8 @@ fn split_summary_desc(desc: &str) -> SplitDesc{ description: None } } - let first_line = &desc_no_newlines[breakpoints[0]..breakpoints[1]]; - let rest = &desc_no_newlines[breakpoints[1]..breakpoints[breakpoints.len()-1]]; + let first_line = &desc[breakpoints[0]..breakpoints[1]]; + let rest = &desc[breakpoints[1]..breakpoints[breakpoints.len()-1]]; SplitDesc { summary: Some(String::from(first_line.trim().strip_suffix('.').unwrap_or(first_line))), @@ -370,9 +368,9 @@ mod tests { summary: Some(String::from("One sentence")), description: None }); - assert_eq!(split_summary_desc("This is\nstill one. sentence: all; together"), + assert_eq!(split_summary_desc("This is - still one. sentence: all; together"), SplitDesc{ - summary: Some(String::from("This is still one. sentence: all; together")), + summary: Some(String::from("This is - still one. sentence: all; together")), description: None }); assert_eq!(split_summary_desc("These are two totally. Separate sentences!"), @@ -380,10 +378,10 @@ mod tests { summary: Some(String::from("These are two totally")), description: Some(String::from("Separate sentences!")) }); - assert_eq!(split_summary_desc("Such a weird way to separate sentences\n\nRight?"), + assert_eq!(split_summary_desc("These -> \n are allowed \n because they're needed \n\n for \n\n\n formatting"), SplitDesc{ - summary: Some(String::from("Such a weird way to separate sentences")), - description: Some(String::from("Right?")) + summary: Some(String::from("These -> \n")), + description: Some(String::from("are allowed \n because they're needed \n\n for \n\n\n formatting")) }); assert_eq!(split_summary_desc(""), SplitDesc{ diff --git a/compiler-rs/clients_schema_to_openapi/src/schemas.rs b/compiler-rs/clients_schema_to_openapi/src/schemas.rs index 3bf0b2c8a8..ce6080328a 100644 --- a/compiler-rs/clients_schema_to_openapi/src/schemas.rs +++ b/compiler-rs/clients_schema_to_openapi/src/schemas.rs @@ -472,7 +472,7 @@ impl<'a> TypesAndComponents<'a> { data.external_docs = self.convert_external_docs(prop); data.deprecated = prop.deprecation.is_some(); data.description = prop.description.clone(); - data.extensions = crate::availability_as_extension(&prop.availability); + data.extensions = crate::availability_as_extensions(&prop.availability); // TODO: prop.aliases as extensions // TODO: prop.server_default as extension // TODO: prop.doc_id as extension (new representation of since and stability) diff --git a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm index bac9bafdfc..66d32863d0 100644 Binary files a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm and b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm differ diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 82ca8b807c..ee331e1c15 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -82,7 +82,7 @@ "async_search.delete" ], "summary": "Deletes an async search by identifier", - "description": "If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. If 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.", + "description": "If the search is still running, the search request will be 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -120,8 +120,8 @@ "tags": [ "async_search.status" ], - "summary": "Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results", - "description": "If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get async search status\n", + "description": "Retrieves 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -160,7 +160,7 @@ "async_search.submit" ], "summary": "Runs a search request asynchronously", - "description": "When 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "When 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, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -322,7 +322,7 @@ "async_search.submit" ], "summary": "Runs a search request asynchronously", - "description": "When 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "When 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, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -849,7 +849,7 @@ "cat.aliases" ], "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases. IMPORTANT: 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": "The API does not return data stream aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -872,7 +872,7 @@ "cat.aliases" ], "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases. IMPORTANT: 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": "The API does not return data stream aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -947,7 +947,7 @@ "cat.component_templates" ], "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: 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 component template API.", + "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -966,7 +966,7 @@ "cat.component_templates" ], "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: 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 component template API.", + "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -990,7 +990,7 @@ "cat.count" ], "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: 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 count API.", + "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -1008,7 +1008,7 @@ "cat.count" ], "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: 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 count API.", + "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -1031,7 +1031,7 @@ "cat.fielddata" ], "summary": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster", - "description": "IMPORTANT: 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 stats API.", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html" }, @@ -1057,7 +1057,7 @@ "cat.fielddata" ], "summary": "Returns the amount of heap memory currently used by the field data cache on every data node in the cluster", - "description": "IMPORTANT: 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 stats API.", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html" }, @@ -1086,7 +1086,7 @@ "cat.health" ], "summary": "Returns the health status of a cluster, similar to the cluster health API", - "description": "IMPORTANT: 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 cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html" }, @@ -1163,7 +1163,7 @@ "cat.indices" ], "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: 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 API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These 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. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "description": "IMPORTANT: 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 index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -1201,7 +1201,7 @@ "cat.indices" ], "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: 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 API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These 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. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "description": "IMPORTANT: 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 index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -1269,8 +1269,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.", + "summary": "Returns configuration and usage information about data frame analytics jobs", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -1305,8 +1305,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.", + "summary": "Returns configuration and usage information about data frame analytics jobs", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -1345,7 +1345,7 @@ "cat.ml_datafeeds" ], "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1378,7 +1378,7 @@ "cat.ml_datafeeds" ], "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1414,7 +1414,7 @@ "cat.ml_jobs" ], "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1450,7 +1450,7 @@ "cat.ml_jobs" ], "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1488,8 +1488,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.", + "summary": "Returns configuration and usage information about inference trained models", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1527,8 +1527,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.", + "summary": "Returns configuration and usage information about inference trained models", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1721,7 +1721,7 @@ "cat.recovery" ], "summary": "Returns information about ongoing and completed shard recoveries", - "description": "Shard 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. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: 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": "Shard 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html" }, @@ -1750,7 +1750,7 @@ "cat.recovery" ], "summary": "Returns information about ongoing and completed shard recoveries", - "description": "Shard 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. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: 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": "Shard 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html" }, @@ -1811,7 +1811,7 @@ "cat.segments" ], "summary": "Returns low-level information about the Lucene segments in index shards", - "description": "For data streams, the API returns information about the backing indices. IMPORTANT: 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": "For 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html" }, @@ -1834,7 +1834,7 @@ "cat.segments" ], "summary": "Returns low-level information about the Lucene segments in index shards", - "description": "For data streams, the API returns information about the backing indices. IMPORTANT: 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": "For 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html" }, @@ -1860,7 +1860,7 @@ "cat.shards" ], "summary": "Returns information about the shards in a cluster", - "description": "For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "For 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html" }, @@ -1883,7 +1883,7 @@ "cat.shards" ], "summary": "Returns information about the shards in a cluster", - "description": "For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", + "description": "For 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html" }, @@ -1909,7 +1909,7 @@ "cat.snapshots" ], "summary": "Returns information about the snapshots stored in one or more repositories", - "description": "A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: 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": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html" }, @@ -1933,7 +1933,7 @@ "cat.snapshots" ], "summary": "Returns information about the snapshots stored in one or more repositories", - "description": "A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: 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": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html" }, @@ -2028,6 +2028,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "5.0.0" } }, @@ -2037,7 +2038,7 @@ "cat.templates" ], "summary": "Returns information about index templates in a cluster", - "description": "You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: 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": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html" }, @@ -2056,7 +2057,7 @@ "cat.templates" ], "summary": "Returns information about index templates in a cluster", - "description": "You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: 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": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html" }, @@ -2080,7 +2081,7 @@ "cat.thread_pool" ], "summary": "Returns thread pool statistics for each node in a cluster", - "description": "Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: 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": "Returned 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html" }, @@ -2103,7 +2104,7 @@ "cat.thread_pool" ], "summary": "Returns thread pool statistics for each node in a cluster", - "description": "Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: 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": "Returned 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html" }, @@ -2128,8 +2129,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.", + "summary": "Returns configuration and usage information about transforms", + "description": "IMPORTANT: 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 transform statistics API.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -2167,8 +2168,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.", + "summary": "Returns configuration and usage information about transforms", + "description": "IMPORTANT: 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 transform statistics API.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -3258,7 +3259,7 @@ "cluster.put_component_template" ], "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.. You can use C-style `/* *\\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.", + "description": "Component 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3289,7 +3290,7 @@ "cluster.put_component_template" ], "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.. You can use C-style `/* *\\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.", + "description": "Component 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -3738,7 +3739,7 @@ "cluster.health" ], "summary": "The cluster health API returns a simple status on the health of the cluster", - "description": "You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On 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, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", + "description": "You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.\nThe cluster health status is: green, yellow or red. On 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, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html" }, @@ -3792,7 +3793,7 @@ "cluster.health" ], "summary": "The cluster health API returns a simple status on the health of the cluster", - "description": "You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On 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, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", + "description": "You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.\nThe cluster health status is: green, yellow or red. On 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, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html" }, @@ -3910,7 +3911,7 @@ "cluster.pending_tasks" ], "summary": "Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed", - "description": "NOTE: This API returns a list of any pending updates to the cluster state. These 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. However, 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.", + "description": "NOTE: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html" }, @@ -3967,8 +3968,8 @@ "tags": [ "cluster.remote_info" ], - "summary": "The cluster remote info API allows you to retrieve all of the configured remote cluster information", - "description": "It returns connection and endpoint information keyed by the configured remote cluster alias.", + "summary": "The cluster remote info API allows you to retrieve all of the configured\n", + "description": "remote cluster information. It returns connection and endpoint information\nkeyed by the configured remote cluster alias.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html" }, @@ -4355,6 +4356,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -4393,6 +4395,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "put": { @@ -4417,6 +4420,7 @@ "$ref": "#/components/responses/connector.put#200" } }, + "x-beta": true, "x-available-since": "8.12.0" }, "delete": { @@ -4464,6 +4468,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -4576,6 +4581,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -4678,6 +4684,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "put": { @@ -4697,6 +4704,7 @@ "$ref": "#/components/responses/connector.put#200" } }, + "x-beta": true, "x-available-since": "8.12.0" }, "post": { @@ -4767,6 +4775,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -4813,6 +4822,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -4851,6 +4861,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "delete": { @@ -4887,6 +4898,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -4982,6 +4994,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "post": { @@ -5037,6 +5050,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5083,6 +5097,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -5161,6 +5176,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5228,6 +5244,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5299,6 +5316,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -5372,6 +5390,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5436,6 +5455,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -5507,6 +5527,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5574,6 +5595,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5638,6 +5660,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5702,6 +5725,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5766,6 +5790,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5830,6 +5855,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -5894,6 +5920,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -8669,6 +8696,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "7.12.0" } }, @@ -8678,7 +8706,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -8724,7 +8752,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -8772,7 +8800,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -8821,7 +8849,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -8976,7 +9004,7 @@ "fleet.msearch" ], "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.", + "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", "operationId": "fleet-msearch", "parameters": [ { @@ -9027,6 +9055,7 @@ "$ref": "#/components/responses/fleet.msearch#200" } }, + "x-technical-preview": true, "x-available-since": "7.16.0" }, "post": { @@ -9034,7 +9063,7 @@ "fleet.msearch" ], "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.", + "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", "operationId": "fleet-msearch-1", "parameters": [ { @@ -9085,6 +9114,7 @@ "$ref": "#/components/responses/fleet.msearch#200" } }, + "x-technical-preview": true, "x-available-since": "7.16.0" } }, @@ -9094,7 +9124,7 @@ "fleet.msearch" ], "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.", + "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", "operationId": "fleet-msearch-2", "parameters": [ { @@ -9148,6 +9178,7 @@ "$ref": "#/components/responses/fleet.msearch#200" } }, + "x-technical-preview": true, "x-available-since": "7.16.0" }, "post": { @@ -9155,7 +9186,7 @@ "fleet.msearch" ], "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.", + "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", "operationId": "fleet-msearch-3", "parameters": [ { @@ -9209,6 +9240,7 @@ "$ref": "#/components/responses/fleet.msearch#200" } }, + "x-technical-preview": true, "x-available-since": "7.16.0" } }, @@ -9217,7 +9249,8 @@ "tags": [ "fleet.search" ], - "summary": "The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch", + "summary": "The purpose of the fleet search api is to provide a search api where the search will only be executed\n", + "description": "after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "operationId": "fleet-search", "parameters": [ { @@ -9364,13 +9397,15 @@ "$ref": "#/components/responses/fleet.search#200" } }, + "x-technical-preview": true, "x-available-since": "7.16.0" }, "post": { "tags": [ "fleet.search" ], - "summary": "The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch", + "summary": "The purpose of the fleet search api is to provide a search api where the search will only be executed\n", + "description": "after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "operationId": "fleet-search-1", "parameters": [ { @@ -9517,6 +9552,7 @@ "$ref": "#/components/responses/fleet.search#200" } }, + "x-technical-preview": true, "x-available-since": "7.16.0" } }, @@ -10029,8 +10065,8 @@ "tags": [ "ilm.migrate_to_data_tiers" ], - "summary": "Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template", - "description": "+ Using node roles enables ILM to automatically move the indices between data tiers.", + "summary": "Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and\n", + "description": "attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+\nUsing node roles enables ILM to automatically move the indices between data tiers.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html" }, @@ -10903,7 +10939,7 @@ "indices.get" ], "summary": "Returns information about one or more indices", - "description": "For data streams, the API returns information about the stream’s backing indices.", + "description": "For data streams, the API returns information about the\nstream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" }, @@ -11333,7 +11369,7 @@ "indices.create_data_stream" ], "summary": "Create a data stream", - "description": "Creates a data stream. You must have a matching index template with data stream enabled.", + "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -12059,7 +12095,7 @@ "indices.delete_index_template" ], "summary": "Delete an index template", - "description": "The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" }, @@ -12459,6 +12495,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "7.15.0" } }, @@ -12518,6 +12555,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.5.0" } }, @@ -12764,6 +12802,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "7.15.0" } }, @@ -13273,7 +13312,7 @@ "indices.put_mapping" ], "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -13315,7 +13354,7 @@ "indices.put_mapping" ], "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -13359,7 +13398,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13398,7 +13437,7 @@ "indices.put_settings" ], "summary": "Update index settings", - "description": "Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -13442,7 +13481,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13484,7 +13523,7 @@ "indices.put_settings" ], "summary": "Update index settings", - "description": "Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -13531,7 +13570,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13578,7 +13617,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -13651,7 +13690,7 @@ "indices.migrate_to_data_stream" ], "summary": "Convert an index alias to a data stream", - "description": "Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.", + "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -13941,7 +13980,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -13968,7 +14007,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -13997,7 +14036,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -14027,7 +14066,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -14120,8 +14159,8 @@ "tags": [ "indices.resolve_cluster" ], - "summary": "Resolves the specified index expressions to return information about each cluster, including the local cluster, if included", - "description": "Multiple patterns and remote clusters are supported.", + "summary": "Resolves the specified index expressions to return information about each cluster, including\n", + "description": "the local cluster, if included.\nMultiple patterns and remote clusters are supported.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html" }, @@ -15413,6 +15452,7 @@ "$ref": "#/components/responses/inference.get#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "put": { @@ -15437,6 +15477,7 @@ "$ref": "#/components/responses/inference.put#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "post": { @@ -15464,6 +15505,7 @@ "$ref": "#/components/responses/inference.inference#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "delete": { @@ -15491,6 +15533,7 @@ "$ref": "#/components/responses/inference.delete#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" } }, @@ -15517,6 +15560,7 @@ "$ref": "#/components/responses/inference.get#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "put": { @@ -15544,6 +15588,7 @@ "$ref": "#/components/responses/inference.put#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "post": { @@ -15574,6 +15619,7 @@ "$ref": "#/components/responses/inference.inference#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "delete": { @@ -15604,6 +15650,7 @@ "$ref": "#/components/responses/inference.delete#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" } }, @@ -15622,6 +15669,7 @@ "$ref": "#/components/responses/inference.get#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" } }, @@ -15954,7 +16002,7 @@ "ingest.processor_grok" ], "summary": "Extracts structured fields out of a single text field within a document", - "description": "You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" }, @@ -16118,7 +16166,8 @@ } }, "deprecated": true, - "x-available-since": "8.0.0" + "x-available-since": "8.0.0", + "x-technical-preview": true }, "post": { "tags": [ @@ -16146,7 +16195,8 @@ } }, "deprecated": true, - "x-available-since": "8.0.0" + "x-available-since": "8.0.0", + "x-technical-preview": true } }, "/_license": { @@ -16155,7 +16205,7 @@ "license.get" ], "summary": "Get license information", - "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" }, @@ -16344,7 +16394,7 @@ "license.post_start_basic" ], "summary": "The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features", - "description": "If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).", + "description": "If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.\nTo check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html" }, @@ -16916,7 +16966,7 @@ "ml.clear_trained_model_deployment_cache" ], "summary": "Clears a trained model deployment cache on all nodes where the trained model is assigned", - "description": "A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html" }, @@ -16963,7 +17013,7 @@ "ml.close_job" ], "summary": "Close anomaly detection jobs", - "description": "A 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. When 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. If 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. When a datafeed that has a specified end date stops, it automatically closes its associated job.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html" }, @@ -17411,7 +17461,7 @@ "ml.get_data_frame_analytics" ], "summary": "Retrieves configuration information for data frame analytics jobs", - "description": "You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" }, @@ -17445,7 +17495,7 @@ "ml.put_data_frame_analytics" ], "summary": "Instantiates a data frame analytics job", - "description": "This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.", + "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" }, @@ -17643,7 +17693,7 @@ "ml.get_datafeeds" ], "summary": "Retrieves configuration information for datafeeds", - "description": "You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" }, @@ -17671,7 +17721,7 @@ "ml.put_datafeed" ], "summary": "Instantiates a datafeed", - "description": "Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "description": "Datafeeds 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" }, @@ -17925,7 +17975,7 @@ "ml.delete_expired_data" ], "summary": "Deletes expired and unused machine learning data", - "description": "Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the , or by omitting the .", + "description": "Deletes 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html" }, @@ -17958,7 +18008,7 @@ "ml.delete_expired_data" ], "summary": "Deletes expired and unused machine learning data", - "description": "Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the , or by omitting the .", + "description": "Deletes 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html" }, @@ -18016,7 +18066,7 @@ "ml.put_filter" ], "summary": "Instantiates a filter", - "description": "A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" }, @@ -18095,7 +18145,7 @@ "ml.delete_filter" ], "summary": "Deletes a filter", - "description": "If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter.", + "description": "If 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" }, @@ -18133,8 +18183,8 @@ "tags": [ "ml.forecast" ], - "summary": "Predicts the future behavior of a time series by using its historical behavior.", - "description": "Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration.", + "summary": "Predicts the future behavior of a time series by using its historical\n", + "description": "behavior.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html" }, @@ -18234,7 +18284,7 @@ "ml.delete_forecast" ], "summary": "Deletes forecasts from a machine learning job", - "description": "By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.", + "description": "By 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html" }, @@ -18264,7 +18314,7 @@ "ml.delete_forecast" ], "summary": "Deletes forecasts from a machine learning job", - "description": "By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.", + "description": "By 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html" }, @@ -18297,7 +18347,7 @@ "ml.get_jobs" ], "summary": "Retrieves configuration information for anomaly detection jobs", - "description": "You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "description": "You 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 ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" }, @@ -18511,7 +18561,7 @@ "ml.delete_job" ], "summary": "Delete an anomaly detection job", - "description": "All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.", + "description": "All 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html" }, @@ -18670,7 +18720,7 @@ "ml.delete_model_snapshot" ], "summary": "Deletes an existing model snapshot", - "description": "You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html" }, @@ -18871,7 +18921,8 @@ "tags": [ "ml.delete_trained_model" ], - "summary": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline", + "summary": "Deletes an existing trained inference model that is currently not referenced\n", + "description": "by an ingest pipeline.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" }, @@ -18920,7 +18971,7 @@ "ml.put_trained_model_alias" ], "summary": "Creates or updates a trained model alias", - "description": "A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning.", + "description": "A trained model alias is a logical\nname used to reference a single trained model.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" }, @@ -18978,7 +19029,7 @@ "ml.delete_trained_model_alias" ], "summary": "Deletes a trained model alias", - "description": "This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" }, @@ -19028,7 +19079,7 @@ "ml.estimate_model_memory" ], "summary": "Makes an estimation of the memory usage for an anomaly detection job model", - "description": "It is based on analysis configuration details for the job and cardinality estimates for the fields it references.", + "description": "It is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" }, @@ -19091,7 +19142,7 @@ "ml.evaluate_data_frame" ], "summary": "Evaluates the data frame analytics for an annotated index", - "description": "The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" }, @@ -19153,7 +19204,7 @@ "ml.explain_data_frame_analytics" ], "summary": "Explains a data frame analytics config", - "description": "This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * 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. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "This 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.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" }, @@ -19173,7 +19224,7 @@ "ml.explain_data_frame_analytics" ], "summary": "Explains a data frame analytics config", - "description": "This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * 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. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "This 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.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" }, @@ -19195,7 +19246,7 @@ "ml.explain_data_frame_analytics" ], "summary": "Explains a data frame analytics config", - "description": "This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * 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. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "This 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.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" }, @@ -19220,7 +19271,7 @@ "ml.explain_data_frame_analytics" ], "summary": "Explains a data frame analytics config", - "description": "This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * 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. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "This 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.", "externalDocs": { "url": "http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html" }, @@ -19247,7 +19298,7 @@ "ml.flush_job" ], "summary": "Forces any buffered data to be processed by the job", - "description": "The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" }, @@ -19963,7 +20014,7 @@ "ml.get_data_frame_analytics" ], "summary": "Retrieves configuration information for data frame analytics jobs", - "description": "You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" }, @@ -20063,7 +20114,7 @@ "ml.get_datafeed_stats" ], "summary": "Retrieves usage information for datafeeds", - "description": "You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" }, @@ -20090,7 +20141,7 @@ "ml.get_datafeed_stats" ], "summary": "Retrieves usage information for datafeeds", - "description": "You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" }, @@ -20114,7 +20165,7 @@ "ml.get_datafeeds" ], "summary": "Retrieves configuration information for datafeeds", - "description": "You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" }, @@ -20168,7 +20219,7 @@ "ml.get_influencers" ], "summary": "Retrieves anomaly detection job results for one or more influencers", - "description": "Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration.", + "description": "Influencers 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html" }, @@ -20217,7 +20268,7 @@ "ml.get_influencers" ], "summary": "Retrieves anomaly detection job results for one or more influencers", - "description": "Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration.", + "description": "Influencers 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html" }, @@ -20317,7 +20368,7 @@ "ml.get_jobs" ], "summary": "Retrieves configuration information for anomaly detection jobs", - "description": "You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "description": "You 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 ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" }, @@ -20343,7 +20394,8 @@ "tags": [ "ml.get_memory_stats" ], - "summary": "Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM", + "summary": "Get information about how machine learning jobs and trained models are using memory,\n", + "description": "on each node, both within the JVM heap, and natively, outside of the JVM.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html" }, @@ -20372,7 +20424,8 @@ "tags": [ "ml.get_memory_stats" ], - "summary": "Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM", + "summary": "Get information about how machine learning jobs and trained models are using memory,\n", + "description": "on each node, both within the JVM heap, and natively, outside of the JVM.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html" }, @@ -20564,8 +20617,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "description": "The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span.", + "summary": "Retrieves overall bucket results that summarize the bucket results of\n", + "description": "multiple 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -20610,8 +20663,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "description": "The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span.", + "summary": "Retrieves overall bucket results that summarize the bucket results of\n", + "description": "multiple 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -20659,7 +20712,7 @@ "ml.get_records" ], "summary": "Retrieves anomaly records for an anomaly detection job", - "description": "Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors.", + "description": "Records 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html" }, @@ -20708,7 +20761,7 @@ "ml.get_records" ], "summary": "Retrieves anomaly records for an anomaly detection job", - "description": "Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors.", + "description": "Records 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html" }, @@ -20800,7 +20853,7 @@ "ml.get_trained_models_stats" ], "summary": "Retrieves usage information for trained models", - "description": "You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" }, @@ -20833,7 +20886,7 @@ "ml.get_trained_models_stats" ], "summary": "Retrieves usage information for trained models", - "description": "You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" }, @@ -20921,7 +20974,7 @@ "ml.info" ], "summary": "Returns defaults and limits used by machine learning", - "description": "This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html" }, @@ -20967,7 +21020,7 @@ "ml.open_job" ], "summary": "Open anomaly detection jobs", - "description": "An anomaly detection job must be opened in order for it to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.", + "description": "An anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" }, @@ -21041,8 +21094,8 @@ "tags": [ "ml.post_data" ], - "summary": "Sends data to an anomaly detection job for analysis.", - "description": "IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", + "summary": "Sends data to an anomaly detection job for analysis", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html" }, @@ -21269,7 +21322,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -21300,7 +21353,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -21333,7 +21386,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -21361,7 +21414,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -21469,7 +21522,7 @@ "ml.put_trained_model_vocabulary" ], "summary": "Creates a trained model vocabulary", - "description": "This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" }, @@ -21546,7 +21599,7 @@ "ml.reset_job" ], "summary": "Resets an anomaly detection job", - "description": "All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.", + "description": "All 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" }, @@ -21605,7 +21658,7 @@ "ml.revert_model_snapshot" ], "summary": "Reverts to a specific snapshot", - "description": "The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html" }, @@ -21687,8 +21740,8 @@ "tags": [ "ml.set_upgrade_mode" ], - "summary": "Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade", - "description": "When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.", + "summary": "Sets a cluster wide upgrade_mode setting that prepares machine learning\n", + "description": "indices 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html" }, @@ -21736,7 +21789,7 @@ "ml.start_data_frame_analytics" ], "summary": "Starts a data frame analytics job", - "description": "A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" }, @@ -21796,8 +21849,8 @@ "tags": [ "ml.start_datafeed" ], - "summary": "Starts one or more datafeeds.", - "description": "A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.. If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.. When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead.", + "summary": "Starts one or more datafeeds", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" }, @@ -22025,7 +22078,7 @@ "ml.stop_data_frame_analytics" ], "summary": "Stops one or more data frame analytics jobs", - "description": "A data frame analytics job can be started and stopped multiple times throughout its lifecycle.", + "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" }, @@ -22102,7 +22155,7 @@ "ml.stop_datafeed" ], "summary": "Stops one or more datafeeds", - "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.", + "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" }, @@ -22388,7 +22441,7 @@ "ml.update_datafeed" ], "summary": "Updates the properties of a datafeed", - "description": "You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" }, @@ -23036,6 +23089,7 @@ } } }, + "x-beta": true, "x-available-since": "8.6.0" } }, @@ -23045,7 +23099,7 @@ "ml.upgrade_job_snapshot" ], "summary": "Upgrades an anomaly detection model snapshot to the latest major version", - "description": "Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job.", + "description": "Over 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html" }, @@ -24023,6 +24077,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "7.16.0" } }, @@ -24032,7 +24087,7 @@ "nodes.get_repositories_metering_info" ], "summary": "You can use the cluster repositories metering API to retrieve repositories metering information in a cluster", - "description": "This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it won’t be present after node restarts.", + "description": "This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the\ninformation needed to compute aggregations over a period of time. Additionally, the information exposed by this\nAPI is volatile, meaning that it won’t be present after node restarts.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html" }, @@ -24062,6 +24117,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "7.16.0" } }, @@ -24769,8 +24825,8 @@ "tags": [ "open_point_in_time" ], - "summary": "A search request by default executes against the most recent visible data of the target indices, which is called point in time", - "description": "Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.", + "summary": "A search request by default executes against the most recent visible data of the target indices,\n", + "description": "which 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" }, @@ -25829,7 +25885,8 @@ "$ref": "#/components/responses/rollup.get_jobs#200" } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true }, "put": { "tags": [ @@ -25915,7 +25972,8 @@ } } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true }, "delete": { "tags": [ @@ -25965,7 +26023,8 @@ } } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/_rollup/job": { @@ -25983,7 +26042,8 @@ "$ref": "#/components/responses/rollup.get_jobs#200" } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/_rollup/data/{id}": { @@ -26006,7 +26066,8 @@ "$ref": "#/components/responses/rollup.get_rollup_caps#200" } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/_rollup/data": { @@ -26024,7 +26085,8 @@ "$ref": "#/components/responses/rollup.get_rollup_caps#200" } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/{index}/_rollup/data": { @@ -26065,7 +26127,8 @@ } } }, - "x-available-since": "6.4.0" + "x-available-since": "6.4.0", + "x-technical-preview": true } }, "/{index}/_rollup_search": { @@ -26097,7 +26160,8 @@ "$ref": "#/components/responses/rollup.rollup_search#200" } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true }, "post": { "tags": [ @@ -26127,7 +26191,8 @@ "$ref": "#/components/responses/rollup.rollup_search#200" } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/_rollup/job/{id}/_start": { @@ -26173,7 +26238,8 @@ } } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/_rollup/job/{id}/_stop": { @@ -26239,7 +26305,8 @@ } } }, - "x-available-since": "6.3.0" + "x-available-since": "6.3.0", + "x-technical-preview": true } }, "/_scripts/painless/_execute": { @@ -26260,6 +26327,7 @@ "$ref": "#/components/responses/scripts_painless_execute#200" } }, + "x-technical-preview": true, "x-available-since": "6.3.0" }, "post": { @@ -26279,6 +26347,7 @@ "$ref": "#/components/responses/scripts_painless_execute#200" } }, + "x-technical-preview": true, "x-available-since": "6.3.0" } }, @@ -26288,7 +26357,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -26441,7 +26510,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -26596,7 +26665,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -26752,7 +26821,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -26939,6 +27008,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" }, "put": { @@ -27003,6 +27073,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" }, "delete": { @@ -27039,6 +27110,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" } }, @@ -27062,6 +27134,7 @@ "$ref": "#/components/responses/search_application.get_behavioral_analytics#200" } }, + "x-technical-preview": true, "x-available-since": "8.8.0" }, "put": { @@ -27098,6 +27171,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.8.0" }, "delete": { @@ -27134,6 +27208,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.8.0" } }, @@ -27152,6 +27227,7 @@ "$ref": "#/components/responses/search_application.get_behavioral_analytics#200" } }, + "x-technical-preview": true, "x-available-since": "8.8.0" } }, @@ -27224,6 +27300,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" } }, @@ -27253,6 +27330,7 @@ "$ref": "#/components/responses/search_application.search#200" } }, + "x-beta": true, "x-available-since": "8.8.0" }, "post": { @@ -27280,6 +27358,7 @@ "$ref": "#/components/responses/search_application.search#200" } }, + "x-beta": true, "x-available-since": "8.8.0" } }, @@ -27821,7 +27900,8 @@ "$ref": "#/components/responses/searchable_snapshots.cache_stats#200" } }, - "x-available-since": "7.13.0" + "x-available-since": "7.13.0", + "x-technical-preview": true } }, "/_searchable_snapshots/{node_id}/cache/stats": { @@ -27847,7 +27927,8 @@ "$ref": "#/components/responses/searchable_snapshots.cache_stats#200" } }, - "x-available-since": "7.13.0" + "x-available-since": "7.13.0", + "x-technical-preview": true } }, "/_searchable_snapshots/cache/clear": { @@ -27882,7 +27963,8 @@ "$ref": "#/components/responses/searchable_snapshots.clear_cache#200" } }, - "x-available-since": "7.10.0" + "x-available-since": "7.10.0", + "x-technical-preview": true } }, "/{index}/_searchable_snapshots/cache/clear": { @@ -27920,7 +28002,8 @@ "$ref": "#/components/responses/searchable_snapshots.clear_cache#200" } }, - "x-available-since": "7.10.0" + "x-available-since": "7.10.0", + "x-technical-preview": true } }, "/_snapshot/{repository}/{snapshot}/_mount": { @@ -28150,7 +28233,7 @@ "security.authenticate" ], "summary": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user", - "description": "A 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. If the user cannot be authenticated, this API returns a 401 status code.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html" }, @@ -28839,7 +28922,7 @@ "security.get_api_key" ], "summary": "Retrieves information for one or more API keys", - "description": "NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "NOTE: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html" }, @@ -28956,7 +29039,7 @@ "security.create_api_key" ], "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -28981,7 +29064,7 @@ "security.create_api_key" ], "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -29006,7 +29089,7 @@ "security.invalidate_api_key" ], "summary": "Invalidates one or more API keys", - "description": "The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "The `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, i.e. an API key invalidates itself, specify its ID in the `ids` field.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html" }, @@ -30677,7 +30760,7 @@ "security.grant_api_key" ], "summary": "Creates an API key on behalf of another user", - "description": "This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. The 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. It is not possible to use this API to create an API key without that user’s credentials. The user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user.. This 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.. A successful grant API key API call 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.. By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "This API is similar to Create API keys, 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html" }, @@ -31462,7 +31545,7 @@ "security.update_api_key" ], "summary": "Updates attributes of an existing API key", - "description": "Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The 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. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify `role_descriptors` in the request, a call to this API might still change the 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. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.", + "description": "Users 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html" }, @@ -33959,6 +34042,7 @@ "$ref": "#/components/responses/tasks.cancel#200" } }, + "x-technical-preview": true, "x-available-since": "2.3.0" } }, @@ -33994,6 +34078,7 @@ "$ref": "#/components/responses/tasks.cancel#200" } }, + "x-technical-preview": true, "x-available-since": "2.3.0" } }, @@ -34070,6 +34155,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "5.0.0" } }, @@ -34190,6 +34276,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "2.3.0" } }, @@ -34853,8 +34940,8 @@ "tags": [ "transform.put_transform" ], - "summary": "Creates a transform.", - "description": "A 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 a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity.. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object.. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices.", + "summary": "Creates a transform", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html" }, @@ -35150,8 +35237,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35178,8 +35265,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35208,8 +35295,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35233,8 +35320,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -35261,7 +35348,7 @@ "transform.reset_transform" ], "summary": "Resets a transform", - "description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted.", + "description": "Before 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html" }, @@ -35309,8 +35396,8 @@ "tags": [ "transform.schedule_now_transform" ], - "summary": "Schedules now a transform.", - "description": "If you _schedule_now a transform, it will process the new data instantly, without waiting for the configured frequency interval. After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime.", + "summary": "Schedules now a transform", + "description": "If 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html" }, @@ -35358,8 +35445,8 @@ "tags": [ "transform.start_transform" ], - "summary": "Starts a transform.", - "description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform.. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—​with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.", + "summary": "Starts a transform", + "description": "When 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html" }, @@ -35505,8 +35592,8 @@ "tags": [ "transform.update_transform" ], - "summary": "Updates certain properties of a transform.", - "description": "All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.", + "summary": "Updates certain properties of a transform", + "description": "All 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html" }, @@ -35664,7 +35751,7 @@ "transform.upgrade_transforms" ], "summary": "Upgrades all transforms", - "description": "This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The 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.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html" }, @@ -40597,7 +40684,6 @@ }, "required": [ "found", - "_id", "_index", "took", "_version" @@ -56038,6 +56124,9 @@ "_source": { "type": "object" }, + "_rank": { + "type": "number" + }, "_seq_no": { "$ref": "#/components/schemas/_types:SequenceNumber" }, @@ -62329,6 +62418,7 @@ }, "prune": { "description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false", + "x-technical-preview": true, "x-available-since": "8.15.0", "type": "boolean" }, @@ -74682,6 +74772,7 @@ }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, "type": "boolean" }, "type": { @@ -75142,12 +75233,13 @@ }, "ef_construction": { "type": "number" + }, + "confidence_interval": { + "type": "number" } }, "required": [ - "type", - "m", - "ef_construction" + "type" ] }, "_types.mapping:FlattenedProperty": { @@ -75467,6 +75559,7 @@ }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, "type": "boolean" }, "type": { @@ -75755,6 +75848,7 @@ }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, "type": "boolean" } } @@ -80082,6 +80176,7 @@ }, "time_series_dimension": { "description": "Whether this field is used as a time series dimension.", + "x-technical-preview": true, "x-available-since": "8.0.0", "type": "boolean" }, @@ -80090,6 +80185,7 @@ }, "non_dimension_indices": { "description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.", + "x-technical-preview": true, "x-available-since": "8.0.0", "type": "array", "items": { @@ -80098,6 +80194,7 @@ }, "metric_conflicts_indices": { "description": "The list of indices where this field is present if these indices\ndon’t have the same `time_series_metric` value for this field.", + "x-technical-preview": true, "x-available-since": "8.0.0", "type": "array", "items": { @@ -91575,7 +91672,6 @@ } }, "required": [ - "_id", "_index" ] }, @@ -91593,7 +91689,6 @@ } }, "required": [ - "field_statistics", "terms" ] }, @@ -95276,7 +95371,7 @@ "description": "How much influence documents in individual result sets per query have over the final ranked result set", "type": "number" }, - "window_size": { + "rank_window_size": { "description": "Size of the individual result sets per query", "type": "number" } diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 2fc0519d11..f6232cb2a2 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -82,7 +82,7 @@ "async_search.delete" ], "summary": "Deletes an async search by identifier", - "description": "If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. If 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.", + "description": "If the search is still running, the search request will be 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -120,8 +120,8 @@ "tags": [ "async_search.status" ], - "summary": "Get async search status Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results", - "description": "If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get async search status\n", + "description": "Retrieves 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -160,7 +160,7 @@ "async_search.submit" ], "summary": "Runs a search request asynchronously", - "description": "When 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "When 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, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -322,7 +322,7 @@ "async_search.submit" ], "summary": "Runs a search request asynchronously", - "description": "When 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, hence partial results become available following the sort criteria that was requested. Warning: Async search does not support scroll nor search requests that only include the suggest section. By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "When 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, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html" }, @@ -689,7 +689,7 @@ "cat.aliases" ], "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases. IMPORTANT: 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": "The API does not return data stream aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -712,7 +712,7 @@ "cat.aliases" ], "summary": "Retrieves the cluster’s index aliases, including filter and routing information", - "description": "The API does not return data stream aliases. IMPORTANT: 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": "The API does not return data stream aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html" }, @@ -738,7 +738,7 @@ "cat.component_templates" ], "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: 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 component template API.", + "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -757,7 +757,7 @@ "cat.component_templates" ], "summary": "Returns information about component templates in a cluster", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: 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 component template API.", + "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html" }, @@ -781,7 +781,7 @@ "cat.count" ], "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: 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 count API.", + "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -799,7 +799,7 @@ "cat.count" ], "summary": "Provides quick access to a document count for a data stream, an index, or an entire cluster", - "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: 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 count API.", + "description": "NOTE: The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html" }, @@ -849,7 +849,7 @@ "cat.indices" ], "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: 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 API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These 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. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "description": "IMPORTANT: 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 index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -887,7 +887,7 @@ "cat.indices" ], "summary": "Returns high-level information about indices in a cluster, including backing indices for data streams", - "description": "IMPORTANT: 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 API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These 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. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.", + "description": "IMPORTANT: 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 index API.\nUse the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html" }, @@ -927,8 +927,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.", + "summary": "Returns configuration and usage information about data frame analytics jobs", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -963,8 +963,8 @@ "tags": [ "cat.ml_data_frame_analytics" ], - "summary": "Returns configuration and usage information about data frame analytics jobs.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.", + "summary": "Returns configuration and usage information about data frame analytics jobs", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html" }, @@ -1003,7 +1003,7 @@ "cat.ml_datafeeds" ], "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1036,7 +1036,7 @@ "cat.ml_datafeeds" ], "summary": "Returns configuration and usage information about datafeeds", - "description": "This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html" }, @@ -1072,7 +1072,7 @@ "cat.ml_jobs" ], "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1108,7 +1108,7 @@ "cat.ml_jobs" ], "summary": "Returns configuration and usage information for anomaly detection jobs", - "description": "This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.. IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html" }, @@ -1146,8 +1146,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.", + "summary": "Returns configuration and usage information about inference trained models", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1185,8 +1185,8 @@ "tags": [ "cat.ml_trained_models" ], - "summary": "Returns configuration and usage information about inference trained models.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.", + "summary": "Returns configuration and usage information about inference trained models", + "description": "IMPORTANT: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html" }, @@ -1227,8 +1227,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.", + "summary": "Returns configuration and usage information about transforms", + "description": "IMPORTANT: 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 transform statistics API.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -1266,8 +1266,8 @@ "tags": [ "cat.transforms" ], - "summary": "Returns configuration and usage information about transforms.", - "description": "IMPORTANT: cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.", + "summary": "Returns configuration and usage information about transforms", + "description": "IMPORTANT: 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 transform statistics API.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html" }, @@ -1563,7 +1563,7 @@ "cluster.put_component_template" ], "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.. You can use C-style `/* *\\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.", + "description": "Component 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1594,7 +1594,7 @@ "cluster.put_component_template" ], "summary": "Creates or updates a component template", - "description": "Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.. You can use C-style `/* *\\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.", + "description": "Component 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html" }, @@ -1866,6 +1866,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -1904,6 +1905,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "put": { @@ -1928,6 +1930,7 @@ "$ref": "#/components/responses/connector.put#200" } }, + "x-beta": true, "x-available-since": "8.12.0" }, "delete": { @@ -1975,6 +1978,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2087,6 +2091,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -2189,6 +2194,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "put": { @@ -2208,6 +2214,7 @@ "$ref": "#/components/responses/connector.put#200" } }, + "x-beta": true, "x-available-since": "8.12.0" }, "post": { @@ -2278,6 +2285,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2324,6 +2332,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2362,6 +2371,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "delete": { @@ -2398,6 +2408,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2493,6 +2504,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" }, "post": { @@ -2548,6 +2560,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2594,6 +2607,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -2672,6 +2686,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2739,6 +2754,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2810,6 +2826,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -2883,6 +2900,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -2947,6 +2965,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -3018,6 +3037,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -3085,6 +3105,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -3149,6 +3170,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -3213,6 +3235,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -3277,6 +3300,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -3341,6 +3365,7 @@ } } }, + "x-beta": true, "x-available-since": "8.12.0" } }, @@ -3405,6 +3430,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.12.0" } }, @@ -5887,7 +5913,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -5933,7 +5959,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -5981,7 +6007,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -6030,7 +6056,7 @@ "field_caps" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", - "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned as any other field that belongs to the `keyword` family.", + "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html" }, @@ -6404,7 +6430,7 @@ "indices.get" ], "summary": "Returns information about one or more indices", - "description": "For data streams, the API returns information about the stream’s backing indices.", + "description": "For data streams, the API returns information about the\nstream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html" }, @@ -6834,7 +6860,7 @@ "indices.create_data_stream" ], "summary": "Create a data stream", - "description": "Creates a data stream. You must have a matching index template with data stream enabled.", + "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -7560,7 +7586,7 @@ "indices.delete_index_template" ], "summary": "Delete an index template", - "description": "The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html" }, @@ -7996,7 +8022,7 @@ "indices.put_mapping" ], "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -8038,7 +8064,7 @@ "indices.put_mapping" ], "summary": "Adds new fields to an existing data stream or index", - "description": "You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html" }, @@ -8082,7 +8108,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8121,7 +8147,7 @@ "indices.put_settings" ], "summary": "Update index settings", - "description": "Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -8165,7 +8191,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8207,7 +8233,7 @@ "indices.put_settings" ], "summary": "Update index settings", - "description": "Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.", + "description": "Changes dynamic index settings in real time. For data streams, index setting\nchanges are applied to all backing indices by default.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html" }, @@ -8254,7 +8280,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8301,7 +8327,7 @@ "indices.get_settings" ], "summary": "Get index settings", - "description": "Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.", + "description": "Returns setting information for one or more indices. For data streams,\nreturns setting information for the stream’s backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html" }, @@ -8345,7 +8371,7 @@ "indices.migrate_to_data_stream" ], "summary": "Convert an index alias to a data stream", - "description": "Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.", + "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -8506,7 +8532,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8533,7 +8559,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8562,7 +8588,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -8592,7 +8618,7 @@ "indices.refresh" ], "summary": "Refresh an index", - "description": "A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html" }, @@ -9238,6 +9264,7 @@ "$ref": "#/components/responses/inference.get#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "put": { @@ -9262,6 +9289,7 @@ "$ref": "#/components/responses/inference.put#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "post": { @@ -9289,6 +9317,7 @@ "$ref": "#/components/responses/inference.inference#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "delete": { @@ -9316,6 +9345,7 @@ "$ref": "#/components/responses/inference.delete#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" } }, @@ -9342,6 +9372,7 @@ "$ref": "#/components/responses/inference.get#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "put": { @@ -9369,6 +9400,7 @@ "$ref": "#/components/responses/inference.put#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "post": { @@ -9399,6 +9431,7 @@ "$ref": "#/components/responses/inference.inference#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" }, "delete": { @@ -9429,6 +9462,7 @@ "$ref": "#/components/responses/inference.delete#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" } }, @@ -9447,6 +9481,7 @@ "$ref": "#/components/responses/inference.get#200" } }, + "x-technical-preview": true, "x-available-since": "8.11.0" } }, @@ -9738,7 +9773,7 @@ "ingest.processor_grok" ], "summary": "Extracts structured fields out of a single text field within a document", - "description": "You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" }, @@ -9881,7 +9916,7 @@ "license.get" ], "summary": "Get license information", - "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html" }, @@ -10241,7 +10276,7 @@ "ml.close_job" ], "summary": "Close anomaly detection jobs", - "description": "A 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. When 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. If 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. When a datafeed that has a specified end date stops, it automatically closes its associated job.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html" }, @@ -10689,7 +10724,7 @@ "ml.get_data_frame_analytics" ], "summary": "Retrieves configuration information for data frame analytics jobs", - "description": "You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" }, @@ -10723,7 +10758,7 @@ "ml.put_data_frame_analytics" ], "summary": "Instantiates a data frame analytics job", - "description": "This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.", + "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html" }, @@ -10921,7 +10956,7 @@ "ml.get_datafeeds" ], "summary": "Retrieves configuration information for datafeeds", - "description": "You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" }, @@ -10949,7 +10984,7 @@ "ml.put_datafeed" ], "summary": "Instantiates a datafeed", - "description": "Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", + "description": "Datafeeds 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html" }, @@ -11231,7 +11266,7 @@ "ml.put_filter" ], "summary": "Instantiates a filter", - "description": "A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html" }, @@ -11310,7 +11345,7 @@ "ml.delete_filter" ], "summary": "Deletes a filter", - "description": "If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter.", + "description": "If 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html" }, @@ -11349,7 +11384,7 @@ "ml.get_jobs" ], "summary": "Retrieves configuration information for anomaly detection jobs", - "description": "You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "description": "You 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 ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" }, @@ -11563,7 +11598,7 @@ "ml.delete_job" ], "summary": "Delete an anomaly detection job", - "description": "All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.", + "description": "All 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html" }, @@ -11783,7 +11818,8 @@ "tags": [ "ml.delete_trained_model" ], - "summary": "Deletes an existing trained inference model that is currently not referenced by an ingest pipeline", + "summary": "Deletes an existing trained inference model that is currently not referenced\n", + "description": "by an ingest pipeline.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html" }, @@ -11832,7 +11868,7 @@ "ml.put_trained_model_alias" ], "summary": "Creates or updates a trained model alias", - "description": "A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning.", + "description": "A trained model alias is a logical\nname used to reference a single trained model.\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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html" }, @@ -11890,7 +11926,7 @@ "ml.delete_trained_model_alias" ], "summary": "Deletes a trained model alias", - "description": "This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html" }, @@ -11940,7 +11976,7 @@ "ml.estimate_model_memory" ], "summary": "Makes an estimation of the memory usage for an anomaly detection job model", - "description": "It is based on analysis configuration details for the job and cardinality estimates for the fields it references.", + "description": "It is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html" }, @@ -12003,7 +12039,7 @@ "ml.evaluate_data_frame" ], "summary": "Evaluates the data frame analytics for an annotated index", - "description": "The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html" }, @@ -12065,7 +12101,7 @@ "ml.flush_job" ], "summary": "Forces any buffered data to be processed by the job", - "description": "The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.", + "description": "The 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html" }, @@ -12421,7 +12457,7 @@ "ml.get_data_frame_analytics" ], "summary": "Retrieves configuration information for data frame analytics jobs", - "description": "You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html" }, @@ -12521,7 +12557,7 @@ "ml.get_datafeed_stats" ], "summary": "Retrieves usage information for datafeeds", - "description": "You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" }, @@ -12548,7 +12584,7 @@ "ml.get_datafeed_stats" ], "summary": "Retrieves usage information for datafeeds", - "description": "You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html" }, @@ -12572,7 +12608,7 @@ "ml.get_datafeeds" ], "summary": "Retrieves configuration information for datafeeds", - "description": "You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html" }, @@ -12675,7 +12711,7 @@ "ml.get_jobs" ], "summary": "Retrieves configuration information for anomaly detection jobs", - "description": "You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``.", + "description": "You 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 ``.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html" }, @@ -12701,8 +12737,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "description": "The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span.", + "summary": "Retrieves overall bucket results that summarize the bucket results of\n", + "description": "multiple 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -12747,8 +12783,8 @@ "tags": [ "ml.get_overall_buckets" ], - "summary": "Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.", - "description": "The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span.", + "summary": "Retrieves overall bucket results that summarize the bucket results of\n", + "description": "multiple 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html" }, @@ -12837,7 +12873,7 @@ "ml.get_trained_models_stats" ], "summary": "Retrieves usage information for trained models", - "description": "You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" }, @@ -12870,7 +12906,7 @@ "ml.get_trained_models_stats" ], "summary": "Retrieves usage information for trained models", - "description": "You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html" }, @@ -12958,7 +12994,7 @@ "ml.open_job" ], "summary": "Open anomaly detection jobs", - "description": "An anomaly detection job must be opened in order for it to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.", + "description": "An anomaly detection job must be opened in order for it to be ready to\nreceive and analyze data. It can be opened and closed multiple times\nthroughout 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html" }, @@ -13123,7 +13159,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -13154,7 +13190,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -13187,7 +13223,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -13215,7 +13251,7 @@ "ml.preview_datafeed" ], "summary": "Previews a datafeed", - "description": "This API returns the first \"page\" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html" }, @@ -13323,7 +13359,7 @@ "ml.put_trained_model_vocabulary" ], "summary": "Creates a trained model vocabulary", - "description": "This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", + "description": "This 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html" }, @@ -13400,7 +13436,7 @@ "ml.reset_job" ], "summary": "Resets an anomaly detection job", - "description": "All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.", + "description": "All 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html" }, @@ -13459,7 +13495,7 @@ "ml.start_data_frame_analytics" ], "summary": "Starts a data frame analytics job", - "description": "A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html" }, @@ -13519,8 +13555,8 @@ "tags": [ "ml.start_datafeed" ], - "summary": "Starts one or more datafeeds.", - "description": "A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.. If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.. When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead.", + "summary": "Starts one or more datafeeds", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html" }, @@ -13738,7 +13774,7 @@ "ml.stop_data_frame_analytics" ], "summary": "Stops one or more data frame analytics jobs", - "description": "A data frame analytics job can be started and stopped multiple times throughout its lifecycle.", + "description": "A data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html" }, @@ -13815,7 +13851,7 @@ "ml.stop_datafeed" ], "summary": "Stops one or more datafeeds", - "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.", + "description": "A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html" }, @@ -14101,7 +14137,7 @@ "ml.update_datafeed" ], "summary": "Updates the properties of a datafeed", - "description": "You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.", + "description": "You 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html" }, @@ -14668,6 +14704,7 @@ } } }, + "x-beta": true, "x-available-since": "8.6.0" } }, @@ -15302,8 +15339,8 @@ "tags": [ "open_point_in_time" ], - "summary": "A search request by default executes against the most recent visible data of the target indices, which is called point in time", - "description": "Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.", + "summary": "A search request by default executes against the most recent visible data of the target indices,\n", + "description": "which 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" }, @@ -16301,6 +16338,7 @@ "$ref": "#/components/responses/scripts_painless_execute#200" } }, + "x-technical-preview": true, "x-available-since": "6.3.0" }, "post": { @@ -16320,6 +16358,7 @@ "$ref": "#/components/responses/scripts_painless_execute#200" } }, + "x-technical-preview": true, "x-available-since": "6.3.0" } }, @@ -16329,7 +16368,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -16479,7 +16518,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -16631,7 +16670,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -16784,7 +16823,7 @@ "search" ], "summary": "Returns search hits that match the query defined in the request", - "description": "You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.", + "description": "You can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html" }, @@ -16968,6 +17007,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" }, "put": { @@ -17032,6 +17072,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" }, "delete": { @@ -17068,6 +17109,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" } }, @@ -17091,6 +17133,7 @@ "$ref": "#/components/responses/search_application.get_behavioral_analytics#200" } }, + "x-technical-preview": true, "x-available-since": "8.8.0" }, "put": { @@ -17127,6 +17170,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.8.0" }, "delete": { @@ -17163,6 +17207,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "8.8.0" } }, @@ -17181,6 +17226,7 @@ "$ref": "#/components/responses/search_application.get_behavioral_analytics#200" } }, + "x-technical-preview": true, "x-available-since": "8.8.0" } }, @@ -17253,6 +17299,7 @@ } } }, + "x-beta": true, "x-available-since": "8.8.0" } }, @@ -17282,6 +17329,7 @@ "$ref": "#/components/responses/search_application.search#200" } }, + "x-beta": true, "x-available-since": "8.8.0" }, "post": { @@ -17309,6 +17357,7 @@ "$ref": "#/components/responses/search_application.search#200" } }, + "x-beta": true, "x-available-since": "8.8.0" } }, @@ -17686,7 +17735,7 @@ "security.authenticate" ], "summary": "Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user", - "description": "A 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. If the user cannot be authenticated, this API returns a 401 status code.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html" }, @@ -17775,7 +17824,7 @@ "security.get_api_key" ], "summary": "Retrieves information for one or more API keys", - "description": "NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "NOTE: 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html" }, @@ -17892,7 +17941,7 @@ "security.create_api_key" ], "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -17917,7 +17966,7 @@ "security.create_api_key" ], "summary": "Creates an API key for access without requiring basic authentication", - "description": "A 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. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html" }, @@ -17942,7 +17991,7 @@ "security.invalidate_api_key" ], "summary": "Invalidates one or more API keys", - "description": "The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "The `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, i.e. an API key invalidates itself, specify its ID in the `ids` field.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html" }, @@ -18186,7 +18235,7 @@ "security.update_api_key" ], "summary": "Updates attributes of an existing API key", - "description": "Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The 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. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify `role_descriptors` in the request, a call to this API might still change the 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. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.", + "description": "Users 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html" }, @@ -19094,6 +19143,7 @@ } } }, + "x-technical-preview": true, "x-available-since": "5.0.0" } }, @@ -19421,8 +19471,8 @@ "tags": [ "transform.put_transform" ], - "summary": "Creates a transform.", - "description": "A 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 a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity.. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object.. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices.", + "summary": "Creates a transform", + "description": "A 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html" }, @@ -19718,8 +19768,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19746,8 +19796,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19776,8 +19826,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19801,8 +19851,8 @@ "tags": [ "transform.preview_transform" ], - "summary": "Previews a transform.", - "description": "It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.", + "summary": "Previews a transform", + "description": "It 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html" }, @@ -19829,7 +19879,7 @@ "transform.reset_transform" ], "summary": "Resets a transform", - "description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted.", + "description": "Before 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html" }, @@ -19877,8 +19927,8 @@ "tags": [ "transform.schedule_now_transform" ], - "summary": "Schedules now a transform.", - "description": "If you _schedule_now a transform, it will process the new data instantly, without waiting for the configured frequency interval. After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime.", + "summary": "Schedules now a transform", + "description": "If 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html" }, @@ -19926,8 +19976,8 @@ "tags": [ "transform.start_transform" ], - "summary": "Starts a transform.", - "description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform.. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—​with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.", + "summary": "Starts a transform", + "description": "When 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html" }, @@ -20073,8 +20123,8 @@ "tags": [ "transform.update_transform" ], - "summary": "Updates certain properties of a transform.", - "description": "All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.", + "summary": "Updates certain properties of a transform", + "description": "All 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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html" }, @@ -22556,7 +22606,6 @@ }, "required": [ "found", - "_id", "_index", "took", "_version" @@ -32711,6 +32760,9 @@ "_source": { "type": "object" }, + "_rank": { + "type": "number" + }, "_seq_no": { "$ref": "#/components/schemas/_types:SequenceNumber" }, @@ -39002,6 +39054,7 @@ }, "prune": { "description": "Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.\nIf prune is true but the pruning_config is not specified, pruning will occur but default values will be used.\nDefault: false", + "x-technical-preview": true, "x-available-since": "8.15.0", "type": "boolean" }, @@ -48976,6 +49029,7 @@ }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, "type": "boolean" }, "type": { @@ -49436,12 +49490,13 @@ }, "ef_construction": { "type": "number" + }, + "confidence_interval": { + "type": "number" } }, "required": [ - "type", - "m", - "ef_construction" + "type" ] }, "_types.mapping:FlattenedProperty": { @@ -49761,6 +49816,7 @@ }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, "type": "boolean" }, "type": { @@ -50049,6 +50105,7 @@ }, "time_series_dimension": { "description": "For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false.", + "x-technical-preview": true, "type": "boolean" } } @@ -52347,6 +52404,7 @@ }, "time_series_dimension": { "description": "Whether this field is used as a time series dimension.", + "x-technical-preview": true, "x-available-since": "8.0.0", "type": "boolean" }, @@ -52355,6 +52413,7 @@ }, "non_dimension_indices": { "description": "If this list is present in response then some indices have the\nfield marked as a dimension and other indices, the ones in this list, do not.", + "x-technical-preview": true, "x-available-since": "8.0.0", "type": "array", "items": { @@ -52363,6 +52422,7 @@ }, "metric_conflicts_indices": { "description": "The list of indices where this field is present if these indices\ndon’t have the same `time_series_metric` value for this field.", + "x-technical-preview": true, "x-available-since": "8.0.0", "type": "array", "items": { @@ -60159,7 +60219,6 @@ } }, "required": [ - "_id", "_index" ] }, @@ -60177,7 +60236,6 @@ } }, "required": [ - "field_statistics", "terms" ] }, @@ -60803,7 +60861,7 @@ "description": "How much influence documents in individual result sets per query have over the final ranked result set", "type": "number" }, - "window_size": { + "rank_window_size": { "description": "Size of the individual result sets per query", "type": "number" } diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index f3d08935b2..15d3f9ab33 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -2960,7 +2960,7 @@ "stability": "stable" } }, - "description": "Creates a data stream.\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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.create_data_stream", "privileges": { @@ -3000,7 +3000,7 @@ "stability": "stable" } }, - "description": "Retrieves statistics for one or more data streams.", + "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", "privileges": { @@ -3120,7 +3120,7 @@ "stability": "stable" } }, - "description": "Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle", + "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", "name": "indices.delete_data_lifecycle", "request": { @@ -3155,7 +3155,7 @@ "stability": "stable" } }, - "description": "Deletes one or more data streams and their backing indices.", + "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", "privileges": { @@ -3471,7 +3471,7 @@ "stability": "stable" } }, - "description": "Retrieves 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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { @@ -3506,7 +3506,7 @@ "stability": "stable" } }, - "description": "Retrieves information about one or more data streams.", + "description": "Get data streams.\nRetrieves information about one or more data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.get_data_stream", "privileges": { @@ -3698,7 +3698,7 @@ "stability": "stable" } }, - "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.migrate_to_data_stream", "privileges": { @@ -3738,7 +3738,7 @@ "stability": "stable" } }, - "description": "Performs one or more data stream modification actions in a single atomic operation.", + "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.modify_data_stream", "request": { @@ -3821,7 +3821,7 @@ "stability": "stable" } }, - "description": "Update the data lifecycle of the specified data streams.", + "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "name": "indices.put_data_lifecycle", "request": { @@ -20309,7 +20309,7 @@ "body": { "kind": "no_body" }, - "description": "Creates a data stream.\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", @@ -20336,7 +20336,7 @@ } ], "query": [], - "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L23-L43" + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L23-L44" }, { "body": { @@ -20363,7 +20363,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves statistics for one or more data streams.", + "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -20404,7 +20404,7 @@ } } ], - "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L47" + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L48" }, { "body": { @@ -20714,7 +20714,7 @@ "body": { "kind": "no_body" }, - "description": "Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle", + "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -20778,7 +20778,7 @@ } } ], - "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L39" + "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L40" }, { "body": { @@ -20805,7 +20805,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes one or more data streams and their backing indices.", + "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -20846,7 +20846,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L23-L44" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L23-L45" }, { "body": { @@ -21684,7 +21684,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves 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", @@ -21738,7 +21738,7 @@ } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L23-L52" + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L23-L53" }, { "body": { @@ -21774,7 +21774,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about one or more data streams.", + "description": "Get data streams.\nRetrieves information about one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -21837,7 +21837,7 @@ } } ], - "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L23-L53" + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L23-L54" }, { "body": { @@ -22298,7 +22298,7 @@ "body": { "kind": "no_body" }, - "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "inherits": { "type": { "name": "RequestBase", @@ -22325,7 +22325,7 @@ } ], "query": [], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L23-L44" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L23-L45" }, { "body": { @@ -22369,7 +22369,7 @@ } ] }, - "description": "Performs one or more data stream modification actions in a single atomic operation.", + "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", "inherits": { "type": { "name": "RequestBase", @@ -22383,7 +22383,7 @@ }, "path": [], "query": [], - "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L36" + "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L37" }, { "body": { @@ -22593,7 +22593,7 @@ } ] }, - "description": "Update the data lifecycle of the specified data streams.", + "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "inherits": { "type": { "name": "RequestBase", @@ -22660,7 +22660,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L75" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L76" }, { "body": { @@ -42105,7 +42105,7 @@ }, { "name": "_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -51302,7 +51302,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L106-L140" + "specLocation": "_global/search/_types/hits.ts#L107-L141" }, { "kind": "type_alias", @@ -66917,7 +66917,7 @@ "name": "TrackHits", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/hits.ts#L142-L150", + "specLocation": "_global/search/_types/hits.ts#L143-L151", "type": { "items": [ { @@ -69041,7 +69041,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L66-L72" + "specLocation": "_global/search/_types/hits.ts#L67-L73" }, { "kind": "interface", @@ -69073,7 +69073,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L94-L97" + "specLocation": "_global/search/_types/hits.ts#L95-L98" }, { "kind": "enum", @@ -69091,7 +69091,7 @@ "name": "TotalHitsRelation", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/hits.ts#L99-L104" + "specLocation": "_global/search/_types/hits.ts#L100-L105" }, { "generics": [ @@ -69336,6 +69336,17 @@ } } }, + { + "name": "_rank", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { "name": "_seq_no", "required": false, @@ -69381,7 +69392,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L40-L64" + "specLocation": "_global/search/_types/hits.ts#L40-L65" }, { "kind": "interface", @@ -69499,7 +69510,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L84-L86" + "specLocation": "_global/search/_types/hits.ts#L85-L87" }, { "kind": "interface", @@ -69542,7 +69553,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L88-L92" + "specLocation": "_global/search/_types/hits.ts#L89-L93" }, { "description": "The aggregation name as returned from the server. Depending whether typed_keys is specified this could come back\nin the form of `name#type` instead of simply `name`", @@ -84605,7 +84616,7 @@ }, { "name": "m", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -84616,7 +84627,7 @@ }, { "name": "ef_construction", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -84624,9 +84635,20 @@ "namespace": "_types" } } + }, + { + "name": "confidence_interval", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } } ], - "specLocation": "_types/mapping/DenseVectorIndexOptions.ts#L22-L26" + "specLocation": "_types/mapping/DenseVectorIndexOptions.ts#L22-L27" }, { "inherits": { @@ -110742,7 +110764,7 @@ "specLocation": "indices/_types/AliasDefinition.ts#L22-L54" }, { - "description": "Data lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", + "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", "kind": "interface", "name": { "name": "DataStreamLifecycleWithRollover", @@ -111073,7 +111095,7 @@ "stability": "stable" } }, - "description": "Data lifecycle applicable if this is a data stream.", + "description": "Data stream lifecycle applicable if this is a data stream.", "name": "lifecycle", "required": false, "type": { @@ -111172,7 +111194,7 @@ "specLocation": "indices/_types/Alias.ts#L23-L53" }, { - "description": "Data lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", + "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", "kind": "interface", "name": { "name": "DataStreamLifecycle", @@ -114656,7 +114678,7 @@ "stability": "stable" } }, - "description": "Contains the configuration for the data lifecycle management of this data stream.", + "description": "Contains the configuration for the data stream lifecycle of this data stream.", "name": "lifecycle", "required": false, "type": { @@ -131573,7 +131595,7 @@ "properties": [ { "name": "_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -131671,7 +131693,7 @@ "properties": [ { "name": "field_statistics", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -133097,7 +133119,7 @@ }, { "description": "Size of the individual result sets per query", - "name": "window_size", + "name": "rank_window_size", "required": false, "type": { "kind": "instance_of", diff --git a/output/schema/schema.json b/output/schema/schema.json index a609f075df..e51c2e9ce1 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -28708,7 +28708,7 @@ "properties": [ { "name": "_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -35118,6 +35118,17 @@ } } }, + { + "name": "_rank", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, { "name": "_seq_no", "required": false, @@ -35163,7 +35174,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L40-L64" + "specLocation": "_global/search/_types/hits.ts#L40-L65" }, { "generics": [ @@ -35249,7 +35260,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L66-L72" + "specLocation": "_global/search/_types/hits.ts#L67-L73" }, { "kind": "interface", @@ -35456,7 +35467,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L106-L140" + "specLocation": "_global/search/_types/hits.ts#L107-L141" }, { "kind": "interface", @@ -35482,7 +35493,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L84-L86" + "specLocation": "_global/search/_types/hits.ts#L85-L87" }, { "kind": "interface", @@ -35631,7 +35642,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L88-L92" + "specLocation": "_global/search/_types/hits.ts#L89-L93" }, { "inherits": { @@ -37464,7 +37475,7 @@ } } ], - "specLocation": "_global/search/_types/hits.ts#L94-L97" + "specLocation": "_global/search/_types/hits.ts#L95-L98" }, { "kind": "enum", @@ -37482,7 +37493,7 @@ "name": "TotalHitsRelation", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/hits.ts#L99-L104" + "specLocation": "_global/search/_types/hits.ts#L100-L105" }, { "codegenNames": [ @@ -37495,7 +37506,7 @@ "name": "TrackHits", "namespace": "_global.search._types" }, - "specLocation": "_global/search/_types/hits.ts#L142-L150", + "specLocation": "_global/search/_types/hits.ts#L143-L151", "type": { "items": [ { @@ -39268,7 +39279,7 @@ }, { "name": "_id", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -39418,7 +39429,7 @@ "properties": [ { "name": "field_statistics", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -46354,7 +46365,7 @@ }, { "description": "Size of the individual result sets per query", - "name": "window_size", + "name": "rank_window_size", "required": false, "type": { "kind": "instance_of", @@ -68884,7 +68895,7 @@ }, { "name": "m", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -68895,7 +68906,7 @@ }, { "name": "ef_construction", - "required": true, + "required": false, "type": { "kind": "instance_of", "type": { @@ -68903,9 +68914,20 @@ "namespace": "_types" } } + }, + { + "name": "confidence_interval", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } } ], - "specLocation": "_types/mapping/DenseVectorIndexOptions.ts#L22-L26" + "specLocation": "_types/mapping/DenseVectorIndexOptions.ts#L22-L27" }, { "inherits": { diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 7fab2f84d4..e128bc14cf 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -860,7 +860,7 @@ export interface MtermvectorsResponse { } export interface MtermvectorsTermVectorsResult { - _id: Id + _id?: Id _index: IndexName _version?: VersionNumber took?: long @@ -1469,6 +1469,7 @@ export interface SearchHit { _node?: string _routing?: string _source?: TDocument + _rank?: integer _seq_no?: SequenceNumber _primary_term?: long _version?: VersionNumber @@ -1889,7 +1890,7 @@ export interface TermvectorsRequest extends RequestBase { export interface TermvectorsResponse { found: boolean - _id: Id + _id?: Id _index: IndexName term_vectors?: Record took: long @@ -1905,7 +1906,7 @@ export interface TermvectorsTerm { } export interface TermvectorsTermVector { - field_statistics: TermvectorsFieldStatistics + field_statistics?: TermvectorsFieldStatistics terms: Record } @@ -2586,7 +2587,7 @@ export type Routing = string export interface RrfRank { rank_constant?: long - window_size?: long + rank_window_size?: long } export type ScalarValue = long | double | string | boolean | null @@ -4996,8 +4997,9 @@ export interface MappingDateRangeProperty extends MappingRangePropertyBase { export interface MappingDenseVectorIndexOptions { type: string - m: integer - ef_construction: integer + m?: integer + ef_construction?: integer + confidence_interval?: float } export interface MappingDenseVectorProperty extends MappingPropertyBase { diff --git a/specification/_global/mtermvectors/types.ts b/specification/_global/mtermvectors/types.ts index 51d5360c03..680275470f 100644 --- a/specification/_global/mtermvectors/types.ts +++ b/specification/_global/mtermvectors/types.ts @@ -94,7 +94,7 @@ export class Operation { } export class TermVectorsResult { - _id: Id + _id?: Id _index: IndexName _version?: VersionNumber took?: long diff --git a/specification/_global/search/_types/hits.ts b/specification/_global/search/_types/hits.ts index a4300dd5c1..c98adbdd69 100644 --- a/specification/_global/search/_types/hits.ts +++ b/specification/_global/search/_types/hits.ts @@ -57,6 +57,7 @@ export class Hit { _node?: string _routing?: string _source?: TDocument + _rank?: integer _seq_no?: SequenceNumber _primary_term?: long _version?: VersionNumber diff --git a/specification/_global/termvectors/TermVectorsResponse.ts b/specification/_global/termvectors/TermVectorsResponse.ts index d2c22588a9..395c0a699d 100644 --- a/specification/_global/termvectors/TermVectorsResponse.ts +++ b/specification/_global/termvectors/TermVectorsResponse.ts @@ -25,7 +25,7 @@ import { TermVector } from './types' export class Response { body: { found: boolean - _id: Id + _id?: Id _index: IndexName term_vectors?: Dictionary took: long diff --git a/specification/_global/termvectors/types.ts b/specification/_global/termvectors/types.ts index f178c25b74..f92d66061a 100644 --- a/specification/_global/termvectors/types.ts +++ b/specification/_global/termvectors/types.ts @@ -21,7 +21,7 @@ import { Dictionary } from '@spec_utils/Dictionary' import { double, integer, long } from '@_types/Numeric' export class TermVector { - field_statistics: FieldStatistics + field_statistics?: FieldStatistics terms: Dictionary } diff --git a/specification/_types/Rank.ts b/specification/_types/Rank.ts index c19e3f5de4..c24bbf11da 100644 --- a/specification/_types/Rank.ts +++ b/specification/_types/Rank.ts @@ -33,5 +33,5 @@ export class RrfRank extends RankBase { /** How much influence documents in individual result sets per query have over the final ranked result set */ rank_constant?: long /** Size of the individual result sets per query */ - window_size?: long + rank_window_size?: long } diff --git a/specification/_types/mapping/DenseVectorIndexOptions.ts b/specification/_types/mapping/DenseVectorIndexOptions.ts index 9876f53942..dd05a7ccd1 100644 --- a/specification/_types/mapping/DenseVectorIndexOptions.ts +++ b/specification/_types/mapping/DenseVectorIndexOptions.ts @@ -17,10 +17,11 @@ * under the License. */ -import { integer } from '@_types/Numeric' +import { float, integer } from '@_types/Numeric' export class DenseVectorIndexOptions { type: string - m: integer - ef_construction: integer + m?: integer + ef_construction?: integer + confidence_interval?: float }