Adds refresh field to value list API docs (#5119) (#5132)

* Adds refresh field to value list API docs * Update docs/detections/api/lists/api-delete-list-item.asciidoc Co-authored-by: Nastasha Solomon <[email protected]> * Apply suggestions from code review Co-authored-by: Benjamin Ironside Goldstein <[email protected]> * Update docs/detections/api/lists/api-delete-list-item.asciidoc --------- Co-authored-by: Nastasha Solomon <[email protected]> Co-authored-by: Benjamin Ironside Goldstein <[email protected]> (cherry picked from commit cf5bd47) Co-authored-by: natasha-moore-elastic <[email protected]>
elastic · Apr 26, 2024 · 961b116 · 961b116
1 parent 7e60170
commit 961b116
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/docs/detections/api/lists/api-create-list-item.asciidoc b/docs/detections/api/lists/api-create-list-item.asciidoc
@@ -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

diff --git a/docs/detections/api/lists/api-delete-list-item.asciidoc b/docs/detections/api/lists/api-delete-list-item.asciidoc
@@ -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>`

diff --git a/docs/detections/api/lists/api-import-list-items.asciidoc b/docs/detections/api/lists/api-import-list-items.asciidoc
@@ -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

diff --git a/docs/detections/api/lists/api-update-list-item.asciidoc b/docs/detections/api/lists/api-update-list-item.asciidoc
@@ -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
 
 |==============================================