From f0f17756324836e00ae0440ed1ba34c90490e843 Mon Sep 17 00:00:00 2001
From: natasha-moore-elastic
 <137783811+natasha-moore-elastic@users.noreply.github.com>
Date: Tue, 15 Oct 2024 16:29:05 +0100
Subject: [PATCH] [DOCS ]Direct users to new API reference site (#195909)

## Summary

Contributes to
https://github.com/elastic/security-docs-internal/issues/48.

Add callouts to the asciidoc Osquery API docs to direct users to the new
API reference site, in preparation for retiring the asciidoc API docs.

NOTE: The api-kibana variable is defined in version-specific files. In
[8.15.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.15.asciidoc#L74)
and
[8.x.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.x.asciidoc#L75),
the variable points to the [v8
branch](https://www.elastic.co/docs/api/doc/kibana/v8) of the API
reference, which currently doesn't include Security API docs. The v8
branch is derived from the "current" Kibana branch, which is currently
8.15. This likely means that we can only backport the callouts to 8.16
once 8.16 becomes the "current" docs version.

Preview: [Osquery manager
API](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)
and all its child pages
---
 docs/api/osquery-manager.asciidoc                          | 6 ++++++
 docs/api/osquery-manager/live-queries/create.asciidoc      | 6 ++++++
 docs/api/osquery-manager/live-queries/get-all.asciidoc     | 6 ++++++
 docs/api/osquery-manager/live-queries/get-results.asciidoc | 6 ++++++
 docs/api/osquery-manager/live-queries/get.asciidoc         | 6 ++++++
 docs/api/osquery-manager/packs/create.asciidoc             | 6 ++++++
 docs/api/osquery-manager/packs/delete.asciidoc             | 6 ++++++
 docs/api/osquery-manager/packs/get-all.asciidoc            | 6 ++++++
 docs/api/osquery-manager/packs/get.asciidoc                | 6 ++++++
 docs/api/osquery-manager/packs/update.asciidoc             | 6 ++++++
 docs/api/osquery-manager/saved-queries/create.asciidoc     | 6 ++++++
 docs/api/osquery-manager/saved-queries/delete.asciidoc     | 6 ++++++
 docs/api/osquery-manager/saved-queries/get-all.asciidoc    | 6 ++++++
 docs/api/osquery-manager/saved-queries/get.asciidoc        | 6 ++++++
 docs/api/osquery-manager/saved-queries/update.asciidoc     | 6 ++++++
 15 files changed, 90 insertions(+)

diff --git a/docs/api/osquery-manager.asciidoc b/docs/api/osquery-manager.asciidoc
index 2607bdad1f54f..3e7176e30f31f 100644
--- a/docs/api/osquery-manager.asciidoc
+++ b/docs/api/osquery-manager.asciidoc
@@ -1,6 +1,12 @@
 [[osquery-manager-api]]
 == Osquery manager API
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Run live queries, manage packs and saved queries
 
 Use the osquery manager APIs for managing packs and saved queries.
diff --git a/docs/api/osquery-manager/live-queries/create.asciidoc b/docs/api/osquery-manager/live-queries/create.asciidoc
index c080cfe08a903..fcddf247e3e8e 100644
--- a/docs/api/osquery-manager/live-queries/create.asciidoc
+++ b/docs/api/osquery-manager/live-queries/create.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Create live query</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Create live queries.
 
 
diff --git a/docs/api/osquery-manager/live-queries/get-all.asciidoc b/docs/api/osquery-manager/live-queries/get-all.asciidoc
index 58845d3c498e6..3586c52577ae3 100644
--- a/docs/api/osquery-manager/live-queries/get-all.asciidoc
+++ b/docs/api/osquery-manager/live-queries/get-all.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get live queries</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Get live queries.
 
 
diff --git a/docs/api/osquery-manager/live-queries/get-results.asciidoc b/docs/api/osquery-manager/live-queries/get-results.asciidoc
index 9c7fa1833e0de..53fcaa35abf09 100644
--- a/docs/api/osquery-manager/live-queries/get-results.asciidoc
+++ b/docs/api/osquery-manager/live-queries/get-results.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get live query results</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Retrieve a single live query result by ID.
 
 
diff --git a/docs/api/osquery-manager/live-queries/get.asciidoc b/docs/api/osquery-manager/live-queries/get.asciidoc
index 8cf5a3abd1c3c..b2a1e9bf7bfd1 100644
--- a/docs/api/osquery-manager/live-queries/get.asciidoc
+++ b/docs/api/osquery-manager/live-queries/get.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get live query</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Retrieves a single live query by ID.
 
 
diff --git a/docs/api/osquery-manager/packs/create.asciidoc b/docs/api/osquery-manager/packs/create.asciidoc
index 84e8c3e71eb5c..c23d2e40a4ba2 100644
--- a/docs/api/osquery-manager/packs/create.asciidoc
+++ b/docs/api/osquery-manager/packs/create.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Create pack</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Create packs.
 
 
diff --git a/docs/api/osquery-manager/packs/delete.asciidoc b/docs/api/osquery-manager/packs/delete.asciidoc
index ae0834e6f2b4a..8a7832d91e3c7 100644
--- a/docs/api/osquery-manager/packs/delete.asciidoc
+++ b/docs/api/osquery-manager/packs/delete.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Delete pack</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Delete packs.
 
 WARNING: Once you delete a pack, _it cannot be recovered_.
diff --git a/docs/api/osquery-manager/packs/get-all.asciidoc b/docs/api/osquery-manager/packs/get-all.asciidoc
index 44c36947f46b0..bf007d44e61a1 100644
--- a/docs/api/osquery-manager/packs/get-all.asciidoc
+++ b/docs/api/osquery-manager/packs/get-all.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get packs</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Get packs.
 
 
diff --git a/docs/api/osquery-manager/packs/get.asciidoc b/docs/api/osquery-manager/packs/get.asciidoc
index 795adef90e24d..6686751d6902e 100644
--- a/docs/api/osquery-manager/packs/get.asciidoc
+++ b/docs/api/osquery-manager/packs/get.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get pack</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Retrieve a single pack by ID.
 
 
diff --git a/docs/api/osquery-manager/packs/update.asciidoc b/docs/api/osquery-manager/packs/update.asciidoc
index d098d2567f1ac..2e7f6004fd008 100644
--- a/docs/api/osquery-manager/packs/update.asciidoc
+++ b/docs/api/osquery-manager/packs/update.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Update pack</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Update packs.
 
 WARNING: You are unable to update a prebuilt pack (`read_only = true`).
diff --git a/docs/api/osquery-manager/saved-queries/create.asciidoc b/docs/api/osquery-manager/saved-queries/create.asciidoc
index 75b764ded6023..e137c6cb78484 100644
--- a/docs/api/osquery-manager/saved-queries/create.asciidoc
+++ b/docs/api/osquery-manager/saved-queries/create.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Create saved query</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Create saved queries.
 
 
diff --git a/docs/api/osquery-manager/saved-queries/delete.asciidoc b/docs/api/osquery-manager/saved-queries/delete.asciidoc
index 5518159a1aa1b..7d0b36de0405d 100644
--- a/docs/api/osquery-manager/saved-queries/delete.asciidoc
+++ b/docs/api/osquery-manager/saved-queries/delete.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Delete saved query</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Delete saved queries.
 
 WARNING: Once you delete a saved query, _it cannot be recovered_.
diff --git a/docs/api/osquery-manager/saved-queries/get-all.asciidoc b/docs/api/osquery-manager/saved-queries/get-all.asciidoc
index 3fc8d1d5da93c..829ee51c6d6e4 100644
--- a/docs/api/osquery-manager/saved-queries/get-all.asciidoc
+++ b/docs/api/osquery-manager/saved-queries/get-all.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get saved-queries</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Get saved queries.
 
 
diff --git a/docs/api/osquery-manager/saved-queries/get.asciidoc b/docs/api/osquery-manager/saved-queries/get.asciidoc
index c1d2cd43bab86..b9764c8d27a3f 100644
--- a/docs/api/osquery-manager/saved-queries/get.asciidoc
+++ b/docs/api/osquery-manager/saved-queries/get.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Get saved query</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Retrieve a single saved query by ID.
 
 
diff --git a/docs/api/osquery-manager/saved-queries/update.asciidoc b/docs/api/osquery-manager/saved-queries/update.asciidoc
index 025a69b28e0f0..b7d620efc7692 100644
--- a/docs/api/osquery-manager/saved-queries/update.asciidoc
+++ b/docs/api/osquery-manager/saved-queries/update.asciidoc
@@ -4,6 +4,12 @@
 <titleabbrev>Update saved query</titleabbrev>
 ++++
 
+.New API Reference
+[sidebar]
+--
+For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
+--
+
 experimental[] Update saved queries.
 
 WARNING: You are unable to update a prebuilt saved query (`prebuilt = true`).