Skip to content

Commit de49fa4

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 459edfb commit de49fa4

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q]
195195

196196
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=request_cache]
197197

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

200202
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=requests_per_second]
201203

docs/reference/docs/get.asciidoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,8 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
161161
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
162162

163163
`refresh`::
164-
(Optional, boolean)
165-
If `true`, {es} refreshes the affected shards to make this operation visible to
166-
search. If `false`, do nothing with refreshes. Defaults to `false`.
164+
(Optional, Boolean) If `true`, the request refreshes the relevant shard before
165+
retrieving the document. Defaults to `false`.
167166

168167
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
169168

docs/reference/docs/multi-get.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
6262

6363
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
6464

65-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
65+
`refresh`::
66+
(Optional, Boolean) If `true`, the request refreshes relevant shards before
67+
retrieving documents. Defaults to `false`.
6668

6769
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
6870

docs/reference/docs/reindex.asciidoc

Lines changed: 3 additions & 1 deletion
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::{es-repo-dir}/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::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeout]
423425

0 commit comments

Comments
 (0)