Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.14] Adds refresh field to value list API docs (backport #5119) #5132

Merged
merged 1 commit into from
Apr 26, 2024
Merged

[8.14] Adds refresh field to value list API docs (backport #5119) #5132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/detections/api/lists/api-create-list-item.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,13 @@ when it is not provided.
|`value` |String |The value used to evaluate exceptions. For information on how
list item exceptions are evaluated, see
<<exceptions-api-create-exception-item>>. |Yes
|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request become visible to search. Defaults to `wait_for`. Valid values are:

* `true`
* `false`
* `wait_for`

|No
|==============================================

===== Example requests
Expand Down
18 changes: 18 additions & 0 deletions docs/detections/api/lists/api-delete-list-item.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,24 @@ Deletes list items.

===== URL query parameters

[width="100%",options="header"]
|==============================================
|Name |Type |Description |Required

|`id` |String |Unique identifier of the list item. |Required if `list_id` and `value` are not specified.
|`list_id` |String |Unique identifier of the <<lists-api-create-container, list container>>.
|Required if `id` is not specified.
|`value` |String |The value used to evaluate exceptions. For information on how
list item exceptions are evaluated, refer to
<<exceptions-api-create-exception-item>>. |Required if `id` is not specified.
|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request are made visible to search. Defaults to `false`. Valid values are:

* `true`
* `false`

|Optional.
|==============================================

The URL query must include one of the following:

* `id` - `DELETE /api/lists/items?id=<id>`
Expand Down
7 changes: 7 additions & 0 deletions docs/detections/api/lists/api-import-list-items.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ curl -X POST "<kibana host>:<port>/api/lists/items/_import"
|Required when importing to an existing container.
|`type` |String |The datatype of excludes the list container holds, which can
be either `ip` or `keyword`. |Required when importing to a new container.
|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request become visible to search. Defaults to `wait_for`. Valid values are:

* `true`
* `false`
* `wait_for`

|Optional.
|==============================================

===== Example requests
Expand Down
6 changes: 6 additions & 0 deletions docs/detections/api/lists/api-update-list-item.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ list item exceptions are evaluated, see
|`_version` |String |Base-64 encoded value of `if_seq_no` and `if_primary_term`
parameters, used to prevent update conflicts (see
{ref}/optimistic-concurrency-control.html[Optimistic concurrency control]). |No
|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request become visible to search. Defaults to `false`. Valid values are:

* `true`
* `false`

|No

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

Expand Down