From d78ae91e9e221a8e7c6bea7c362a0522c65e6d12 Mon Sep 17 00:00:00 2001 From: natasha-moore-elastic Date: Wed, 24 Apr 2024 12:59:46 +0100 Subject: [PATCH 1/4] Adds refresh field to value list API docs --- .../api/lists/api-create-list-item.asciidoc | 6 ++++++ .../api/lists/api-delete-list-item.asciidoc | 18 ++++++++++++++++++ .../api/lists/api-import-list-items.asciidoc | 7 +++++++ .../api/lists/api-update-list-item.asciidoc | 6 ++++++ 4 files changed, 37 insertions(+) diff --git a/docs/detections/api/lists/api-create-list-item.asciidoc b/docs/detections/api/lists/api-create-list-item.asciidoc index 83e1a1971e..7326e17f14 100644 --- 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 <>. |Yes +|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request are made 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 index f3d3bb2816..ddb3318159 100644 --- 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 |ID of the <>. +|Required if `id` is not specified. +|`value` |String |The value used to evaluate exceptions. For information on how +list item exceptions are evaluated, see +<>. |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=` diff --git a/docs/detections/api/lists/api-import-list-items.asciidoc b/docs/detections/api/lists/api-import-list-items.asciidoc index f0aeaeb3c1..09beeb93e8 100644 --- 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 ":/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 are made 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 index d5e8c1fde9..bfac5964a8 100644 --- 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 are made visible to search. Defaults to `false`. Valid values are: + +* `true` +* `false` + +|No |============================================== From 092db97419daf60283c5d80440811fe7c3d8e9a7 Mon Sep 17 00:00:00 2001 From: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> Date: Wed, 24 Apr 2024 15:56:20 +0100 Subject: [PATCH 2/4] Update docs/detections/api/lists/api-delete-list-item.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> --- docs/detections/api/lists/api-delete-list-item.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/lists/api-delete-list-item.asciidoc b/docs/detections/api/lists/api-delete-list-item.asciidoc index ddb3318159..a6ce12745a 100644 --- a/docs/detections/api/lists/api-delete-list-item.asciidoc +++ b/docs/detections/api/lists/api-delete-list-item.asciidoc @@ -17,7 +17,7 @@ Deletes list items. |`list_id` |String |ID of the <>. |Required if `id` is not specified. |`value` |String |The value used to evaluate exceptions. For information on how -list item exceptions are evaluated, see +list item exceptions are evaluated, refer to <>. |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: From 2b99403133aaa0f34307a6ac388f4d95afa56b0b Mon Sep 17 00:00:00 2001 From: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> Date: Thu, 25 Apr 2024 11:54:34 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> --- docs/detections/api/lists/api-create-list-item.asciidoc | 2 +- docs/detections/api/lists/api-import-list-items.asciidoc | 2 +- docs/detections/api/lists/api-update-list-item.asciidoc | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/detections/api/lists/api-create-list-item.asciidoc b/docs/detections/api/lists/api-create-list-item.asciidoc index 7326e17f14..71096fe420 100644 --- a/docs/detections/api/lists/api-create-list-item.asciidoc +++ b/docs/detections/api/lists/api-create-list-item.asciidoc @@ -28,7 +28,7 @@ when it is not provided. |`value` |String |The value used to evaluate exceptions. For information on how list item exceptions are evaluated, see <>. |Yes -|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request are made visible to search. Defaults to `wait_for`. Valid values are: +|{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` diff --git a/docs/detections/api/lists/api-import-list-items.asciidoc b/docs/detections/api/lists/api-import-list-items.asciidoc index 09beeb93e8..67b81cca90 100644 --- a/docs/detections/api/lists/api-import-list-items.asciidoc +++ b/docs/detections/api/lists/api-import-list-items.asciidoc @@ -36,7 +36,7 @@ curl -X POST ":/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 are made visible to search. Defaults to `wait_for`. Valid values are: +|{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` diff --git a/docs/detections/api/lists/api-update-list-item.asciidoc b/docs/detections/api/lists/api-update-list-item.asciidoc index bfac5964a8..e27afd95a4 100644 --- a/docs/detections/api/lists/api-update-list-item.asciidoc +++ b/docs/detections/api/lists/api-update-list-item.asciidoc @@ -39,7 +39,7 @@ 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 are made visible to search. Defaults to `false`. Valid values are: +|{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` From d91f852c4d2dc0e4984013553806ee7a7b03b748 Mon Sep 17 00:00:00 2001 From: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> Date: Thu, 25 Apr 2024 12:26:17 +0100 Subject: [PATCH 4/4] Update docs/detections/api/lists/api-delete-list-item.asciidoc --- docs/detections/api/lists/api-delete-list-item.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/lists/api-delete-list-item.asciidoc b/docs/detections/api/lists/api-delete-list-item.asciidoc index a6ce12745a..33f08b316a 100644 --- a/docs/detections/api/lists/api-delete-list-item.asciidoc +++ b/docs/detections/api/lists/api-delete-list-item.asciidoc @@ -14,7 +14,7 @@ Deletes list items. |Name |Type |Description |Required |`id` |String |Unique identifier of the list item. |Required if `list_id` and `value` are not specified. -|`list_id` |String |ID of the <>. +|`list_id` |String |Unique identifier of the <>. |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