diff --git a/docs/java-rest/high-level/watcher/ack-watch.asciidoc b/docs/java-rest/high-level/watcher/ack-watch.asciidoc index 46a516798594..3494993d87c2 100644 --- a/docs/java-rest/high-level/watcher/ack-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/ack-watch.asciidoc @@ -5,12 +5,12 @@ -- [id="{upid}-{api}"] -=== Ack Watch API +=== Ack watch API [id="{upid}-{api}-request"] ==== Execution -{xpack-ref}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you +{stack-ov}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you to manually throttle execution of a watch's actions. A watch can be acknowledged through the following request: diff --git a/docs/java-rest/high-level/watcher/activate-watch.asciidoc b/docs/java-rest/high-level/watcher/activate-watch.asciidoc index 52124ccb6edd..229e44e7a84e 100644 --- a/docs/java-rest/high-level/watcher/activate-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/activate-watch.asciidoc @@ -5,7 +5,7 @@ -- [id="{upid}-{api}"] -=== Activate Watch API +=== Activate watch API [id="{upid}-{api}-request"] ==== Execution @@ -29,7 +29,7 @@ include-tagged::{doc-tests-file}[{api}-response] <1> `watchStatus` contains status of the watch [id="{upid}-{api}-request-async"] -==== Asynchronous Execution +==== Asynchronous execution This request can be executed asynchronously: diff --git a/docs/java-rest/high-level/watcher/deactivate-watch.asciidoc b/docs/java-rest/high-level/watcher/deactivate-watch.asciidoc index ca2178e5c05e..2ba82be1d6f3 100644 --- a/docs/java-rest/high-level/watcher/deactivate-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/deactivate-watch.asciidoc @@ -5,6 +5,6 @@ :doc-tests-file: {doc-tests}/WatcherDocumentationIT.java -- [[java-rest-high-watcher-deactivate-watch]] -=== Deactivate Watch API +=== Deactivate watch API include::../execution.asciidoc[] diff --git a/docs/java-rest/high-level/watcher/delete-watch.asciidoc b/docs/java-rest/high-level/watcher/delete-watch.asciidoc index 615337ba317b..3edf2e83c9fe 100644 --- a/docs/java-rest/high-level/watcher/delete-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/delete-watch.asciidoc @@ -1,5 +1,5 @@ [[java-rest-high-x-pack-watcher-delete-watch]] -=== Delete Watch API +=== Delete watch API [[java-rest-high-x-pack-watcher-delete-watch-execution]] ==== Execution @@ -26,7 +26,7 @@ include-tagged::{doc-tests}/WatcherDocumentationIT.java[x-pack-put-watch-respons <3> `_version` returns the version of the deleted watch [[java-rest-high-x-pack-watcher-delete-watch-async]] -==== Asynchronous Execution +==== Asynchronous execution This request can be executed asynchronously: diff --git a/docs/java-rest/high-level/watcher/execute-watch.asciidoc b/docs/java-rest/high-level/watcher/execute-watch.asciidoc index ed5b4b1659dc..06a282228b46 100644 --- a/docs/java-rest/high-level/watcher/execute-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/execute-watch.asciidoc @@ -4,7 +4,7 @@ :response: ExecuteWatchResponse -- [id="{upid}-{api}"] -=== Execute Watch API +=== Execute watch API The execute watch API allows clients to immediately execute a watch, either one that has been previously added via the @@ -27,7 +27,7 @@ include-tagged::{doc-tests-file}[x-pack-execute-watch-by-id] <6> Enable debug mode [id="{upid}-{api}-response-by-id"] -==== Execute by id Response +==== Execute by id response The returned `Response` contains details of the execution: diff --git a/docs/java-rest/high-level/watcher/get-watch.asciidoc b/docs/java-rest/high-level/watcher/get-watch.asciidoc index 7321a66eeaaf..3ba232aa6694 100644 --- a/docs/java-rest/high-level/watcher/get-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/get-watch.asciidoc @@ -5,7 +5,7 @@ -- [id="{upid}-{api}"] -=== Get Watch API +=== Get watch API [id="{upid}-{api}-request"] ==== Execution diff --git a/docs/java-rest/high-level/watcher/put-watch.asciidoc b/docs/java-rest/high-level/watcher/put-watch.asciidoc index e5ee87bea34a..494fc3d40888 100644 --- a/docs/java-rest/high-level/watcher/put-watch.asciidoc +++ b/docs/java-rest/high-level/watcher/put-watch.asciidoc @@ -1,5 +1,5 @@ [[java-rest-high-x-pack-watcher-put-watch]] -=== Put Watch API +=== Put watch API [[java-rest-high-x-pack-watcher-put-watch-execution]] ==== Execution @@ -28,7 +28,7 @@ include-tagged::{doc-tests}/WatcherDocumentationIT.java[x-pack-put-watch-respons <3> `_version` returns the newly created version [[java-rest-high-x-pack-watcher-put-watch-async]] -==== Asynchronous Execution +==== Asynchronous execution This request can be executed asynchronously: diff --git a/docs/java-rest/high-level/watcher/start-watch-service.asciidoc b/docs/java-rest/high-level/watcher/start-watch-service.asciidoc index 9e3eaf1359f5..013349410332 100644 --- a/docs/java-rest/high-level/watcher/start-watch-service.asciidoc +++ b/docs/java-rest/high-level/watcher/start-watch-service.asciidoc @@ -4,7 +4,7 @@ :response: StartWatchServiceResponse -- [id="{upid}-{api}"] -=== Start Watch Service API +=== Start watch service API [id="{upid}-{api}-request"] ==== Execution diff --git a/docs/java-rest/high-level/watcher/stop-watch-service.asciidoc b/docs/java-rest/high-level/watcher/stop-watch-service.asciidoc index 173edf3cc7b2..b59db5a34f85 100644 --- a/docs/java-rest/high-level/watcher/stop-watch-service.asciidoc +++ b/docs/java-rest/high-level/watcher/stop-watch-service.asciidoc @@ -4,7 +4,7 @@ :response: StopWatchServiceResponse -- [id="{upid}-{api}"] -=== Stop Watch Service API +=== Stop watch service API [[java-rest-high-watcher-stop-watch-service-execution]] ==== Execution diff --git a/docs/java-rest/high-level/watcher/watcher-stats.asciidoc b/docs/java-rest/high-level/watcher/watcher-stats.asciidoc index 7fd27053fcba..ddc877c2c95c 100644 --- a/docs/java-rest/high-level/watcher/watcher-stats.asciidoc +++ b/docs/java-rest/high-level/watcher/watcher-stats.asciidoc @@ -4,7 +4,7 @@ :response: WatcherStatsResponse -- [id="{upid}-{api}"] -=== Watcher Stats API +=== Get Watcher stats API [id="{upid}-{api}-request"] ==== Execution diff --git a/x-pack/docs/en/rest-api/watcher.asciidoc b/x-pack/docs/en/rest-api/watcher.asciidoc index 2fcb9b9ca190..a2b919386c1d 100644 --- a/x-pack/docs/en/rest-api/watcher.asciidoc +++ b/x-pack/docs/en/rest-api/watcher.asciidoc @@ -13,13 +13,22 @@ * <> * <> -include::watcher/put-watch.asciidoc[] -include::watcher/get-watch.asciidoc[] -include::watcher/delete-watch.asciidoc[] -include::watcher/execute-watch.asciidoc[] +//ACK include::watcher/ack-watch.asciidoc[] +//ACTIVATE include::watcher/activate-watch.asciidoc[] +//DEACTIVATE include::watcher/deactivate-watch.asciidoc[] +//DELETE +include::watcher/delete-watch.asciidoc[] +//EXECUTE +include::watcher/execute-watch.asciidoc[] +//GET +include::watcher/get-watch.asciidoc[] include::watcher/stats.asciidoc[] -include::watcher/stop.asciidoc[] +//PUT +include::watcher/put-watch.asciidoc[] +//START include::watcher/start.asciidoc[] +//STOP +include::watcher/stop.asciidoc[] \ No newline at end of file diff --git a/x-pack/docs/en/rest-api/watcher/start.asciidoc b/x-pack/docs/en/rest-api/watcher/start.asciidoc index 54deb1f8068c..3ae1139cb9a9 100644 --- a/x-pack/docs/en/rest-api/watcher/start.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/start.asciidoc @@ -1,12 +1,11 @@ [role="xpack"] [[watcher-api-start]] -=== Start API +=== Start watch service API ++++ -Start +Start watch service ++++ -The `start` API starts the {watcher} service if the service is not already -running. +Starts the {watcher} service if it is not already running. [float] ==== Request diff --git a/x-pack/docs/en/rest-api/watcher/stats.asciidoc b/x-pack/docs/en/rest-api/watcher/stats.asciidoc index d5fa4c75bbf1..8ae06491ef4b 100644 --- a/x-pack/docs/en/rest-api/watcher/stats.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/stats.asciidoc @@ -1,11 +1,12 @@ [role="xpack"] [[watcher-api-stats]] -=== Stats API +=== Get {watcher} stats API +[subs="attributes"] ++++ -Stats +Get {watcher} stats ++++ -The `stats` API returns the current {watcher} metrics. +Retrieves the current {watcher} metrics. [float] ==== Request diff --git a/x-pack/docs/en/rest-api/watcher/stop.asciidoc b/x-pack/docs/en/rest-api/watcher/stop.asciidoc index 5cbc8a622672..782b983a88cf 100644 --- a/x-pack/docs/en/rest-api/watcher/stop.asciidoc +++ b/x-pack/docs/en/rest-api/watcher/stop.asciidoc @@ -1,11 +1,11 @@ [role="xpack"] [[watcher-api-stop]] -=== Stop API +=== Stop watch service API ++++ -Stop +Stop watch service ++++ -The `stop` API stops the {watcher} service if the service is running. +Stops the {watcher} service if it is running. [float] ==== Request