Skip to content

Commit 8d63196

Browse files
committed
[DOCS] Fix allowed refresh args for several doc APIs (#74749)
We incorrectly list `wait_for` as a valid `refresh` argument for the following APIs: * Delete by query * Multi get * Reindex This fixes that error. It also updates the get API docs for consistency. Closes #65031
1 parent 21e3ae2 commit 8d63196

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

docs/reference/docs/delete-by-query.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q]
194194

195195
include::{docdir}/rest-api/common-parms.asciidoc[tag=request_cache]
196196

197-
include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh]
197+
`refresh`::
198+
(Optional, Boolean) If `true`, {es} refreshes all shards involved in the
199+
delete by query after the request completes. Defaults to `false`.
198200

199201
include::{docdir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
200202

docs/reference/docs/get.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=preference]
166166

167167
include::{docdir}/rest-api/common-parms.asciidoc[tag=realtime]
168168

169-
include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh]
169+
`refresh`::
170+
(Optional, Boolean) If `true`, the request refreshes the relevant shard before
171+
retrieving the document. Defaults to `false`.
170172

171173
include::{docdir}/rest-api/common-parms.asciidoc[tag=routing]
172174

docs/reference/docs/multi-get.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=preference]
6060

6161
include::{docdir}/rest-api/common-parms.asciidoc[tag=realtime]
6262

63-
include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh]
63+
`refresh`::
64+
(Optional, Boolean) If `true`, the request refreshes relevant shards before
65+
retrieving documents. Defaults to `false`.
6466

6567
include::{docdir}/rest-api/common-parms.asciidoc[tag=routing]
6668

docs/reference/docs/reindex.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,9 @@ POST _reindex
417417
[[docs-reindex-api-query-params]]
418418
==== {api-query-parms-title}
419419

420-
include::{docdir}/rest-api/common-parms.asciidoc[tag=refresh]
420+
`refresh`::
421+
(Optional, Boolean) If `true`, the request refreshes affected shards to make
422+
this operation visible to search. Defaults to `false`.
421423

422424
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeout]
423425

0 commit comments

Comments
 (0)