Skip to content

[7.14] [DOCS] Fix allowed refresh args for several doc APIs (#74749) #75057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2021
Merged

[7.14] [DOCS] Fix allowed refresh args for several doc APIs (#74749) #75057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/reference/docs/delete-by-query.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=search-q]

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

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

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

Expand Down
5 changes: 2 additions & 3 deletions docs/reference/docs/get.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,8 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]

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

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

Expand Down
4 changes: 3 additions & 1 deletion docs/reference/docs/multi-get.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]

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

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

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

Expand Down
4 changes: 3 additions & 1 deletion docs/reference/docs/reindex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,9 @@ POST _reindex
[[docs-reindex-api-query-params]]
==== {api-query-parms-title}

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

`timeout`::
+
Expand Down