[DOCS] Link to new API pages (#190569)

elastic · Aug 15, 2024 · 06f1681 · 06f1681
1 parent 9121cb4
commit 06f1681
Show file tree

Hide file tree

Showing 98 changed files with 166 additions and 415 deletions.
diff --git a/docs/api/actions-and-connectors.asciidoc b/docs/api/actions-and-connectors.asciidoc
@@ -1,23 +1,7 @@
 [[actions-and-connectors-api]]
 == Action and connector APIs
 
-The following connector APIs are available:
-
-* <<get-connector-api,Get connector API>> to retrieve a single connector by ID
-
-* <<get-all-connectors-api,Get all connectors API>> to retrieve all connectors
-
-* <<list-connector-types-api,List all connector types API>> to retrieve a list of all connector types
-
-* <<create-connector-api,Create connector API>> to create connectors
-
-* <<update-connector-api,Update connector API>> to update the attributes for an existing connector
-
-* <<execute-connector-api,Run connector API>> to execute a connector by ID
-
-* <<delete-connector-api,Delete connector API>> to delete a connector by ID
-
-For deprecated APIs, refer to <<actions-and-connectors-legacy-apis>>.
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 For information about the actions and connectors that {kib} supports, refer to
 <<action-types>>.

diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc
@@ -6,11 +6,7 @@
 
 Creates a connector.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [[create-connector-api-request]]
 === {api-request-title}

diff --git a/docs/api/actions-and-connectors/delete.asciidoc b/docs/api/actions-and-connectors/delete.asciidoc
@@ -8,11 +8,7 @@ Deletes an connector by ID.
 
 WARNING: When you delete a connector, _it cannot be recovered_.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [discrete]
 [[delete-connector-api-request]]

diff --git a/docs/api/actions-and-connectors/execute.asciidoc b/docs/api/actions-and-connectors/execute.asciidoc
@@ -6,11 +6,7 @@
 
 Runs a connector by ID.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [[execute-connector-api-request]]
 === {api-request-title}

diff --git a/docs/api/actions-and-connectors/get.asciidoc b/docs/api/actions-and-connectors/get.asciidoc
@@ -6,11 +6,7 @@
 
 Retrieves a connector by ID.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [discrete]
 [[get-connector-api-request]]

diff --git a/docs/api/actions-and-connectors/get_all.asciidoc b/docs/api/actions-and-connectors/get_all.asciidoc
@@ -6,11 +6,7 @@
 
 Retrieves all connectors.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [discrete]
 [[get-all-connectors-api-request]]

diff --git a/docs/api/actions-and-connectors/legacy/create.asciidoc b/docs/api/actions-and-connectors/legacy/create.asciidoc
@@ -8,6 +8,8 @@ deprecated::[7.13.0,Use <<create-connector-api>> instead.]
 
 Creates a connector.
 
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
+
 [[actions-and-connectors-legacy-api-create-request]]
 ===== Request
 

diff --git a/docs/api/actions-and-connectors/legacy/delete.asciidoc b/docs/api/actions-and-connectors/legacy/delete.asciidoc
@@ -8,7 +8,9 @@ deprecated::[7.13.0,Use <<delete-connector-api>> instead.]
 
 Deletes a connector by ID.
 
-WARNING: When you delete an connector, _it cannot be recovered_.
+When you delete an connector, _it cannot be recovered_.
+
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [[actions-and-connectors-legacy-api-delete-request]]
 ===== Request

diff --git a/docs/api/actions-and-connectors/legacy/execute.asciidoc b/docs/api/actions-and-connectors/legacy/execute.asciidoc
@@ -8,6 +8,8 @@ deprecated::[7.13.0,Use <<execute-connector-api>> instead.]
 
 Executes a connector by ID.
 
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
+
 [[actions-and-connectors-legacy-api-execute-request]]
 ===== Request
 

diff --git a/docs/api/actions-and-connectors/legacy/get.asciidoc b/docs/api/actions-and-connectors/legacy/get.asciidoc
@@ -8,6 +8,8 @@ deprecated::[7.13.0,Use <<get-connector-api>> instead.]
 
 Retrieves a connector by ID.
 
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
+
 [[actions-and-connectors-legacy-api-get-request]]
 ===== Request
 

diff --git a/docs/api/actions-and-connectors/legacy/get_all.asciidoc b/docs/api/actions-and-connectors/legacy/get_all.asciidoc
@@ -8,6 +8,8 @@ deprecated::[7.13.0,Use <<get-all-connectors-api>> instead.]
 
 Retrieves all connectors.
 
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
+
 [[actions-and-connectors-legacy-api-get-all-request]]
 ===== Request
 

diff --git a/docs/api/actions-and-connectors/legacy/index.asciidoc b/docs/api/actions-and-connectors/legacy/index.asciidoc
@@ -2,3 +2,5 @@
 === Deprecated 7.x APIs
 
 These APIs are deprecated and will be removed in a future release.
+
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
diff --git a/docs/api/actions-and-connectors/legacy/list.asciidoc b/docs/api/actions-and-connectors/legacy/list.asciidoc
@@ -8,6 +8,8 @@ deprecated::[7.13.0,Use <<list-connector-types-api>> instead.]
 
 Retrieves a list of all connector types.
 
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
+
 [[actions-and-connectors-legacy-api-list-request]]
 ===== Request
 

diff --git a/docs/api/actions-and-connectors/legacy/update.asciidoc b/docs/api/actions-and-connectors/legacy/update.asciidoc
@@ -8,6 +8,8 @@ deprecated::[7.13.0,Use <<update-connector-api>> instead.]
 
 Updates the attributes for an existing connector.
 
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
+
 [[actions-and-connectors-legacy-api-update-request]]
 ===== Request
 

diff --git a/docs/api/actions-and-connectors/list.asciidoc b/docs/api/actions-and-connectors/list.asciidoc
@@ -6,11 +6,7 @@
 
 Retrieves a list of all connector types.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [[list-connector-types-api-request]]
 === {api-request-title}

diff --git a/docs/api/actions-and-connectors/update.asciidoc b/docs/api/actions-and-connectors/update.asciidoc
@@ -6,11 +6,7 @@
 
 Updates the attributes for a connector.
 
-[NOTE]
-====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification].
-====
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].
 
 [[update-connector-api-request]]
 === {api-request-title}

diff --git a/docs/api/alerting.asciidoc b/docs/api/alerting.asciidoc
@@ -1,35 +1,7 @@
 [[alerting-apis]]
 == Alerting APIs
 
-The following APIs are available for Alerting.
-
-* <<create-rule-api, Create rule API>> to create a rule
-
-* <<update-rule-api, Update rule API>> to update the attributes for existing rules
-
-* <<get-rule-api, Get rule API>> to retrieve a single rule by ID
-
-* <<delete-rule-api, Delete rule API>> to permanently remove a rule
-
-* <<find-rules-api, Find rules API>> to retrieve a paginated set of rules by condition
-
-* <<list-rule-types-api, List rule types API>> to retrieve a list of rule types
-
-* <<enable-rule-api, Enable rule API>> to enable a single rule by ID
-
-* <<disable-rule-api, Disable rule API>> to disable a single rule by ID
-
-* <<mute-alert-api, Mute alert API>> to mute alert for a single rule by ID
-
-* <<unmute-alert-api, Unmute alert API>> to unmute alert for a single rule by ID
-
-* <<mute-all-alerts-api, Mute all alerts API>> to mute all alerts for a single rule by ID
-
-* <<unmute-all-alerts-api, Unmute all alerts API>> to unmute all alerts for a single rule by ID
-
-* <<get-alerting-framework-health-api, Get Alerting framework health API>> to retrieve the health of the Alerting framework
-
-For deprecated APIs, refer to <<alerts-api>>.
+NOTE: For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 
 include::alerting/create_rule.asciidoc[leveloffset=+1]
 include::alerting/delete_rule.asciidoc[leveloffset=+1]

diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc
@@ -8,8 +8,7 @@ Create {kib} rules.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[create-rule-api-request]]

diff --git a/docs/api/alerting/delete_rule.asciidoc b/docs/api/alerting/delete_rule.asciidoc
@@ -10,8 +10,7 @@ WARNING: After you delete a rule, you cannot recover it.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[delete-rule-api-request]]

diff --git a/docs/api/alerting/disable_rule.asciidoc b/docs/api/alerting/disable_rule.asciidoc
@@ -8,8 +8,7 @@ Disable a rule.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[disable-rule-api-request]]

diff --git a/docs/api/alerting/enable_rule.asciidoc b/docs/api/alerting/enable_rule.asciidoc
@@ -8,8 +8,7 @@ Enable a rule.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[enable-rule-api-request]]

diff --git a/docs/api/alerting/find_rules.asciidoc b/docs/api/alerting/find_rules.asciidoc
@@ -8,8 +8,7 @@ Retrieve a paginated set of rules based on condition.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[find-rules-api-request]]

diff --git a/docs/api/alerting/get_rules.asciidoc b/docs/api/alerting/get_rules.asciidoc
@@ -8,8 +8,7 @@ Retrieve a rule by ID.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[get-rule-api-request]]

diff --git a/docs/api/alerting/health.asciidoc b/docs/api/alerting/health.asciidoc
@@ -8,8 +8,7 @@ Retrieve the health status of the alerting framework.
 
 [NOTE]
 ====
-For the most up-to-date API details, refer to the
-{kib-repo}/tree/{branch}/x-pack/plugins/alerting/docs/openapi[open API specification].
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
 ====
 
 [[get-alerting-framework-health-api-request]]

diff --git a/docs/api/alerting/legacy/create.asciidoc b/docs/api/alerting/legacy/create.asciidoc
@@ -8,6 +8,11 @@ deprecated::[7.13.0,Use <<create-rule-api>> instead.]
 
 Create {kib} alerts.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-create-request]]
 ==== Request
 

diff --git a/docs/api/alerting/legacy/delete.asciidoc b/docs/api/alerting/legacy/delete.asciidoc
@@ -10,6 +10,11 @@ Permanently remove an alert.
 
 WARNING: Once you delete an alert, you cannot recover it.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-delete-request]]
 ==== Request
 

diff --git a/docs/api/alerting/legacy/disable.asciidoc b/docs/api/alerting/legacy/disable.asciidoc
@@ -8,6 +8,11 @@ deprecated::[7.13.0,Use <<disable-rule-api>> instead.]
 
 Disable an alert.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-disable-request]]
 ==== Request
 

diff --git a/docs/api/alerting/legacy/enable.asciidoc b/docs/api/alerting/legacy/enable.asciidoc
@@ -8,6 +8,11 @@ deprecated::[7.13.0,Use <<enable-rule-api>> instead.]
 
 Enable an alert.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-enable-request]]
 ==== Request
 

diff --git a/docs/api/alerting/legacy/find.asciidoc b/docs/api/alerting/legacy/find.asciidoc
@@ -8,7 +8,12 @@ deprecated::[7.13.0,Use <<find-rules-api>> instead.]
 
 Retrieve a paginated set of alerts based on condition.
 
-NOTE: As alerts change in {kib}, the results on each page of the response also
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
+As alerts change in {kib}, the results on each page of the response also
 change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
 
 [[alerts-api-find-request]]

diff --git a/docs/api/alerting/legacy/get.asciidoc b/docs/api/alerting/legacy/get.asciidoc
@@ -8,6 +8,11 @@ deprecated::[7.13.0,Use <<get-rule-api>> instead.]
 
 Retrieve an alert by ID.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-get-request]]
 ==== Request
 

diff --git a/docs/api/alerting/legacy/health.asciidoc b/docs/api/alerting/legacy/health.asciidoc
@@ -8,6 +8,11 @@ deprecated::[7.13.0,Use <<get-alerting-framework-health-api>> instead.]
 
 Retrieve the health status of the Alerting framework.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-health-request]]
 ==== Request
 

diff --git a/docs/api/alerting/legacy/list.asciidoc b/docs/api/alerting/legacy/list.asciidoc
@@ -8,6 +8,11 @@ deprecated::[7.13.0,Use <<list-rule-types-api>> instead.]
 
 Retrieve a list of all alert types.
 
+[NOTE]
+====
+For the latest details, refer to {api-kibana}/group/endpoint-alerting[alerting APIs].
+====
+
 [[alerts-api-list-request]]
 ==== Request
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,3 +2,5 @@
		=== Deprecated 7.x APIs

		These APIs are deprecated and will be removed in a future release.

		NOTE: For the latest details, refer to {api-kibana}/group/endpoint-connectors[connector APIs].