Skip to content

Commit 210b592

Browse files
authored
[DOCS] Synchs Watcher API titles with better HLRC titles (#46328)
1 parent 7e112ca commit 210b592

14 files changed

+39
-30
lines changed

docs/java-rest/high-level/watcher/ack-watch.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Ack Watch API
8+
=== Ack watch API
99

1010
[id="{upid}-{api}-request"]
1111
==== Execution
1212

13-
{xpack-ref}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you
13+
{stack-ov}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you
1414
to manually throttle execution of a watch's actions. A watch can be acknowledged
1515
through the following request:
1616

docs/java-rest/high-level/watcher/activate-watch.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Activate Watch API
8+
=== Activate watch API
99

1010
[id="{upid}-{api}-request"]
1111
==== Execution
@@ -29,7 +29,7 @@ include-tagged::{doc-tests-file}[{api}-response]
2929
<1> `watchStatus` contains status of the watch
3030

3131
[id="{upid}-{api}-request-async"]
32-
==== Asynchronous Execution
32+
==== Asynchronous execution
3333

3434
This request can be executed asynchronously:
3535

docs/java-rest/high-level/watcher/deactivate-watch.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
:doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
66
--
77
[[java-rest-high-watcher-deactivate-watch]]
8-
=== Deactivate Watch API
8+
=== Deactivate watch API
99

1010
include::../execution.asciidoc[]

docs/java-rest/high-level/watcher/delete-watch.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[java-rest-high-x-pack-watcher-delete-watch]]
2-
=== Delete Watch API
2+
=== Delete watch API
33

44
[[java-rest-high-x-pack-watcher-delete-watch-execution]]
55
==== Execution
@@ -26,7 +26,7 @@ include-tagged::{doc-tests}/WatcherDocumentationIT.java[x-pack-put-watch-respons
2626
<3> `_version` returns the version of the deleted watch
2727

2828
[[java-rest-high-x-pack-watcher-delete-watch-async]]
29-
==== Asynchronous Execution
29+
==== Asynchronous execution
3030

3131
This request can be executed asynchronously:
3232

docs/java-rest/high-level/watcher/execute-watch.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:response: ExecuteWatchResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Execute Watch API
7+
=== Execute watch API
88

99
The execute watch API allows clients to immediately execute a watch, either
1010
one that has been previously added via the
@@ -27,7 +27,7 @@ include-tagged::{doc-tests-file}[x-pack-execute-watch-by-id]
2727
<6> Enable debug mode
2828

2929
[id="{upid}-{api}-response-by-id"]
30-
==== Execute by id Response
30+
==== Execute by id response
3131

3232
The returned `Response` contains details of the execution:
3333

docs/java-rest/high-level/watcher/get-watch.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
--
66

77
[id="{upid}-{api}"]
8-
=== Get Watch API
8+
=== Get watch API
99

1010
[id="{upid}-{api}-request"]
1111
==== Execution

docs/java-rest/high-level/watcher/put-watch.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[java-rest-high-x-pack-watcher-put-watch]]
2-
=== Put Watch API
2+
=== Put watch API
33

44
[[java-rest-high-x-pack-watcher-put-watch-execution]]
55
==== Execution
@@ -28,7 +28,7 @@ include-tagged::{doc-tests}/WatcherDocumentationIT.java[x-pack-put-watch-respons
2828
<3> `_version` returns the newly created version
2929

3030
[[java-rest-high-x-pack-watcher-put-watch-async]]
31-
==== Asynchronous Execution
31+
==== Asynchronous execution
3232

3333
This request can be executed asynchronously:
3434

docs/java-rest/high-level/watcher/start-watch-service.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:response: StartWatchServiceResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Start Watch Service API
7+
=== Start watch service API
88

99
[id="{upid}-{api}-request"]
1010
==== Execution

docs/java-rest/high-level/watcher/stop-watch-service.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:response: StopWatchServiceResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Stop Watch Service API
7+
=== Stop watch service API
88

99
[[java-rest-high-watcher-stop-watch-service-execution]]
1010
==== Execution

docs/java-rest/high-level/watcher/watcher-stats.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:response: WatcherStatsResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Watcher Stats API
7+
=== Get Watcher stats API
88

99
[id="{upid}-{api}-request"]
1010
==== Execution

x-pack/docs/en/rest-api/watcher.asciidoc

+14-5
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,22 @@
1313
* <<watcher-api-stop>>
1414
* <<watcher-api-start>>
1515

16-
include::watcher/put-watch.asciidoc[]
17-
include::watcher/get-watch.asciidoc[]
18-
include::watcher/delete-watch.asciidoc[]
19-
include::watcher/execute-watch.asciidoc[]
16+
//ACK
2017
include::watcher/ack-watch.asciidoc[]
18+
//ACTIVATE
2119
include::watcher/activate-watch.asciidoc[]
20+
//DEACTIVATE
2221
include::watcher/deactivate-watch.asciidoc[]
22+
//DELETE
23+
include::watcher/delete-watch.asciidoc[]
24+
//EXECUTE
25+
include::watcher/execute-watch.asciidoc[]
26+
//GET
27+
include::watcher/get-watch.asciidoc[]
2328
include::watcher/stats.asciidoc[]
24-
include::watcher/stop.asciidoc[]
29+
//PUT
30+
include::watcher/put-watch.asciidoc[]
31+
//START
2532
include::watcher/start.asciidoc[]
33+
//STOP
34+
include::watcher/stop.asciidoc[]

x-pack/docs/en/rest-api/watcher/start.asciidoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
[role="xpack"]
22
[[watcher-api-start]]
3-
=== Start API
3+
=== Start watch service API
44
++++
5-
<titleabbrev>Start</titleabbrev>
5+
<titleabbrev>Start watch service</titleabbrev>
66
++++
77

8-
The `start` API starts the {watcher} service if the service is not already
9-
running.
8+
Starts the {watcher} service if it is not already running.
109

1110
[float]
1211
==== Request

x-pack/docs/en/rest-api/watcher/stats.asciidoc

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
[role="xpack"]
22
[[watcher-api-stats]]
3-
=== Stats API
3+
=== Get {watcher} stats API
4+
[subs="attributes"]
45
++++
5-
<titleabbrev>Stats</titleabbrev>
6+
<titleabbrev>Get {watcher} stats</titleabbrev>
67
++++
78

8-
The `stats` API returns the current {watcher} metrics.
9+
Retrieves the current {watcher} metrics.
910

1011
[float]
1112
==== Request

x-pack/docs/en/rest-api/watcher/stop.asciidoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[role="xpack"]
22
[[watcher-api-stop]]
3-
=== Stop API
3+
=== Stop watch service API
44
++++
5-
<titleabbrev>Stop</titleabbrev>
5+
<titleabbrev>Stop watch service</titleabbrev>
66
++++
77

8-
The `stop` API stops the {watcher} service if the service is running.
8+
Stops the {watcher} service if it is running.
99

1010
[float]
1111
==== Request

0 commit comments

Comments
 (0)