[DOCS] Edit Fleet operation summaries (#3227)

Co-authored-by: Marci W <[email protected]>
elastic · Dec 4, 2024 · 355291a · 355291a
1 parent 1229a21
commit 355291a
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 28 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git 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
@@ -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
@@ -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