Skip to content

Commit d375116

Browse files
committed
[DOCS] Fix allowed refresh args for several doc APIs (elastic#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 elastic#65031
1 parent ff7d802 commit d375116

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
@@ -209,7 +209,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q]
209209

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

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

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

docs/reference/docs/get.asciidoc

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

169169
`refresh`::
170-
(Optional, Boolean)
171-
If `true`, {es} refreshes the affected shards to make this operation visible to
172-
search. If `false`, do nothing with refreshes. Defaults to `false`.
170+
(Optional, Boolean) If `true`, the request refreshes the relevant shard before
171+
retrieving the document. Defaults to `false`.
173172

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

docs/reference/docs/multi-get.asciidoc

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

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

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

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

docs/reference/docs/reindex.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,9 @@ POST _reindex
461461
[[docs-reindex-api-query-params]]
462462
==== {api-query-parms-title}
463463

464-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
464+
`refresh`::
465+
(Optional, Boolean) If `true`, the request refreshes affected shards to make
466+
this operation visible to search. Defaults to `false`.
465467

466468
`timeout`::
467469
+

0 commit comments

Comments
 (0)