Commit graph

6 commits

Author SHA1 Message Date
natasha-moore-elastic
86a31db057
[DOCS] Documents Osquery Timeout setting (#174595)
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>
2024-01-17 15:29:23 +00:00
natasha-moore-elastic
62e087a8a8
[DOCS] Makes shards optional in Create pack API (#166639)
## Summary

* Resolves https://github.com/elastic/security-docs/issues/3822.  

* Updates the `shards` object in Create pack API to optional for 8.10.1
and 8.11.0 onwards, per https://github.com/elastic/kibana/pull/166178

* Related to changes made in
https://github.com/elastic/kibana/pull/166363.
2023-09-25 11:38:41 +01:00
natasha-moore-elastic
0215ed3a0f
[DOCS] Adds shards object to Create pack and Update pack API (#166363)
## Summary

- Resolves https://github.com/elastic/security-docs/issues/3822 

Adds the `shards` object schema definition to Create pack and Update
pack API, and to the Create pack request example.

- Related dev PR: https://github.com/elastic/kibana/pull/166178
2023-09-18 14:55:57 +01:00
Konrad Szwarc
ee26923aab
[Defend Workflows] Fix saved queries 500 (#150426)
**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>
2023-02-14 16:11:14 +01:00
Kaarina Tungseth
be498a5c58
[DOCS] Fixes formatting in the Osquery manager APIs (#149871)
## Summary

Fixes the formatting of the rogue `Query parameters` sections.
2023-01-30 12:41:10 -06:00
Patryk Kopyciński
33689abc77
[Osquery] Add docs for Osquery API (#137162) 2022-08-09 18:43:31 +02:00