Skip to content

[DOCS] Edit Fleet operation summaries #3227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions specification/fleet/msearch/MultiSearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions specification/fleet/search/SearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading