Skip to content

Commit 438d83e

Browse files
committed
[OpenAPI] Edit rethrottle APIs
1 parent b57ff17 commit 438d83e

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,6 @@ actions:
5555
externalDocs:
5656
description: Reading and writing documents
5757
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html
58-
- name: delete_by_query_rethrottle
59-
x-displayName: Document - Rethrottle delete by query
60-
- name: update_by_query_rethrottle
61-
x-displayName: Document - Rethrottle update by query
6258
# E
6359
- name: enrich
6460
x-displayName: Enrich

specification/_global/delete_by_query_rethrottle/DeleteByQueryRethrottleRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,14 @@ import { TaskId } from '@_types/common'
2222
import { float } from '@_types/Numeric'
2323

2424
/**
25+
* Throttle a delete by query operation.
26+
*
27+
* Change the number of requests per second for a particular delete by query operation.
28+
* Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
2529
* @rest_spec_name delete_by_query_rethrottle
2630
* @availability stack since=6.5.0 stability=stable
2731
* @availability serverless stability=stable visibility=private
32+
* @doc_tag document
2833
*/
2934
export interface Request extends RequestBase {
3035
path_parts: {

specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ import { Id } from '@_types/common'
2222
import { float } from '@_types/Numeric'
2323

2424
/**
25-
* Copies documents from a source to a destination.
25+
* Throttle a reindex operation.
26+
*
27+
* Change the number of requests per second for a particular reindex operation.
2628
* @rest_spec_name reindex_rethrottle
2729
* @availability stack since=2.4.0 stability=stable
2830
* @availability serverless stability=stable visibility=private

specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleRequest.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,14 @@ import { Id } from '@_types/common'
2222
import { float } from '@_types/Numeric'
2323

2424
/**
25+
* Throttle an update by query operation.
26+
*
27+
* Change the number of requests per second for a particular update by query operation.
28+
* Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
2529
* @rest_spec_name update_by_query_rethrottle
2630
* @availability stack since=6.5.0 stability=stable
2731
* @availability serverless stability=stable visibility=private
32+
* @doc_tag document
2833
*/
2934
export interface Request extends RequestBase {
3035
path_parts: {

0 commit comments

Comments
 (0)