From 171950445a500d568ca6d275c049fc7b83b88394 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 3 Dec 2020 18:11:49 -0500 Subject: [PATCH 01/12] [DOCS] Document hidden data streams and naming restrictions --- docs/reference/api-conventions.asciidoc | 16 +++++---- .../set-up-a-data-stream.asciidoc | 6 ++-- .../indices/create-data-stream.asciidoc | 8 +++-- .../indices/data-stream-stats.asciidoc | 25 ++++++++++++++ .../indices/delete-data-stream.asciidoc | 29 ++++++++++++++++ .../indices/get-data-stream.asciidoc | 33 +++++++++++++++++++ .../indices/put-index-template.asciidoc | 15 +++++++-- docs/reference/rest-api/common-parms.asciidoc | 18 +++++----- 8 files changed, 127 insertions(+), 23 deletions(-) diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 6203332e9ab41..8812230f9e570 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -52,14 +52,18 @@ NOTE: Single index APIs, such as the <> and syntax. [[hidden-indices]] -==== Hidden indices +==== Hidden data streams and indices -Indices that are configured to be hidden with the <> setting are -excluded from mult-target queries by default. -To include hidden indices, you must specify the `expand_wildcards` parameter. +By default, wildcard expressions do not match hidden data streams and indices. +To match hidden data streams and indices using a wildcard expression, use the +`expand_wildcards` query parameter. -The backing indices for data streams are hidden indices, -and some features like {ml} store information in hidden indices. +You can hide data streams by setting <> +to `true` in the stream's matching index template. You can hide indices using +the <> index setting. + +The backing indices for data streams are hidden automatically. Some features, +such as {ml}, store information in hidden indices. Global index templates that match all indices are not applied to hidden indices. diff --git a/docs/reference/data-streams/set-up-a-data-stream.asciidoc b/docs/reference/data-streams/set-up-a-data-stream.asciidoc index 8f036be9e832b..8f46e9f737a90 100644 --- a/docs/reference/data-streams/set-up-a-data-stream.asciidoc +++ b/docs/reference/data-streams/set-up-a-data-stream.asciidoc @@ -63,7 +63,8 @@ PUT /_ilm/policy/my-data-stream-policy template is used for data streams. . Use the wizard to finish defining your template. Specify: -* One or more index patterns that match the data stream's name. +* One or more index patterns that match the data stream's name. + +include::{es-repo-dir}/indices/create-data-stream.asciidoc[tag=data-stream-name] * Mappings and settings for the stream's backing indices. @@ -91,7 +92,6 @@ maps `@timestamp` as a `date` field with default options. If using {ilm-init}, specify your lifecycle policy in the `index.lifecycle.name` setting. - TIP: Carefully consider your template's mappings and settings. Later changes may require reindexing. See <>. @@ -102,7 +102,7 @@ image::images/data-streams/create-index-template.png[Create template page] .API example ==== Use the <> to create an index -template. The template must include an empty `data_stream` object, indicating +template. The template must include a `data_stream` object, indicating it's used for data streams. [source,console] diff --git a/docs/reference/indices/create-data-stream.asciidoc b/docs/reference/indices/create-data-stream.asciidoc index d7da6c95d7d71..e456bcdb9bace 100644 --- a/docs/reference/indices/create-data-stream.asciidoc +++ b/docs/reference/indices/create-data-stream.asciidoc @@ -49,14 +49,16 @@ DELETE /_index_template/template -- (Required, string) Name of the data stream to create. +// tag::data-stream-name[] Data stream names must meet the following criteria: - Lowercase only -- Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), -`,`, `#`, `:` -- Cannot start with `-`, `_`, `+`, `.` +- Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a +space character +- Cannot start with `-`, `_`, `+`, or `.ds-` - Cannot be `.` or `..` - Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster) +// end::data-stream-name[] -- diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index 4eb10d60fd897..45245d7382d7c 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -72,6 +72,31 @@ To target all data streams in a cluster, omit this parameter or use `*`. [[data-stream-stats-api-query-params]] ==== {api-query-parms-title} +`expand_wildcards`:: ++ +-- +(Optional, string) +Type of data stream that wildcard expressions can match. Supports +comma-separated values, such as `open,hidden`. Valid values are: + +`all`::: +Targets any data stream, including <> ones. + +`open`::: +Match non-hidden data streams. + +`hidden`::: +Match hidden data streams. Must be combined with `open`, `closed`, or both. + +`none`::: +Wildcard expressions are not accepted. + +`closed`::: +Reserved for future use. + +Defaults to `open`. +-- + `human`:: (Optional, Boolean) If `true`, the response includes statistics in human-readable <> ones. + +`open`::: +Match non-hidden data streams. + +`hidden`::: +Match hidden data streams. Must be combined with `open`, `closed`, or both. + +`none`::: +Wildcard expressions are not accepted. + +`closed`::: +Reserved for future use. + +Defaults to `open`. +-- diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc index 0e1e916f68c9d..7333e3efd2092 100644 --- a/docs/reference/indices/get-data-stream.asciidoc +++ b/docs/reference/indices/get-data-stream.asciidoc @@ -84,6 +84,35 @@ Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams will be returned. +[role="child_attributes"] +[[get-data-stream-api-query-parms]] +==== {api-query-parms-title} + +`expand_wildcards`:: ++ +-- +(Optional, string) +Type of data stream that wildcard expressions can match. Supports +comma-separated values, such as `open,hidden`. Valid values are: + +`all`::: +Targets any data stream, including <> ones. + +`open`::: +Match non-hidden data streams. + +`hidden`::: +Match hidden data streams. Must be combined with `open`, `closed`, or both. + +`none`::: +Wildcard expressions are not accepted. + +`closed`::: +Reserved for future use. + +Defaults to `open`. +-- + [role="child_attributes"] [[get-data-stream-api-response-body]] ==== {api-response-body-title} @@ -184,6 +213,10 @@ included in the response. NOTE: A data stream's backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the <>. + +`hidden`:: +(Boolean) +If `true`, the data stream is <>. ==== [[get-data-stream-api-example]] diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index 047c98ff70868..2f3a0937d75c6 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -103,12 +103,21 @@ your template is applied instead of the built-in template for `logs-*-*`. [xpack]#`data_stream`#:: (Optional, object) -Indicates whether the template is used to create data streams and their backing -indices. If so, use an empty object as the argument: + -`data_stream: { }`. +If this object is included, the template is used to create data streams and +their backing indices. Supports an empty object: `data_stream: { }` + Data streams require a matching index template with a `data_stream` object. See <>. ++ +.Properties of `data_stream` +[%collapsible%open] +==== +[[data-stream-hidden]] +`hidden`:: +(Optional, Boolean) +If `true`, the data stream is <>. By default, wildcard +expressions do not match hidden data streams. Defaults to `false`. +==== `template`:: (Optional, object) diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 212a887370bce..1d4f5e97a605a 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -209,22 +209,24 @@ tag::expand-wildcards[] `expand_wildcards`:: + -- -(Optional, string) Controls what kind of indices that wildcard expressions can -expand to. Multiple values are accepted when separated by a comma, as in -`open,hidden`. Valid values are: +(Optional, string) +Type of index that wildcard expressions can match. If the request can target +data streams, this argument also determines whether wildcard expressions match +hidden data streams. Supports comma-separated values, such as `open,hidden`. +Valid values are: `all`:: -Expand to open and closed indices, including <>. +Match any data stream or index, including <> ones. `open`:: -Expand only to open indices. +Match non-hidden data streams and open, non-hidden indices. `closed`:: -Expand only to closed indices. +Match closed indices. `hidden`:: -Expansion of wildcards will include hidden indices. -Must be combined with `open`, `closed`, or both. +Match hidden data streams and hidden indices. Must be combined with `open`, +`closed`, or both. `none`:: Wildcard expressions are not accepted. From 302526144926341e8b24b0a9ce879c4abdc14d28 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 3 Dec 2020 21:14:46 -0500 Subject: [PATCH 02/12] fixes --- docs/reference/api-conventions.asciidoc | 15 ++++++++------- .../reference/indices/put-index-template.asciidoc | 3 +-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 8812230f9e570..09bf86976c278 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -54,13 +54,14 @@ syntax. [[hidden-indices]] ==== Hidden data streams and indices -By default, wildcard expressions do not match hidden data streams and indices. -To match hidden data streams and indices using a wildcard expression, use the -`expand_wildcards` query parameter. - -You can hide data streams by setting <> -to `true` in the stream's matching index template. You can hide indices using -the <> index setting. +For most APIs, wildcard expressions do not match hidden data streams and indices +by default. To match hidden data streams and indices using a wildcard +expression, use the `expand_wildcards` query parameter. + +You can create hidden data streams by setting +<> to `true` in the stream's matching +index template. You can hide indices using the <> +index setting. The backing indices for data streams are hidden automatically. Some features, such as {ml}, store information in hidden indices. diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index 2f3a0937d75c6..3300c628709ce 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -115,8 +115,7 @@ See <>. [[data-stream-hidden]] `hidden`:: (Optional, Boolean) -If `true`, the data stream is <>. By default, wildcard -expressions do not match hidden data streams. Defaults to `false`. +If `true`, the data stream is <>. Defaults to `false`. ==== `template`:: From 86070932e7414e3903701d3360a0974aaf9c2cff Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 3 Dec 2020 21:27:50 -0500 Subject: [PATCH 03/12] make expand wildcards consistent --- .../indices/data-stream-stats.asciidoc | 23 +------------------ .../indices/delete-data-stream.asciidoc | 23 +------------------ .../indices/get-data-stream.asciidoc | 23 +------------------ docs/reference/rest-api/common-parms.asciidoc | 2 +- 4 files changed, 4 insertions(+), 67 deletions(-) diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index 45245d7382d7c..e9608886d4dc1 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -72,30 +72,9 @@ To target all data streams in a cluster, omit this parameter or use `*`. [[data-stream-stats-api-query-params]] ==== {api-query-parms-title} -`expand_wildcards`:: +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + --- -(Optional, string) -Type of data stream that wildcard expressions can match. Supports -comma-separated values, such as `open,hidden`. Valid values are: - -`all`::: -Targets any data stream, including <> ones. - -`open`::: -Match non-hidden data streams. - -`hidden`::: -Match hidden data streams. Must be combined with `open`, `closed`, or both. - -`none`::: -Wildcard expressions are not accepted. - -`closed`::: -Reserved for future use. - Defaults to `open`. --- `human`:: (Optional, Boolean) diff --git a/docs/reference/indices/delete-data-stream.asciidoc b/docs/reference/indices/delete-data-stream.asciidoc index 433934db80d2e..fbe2c8c605e1a 100644 --- a/docs/reference/indices/delete-data-stream.asciidoc +++ b/docs/reference/indices/delete-data-stream.asciidoc @@ -53,27 +53,6 @@ Wildcard (`*`) expressions are supported. [[delete-data-stream-api-query-parms]] ==== {api-query-parms-title} -`expand_wildcards`:: +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + --- -(Optional, string) -Type of data stream that wildcard expressions can match. Supports -comma-separated values, such as `open,hidden`. Valid values are: - -`all`::: -Targets any data stream, including <> ones. - -`open`::: -Match non-hidden data streams. - -`hidden`::: -Match hidden data streams. Must be combined with `open`, `closed`, or both. - -`none`::: -Wildcard expressions are not accepted. - -`closed`::: -Reserved for future use. - Defaults to `open`. --- diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc index 7333e3efd2092..de894e23615bd 100644 --- a/docs/reference/indices/get-data-stream.asciidoc +++ b/docs/reference/indices/get-data-stream.asciidoc @@ -88,30 +88,9 @@ returned. [[get-data-stream-api-query-parms]] ==== {api-query-parms-title} -`expand_wildcards`:: +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + --- -(Optional, string) -Type of data stream that wildcard expressions can match. Supports -comma-separated values, such as `open,hidden`. Valid values are: - -`all`::: -Targets any data stream, including <> ones. - -`open`::: -Match non-hidden data streams. - -`hidden`::: -Match hidden data streams. Must be combined with `open`, `closed`, or both. - -`none`::: -Wildcard expressions are not accepted. - -`closed`::: -Reserved for future use. - Defaults to `open`. --- [role="child_attributes"] [[get-data-stream-api-response-body]] diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 1d4f5e97a605a..31207b6ceddb5 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -211,7 +211,7 @@ tag::expand-wildcards[] -- (Optional, string) Type of index that wildcard expressions can match. If the request can target -data streams, this argument also determines whether wildcard expressions match +data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: From aeb28d27da095f9517f28bd6901415e907c1e6f4 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 3 Dec 2020 21:33:57 -0500 Subject: [PATCH 04/12] reword --- docs/reference/api-conventions.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 09bf86976c278..532f3e4eefb43 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -56,7 +56,7 @@ syntax. For most APIs, wildcard expressions do not match hidden data streams and indices by default. To match hidden data streams and indices using a wildcard -expression, use the `expand_wildcards` query parameter. +expression, you must specify the `expand_wildcards` query parameter. You can create hidden data streams by setting <> to `true` in the stream's matching From e24418851eb15647f2d125ee6f3a82dcae9913e4 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 3 Dec 2020 22:23:25 -0500 Subject: [PATCH 05/12] Edit --- docs/reference/indices/create-data-stream.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/indices/create-data-stream.asciidoc b/docs/reference/indices/create-data-stream.asciidoc index e456bcdb9bace..09d2f175b6381 100644 --- a/docs/reference/indices/create-data-stream.asciidoc +++ b/docs/reference/indices/create-data-stream.asciidoc @@ -57,8 +57,8 @@ Data stream names must meet the following criteria: space character - Cannot start with `-`, `_`, `+`, or `.ds-` - Cannot be `.` or `..` -- Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters -will count towards the 255 limit faster) +- Cannot be longer than 255 bytes Multi-byte characters +count towards this limit faster. // end::data-stream-name[] -- From def8366c643a0db5a2e35d4f106244aa914295b8 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 6 Jan 2021 18:26:57 -0500 Subject: [PATCH 06/12] Fix typo --- docs/reference/indices/create-data-stream.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/indices/create-data-stream.asciidoc b/docs/reference/indices/create-data-stream.asciidoc index 09d2f175b6381..9ed6499f03667 100644 --- a/docs/reference/indices/create-data-stream.asciidoc +++ b/docs/reference/indices/create-data-stream.asciidoc @@ -57,7 +57,7 @@ Data stream names must meet the following criteria: space character - Cannot start with `-`, `_`, `+`, or `.ds-` - Cannot be `.` or `..` -- Cannot be longer than 255 bytes Multi-byte characters +- Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. // end::data-stream-name[] -- From 04cd44009a2f27b9f2ef93f1125d5f17edd76a13 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 11 Jan 2021 21:59:20 -0500 Subject: [PATCH 07/12] Add separate def for DS expand wildcards --- .../indices/data-stream-stats.asciidoc | 2 +- .../indices/delete-data-stream.asciidoc | 4 ++- .../indices/get-data-stream.asciidoc | 2 +- docs/reference/rest-api/common-parms.asciidoc | 32 +++++++++++++++++-- 4 files changed, 35 insertions(+), 5 deletions(-) diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index e9608886d4dc1..52dbf73d2655b 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -72,7 +72,7 @@ To target all data streams in a cluster, omit this parameter or use `*`. [[data-stream-stats-api-query-params]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/indices/delete-data-stream.asciidoc b/docs/reference/indices/delete-data-stream.asciidoc index fbe2c8c605e1a..9b69e3121c647 100644 --- a/docs/reference/indices/delete-data-stream.asciidoc +++ b/docs/reference/indices/delete-data-stream.asciidoc @@ -53,6 +53,8 @@ Wildcard (`*`) expressions are supported. [[delete-data-stream-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. ++ +NOTE: For data stream APIs, `hidden` diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc index de894e23615bd..1d9e71b61f50e 100644 --- a/docs/reference/indices/get-data-stream.asciidoc +++ b/docs/reference/indices/get-data-stream.asciidoc @@ -88,7 +88,7 @@ returned. [[get-data-stream-api-query-parms]] ==== {api-query-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 31207b6ceddb5..e392dcce989dd 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -205,6 +205,33 @@ Enrich policy name used to limit the request. end::enrich-policy[] +tag::ds-expand-wildcards[] +`expand_wildcards`:: ++ +-- +(Optional, string) +Type of index that wildcard expressions can match. If the request can target +data streams, this argument determines whether wildcard expressions match +hidden data streams. Supports comma-separated values, such as `open,hidden`. +Valid values are: + +`all`:: +Match any data stream, including <> ones. + +`open`:: +Matches any non-hidden data streams. + +`closed`:: +Matches any non-hidden data streams. Data streams cannot be closed. + +`hidden`:: +Match hidden and non-hidden data streams. + +`none`:: +Wildcard expressions are not accepted. +-- +end::ds-expand-wildcards[] + tag::expand-wildcards[] `expand_wildcards`:: + @@ -219,10 +246,11 @@ Valid values are: Match any data stream or index, including <> ones. `open`:: -Match non-hidden data streams and open, non-hidden indices. +Match open, non-hidden indices. Also matches any non-hidden data stream. `closed`:: -Match closed indices. +Match closed, non-hidden indices. Also matches any non-hidden data stream. Data +streams cannot be closed. `hidden`:: Match hidden data streams and hidden indices. Must be combined with `open`, From 477cbd0ab0cdf713eb7fb03dee0d4fcf5116c4c8 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 11 Jan 2021 22:01:10 -0500 Subject: [PATCH 08/12] Consistent wording --- docs/reference/rest-api/common-parms.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index e392dcce989dd..d5faaed29ba98 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -219,10 +219,10 @@ Valid values are: Match any data stream, including <> ones. `open`:: -Matches any non-hidden data streams. +Matches any non-hidden data stream. `closed`:: -Matches any non-hidden data streams. Data streams cannot be closed. +Matches any non-hidden data stream. Data streams cannot be closed. `hidden`:: Match hidden and non-hidden data streams. From d3472d533afe2a8d791c293e4011ed1670eca587 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 12 Jan 2021 09:18:05 -0500 Subject: [PATCH 09/12] Update DS expand wildcards def --- docs/reference/rest-api/common-parms.asciidoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index d5faaed29ba98..e2f0bd089a0b1 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -210,10 +210,8 @@ tag::ds-expand-wildcards[] + -- (Optional, string) -Type of index that wildcard expressions can match. If the request can target -data streams, this argument determines whether wildcard expressions match -hidden data streams. Supports comma-separated values, such as `open,hidden`. -Valid values are: +Determines whether wildcard expressions match hidden data streams. Supports +comma-separated values, such as `open,hidden`. Valid values are: `all`:: Match any data stream, including <> ones. From c4521e01bd39de4d127c68858d799f396d4075f8 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 12 Jan 2021 09:19:16 -0500 Subject: [PATCH 10/12] Condense values --- docs/reference/rest-api/common-parms.asciidoc | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index e2f0bd089a0b1..9dbe947c5accd 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -213,18 +213,12 @@ tag::ds-expand-wildcards[] Determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: -`all`:: +`all`, `hidden`:: Match any data stream, including <> ones. -`open`:: -Matches any non-hidden data stream. - -`closed`:: +`open`, `closed`:: Matches any non-hidden data stream. Data streams cannot be closed. -`hidden`:: -Match hidden and non-hidden data streams. - `none`:: Wildcard expressions are not accepted. -- From a489215ac07251ae4db7957b4600bee878c29ea0 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 12 Jan 2021 09:20:00 -0500 Subject: [PATCH 11/12] Reword --- docs/reference/rest-api/common-parms.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 9dbe947c5accd..65188e575933b 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -210,7 +210,7 @@ tag::ds-expand-wildcards[] + -- (Optional, string) -Determines whether wildcard expressions match hidden data streams. Supports +Type of data stream that wildcard expressions can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `hidden`:: From 493720624c30e5a3e11630c58e05829822d3234e Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 13 Jan 2021 08:47:37 -0500 Subject: [PATCH 12/12] Remove fragment --- docs/reference/indices/delete-data-stream.asciidoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/reference/indices/delete-data-stream.asciidoc b/docs/reference/indices/delete-data-stream.asciidoc index 9b69e3121c647..e40ec97254e26 100644 --- a/docs/reference/indices/delete-data-stream.asciidoc +++ b/docs/reference/indices/delete-data-stream.asciidoc @@ -56,5 +56,3 @@ Wildcard (`*`) expressions are supported. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards] + Defaults to `open`. -+ -NOTE: For data stream APIs, `hidden`