From 41345d4dd3be618eee8829abf8183f0eb64837fc Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 9 Jul 2020 16:54:04 -0400 Subject: [PATCH] [DOCS] Add data streams to clear cache API docs (#59324) (#59339) --- docs/reference/indices/clearcache.asciidoc | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index ba83b8baf34..af3696e38a0 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -4,7 +4,8 @@ Clear cache ++++ -Clears caches for one or more indices. +Clears the caches of one or more indices. For data streams, the API clears the +caches of the stream's backing indices. [source,console] ---- @@ -16,7 +17,7 @@ POST /twitter/_cache/clear [[clear-cache-api-request]] ==== {api-request-title} -`POST //_cache/clear` +`POST //_cache/clear` `POST /_cache/clear` @@ -24,7 +25,13 @@ POST /twitter/_cache/clear [[clear-cache-api-path-params]] ==== {api-path-parms-title} -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index] +``:: +(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 `*`. [[clear-cache-api-query-params]] @@ -127,7 +134,7 @@ POST /twitter/_cache/clear?fields=foo,bar <1> [[clear-cache-api-multi-ex]] -===== Clear caches for several indices +===== Clear caches for several data streams and indices [source,console] ---- @@ -137,7 +144,7 @@ POST /kimchy,elasticsearch/_cache/clear [[clear-cache-api-all-ex]] -===== Clear caches for all indices +===== Clear caches for all data streams and indices [source,console] ----