Skip to content

Commit f7dbcdc

Browse files
authored
Adds external link to ack_watch API (#4607) (#4635)
(cherry picked from commit 92f69aa)
1 parent 72c3a01 commit f7dbcdc

File tree

4 files changed

+26
-9
lines changed

4 files changed

+26
-9
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 16 additions & 4 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: 6 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
apis,https://www.elastic.co/docs/api/doc/elasticsearch/v9/
1+
ack-watch, https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example
2+
apis,https://www.elastic.co/docs/api/doc/elasticsearch
23
add-nodes,https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes
34
alias-update,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-alias
45
aliases-update,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases

specification/watcher/ack_watch/WatcherAckWatchRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@ import { Name, Names } from '@_types/common'
3131
*
3232
* Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.
3333
* This happens when the condition of the watch is not met (the condition evaluates to false).
34+
* To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.
3435
* @rest_spec_name watcher.ack_watch
3536
* @availability stack stability=stable
3637
* @cluster_privileges manage_watcher
3738
* @doc_id watcher-api-ack-watch
39+
* @ext_doc_id ack-watch
3840
*/
3941
export interface Request extends RequestBase {
4042
urls: [

0 commit comments

Comments
 (0)