diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e0597f5976..a140258b4d 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -8557,8 +8557,8 @@ "tags": [ "fleet" ], - "summary": "Returns the current global checkpoints for an index", - "description": "This API is design for internal use by the fleet server project.", + "summary": "Get global checkpoints", + "description": "Get the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "operationId": "fleet-global-checkpoints", "parameters": [ { @@ -8658,8 +8658,8 @@ "tags": [ "fleet" ], - "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\nsupports the wait_for_checkpoints parameter.", + "summary": "Run multiple Fleet searches", + "description": "Run several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "operationId": "fleet-msearch", "parameters": [ { @@ -8716,8 +8716,8 @@ "tags": [ "fleet" ], - "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\nsupports the wait_for_checkpoints parameter.", + "summary": "Run multiple Fleet searches", + "description": "Run several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "operationId": "fleet-msearch-1", "parameters": [ { @@ -8776,8 +8776,8 @@ "tags": [ "fleet" ], - "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\nsupports the wait_for_checkpoints parameter.", + "summary": "Run multiple Fleet searches", + "description": "Run several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "operationId": "fleet-msearch-2", "parameters": [ { @@ -8837,8 +8837,8 @@ "tags": [ "fleet" ], - "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\nsupports the wait_for_checkpoints parameter.", + "summary": "Run multiple Fleet searches", + "description": "Run several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "operationId": "fleet-msearch-3", "parameters": [ { @@ -8900,8 +8900,8 @@ "tags": [ "fleet" ], - "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.", + "summary": "Run a Fleet search", + "description": "The purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "operationId": "fleet-search", "parameters": [ { @@ -9051,8 +9051,8 @@ "tags": [ "fleet" ], - "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.", + "summary": "Run a Fleet search", + "description": "The purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "operationId": "fleet-search-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 9ee9f5630b..e37690d3b9 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -5120,7 +5120,7 @@ "stability": "stable" } }, - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "description": "Get global checkpoints.\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html", "name": "fleet.global_checkpoints", "request": { @@ -5158,7 +5158,7 @@ "stability": "experimental" } }, - "description": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.\nThe 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.", + "description": "Run multiple Fleet searches.\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "docUrl": null, "name": "fleet.msearch", "privileges": { @@ -5234,7 +5234,7 @@ "stability": "experimental" } }, - "description": "The purpose of the fleet search api is to provide a search api where the search will only be executed\nafter provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", + "description": "Run a Fleet search.\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "docUrl": null, "name": "fleet.search", "privileges": { @@ -118701,7 +118701,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.", + "description": "Get global checkpoints.\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "inherits": { "type": { "name": "RequestBase", @@ -118795,7 +118795,7 @@ } } ], - "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L63" + "specLocation": "fleet/global_checkpoints/GlobalCheckpointsRequest.ts#L25-L66" }, { "kind": "response", @@ -118854,7 +118854,7 @@ } } }, - "description": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.\nThe 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.", + "description": "Run multiple Fleet searches.\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "inherits": { "type": { "name": "RequestBase", @@ -119060,7 +119060,7 @@ } } ], - "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L114" + "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L115" }, { "kind": "response", @@ -119554,7 +119554,7 @@ } ] }, - "description": "The purpose of the fleet search api is to provide a search api where the search will only be executed\nafter provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", + "description": "Run a Fleet search.\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -120092,7 +120092,7 @@ } } ], - "specLocation": "fleet/search/SearchRequest.ts#L54-L258" + "specLocation": "fleet/search/SearchRequest.ts#L54-L259" }, { "kind": "response", diff --git a/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts b/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts index a2128b1892..9ce7f85702 100644 --- a/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts +++ b/specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts @@ -23,6 +23,9 @@ import { Duration } from '@_types/Time' import { Checkpoint } from '../_types/Checkpoints' /** + * Get global checkpoints. + * Get the current global checkpoints for an index. + * This API is designed for internal use by the Fleet server project. * @rest_spec_name fleet.global_checkpoints * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/fleet/msearch/MultiSearchRequest.ts b/specification/fleet/msearch/MultiSearchRequest.ts index 188da0e43f..be9bf01bf6 100644 --- a/specification/fleet/msearch/MultiSearchRequest.ts +++ b/specification/fleet/msearch/MultiSearchRequest.ts @@ -29,9 +29,10 @@ import { long } from '@_types/Numeric' import { Checkpoint } from '../_types/Checkpoints' /** - * Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request. - * 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. + * Run multiple Fleet searches. + * Run several Fleet searches with a single API request. + * The API follows the same structure as the multi search API. + * However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. * @rest_spec_name fleet.msearch * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private diff --git a/specification/fleet/search/SearchRequest.ts b/specification/fleet/search/SearchRequest.ts index 36f0159763..9d50908cc1 100644 --- a/specification/fleet/search/SearchRequest.ts +++ b/specification/fleet/search/SearchRequest.ts @@ -52,8 +52,9 @@ import { Duration } from '@_types/Time' import { Checkpoint } from '../_types/Checkpoints' /** - * 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. + * Run a Fleet search. + * The purpose of the Fleet search API is to provide an API where the search will be run only + * after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. * @rest_spec_name fleet.search * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private