# 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>
Contributes to https://github.com/elastic/security-docs/issues/4536 by
documenting the new **Timeout** setting and `timeout` API parameter in
Osquery docs.
---------
Co-authored-by: nastasha.solomon <nastasha.solomon@elastic.co>
Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
**Bug**
Calling `/api/osquery/saved_queries` with `sortOrder` but without `sort`
field (`/api/osquery/saved_queries?sortOrder=desc`) was causing 500
server error. Same with calls without any parameters
(`/api/osquery/saved_queries`)
**Cause**
We had defaults failover set for `sortOrder` but not for `sort`. Sorting
logic required both fields to be defined. All schema params were set to
optional and we were validating them ourselves.
**Fix**
I've tightened the schema by making all the params required and provided
default values if not provided.
`page: schema.number({ defaultValue: 1 }),
sort: schema.string({ defaultValue: 'id' }),
sortOrder: schema.oneOf([schema.literal('asc'), schema.literal('desc')],
{defaultValue: 'desc',}),`
**Additionally**
Outdated osQuery API docs - `perPage` became `pageSize` and `sortField`
became `sort`. Also, minor spelling fixes.
---------
Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com>
