Skip to content

Commit 34ee22f

Browse files
committed
[DOCS] Add links to watcher APIs
1 parent 9d29a33 commit 34ee22f

14 files changed

+84
-0
lines changed

docs/reference/rest-api/watcher.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
[[watcher-api]]
33
== Watcher APIs
44

5+
.New API reference
6+
[sidebar]
7+
--
8+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
9+
--
10+
511
* <<watcher-api-put-watch>>
612
* <<watcher-api-get-watch>>
713
* <<watcher-api-query-watches>>

docs/reference/rest-api/watcher/ack-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Ack watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
<<actions-ack-throttle,Acknowledging a watch>> enables you
915
to manually throttle execution of the watch's actions.
1016

docs/reference/rest-api/watcher/activate-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Activate watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
A watch can be either <<watch-active-state,active or inactive>>. This
915
API enables you to activate a currently inactive watch.
1016

docs/reference/rest-api/watcher/deactivate-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Deactivate watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
A watch can be either <<watch-active-state,active or inactive>>. This
915
API enables you to deactivate a currently active watch.
1016

docs/reference/rest-api/watcher/delete-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Delete watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
Removes a watch from {watcher}.
915

1016
[[watcher-api-delete-watch-request]]

docs/reference/rest-api/watcher/execute-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Execute watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
Forces the execution of a stored watch.
915

1016
[[watcher-api-execute-watch-request]]

docs/reference/rest-api/watcher/get-settings.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Get Watcher settings</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
This API allows a user to retrieve the user-configurable settings for the Watcher internal index (`.watches`). Only a subset of the index settings—those that are user-configurable—will be shown. This includes:
915

1016
- `index.auto_expand_replicas`

docs/reference/rest-api/watcher/get-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Get watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
Retrieves a watch by its ID.
915

1016
[[watcher-api-get-watch-request]]

docs/reference/rest-api/watcher/put-watch.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Create or update watch</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
Either registers a new watch in {watcher} or updates an existing one.
915

1016
[[watcher-api-put-watch-request]]

docs/reference/rest-api/watcher/query-watches.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Query watches</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
12+
--
13+
814
Retrieves all registered watches.
915

1016
[[watcher-api-query-watches-request]]

0 commit comments

Comments
 (0)