kibana/docs/api
Kibana Machine d0f095f2ec
[8.x] [DOCS ]Direct users to new API reference site (#195909) (#196352)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS ]Direct users to new API reference site
(#195909)](https://github.com/elastic/kibana/pull/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](873ec2c47f/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](873ec2c47f/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](873ec2c47f/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>
2024-10-15 16:00:44 +00:00
..
dashboard [DOCS] Remove saved object and data view API pages (#190654) 2024-08-20 17:29:06 +00:00
index-patterns [DOCS] Remove saved object and data view API pages (#190654) 2024-08-20 17:29:06 +00:00
logstash-configuration-management Add a note that if list pipelines exceeds 10k, Kibana faces performan… (#131992) 2022-05-11 16:24:16 -07:00
osquery-manager [8.x] [DOCS ]Direct users to new API reference site (#195909) (#196352) 2024-10-15 16:00:44 +00:00
role-management [Docs] Fixed endpoint in the example (#190699) 2024-08-20 14:14:29 +02:00
session-management Expose session invalidation API. (#92376) 2021-03-24 09:54:08 +01:00
short-urls Short url docs (#113084) 2021-10-12 19:46:58 +02:00
spaces-management [Spaces] Passing default solution from cloud onboarding process (#185926) 2024-06-18 11:10:52 +02:00
synthetics [Synthetics] Delete monitor API via id param !! (#190210) 2024-08-12 21:13:33 +02:00
task-manager Fix task manager polling flow controls (#153491) 2023-05-03 09:33:10 -04:00
upgrade-assistant Fixed some typos (#125802) 2022-03-02 16:40:34 -06:00
uptime [Uptime] Settings public API (#163400) 2023-10-23 06:14:37 -07:00
actions-and-connectors.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
alerting.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
cases.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
dashboard-api.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
data-views.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
features.asciidoc Timelion App removal (#110255) 2021-09-10 14:53:07 +03:00
index-patterns.asciidoc [DOCS] Add deprecated index pattern APIs (#124065) 2022-01-31 15:47:25 -08:00
logstash-configuration-management.asciidoc [DOCS] Updates API requests and examples (#60695) 2020-03-20 16:33:20 -05:00
machine-learning.asciidoc [DOCS] Remove machine learning, alerting, cases, and connector API pages (#190747) 2024-08-20 14:43:59 +00:00
osquery-manager.asciidoc [8.x] [DOCS ]Direct users to new API reference site (#195909) (#196352) 2024-10-15 16:00:44 +00:00
role-management.asciidoc Bulk Role Endpoint (#189173) 2024-08-08 14:33:25 +02:00
saved-objects.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
session-management.asciidoc Expose session invalidation API. (#92376) 2021-03-24 09:54:08 +01:00
short-urls.asciidoc [Docs] Add details to SO APIs landing page (#191693) 2024-08-29 15:04:00 -05:00
spaces-management.asciidoc Document update objects spaces API (#145109) 2022-11-15 16:55:58 +00:00
upgrade-assistant.asciidoc [DOCS] Adds missing add default field API (#86332) 2020-12-17 13:59:56 -06:00
uptime-api.asciidoc [Uptime] Settings public API (#163400) 2023-10-23 06:14:37 -07:00