diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index ada0b1c96e..f333631238 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -43899,7 +43899,10 @@ "watcher" ], "summary": "Acknowledge a watch", - "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example" + }, "operationId": "watcher-ack-watch", "parameters": [ { @@ -43919,7 +43922,10 @@ "watcher" ], "summary": "Acknowledge a watch", - "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example" + }, "operationId": "watcher-ack-watch-1", "parameters": [ { @@ -43941,7 +43947,10 @@ "watcher" ], "summary": "Acknowledge a watch", - "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example" + }, "operationId": "watcher-ack-watch-2", "parameters": [ { @@ -43964,7 +43973,10 @@ "watcher" ], "summary": "Acknowledge a watch", - "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "description": "Acknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.\n\n## Required authorization\n\n* Cluster privileges: `manage_watcher`\n", + "externalDocs": { + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example" + }, "operationId": "watcher-ack-watch-3", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index e5424ae1bf..0e1513e18a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -22815,9 +22815,11 @@ "stability": "stable" } }, - "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", + "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.", "docId": "watcher-api-ack-watch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-ack-watch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch", + "extDocId": "ack-watch", + "extDocUrl": " https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example", "name": "watcher.ack_watch", "privileges": { "cluster": [ @@ -258316,7 +258318,7 @@ "body": { "kind": "no_body" }, - "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", + "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).\nTo demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.", "examples": { "WatcherAckWatchRequestExample1": { "alternatives": [ @@ -258381,7 +258383,7 @@ } ], "query": [], - "specLocation": "watcher/ack_watch/WatcherAckWatchRequest.ts#L23-L61" + "specLocation": "watcher/ack_watch/WatcherAckWatchRequest.ts#L23-L63" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 087946d175..68bda2da46 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -1,4 +1,5 @@ -apis,https://www.elastic.co/docs/api/doc/elasticsearch/v9/ +ack-watch, https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/actions#example +apis,https://www.elastic.co/docs/api/doc/elasticsearch add-nodes,https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes alias-update,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-alias aliases-update,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases diff --git a/specification/watcher/ack_watch/WatcherAckWatchRequest.ts b/specification/watcher/ack_watch/WatcherAckWatchRequest.ts index 95a9b9edbf..6e62a343cc 100644 --- a/specification/watcher/ack_watch/WatcherAckWatchRequest.ts +++ b/specification/watcher/ack_watch/WatcherAckWatchRequest.ts @@ -31,10 +31,12 @@ import { Name, Names } from '@_types/common' * * Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. * This happens when the condition of the watch is not met (the condition evaluates to false). + * To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation. * @rest_spec_name watcher.ack_watch * @availability stack stability=stable * @cluster_privileges manage_watcher * @doc_id watcher-api-ack-watch + * @ext_doc_id ack-watch */ export interface Request extends RequestBase { urls: [