From 3182482701470567996fd55c9035a5ac39af26aa Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 27 May 2021 17:57:51 -0400 Subject: [PATCH] [DOCS] Update alias references (#73427) (#73502) Updates several `index aliases` references to `aliases`. --- docs/reference/api-conventions.asciidoc | 10 +++++----- docs/reference/cat/count.asciidoc | 13 +++++------- docs/reference/cat/indices.asciidoc | 11 ++++------ docs/reference/cat/recovery.asciidoc | 12 ++++------- docs/reference/cat/segments.asciidoc | 11 ++++------ docs/reference/cat/shards.asciidoc | 11 ++++------ docs/reference/cluster/state.asciidoc | 10 +++------- .../change-mappings-and-settings.asciidoc | 6 +++--- .../data-streams/use-a-data-stream.asciidoc | 4 ++-- docs/reference/docs/delete-by-query.asciidoc | 11 ++++------ docs/reference/docs/reindex.asciidoc | 10 +++++----- docs/reference/docs/update-by-query.asciidoc | 11 ++++------ docs/reference/eql/eql-search-api.asciidoc | 2 +- docs/reference/ilm/apis/explain.asciidoc | 8 +++----- .../apis/remove-policy-from-index.asciidoc | 8 +++----- .../indices/apis/reload-analyzers.asciidoc | 11 ++++------ docs/reference/indices/clearcache.asciidoc | 12 ++++------- docs/reference/indices/flush.asciidoc | 12 ++++------- docs/reference/indices/forcemerge.asciidoc | 14 +++++-------- .../indices/get-field-mapping.asciidoc | 10 ++++------ docs/reference/indices/get-index.asciidoc | 12 ++++------- docs/reference/indices/get-mapping.asciidoc | 12 ++++------- docs/reference/indices/get-settings.asciidoc | 11 ++++------ docs/reference/indices/index-mgmt.asciidoc | 8 ++++---- docs/reference/indices/open-close.asciidoc | 9 +++------ docs/reference/indices/put-mapping.asciidoc | 12 ++++------- docs/reference/indices/recovery.asciidoc | 12 ++++------- docs/reference/indices/refresh.asciidoc | 13 ++++++------ docs/reference/indices/resolve.asciidoc | 7 +++---- docs/reference/indices/segments.asciidoc | 12 ++++------- docs/reference/indices/shard-stores.asciidoc | 12 ++++------- docs/reference/indices/stats.asciidoc | 11 ++++------ .../indices/update-settings.asciidoc | 12 ++++------- docs/reference/search/count.asciidoc | 12 ++++------- docs/reference/search/field-caps.asciidoc | 12 ++++------- docs/reference/search/multi-search.asciidoc | 20 +++++++++---------- .../search/point-in-time-api.asciidoc | 6 +++--- docs/reference/search/rank-eval.asciidoc | 11 ++++------ docs/reference/search/scroll-api.asciidoc | 2 +- docs/reference/search/search-shards.asciidoc | 12 ++++------- .../reference/search/search-template.asciidoc | 4 ++-- .../search-multiple-indices.asciidoc | 2 +- docs/reference/search/search.asciidoc | 15 ++++++-------- docs/reference/search/terms-enum.asciidoc | 9 +++------ docs/reference/search/validate.asciidoc | 11 ++++------ .../apis/clear-cache.asciidoc | 7 +++---- 46 files changed, 176 insertions(+), 287 deletions(-) diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 0e639ff07151..9e377fa354c4 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -19,17 +19,17 @@ Most APIs that accept a ``, ``, or `` request path parameter also support _multi-target syntax_. In multi-target syntax, you can use a comma-separated list to run a request on -multiple resources, such as data streams, indices, or index aliases: +multiple resources, such as data streams, indices, or aliases: `test1,test2,test3`. You can also use {wikipedia}/Glob_(programming)[glob-like] wildcard (`*`) expressions to target resources that match a pattern: `test*` or `*test` or `te*t` or `*test*`. You can exclude targets using the `-` character: `test*,-test3`. -IMPORTANT: Index aliases are resolved after wildcard expressions. This can -result in a request that targets an excluded alias. For example, if `test3` is -an index alias, the pattern `test*,-test3` still targets the indices for -`test3`. To avoid this, exclude the concrete indices for the alias instead. +IMPORTANT: Aliases are resolved after wildcard expressions. This can result in a +request that targets an excluded alias. For example, if `test3` is an index +alias, the pattern `test*,-test3` still targets the indices for `test3`. To +avoid this, exclude the concrete indices for the alias instead. Multi-target APIs that can target indices support the following query string parameters: diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index 39f3ab1bdaf6..ce206be30830 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -22,19 +22,16 @@ which have not yet been removed by the merge process. ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have the `read` -<> for any data stream, index, or index -alias you retrieve. +<> for any data stream, index, or alias +you retrieve. [[cat-count-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[cat-count-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 9e82db03c679..97396bc6c591 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -21,7 +21,7 @@ indices for data streams. * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> to use this API. You must also have the `monitor` or `manage` <> -for any data stream, index, or index alias you retrieve. +for any data stream, index, or alias you retrieve. [[cat-indices-api-desc]] ==== {api-description-title} @@ -48,12 +48,9 @@ To get an accurate count of {es} documents, use the <> or ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[cat-indices-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index 6c91b313cac6..3962aeefe858 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -24,7 +24,7 @@ indices. * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> to use this API. You must also have the `monitor` or `manage` <> -for any data stream, index, or index alias you retrieve. +for any data stream, index, or alias you retrieve. [[cat-recovery-api-desc]] ==== {api-description-title} @@ -40,13 +40,9 @@ include::{es-repo-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[cat-recovery-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 7bc38e007773..d9949068d75a 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -24,18 +24,15 @@ indices. * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> to use this API. You must also have the `monitor` or `manage` <> -for any data stream, index, or index alias you retrieve. +for any data stream, index, or alias you retrieve. [[cat-segments-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[cat-segments-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index 0aaa1c0c7d0c..b0ec8f0674fb 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -25,18 +25,15 @@ indices. * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> to use this API. You must also have the `monitor` or `manage` <> -for any data stream, index, or index alias you retrieve. +for any data stream, index, or alias you retrieve. [[cat-shards-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[cat-shards-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index 81e0ce9bc7a1..9dfd71b263f2 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -93,13 +93,9 @@ you can request only the part of the cluster state that you need: -- ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[cluster-state-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/data-streams/change-mappings-and-settings.asciidoc b/docs/reference/data-streams/change-mappings-and-settings.asciidoc index 0136b9d224be..7f6f8cc9b134 100644 --- a/docs/reference/data-streams/change-mappings-and-settings.asciidoc +++ b/docs/reference/data-streams/change-mappings-and-settings.asciidoc @@ -386,10 +386,10 @@ Follow these steps: stream will contain data from your existing stream. + You can use the resolve index API to check if the name or pattern matches any -existing indices, index aliases, or data streams. If so, you should consider -using another name or pattern. +existing indices, aliases, or data streams. If so, you should consider using +another name or pattern. -- -The following resolve index API request checks for any existing indices, index +The following resolve index API request checks for any existing indices, aliases, or data streams that start with `new-data-stream`. If not, the `new-data-stream*` index pattern can be used to create a new data stream. diff --git a/docs/reference/data-streams/use-a-data-stream.asciidoc b/docs/reference/data-streams/use-a-data-stream.asciidoc index 47447f9bb906..b6fbd5ff1d99 100644 --- a/docs/reference/data-streams/use-a-data-stream.asciidoc +++ b/docs/reference/data-streams/use-a-data-stream.asciidoc @@ -154,8 +154,8 @@ POST /my-data-stream/_open/ [[reindex-with-a-data-stream]] === Reindex with a data stream -Use the <> to copy documents from an -existing index, index alias, or data stream to a data stream. Because data streams are +Use the <> to copy documents from an existing index, +alias, or data stream to a data stream. Because data streams are <>, a reindex into a data stream must use an `op_type` of `create`. A reindex cannot update existing documents in a data stream. diff --git a/docs/reference/docs/delete-by-query.asciidoc b/docs/reference/docs/delete-by-query.asciidoc index 67fdc7f5f85e..80de31090bb6 100644 --- a/docs/reference/docs/delete-by-query.asciidoc +++ b/docs/reference/docs/delete-by-query.asciidoc @@ -54,7 +54,7 @@ POST /my-index-000001/_delete_by_query * If the {es} {security-features} are enabled, you must have the following <> for the target data stream, index, -or index alias: +or alias: ** `read` ** `delete` or `write` @@ -168,12 +168,9 @@ documents being reindexed and cluster resources. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams or indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases to +search. Supports wildcards (`*`). To search all data streams or indices, omit +this parameter or use `* or `_all`. [[docs-delete-by-query-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 64be39b3e77a..c524a0fcd57e 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -75,18 +75,18 @@ POST _reindex security privileges: ** The `read` <> for the source data -stream, index, or index alias. +stream, index, or alias. ** The `write` index privilege for the destination data stream, index, or index alias. ** To automatically create a data stream or index with an reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index -privilege for the destination data stream, index, or index alias. +privilege for the destination data stream, index, or alias. ** If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` <> and the `read` index -privilege for the source data stream, index, or index alias. +privilege for the source data stream, index, or alias. * If reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting of `elasticsearch.yml`. See @@ -507,8 +507,8 @@ Defaults to `abort`. `source`:: `index`::: -(Required, string) The name of the data stream, index, or index alias you are copying _from_. -Also accepts a comma-separated list to reindex from multiple sources. +(Required, string) The name of the data stream, index, or alias you are copying +_from_. Also accepts a comma-separated list to reindex from multiple sources. `max_docs`::: (Optional, integer) The maximum number of documents to reindex. If <> is equal to diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index de00d8e3cb18..fa68f219ff07 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -51,7 +51,7 @@ POST my-index-000001/_update_by_query?conflicts=proceed * If the {es} {security-features} are enabled, you must have the following <> for the target data stream, index, -or index alias: +or alias: ** `read` ** `index` or `write` @@ -162,12 +162,9 @@ documents being reindexed and cluster resources. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams or indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases to +search. Supports wildcards (`*`). To search all data streams or indices, omit +this parameter or use `*` or `_all`. [[docs-update-by-query-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index 8b223ff7bdef..3e77158ec8d0 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -44,7 +44,7 @@ GET /my-data-stream/_eql/search * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. +or alias. * See <>. diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index 003d10af6c0c..6185ba0849bf 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -34,11 +34,9 @@ about any failures. ==== {api-path-parms-title} ``:: -(Required, string) -Comma-separated list of data streams, indices, and index aliases to target. -Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, use `_all` or `*`. +(Required, string) Comma-separated list of data streams, indices, and aliases to +target. Supports wildcards (`*`).To target all data streams and indices, use `*` +or `_all`. [[ilm-explain-lifecycle-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc index 1826dc1e6f50..c682038fb264 100644 --- a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc +++ b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc @@ -34,11 +34,9 @@ the stream's backing indices and stops managing the indices. ==== {api-path-parms-title} ``:: -(Required, string) -Comma-separated list of data streams, indices, and index aliases to target. -Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, use `_all` or `*`. +(Required, string) Comma-separated list of data streams, indices, and aliases to +target. Supports wildcards (`*`). To target all data streams and indices, use +`*` or `_all`. [[ilm-remove-policy-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/apis/reload-analyzers.asciidoc b/docs/reference/indices/apis/reload-analyzers.asciidoc index 5e56953a41c2..8daa393c22c3 100644 --- a/docs/reference/indices/apis/reload-analyzers.asciidoc +++ b/docs/reference/indices/apis/reload-analyzers.asciidoc @@ -35,7 +35,7 @@ IMPORTANT: After reloading the search analyzers you should clear the request * If the {es} {security-features} are enabled, you must have the `manage` <> for the target data stream, index, -or index alias. +or alias. [discrete] [[indices-reload-analyzers-api-desc]] @@ -78,12 +78,9 @@ in the future. === {api-path-parms-title} ``:: -(Required, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, use `_all` or `*`. - +(Required, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, use `*` or `_all`. [discrete] [[indices-reload-analyzers-api-query-params]] diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 8011c2cd3aa8..10b590fce097 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -26,19 +26,15 @@ POST /my-index-000001/_cache/clear * If the {es} {security-features} are enabled, you must have the `manage` <> for the target data stream, index, -or index alias. +or alias. [[clear-cache-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[clear-cache-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index a5b20aa251a3..180f63f6adaa 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -29,7 +29,7 @@ POST /my-index-000001/_flush * If the {es} {security-features} are enabled, you must have the `maintenance` or `manage` <> for the target data -stream, index, or index alias. +stream, index, or alias. [[flush-api-desc]] ==== {api-description-title} @@ -60,13 +60,9 @@ flush API was called. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to flush. -Wildcard expressions (`*`) are supported. -+ -To flush all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases to +flush. Supports wildcards (`*`). To flush all data streams and indices, omit +this parameter or use `*` or `_all`. [[flush-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index 743546b14c51..8a2dd1a46419 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -27,7 +27,7 @@ POST /my-index-000001/_forcemerge * If the {es} {security-features} are enabled, you must have the `maintenance` or `manage` <> for the target data -stream, index, or index alias. +stream, index, or alias. [[forcemerge-api-desc]] ==== {api-description-title} @@ -65,7 +65,7 @@ You can force merge multiple indices with a single request by targeting: * One or more data streams that contain multiple backing indices * Multiple indices -* One or more index aliases that point to multiple indices +* One or more aliases * All data streams and indices in a cluster Each targeted shard is force-merged separately using <`:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[forcemerge-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index 8448370cf53f..c4fcb33de921 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -29,17 +29,15 @@ GET /my-index-000001/_mapping/field/user * If the {es} {security-features} are enabled, you must have the `view_index_metadata` or `manage` <> -for the target data stream, index, or index alias. +for the target data stream, index, or alias. [[get-field-mapping-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard (`*`) expressions are supported. -+ -To target all indices in a cluster, omit this parameter or use `_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. ``:: (Optional, string) Comma-separated list or wildcard expression of fields used to diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index ce98f9db91ec..327b677affd2 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -28,19 +28,15 @@ through the parameter include_type_name. For more details, please see <> -for the target data stream, index, or index alias. +for the target data stream, index, or alias. [[get-index-api-path-params]] ==== {api-path-parms-title} ``:: -(Required, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Required, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[get-index-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 44f82f776131..6049267dbc9d 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -30,19 +30,15 @@ through the parameter `include_type_name`. For more details, please see <> -for the target data stream, index, or index alias. +for the target data stream, index, or alias. [[get-mapping-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[get-mapping-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/get-settings.asciidoc b/docs/reference/indices/get-settings.asciidoc index 04c11a82b5a1..3512e9f8eb92 100644 --- a/docs/reference/indices/get-settings.asciidoc +++ b/docs/reference/indices/get-settings.asciidoc @@ -26,18 +26,15 @@ GET /my-index-000001/_settings * If the {es} {security-features} are enabled, you must have the `view_index_metadata`, `monitor`, or `manage` <> for the target data stream, index, or index alias. +privilege>> for the target data stream, index, or alias. [[get-index-settings-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. ``:: (Optional, string) Comma-separated list or wildcard expression of setting names diff --git a/docs/reference/indices/index-mgmt.asciidoc b/docs/reference/indices/index-mgmt.asciidoc index 1b5cc2638980..0cda6dbe7ab0 100644 --- a/docs/reference/indices/index-mgmt.asciidoc +++ b/docs/reference/indices/index-mgmt.asciidoc @@ -125,14 +125,14 @@ with that index pattern. . Leave *Data Stream*, *Priority*, *Version*, and *_meta field* blank or as-is. -*Step 2. Add settings, mappings, and index aliases* +*Step 2. Add settings, mappings, and aliases* . Add <> to your index template. + Component templates are pre-configured sets of mappings, index settings, and -index aliases you can reuse across multiple index templates. Badges indicate +aliases you can reuse across multiple index templates. Badges indicate whether a component template contains mappings (*M*), index settings (*S*), -index aliases (*A*), or a combination of the three. +aliases (*A*), or a combination of the three. + Component templates are optional. For this tutorial, do not add any component templates. @@ -171,7 +171,7 @@ You can create additional mapping configurations in the *Dynamic templates* and *Advanced options* tabs. For this tutorial, do not create any additional mappings. -. Define an index alias named `my-index`: +. Define an alias named `my-index`: + [source,js] ---- diff --git a/docs/reference/indices/open-close.asciidoc b/docs/reference/indices/open-close.asciidoc index 24669d5b871d..bb0b305eb7ce 100644 --- a/docs/reference/indices/open-close.asciidoc +++ b/docs/reference/indices/open-close.asciidoc @@ -25,7 +25,7 @@ POST /my-index-000001/_open * If the {es} {security-features} are enabled, you must have the `manage` <> for the target data stream, index, -or index alias. +or alias. [[open-index-api-desc]] ==== {api-description-title} @@ -85,17 +85,14 @@ index creation applies to the `_open` and `_close` index actions as well. ``:: (Optional, string) -Comma-separated list or wildcard (`*`) expression of data streams, indices, and -index aliases used to limit the request. -+ -To target all data streams and indices, use `_all` or `*`. +Comma-separated list of data streams, indices, and aliases used to limit +the request. Supports wildcards (`*`). + To disallow use of `_all` or wildcard expressions, change the `action.destructive_requires_name` cluster setting to `true`. You can update this setting in the `elasticsearch.yml` file or using the <> API. - [[open-index-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index 3579b535dee1..f5c7764cb4b2 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -38,7 +38,7 @@ please see <>. * If the {es} {security-features} are enabled, you must have the `manage` <> for the target data stream, index, -or index alias. +or alias. + deprecated:[7.9] If the request targets an index or index alias, you can also update its mapping with the `create`, `create_doc`, `index`, or `write` index @@ -49,13 +49,9 @@ privilege. ==== {api-path-parms-title} ``:: -(Required, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Required, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[put-mapping-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 5c231e345eee..270d77c5b313 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -28,7 +28,7 @@ GET /my-index-000001/_recovery * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> for the target data stream, -index, or index alias. +index, or alias. [[index-recovery-api-desc]] ==== {api-description-title} @@ -56,13 +56,9 @@ Recovery automatically occurs during the following processes: ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[index-recovery-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/refresh.asciidoc b/docs/reference/indices/refresh.asciidoc index da10d4d6ce36..1d6a56ce2a40 100644 --- a/docs/reference/indices/refresh.asciidoc +++ b/docs/reference/indices/refresh.asciidoc @@ -30,7 +30,7 @@ POST /my-index-000001/_refresh * If the {es} {security-features} are enabled, you must have the `maintenance` or `manage` <> for the target data -stream, index, or index alias. +stream, index, or alias. [[refresh-api-desc]] ==== {api-description-title} @@ -72,12 +72,11 @@ before running the search. [[refresh-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] -+ -To refresh all indices in the cluster, -omit this parameter -or use a value of `_all` or `*`. - +``:: +(Optional, string) +Comma-separated list of data streams, indices, and aliases used to limit +the request. Supports wildcards (`*`). To target all data streams and indices, +omit this parameter or use `*` or `_all`. [[refresh-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/resolve.asciidoc b/docs/reference/indices/resolve.asciidoc index 0b62cb154382..0ffffae769c0 100644 --- a/docs/reference/indices/resolve.asciidoc +++ b/docs/reference/indices/resolve.asciidoc @@ -4,9 +4,8 @@ Resolve index ++++ -Resolves the specified name(s) and/or index patterns for indices, index -aliases, and data streams. Multiple patterns and remote clusters are -supported. +Resolves the specified name(s) and/or index patterns for indices, aliases, and +data streams. Multiple patterns and remote clusters are supported. //// [source,console] @@ -70,7 +69,7 @@ for the target data stream, index, or index alias. + -- (Required, string) Comma-separated name(s) or index pattern(s) of the -indices, index aliases, and data streams to resolve. Resources on +indices, aliases, and data streams to resolve. Resources on <> can be specified using the `:` syntax. -- diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index bcef2ab17859..f45ac13e1a06 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -27,19 +27,15 @@ GET /my-index-000001/_segments * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> for the target data stream, -index, or index alias. +index, or alias. [[index-segments-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[index-segments-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index fff82789a03c..f014d686b3cb 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -28,7 +28,7 @@ GET /my-index-000001/_shard_stores * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> for the target data stream, -index, or index alias. +index, or alias. [[index-shard-stores-api-desc]] ==== {api-description-title} @@ -51,13 +51,9 @@ or have one or more unassigned replica shards. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[index-shard-stores-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/indices/stats.asciidoc b/docs/reference/indices/stats.asciidoc index 302461f5ce1e..41b213b7a5b2 100644 --- a/docs/reference/indices/stats.asciidoc +++ b/docs/reference/indices/stats.asciidoc @@ -28,7 +28,7 @@ GET /my-index-000001/_stats * If the {es} {security-features} are enabled, you must have the `monitor` or `manage` <> for the target data stream, -index, or index alias. +index, or alias. [[index-stats-api-desc]] ==== {api-description-title} @@ -60,12 +60,9 @@ to which the shard contributed. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-metric] diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index 52672067fd70..c1793c1198a0 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -31,19 +31,15 @@ PUT /my-index-000001/_settings * If the {es} {security-features} are enabled, you must have the `manage` <> for the target data stream, index, -or index alias. +or alias. [[update-index-settings-api-path-params]] ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[update-index-settings-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/search/count.asciidoc b/docs/reference/search/count.asciidoc index 7210ac809421..dd96702a6390 100644 --- a/docs/reference/search/count.asciidoc +++ b/docs/reference/search/count.asciidoc @@ -26,7 +26,7 @@ the <> works. * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. +or alias. [[search-count-api-desc]] @@ -49,13 +49,9 @@ scalability of count. ==== {api-path-parms-title} ``:: - -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases to +search. Supports wildcards (`*`). To search all data streams and indices, omit +this parameter or use `*` or `_all`. [[search-count-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc index 323842116625..80ee6bfc2478 100644 --- a/docs/reference/search/field-caps.asciidoc +++ b/docs/reference/search/field-caps.asciidoc @@ -31,7 +31,7 @@ GET /_field_caps?fields=rating * If the {es} {security-features} are enabled, you must have the `view_index_metadata`, `read`, or `manage` <> for the target data stream, index, or index alias. +privilege>> for the target data stream, index, or alias. [[search-field-caps-api-desc]] ==== {api-description-title} @@ -49,13 +49,9 @@ other field. For example, a runtime field with a type of ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard expressions (`*`) are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[search-field-caps-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/search/multi-search.asciidoc b/docs/reference/search/multi-search.asciidoc index 9f6e20680487..b69f0fe4123b 100644 --- a/docs/reference/search/multi-search.asciidoc +++ b/docs/reference/search/multi-search.asciidoc @@ -26,7 +26,7 @@ GET my-index-000001/_msearch * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. For cross-cluster search, see <>. +or alias. For cross-cluster search, see <>. [[search-multi-search-api-desc]] ==== {api-description-title} @@ -61,7 +61,7 @@ this endpoint the `Content-Type` header should be set to `application/x-ndjson`. ``:: (Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. +Comma-separated list of data streams, indices, and aliases to search. + This list acts as a fallback if a search in the request body does not specify an `index` target. @@ -183,7 +183,7 @@ line. If `true`, the request does *not* return an error if a wildcard expression or `_all` value retrieves only missing or closed indices. + -This parameter also applies to <> that point to a missing +This parameter also applies to <> that point to a missing or closed index. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] @@ -196,8 +196,8 @@ included in the response. Defaults to `false`. `index`:: (Optional, string or array of strings) -Data streams, indices, and index aliases to search. Wildcard (`*`) expressions -are supported. You can specify multiple targets as an array. +Data streams, indices, and aliases to search. Supports wildcards (`*`). Specify +multiple targets as an array. + If this parameter is not specified, the `` request path parameter is used as a fallback. @@ -274,10 +274,10 @@ Number of hits to return. Defaults to `10`. [[search-multi-search-api-example]] ==== {api-examples-title} -The header part includes which data streams, indices, and index aliases to -search. The header also indicates the `search_type`, -`preference`, and `routing`. The body includes the typical search body request -(including the `query`, `aggregations`, `from`, `size`, and so on). +The header includes the data streams, indices, and aliases to search. The header +also indicates the `search_type`, `preference`, and `routing`. The body includes +the typical search body request (including the `query`, `aggregations`, `from`, +`size`, and so on). [source,js] -------------------------------------------------- @@ -305,7 +305,7 @@ Note, the above includes an example of an empty header (can also be just without any content) which is supported as well. -The endpoint also allows you to search against data streams, indices, and index +The endpoint also allows you to search against data streams, indices, and aliases in the request path. In this case, it will be used as the default target unless explicitly specified in the header's `index` parameter. For example: diff --git a/docs/reference/search/point-in-time-api.asciidoc b/docs/reference/search/point-in-time-api.asciidoc index 5091d650594a..048a36d1803b 100644 --- a/docs/reference/search/point-in-time-api.asciidoc +++ b/docs/reference/search/point-in-time-api.asciidoc @@ -17,10 +17,10 @@ changes happening between searches are only visible to the more recent point in * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. +or alias. + -To search a <> for an index alias, you -must have the `read` index privilege for the alias's concrete indices. +To search a <> for an alias, you +must have the `read` index privilege for the alias's data streams or indices. [[point-in-time-api-example]] ==== {api-examples-title} diff --git a/docs/reference/search/rank-eval.asciidoc b/docs/reference/search/rank-eval.asciidoc index af9020d9bcd8..b7a41d3f376a 100644 --- a/docs/reference/search/rank-eval.asciidoc +++ b/docs/reference/search/rank-eval.asciidoc @@ -19,7 +19,7 @@ typical search queries. * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. +or alias. [[search-rank-eval-api-desc]] ==== {api-description-title} @@ -71,12 +71,9 @@ generation in your application. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases used to limit -the request. Wildcard (`*`) expressions are supported. -+ -To target all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases +used to limit the request. Supports wildcards (`*`). To target all data streams +and indices, omit this parameter or use `*` or `_all`. [[search-rank-eval-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/search/scroll-api.asciidoc b/docs/reference/search/scroll-api.asciidoc index cbb846bef6d1..e3b4123ddff6 100644 --- a/docs/reference/search/scroll-api.asciidoc +++ b/docs/reference/search/scroll-api.asciidoc @@ -53,7 +53,7 @@ deprecated:[7.0.0] * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. +or alias. [[scroll-api-desc]] ==== {api-description-title} diff --git a/docs/reference/search/search-shards.asciidoc b/docs/reference/search/search-shards.asciidoc index ae78dd403d37..87a265bf5c8e 100644 --- a/docs/reference/search/search-shards.asciidoc +++ b/docs/reference/search/search-shards.asciidoc @@ -23,7 +23,7 @@ GET /my-index-000001/_search_shards * If the {es} {security-features} are enabled, you must have the `view_index_metadata` or `manage` <> -for the target data stream, index, or index alias. +for the target data stream, index, or alias. [[search-shards-api-desc]] ==== {api-description-title} @@ -38,13 +38,9 @@ are used, the filter is returned as part of the `indices` section. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. - +(Optional, string) Comma-separated list of data streams, indices, and aliases to +search. Supports wildcards (`*`). To search all data streams and indices, omit +this parameter or use `*` or `_all`. [[search-shards-api-query-params]] ==== {api-query-parms-title} diff --git a/docs/reference/search/search-template.asciidoc b/docs/reference/search/search-template.asciidoc index 400f5f0d682e..cdc0e37e18cf 100644 --- a/docs/reference/search/search-template.asciidoc +++ b/docs/reference/search/search-template.asciidoc @@ -33,7 +33,7 @@ GET _search/template * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. For cross-cluster search, see <>. +or alias. For cross-cluster search, see <>. [[search-template-api-desc]] ==== {api-description-title} @@ -671,7 +671,7 @@ Allows to execute several search template requests. * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. For cross-cluster search, see <>. +or alias. For cross-cluster search, see <>. [[multi-search-template-api-desc]] ==== {api-description-title} diff --git a/docs/reference/search/search-your-data/search-multiple-indices.asciidoc b/docs/reference/search/search-your-data/search-multiple-indices.asciidoc index 473028b0decd..c257de0af96e 100644 --- a/docs/reference/search/search-your-data/search-multiple-indices.asciidoc +++ b/docs/reference/search/search-your-data/search-multiple-indices.asciidoc @@ -98,7 +98,7 @@ GET /_search -------------------------------------------------- // TEST[s/^/PUT my-index-000001\nPUT my-index-000002\n/] -Index aliases and index patterns can also be used: +Aliases and index patterns can also be used: [source,console] -------------------------------------------------- diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 73b755f7e916..3e6290301f80 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -28,10 +28,10 @@ GET /my-index-000001/_search * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. For cross-cluster search, see <>. +or alias. For cross-cluster search, see <>. + -To search a <> for an index alias, you -must have the `read` index privilege for the alias's concrete indices. +To search a <> for an alias, you +must have the `read` index privilege for the alias's data streams or indices. [[search-search-api-desc]] ==== {api-description-title} @@ -44,12 +44,9 @@ query string parameter>> or <>. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams and indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases to +search. Supports wildcards (`*`). To search all data streams and indices, omit +this parameter or use `*` or `_all`. [role="child_attributes"] [[search-search-api-query-params]] diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc index 30cf3ae06583..4fc997ecdbdd 100644 --- a/docs/reference/search/terms-enum.asciidoc +++ b/docs/reference/search/terms-enum.asciidoc @@ -55,12 +55,9 @@ string. It is designed for low-latency look-ups used in auto-complete scenarios. ==== {api-path-parms-title} ``:: -(Mandatory, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams or indices in a cluster, omit this parameter or use -`_all` or `*`. +(Required, string) Comma-separated list of data streams, indices, and aliases +to search. Supports wildcards (`*`). To search all data streams or indices, omit +this parameter or use `*` or `_all`. [[search-terms-enum-api-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/search/validate.asciidoc b/docs/reference/search/validate.asciidoc index 5dde3bc6a956..528e24151c47 100644 --- a/docs/reference/search/validate.asciidoc +++ b/docs/reference/search/validate.asciidoc @@ -23,7 +23,7 @@ GET my-index-000001/_validate/query?q=user.id:kimchy * If the {es} {security-features} are enabled, you must have the `read` <> for the target data stream, index, -or index alias. +or alias. [[search-validate-api-desc]] ==== {api-description-title} @@ -37,12 +37,9 @@ request body. ==== {api-path-parms-title} ``:: -(Optional, string) -Comma-separated list of data streams, indices, and index aliases to search. -Wildcard (`*`) expressions are supported. -+ -To search all data streams or indices in a cluster, omit this parameter or use -`_all` or `*`. +(Optional, string) Comma-separated list of data streams, indices, and aliases to +search. Supports wildcards (`*`). To search all data streams or indices, omit +this parameter or use `*` or `_all`. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=query] diff --git a/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc b/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc index 97484fb43a4b..bc86e1328202 100644 --- a/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc +++ b/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc @@ -24,16 +24,15 @@ Clears indices and data streams from the shared cache for If the {es} {security-features} are enabled, you must have the `manage` <> to use this API. You must also have the `manage` <> for the target -data stream, index, or index alias. +data stream, index, or alias. [[searchable-snapshots-api-clear-cache-path-params]] ==== {api-path-parms-title} ``:: (Optional, string) -Comma-separated list of data streams, indices, and index aliases to clear from the cache. -To clear the entire cache, omit this parameter. Supports wildcards (`*`). - +Comma-separated list of data streams, indices, and aliases to clear from the +cache. Supports wildcards (`*`). To clear the entire cache, omit this parameter. [[searchable-snapshots-api-clear-cache-example]] ==== {api-examples-title}