Skip to content

Commit

Permalink
[8.x] [DOCS ]Direct users to new API reference site (#195909) (#196352)
Browse files Browse the repository at this point in the history 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS ]Direct users to new API reference site
(#195909)](#195909)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"natasha-moore-elastic","email":"137783811+natasha-moore-elastic@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-10-15T15:29:05Z","message":"[DOCS
]Direct users to new API reference site (#195909)\n\n##
Summary\r\n\r\nContributes
to\r\nhttps://github.com/elastic/security-docs-internal/issues/48.\r\n\r\nAdd
callouts to the asciidoc Osquery API docs to direct users to the
new\r\nAPI reference site, in preparation for retiring the asciidoc API
docs.\r\n\r\nNOTE: The api-kibana variable is defined in
version-specific files.
In\r\n[8.15.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.15.asciidoc#L74)\r\nand\r\n[8.x.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.x.asciidoc#L75),\r\nthe
variable points to the
[v8\r\nbranch](https://www.elastic.co/docs/api/doc/kibana/v8) of the
API\r\nreference, which currently doesn't include Security API docs. The
v8\r\nbranch is derived from the \"current\" Kibana branch, which is
currently\r\n8.15. This likely means that we can only backport the
callouts to 8.16\r\nonce 8.16 becomes the \"current\" docs
version.\r\n\r\nPreview: [Osquery
manager\r\nAPI](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)\r\nand
all its child
pages","sha":"f0f17756324836e00ae0440ed1ba34c90490e843","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","Feature:Osquery","APIDocs","v8.16.0","backport:version"],"title":"[DOCS
]Direct users to new API reference
site","number":195909,"url":"https://github.com/elastic/kibana/pull/195909","mergeCommit":{"message":"[DOCS
]Direct users to new API reference site (#195909)\n\n##
Summary\r\n\r\nContributes
to\r\nhttps://github.com/elastic/security-docs-internal/issues/48.\r\n\r\nAdd
callouts to the asciidoc Osquery API docs to direct users to the
new\r\nAPI reference site, in preparation for retiring the asciidoc API
docs.\r\n\r\nNOTE: The api-kibana variable is defined in
version-specific files.
In\r\n[8.15.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.15.asciidoc#L74)\r\nand\r\n[8.x.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.x.asciidoc#L75),\r\nthe
variable points to the
[v8\r\nbranch](https://www.elastic.co/docs/api/doc/kibana/v8) of the
API\r\nreference, which currently doesn't include Security API docs. The
v8\r\nbranch is derived from the \"current\" Kibana branch, which is
currently\r\n8.15. This likely means that we can only backport the
callouts to 8.16\r\nonce 8.16 becomes the \"current\" docs
version.\r\n\r\nPreview: [Osquery
manager\r\nAPI](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)\r\nand
all its child
pages","sha":"f0f17756324836e00ae0440ed1ba34c90490e843"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195909","number":195909,"mergeCommit":{"message":"[DOCS
]Direct users to new API reference site (#195909)\n\n##
Summary\r\n\r\nContributes
to\r\nhttps://github.com/elastic/security-docs-internal/issues/48.\r\n\r\nAdd
callouts to the asciidoc Osquery API docs to direct users to the
new\r\nAPI reference site, in preparation for retiring the asciidoc API
docs.\r\n\r\nNOTE: The api-kibana variable is defined in
version-specific files.
In\r\n[8.15.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.15.asciidoc#L74)\r\nand\r\n[8.x.asciidoc](https://github.com/elastic/docs/blob/873ec2c47f905b5e18f5606fde0858a1f127a244/shared/versions/stack/8.x.asciidoc#L75),\r\nthe
variable points to the
[v8\r\nbranch](https://www.elastic.co/docs/api/doc/kibana/v8) of the
API\r\nreference, which currently doesn't include Security API docs. The
v8\r\nbranch is derived from the \"current\" Kibana branch, which is
currently\r\n8.15. This likely means that we can only backport the
callouts to 8.16\r\nonce 8.16 becomes the \"current\" docs
version.\r\n\r\nPreview: [Osquery
manager\r\nAPI](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)\r\nand
all its child
pages","sha":"f0f17756324836e00ae0440ed1ba34c90490e843"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
  • Loading branch information
@kibanamachine @natasha-moore-elastic
kibanamachine and natasha-moore-elastic authored Oct 15, 2024
1 parent b57c9a6 commit d0f095f
Show file tree
Hide file tree
Showing 15 changed files with 90 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/api/osquery-manager.asciidoc
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/live-queries/create.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/live-queries/get-all.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/live-queries/get-results.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/live-queries/get.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/packs/create.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/packs/delete.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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_.
Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/packs/get-all.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/packs/get.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/packs/update.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/saved-queries/create.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/saved-queries/delete.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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_.
Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/saved-queries/get-all.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/saved-queries/get.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
6 changes: 6 additions & 0 deletions docs/api/osquery-manager/saved-queries/update.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down

0 comments on commit d0f095f

Please sign in to comment.