Skip to content

Commit 355291a

Browse files
lcawlmarciw
andauthored
[DOCS] Edit Fleet operation summaries (#3227)
Co-authored-by: Marci W <[email protected]>
1 parent 1229a21 commit 355291a

File tree

5 files changed

+33
-28
lines changed

5 files changed

+33
-28
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 14 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ import { Duration } from '@_types/Time'
2323
import { Checkpoint } from '../_types/Checkpoints'
2424

2525
/**
26+
* Get global checkpoints.
27+
* Get the current global checkpoints for an index.
28+
* This API is designed for internal use by the Fleet server project.
2629
* @rest_spec_name fleet.global_checkpoints
2730
* @availability stack since=7.13.0 stability=stable
2831
* @availability serverless stability=stable visibility=private

specification/fleet/msearch/MultiSearchRequest.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ import { long } from '@_types/Numeric'
2929
import { Checkpoint } from '../_types/Checkpoints'
3030

3131
/**
32-
* Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.
33-
* 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
34-
* supports the wait_for_checkpoints parameter.
32+
* Run multiple Fleet searches.
33+
* Run several Fleet searches with a single API request.
34+
* The API follows the same structure as the multi search API.
35+
* However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
3536
* @rest_spec_name fleet.msearch
3637
* @availability stack since=7.16.0 stability=experimental
3738
* @availability serverless stability=experimental visibility=private

specification/fleet/search/SearchRequest.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@ import { Duration } from '@_types/Time'
5252
import { Checkpoint } from '../_types/Checkpoints'
5353

5454
/**
55-
* The purpose of the fleet search api is to provide a search api where the search will only be executed
56-
* after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
55+
* Run a Fleet search.
56+
* The purpose of the Fleet search API is to provide an API where the search will be run only
57+
* after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
5758
* @rest_spec_name fleet.search
5859
* @availability stack since=7.16.0 stability=experimental
5960
* @availability serverless stability=experimental visibility=private

0 commit comments

Comments
 (0)