Skip to content

Commit

Permalink
[API docs] Expands on docs for finding exception containers (#3456)
Browse files Browse the repository at this point in the history
Co-authored-by: Joe Peeples <[email protected]>
(cherry picked from commit 71e018d)
  • Loading branch information
nastasha-solomon authored and mergify[bot] committed Sep 11, 2023
1 parent e876513 commit 99b5a46
Showing 1 changed file with 10 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,22 @@ See {ref}/search-request-body.html#request-body-search-search-after[Search After
associated with a {kib} space or available in all spaces (`agnostic` or
`single`).

|`filter` |String a|Filters the returned results according to the value of the
specified field, using the `<field name>:<field value>` syntax, where
`<field name>` can be:
|`filter` |String a|Filters the returned results according to the value of the specified field.

Uses the `so type.field name:field value` syntax, where `so type` can be:

* `exception-list`: Specify a space-aware exception list.
* `exception-list-agnostic`: Specify an exception list that is shared across spaces.

And `field name` can be:

* `name`
* `type`
* `created_by`
* `updated_by`

|`search` |String a|Filters the returned results according to the {ref}/query-dsl-simple-query-string-query.html#simple-query-string-syntax[simple query] filter.

|==============================================

===== Example request
Expand Down

0 comments on commit 99b5a46

Please sign in to comment.