From 916f65b04b5299ac9fefb8df7e46433a6eaee2a7 Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 18 Oct 2023 12:21:01 +0100 Subject: [PATCH 1/8] update lists API --- .../lists-index-api-overview.asciidoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index a5840132a8..373ea7906f 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -2,7 +2,7 @@ === Lists index endpoint Before using exceptions and lists, use the `index` endpoint to create `.lists` -and `.items` system indices in the relevant +and `.items` system data streams in the relevant {kibana-ref}/xpack-spaces.html[{kib} space]. For information about the permissions and privileges required to create @@ -11,7 +11,7 @@ For information about the permissions and privileges required to create [discrete] === Create index -Creates `.lists` and `.items` indices. The indices naming convention is +Creates `.lists` and `.items` data streams. The data streams naming convention is `.lists-` and `.items-`. [discrete] @@ -22,7 +22,7 @@ Creates `.lists` and `.items` indices. The indices naming convention is [discrete] ===== Example request -Creates `.lists` and `.items` indices. +Creates `.lists` and `.items` data streams. [source,console] -------------------------------------------------- @@ -39,7 +39,7 @@ POST api/lists/index [discrete] === Get index -Verifies `.lists` and `.items` indices exist. +Verifies `.lists` and `.items` data streams exist. [discrete] ==== Request URL @@ -49,7 +49,7 @@ Verifies `.lists` and `.items` indices exist. [discrete] ===== Example request -Verifies the `lists` index for the {kib} `security` exists: +Verifies the `lists` data stream for the {kib} `security` exists: [source,console] -------------------------------------------------- @@ -68,7 +68,7 @@ GET api/lists/index [discrete] ===== Example responses -Example response when the indices exist: +Example response when the data streams exist: [source,json] -------------------------------------------------- @@ -83,7 +83,7 @@ Example response when the indices do not exist: [source,json] -------------------------------------------------- { - "message": "index .lists-default and index .items-default does not exist", + "message": "data stream .lists-default and data stream .items-default does not exist", "status_code": 404 } -------------------------------------------------- @@ -91,7 +91,7 @@ Example response when the indices do not exist: [discrete] === Delete index -Deletes the `.lists` and `.items` indices. +Deletes the `.lists` and `.items` data streams. [discrete] ==== Request URL @@ -101,7 +101,7 @@ Deletes the `.lists` and `.items` indices. [discrete] ===== Example request -Deletes the `.lists` and `.items` indices: +Deletes the `.lists` and `.items` data streams: [source, js] -------------------------------------------------- From 847bf085a0f9fec2426c868140234a900d4761f2 Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 18 Oct 2023 12:44:38 +0100 Subject: [PATCH 2/8] fix typo --- .../detections/api/exceptions/lists-index-api-overview.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index 373ea7906f..436fb0ebef 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -6,7 +6,7 @@ and `.items` system data streams in the relevant {kibana-ref}/xpack-spaces.html[{kib} space]. For information about the permissions and privileges required to create -`.lists` and `.items` indices, see <>. +`.lists` and `.items` data streams, see <>. [discrete] === Create index From d1022273ddd5f48be007d282cb52e803c954b4c5 Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 25 Oct 2023 14:17:07 +0100 Subject: [PATCH 3/8] updates --- .../api/exceptions/lists-index-api-overview.asciidoc | 6 +++--- docs/detections/api/lists/lists-api-overview.asciidoc | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index 436fb0ebef..94817473aa 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -9,7 +9,7 @@ For information about the permissions and privileges required to create `.lists` and `.items` data streams, see <>. [discrete] -=== Create index +=== Create data stream Creates `.lists` and `.items` data streams. The data streams naming convention is `.lists-` and `.items-`. @@ -63,7 +63,7 @@ GET api/lists/index `200`:: Indicates a successful call. `404`:: - Indicates no index exists. + Indicates no data stream exists. [discrete] ===== Example responses @@ -89,7 +89,7 @@ Example response when the indices do not exist: -------------------------------------------------- [discrete] -=== Delete index +=== Delete data streams Deletes the `.lists` and `.items` data streams. diff --git a/docs/detections/api/lists/lists-api-overview.asciidoc b/docs/detections/api/lists/lists-api-overview.asciidoc index c971d8a637..85a01f5555 100644 --- a/docs/detections/api/lists/lists-api-overview.asciidoc +++ b/docs/detections/api/lists/lists-api-overview.asciidoc @@ -64,7 +64,7 @@ To create list containers and items, the user role for the {kib} space must have: * `read` and `write` index privileges for the -`.lists` and `.items` indices (the system index used for storing exception lists). +`.lists` and `.items` data streams (the system data stream used for storing exception lists). * {kib} space `All` privileges for the `Security` and `Saved Objects Management` features (see {kibana-ref}/xpack-spaces.html#spaces-control-user-access[Feature access based on user privileges]). From 2980284d39abdc029c2b8c2fcd9bc5d617ddcec0 Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 25 Oct 2023 14:27:09 +0100 Subject: [PATCH 4/8] more changes --- .../api/exceptions/exceptions-api-overview.asciidoc | 4 ++-- docs/detections/api/lists/lists-api-overview.asciidoc | 2 +- docs/getting-started/detections-req.asciidoc | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/detections/api/exceptions/exceptions-api-overview.asciidoc b/docs/detections/api/exceptions/exceptions-api-overview.asciidoc index 29bb71deb6..478ea06da4 100644 --- a/docs/detections/api/exceptions/exceptions-api-overview.asciidoc +++ b/docs/detections/api/exceptions/exceptions-api-overview.asciidoc @@ -38,7 +38,7 @@ entities: image::images/exceptions-logic.png[] IMPORTANT: Before you can create exceptions, you must create `.lists` and -`.items` indices for the {kib} space (see <>). +`.items` data streams for the {kib} space (see <>). [float] === Kibana role requirements @@ -47,7 +47,7 @@ To create list containers and items, the user role for the {kib} space must have: * `read` and `write` index privileges for the -`.lists` and `.items` indices (the system index used for storing exception lists). +`.lists` and `.items` data streams (the system data stream used for storing exception lists). * {kib} space `All` privileges for the `Security` and `Saved Objects Management` features (see {kibana-ref}/xpack-spaces.html#spaces-control-user-access[Feature access based on user privileges]). diff --git a/docs/detections/api/lists/lists-api-overview.asciidoc b/docs/detections/api/lists/lists-api-overview.asciidoc index 85a01f5555..a99e6d571c 100644 --- a/docs/detections/api/lists/lists-api-overview.asciidoc +++ b/docs/detections/api/lists/lists-api-overview.asciidoc @@ -55,7 +55,7 @@ operator and associate it with an <>). +data streams for the {kib} space (see <>). [float] === Kibana role requirements diff --git a/docs/getting-started/detections-req.asciidoc b/docs/getting-started/detections-req.asciidoc index 9f5358722c..35100565c8 100644 --- a/docs/getting-started/detections-req.asciidoc +++ b/docs/getting-started/detections-req.asciidoc @@ -53,7 +53,7 @@ named `.alerts-security.alerts-default`. If you're upgrading to 8.0.0 or later, |Enable the Detections feature in your Kibana space |The `manage` privilege -a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices, where `` is the {kib} space name: +a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices and data streams, where `` is the {kib} space name: * `.alerts-security.alerts-` * `.siem-signals-` ^1^ From d517de73a23bfc9426ed8ae6f2617eddf8781e5a Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 25 Oct 2023 14:35:42 +0100 Subject: [PATCH 5/8] updates --- .../detections/api/exceptions/lists-index-api-overview.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index 94817473aa..2ce8a33d9e 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -1,5 +1,5 @@ [[lists-index-api-overview]] -=== Lists index endpoint +=== Lists data stream(/index) endpoint Before using exceptions and lists, use the `index` endpoint to create `.lists` and `.items` system data streams in the relevant From c290e43443be6f712827bbbb9db22016bef0e810 Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 25 Oct 2023 15:14:40 +0100 Subject: [PATCH 6/8] remove /index mention --- .../detections/api/exceptions/lists-index-api-overview.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index 2ce8a33d9e..7082ee442c 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -1,5 +1,5 @@ [[lists-index-api-overview]] -=== Lists data stream(/index) endpoint +=== Lists data stream endpoint Before using exceptions and lists, use the `index` endpoint to create `.lists` and `.items` system data streams in the relevant From 16a2b19505f2cb8b622ddce9137cf99cdfd0c325 Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko Date: Wed, 25 Oct 2023 17:02:16 +0100 Subject: [PATCH 7/8] CR --- .../api/exceptions/lists-index-api-overview.asciidoc | 4 ++-- docs/getting-started/detections-req.asciidoc | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index 7082ee442c..4026696c9b 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -37,7 +37,7 @@ POST api/lists/index Indicates a successful call. [discrete] -=== Get index +=== Get data stream Verifies `.lists` and `.items` data streams exist. @@ -78,7 +78,7 @@ Example response when the data streams exist: } -------------------------------------------------- -Example response when the indices do not exist: +Example response when the data streams do not exist: [source,json] -------------------------------------------------- diff --git a/docs/getting-started/detections-req.asciidoc b/docs/getting-started/detections-req.asciidoc index 35100565c8..cd23627330 100644 --- a/docs/getting-started/detections-req.asciidoc +++ b/docs/getting-started/detections-req.asciidoc @@ -71,7 +71,7 @@ a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for t *NOTE*: To turn on the Detections feature, visit the Detections page for each appropriate Kibana space. |The `manage` privilege -a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices: +a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices and data streams: * `.alerts-security.alerts-` * `.siem-signals-` ^1^ @@ -96,7 +96,7 @@ a| The `read` privilege for the following indices: |Manage rules | N/A -a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices, where `` is the {kib} space name: +a|The `manage`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices and data streams, where `` is the {kib} space name: * `.alerts-security.alerts-`^1^ @@ -118,7 +118,7 @@ a| {kib} space `All` privileges for the `Security` feature (refer to **NOTE**: Allows you to manage alerts, but not modify rules. |N/A -a|The `maintenance`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices, where `` is the {kib} space name: +a|The `maintenance`, `write`,`read`, and `view_index_metadata` index privileges for the following system indices and data streams, where `` is the {kib} space name: * `.alerts-security.alerts-` * `.internal.alerts-security.alerts--*` From f3960d49fc3df54a3e36310f069e3d5e5fad1e7f Mon Sep 17 00:00:00 2001 From: Vitalii Dmyterko <92328789+vitaliidm@users.noreply.github.com> Date: Thu, 26 Oct 2023 10:23:02 +0100 Subject: [PATCH 8/8] Update lists-index-api-overview.asciidoc --- .../detections/api/exceptions/lists-index-api-overview.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc index 4026696c9b..1bade6bcd9 100644 --- a/docs/detections/api/exceptions/lists-index-api-overview.asciidoc +++ b/docs/detections/api/exceptions/lists-index-api-overview.asciidoc @@ -1,5 +1,5 @@ [[lists-index-api-overview]] -=== Lists data stream endpoint +=== Lists index endpoint Before using exceptions and lists, use the `index` endpoint to create `.lists` and `.items` system data streams in the relevant