Skip to content

Commit 4dbd891

Browse files
authored
Document that ?wait_for_active_shards=0 is permitted (#114091) (#114274)
Today the docs for the `?wait_for_active_shards` parameter say that it must be a positive integer, proscribing `0`, yet `0` is a legitimate value for this parameter. This commit fixes this point and rewords the docs slightly for clarity.
1 parent 8aadc7a commit 4dbd891

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1297,10 +1297,11 @@ tag::wait_for_active_shards[]
12971297
`wait_for_active_shards`::
12981298
+
12991299
--
1300-
(Optional, string) The number of shard copies that must be active before
1301-
proceeding with the operation. Set to `all` or any positive integer up
1302-
to the total number of shards in the index (`number_of_replicas+1`).
1303-
Default: 1, the primary shard.
1300+
(Optional, string) The number of copies of each shard that must be active
1301+
before proceeding with the operation. Set to `all` or any non-negative integer
1302+
up to the total number of copies of each shard in the index
1303+
(`number_of_replicas+1`). Defaults to `1`, meaning to wait just for each
1304+
primary shard to be active.
13041305

13051306
See <<index-wait-for-active-shards>>.
13061307
--

0 commit comments

Comments
 (0)