diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 0e8ad68982..07983ea007 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -24306,7 +24306,7 @@ "tags": [ "ml data frame" ], - "summary": "Get data frame analytics jobs usage info", + "summary": "Get data frame analytics job stats", "operationId": "ml-get-data-frame-analytics-stats", "parameters": [ { @@ -24335,7 +24335,7 @@ "tags": [ "ml data frame" ], - "summary": "Get data frame analytics jobs usage info", + "summary": "Get data frame analytics job stats", "operationId": "ml-get-data-frame-analytics-stats-1", "parameters": [ { @@ -24367,7 +24367,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get datafeeds usage info", + "summary": "Get datafeed stats", "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.", "operationId": "ml-get-datafeed-stats", "parameters": [ @@ -24391,7 +24391,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get datafeeds usage info", + "summary": "Get datafeed stats", "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.", "operationId": "ml-get-datafeed-stats-1", "parameters": [ @@ -24554,7 +24554,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get anomaly detection jobs usage info", + "summary": "Get anomaly detection job stats", "operationId": "ml-get-job-stats", "parameters": [ { @@ -24574,7 +24574,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get anomaly detection jobs usage info", + "summary": "Get anomaly detection job stats", "operationId": "ml-get-job-stats-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 0d2cc11174..8659ff3428 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -14344,7 +14344,7 @@ "tags": [ "ml data frame" ], - "summary": "Get data frame analytics jobs usage info", + "summary": "Get data frame analytics job stats", "operationId": "ml-get-data-frame-analytics-stats", "parameters": [ { @@ -14373,7 +14373,7 @@ "tags": [ "ml data frame" ], - "summary": "Get data frame analytics jobs usage info", + "summary": "Get data frame analytics job stats", "operationId": "ml-get-data-frame-analytics-stats-1", "parameters": [ { @@ -14405,7 +14405,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get datafeeds usage info", + "summary": "Get datafeed stats", "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.", "operationId": "ml-get-datafeed-stats", "parameters": [ @@ -14429,7 +14429,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get datafeeds usage info", + "summary": "Get datafeed stats", "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.", "operationId": "ml-get-datafeed-stats-1", "parameters": [ @@ -14498,7 +14498,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get anomaly detection jobs usage info", + "summary": "Get anomaly detection job stats", "operationId": "ml-get-job-stats", "parameters": [ { @@ -14518,7 +14518,7 @@ "tags": [ "ml anomaly" ], - "summary": "Get anomaly detection jobs usage info", + "summary": "Get anomaly detection job stats", "operationId": "ml-get-job-stats-1", "parameters": [ { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index 719a0114c1..f4d13b8984 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -6636,7 +6636,7 @@ "stability": "stable" } }, - "description": "Get data frame analytics jobs usage info.", + "description": "Get data frame analytics job stats.", "docId": "get-dfanalytics-stats", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats", @@ -6684,7 +6684,7 @@ "stability": "stable" } }, - "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Get datafeed stats.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats", @@ -6828,7 +6828,7 @@ "stability": "stable" } }, - "description": "Get anomaly detection jobs usage info.", + "description": "Get anomaly detection job stats.", "docId": "ml-get-job-stats", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-job-stats", @@ -32983,7 +32983,7 @@ "body": { "kind": "no_body" }, - "description": "Get data frame analytics jobs usage info.", + "description": "Get data frame analytics job stats.", "inherits": { "type": { "name": "RequestBase", @@ -33111,7 +33111,7 @@ "body": { "kind": "no_body" }, - "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Get datafeed stats.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -33399,7 +33399,7 @@ "body": { "kind": "no_body" }, - "description": "Get anomaly detection jobs usage info.", + "description": "Get anomaly detection job stats.", "inherits": { "type": { "name": "RequestBase", @@ -42001,6 +42001,8 @@ "aggs" ], "description": "Defines the aggregations that are run as part of the search request.", + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations", "name": "aggregations", "required": false, "type": { @@ -42081,6 +42083,8 @@ }, { "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "extDocId": "search-highlight", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting", "name": "highlight", "required": false, "type": { @@ -42273,6 +42277,8 @@ } }, "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "extDocId": "search-retrievers", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers", "name": "retriever", "required": false, "type": { @@ -43142,7 +43148,7 @@ } } ], - "specLocation": "_global/search/SearchRequest.ts#L53-L584" + "specLocation": "_global/search/SearchRequest.ts#L53-L588" }, { "body": { @@ -52612,6 +52618,8 @@ "aggs" ], "description": "Defines the aggregations that are run as part of the search request.", + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations", "name": "aggregations", "required": false, "type": { @@ -52692,6 +52700,8 @@ }, { "description": "Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.", + "extDocId": "search-highlight", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting", "name": "highlight", "required": false, "type": { @@ -52884,6 +52894,8 @@ } }, "description": "A retriever is a specification to describe top documents returned from a search.\nA retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.", + "extDocId": "search-retrievers", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers", "name": "retriever", "required": false, "type": { @@ -53130,7 +53142,7 @@ } } ], - "specLocation": "_global/search/_types/SearchRequestBody.ts#L42-L238" + "specLocation": "_global/search/_types/SearchRequestBody.ts#L42-L242" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index dfd2ddc09e..1602a62c6d 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -12485,7 +12485,7 @@ "stability": "stable" } }, - "description": "Get data frame analytics jobs usage info.", + "description": "Get data frame analytics job stats.", "docId": "get-dfanalytics-stats", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats", @@ -12533,7 +12533,7 @@ "stability": "stable" } }, - "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Get datafeed stats.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats", @@ -12723,7 +12723,7 @@ "stability": "stable" } }, - "description": "Get anomaly detection jobs usage info.", + "description": "Get anomaly detection job stats.", "docId": "ml-get-job-stats", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-job-stats", @@ -181483,7 +181483,7 @@ "body": { "kind": "no_body" }, - "description": "Get data frame analytics jobs usage info.", + "description": "Get data frame analytics job stats.", "inherits": { "type": { "name": "RequestBase", @@ -181611,7 +181611,7 @@ "body": { "kind": "no_body" }, - "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", + "description": "Get datafeed stats.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "inherits": { "type": { "name": "RequestBase", @@ -182092,7 +182092,7 @@ "body": { "kind": "no_body" }, - "description": "Get anomaly detection jobs usage info.", + "description": "Get anomaly detection job stats.", "inherits": { "type": { "name": "RequestBase", diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts index 5e64b439c9..0389c50eaa 100644 --- a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts +++ b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts @@ -22,7 +22,7 @@ import { Id } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Get data frame analytics jobs usage info. + * Get data frame analytics job stats. * @rest_spec_name ml.get_data_frame_analytics_stats * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts index 546a08225c..b2235aea0f 100644 --- a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts +++ b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Get datafeeds usage info. + * Get datafeed stats. * 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 diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts index 572c5ff51f..712c52fbc7 100644 --- a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts +++ b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts @@ -21,7 +21,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Get anomaly detection jobs usage info. + * Get anomaly detection job stats. * @rest_spec_name ml.get_job_stats * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=public