[DOCS] Add links to watcher APIs

lcawl · Dec 31, 2024 · 34ee22f · 34ee22f
1 parent 9d29a33
commit 34ee22f
Show file tree

Hide file tree

Showing 14 changed files with 84 additions and 0 deletions.
diff --git a/docs/reference/rest-api/watcher.asciidoc b/docs/reference/rest-api/watcher.asciidoc
@@ -2,6 +2,12 @@
 [[watcher-api]]
 == Watcher APIs
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 * <<watcher-api-put-watch>>
 * <<watcher-api-get-watch>>
 * <<watcher-api-query-watches>>

diff --git a/docs/reference/rest-api/watcher/ack-watch.asciidoc b/docs/reference/rest-api/watcher/ack-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Ack watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 <<actions-ack-throttle,Acknowledging a watch>> enables you
 to manually throttle execution of the watch's actions.
 

diff --git a/docs/reference/rest-api/watcher/activate-watch.asciidoc b/docs/reference/rest-api/watcher/activate-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Activate watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 A watch can be either <<watch-active-state,active or inactive>>. This
 API enables you to activate a currently inactive watch.
 

diff --git a/docs/reference/rest-api/watcher/deactivate-watch.asciidoc b/docs/reference/rest-api/watcher/deactivate-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Deactivate watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 A watch can be either <<watch-active-state,active or inactive>>. This
 API enables you to deactivate a currently active watch.
 

diff --git a/docs/reference/rest-api/watcher/delete-watch.asciidoc b/docs/reference/rest-api/watcher/delete-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Delete watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Removes a watch from {watcher}.
 
 [[watcher-api-delete-watch-request]]

diff --git a/docs/reference/rest-api/watcher/execute-watch.asciidoc b/docs/reference/rest-api/watcher/execute-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Execute watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Forces the execution of a stored watch.
 
 [[watcher-api-execute-watch-request]]

diff --git a/docs/reference/rest-api/watcher/get-settings.asciidoc b/docs/reference/rest-api/watcher/get-settings.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Get Watcher settings</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 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:
 
 - `index.auto_expand_replicas`

diff --git a/docs/reference/rest-api/watcher/get-watch.asciidoc b/docs/reference/rest-api/watcher/get-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Get watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Retrieves a watch by its ID.
 
 [[watcher-api-get-watch-request]]

diff --git a/docs/reference/rest-api/watcher/put-watch.asciidoc b/docs/reference/rest-api/watcher/put-watch.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Create or update watch</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Either registers a new watch in {watcher} or updates an existing one.
 
 [[watcher-api-put-watch-request]]

diff --git a/docs/reference/rest-api/watcher/query-watches.asciidoc b/docs/reference/rest-api/watcher/query-watches.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Query watches</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Retrieves all registered watches.
 
 [[watcher-api-query-watches-request]]

diff --git a/docs/reference/rest-api/watcher/start.asciidoc b/docs/reference/rest-api/watcher/start.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Start watch service</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Starts the {watcher} service if it is not already running.
 
 [[watcher-api-start-request]]

diff --git a/docs/reference/rest-api/watcher/stats.asciidoc b/docs/reference/rest-api/watcher/stats.asciidoc
@@ -6,6 +6,12 @@
 <titleabbrev>Get {watcher} stats</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Retrieves the current {watcher} metrics.
 
 [[watcher-api-stats-request]]

diff --git a/docs/reference/rest-api/watcher/stop.asciidoc b/docs/reference/rest-api/watcher/stop.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Stop watch service</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 Stops the {watcher} service if it is running.
 
 [[watcher-api-stop-request]]

diff --git a/docs/reference/rest-api/watcher/update-settings.asciidoc b/docs/reference/rest-api/watcher/update-settings.asciidoc
@@ -5,6 +5,12 @@
 <titleabbrev>Update Watcher settings</titleabbrev>
 ++++
 
+.New API reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
+--
+
 This API allows a user to modify the settings for the Watcher internal index (`.watches`). Only a subset of settings are allowed to by modified. This includes:
 
 - `index.auto_expand_replicas`