Skip to content

Commit 11fb031

Browse files
committed
[OpenAPI] Edit scroll API
1 parent a2af7a5 commit 11fb031

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,6 @@ actions:
181181
x-displayName: Script - Get languages
182182
- name: search
183183
x-displayName: Search
184-
- name: scroll
185-
x-displayName: Search - Scroll
186184
- name: terms_enum
187185
x-displayName: Search - Terms enum
188186
- name: search_application

specification/_global/scroll/ScrollRequest.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,25 @@ import { ScrollId } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25+
* Run a scrolling search.
26+
*
27+
* IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).
28+
*
29+
* The scroll API gets large sets of results from a single scrolling search request.
30+
* To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.
31+
* The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.
32+
* The search response returns a scroll ID in the `_scroll_id` response body parameter.
33+
* You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.
34+
* If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.
35+
*
36+
* You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.
37+
*
38+
* IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.
2539
* @rest_spec_name scroll
2640
* @availability stack stability=stable
2741
* @availability serverless stability=stable visibility=public
42+
* @doc_tag search
43+
* @ext_doc_id scroll-search-results
2844
*/
2945
export interface Request extends RequestBase {
3046
path_parts: {

0 commit comments

Comments
 (0)