Skip to content

Commit be88a40

Browse files
authored
Mention dot-prefixed patterns in hidden index docs (#81464) (#83680)
The hidden index docs did not mention that dot-prefixed patterns default to matching hidden indices. This PR adds a note explaining the behavior and why it's like that.
1 parent db654f3 commit be88a40

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/reference/api-conventions.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,11 @@ For most APIs, wildcard expressions do not match hidden data streams and indices
158158
by default. To match hidden data streams and indices using a wildcard
159159
expression, you must specify the `expand_wildcards` query parameter.
160160

161+
Alternatively, querying an index pattern starting with a dot, such as
162+
`.watcher_hist*`, will match hidden indices by default. This is intended to
163+
mirror Unix file-globbing behavior and provide a smoother transition path to
164+
hidden indices.
165+
161166
You can create hidden data streams by setting `data_stream.hidden` to `true` in
162167
the stream's matching <<indices-put-template,index template>>. You can hide
163168
indices using the <<index-hidden,`index.hidden`>> index setting.

0 commit comments

Comments
 (0)