Skip to content

Commit c03f51f

Browse files
authored
[Docs] Clarify default value for allow_no_indices (#52635) (#52697)
Add default value to each one of the usages of `allow_no_indices` since it differs between different APIs. Relates to: #52534 (cherry picked from commit 2eb9864)
1 parent 225d841 commit c03f51f

28 files changed

+58
-6
lines changed

docs/reference/cluster/state.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
9696
(Optional, boolean) If `true`, the wildcard indices expression that resolves
9797
into no concrete indices will be ignored. (This includes `_all` string or
9898
when no indices have been specified).
99+
+
100+
Defaults to `true`.
99101

100102
`expand_wildcards`::
101103
(Optional, string) Whether to expand wildcard expression to concrete indices

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ or omit to search all indices.
162162
==== {api-query-parms-title}
163163

164164
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
165+
+
166+
Defaults to `true`.
165167

166168
include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
167169

docs/reference/indices/alias-exists.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3636
[[alias-exists-api-query-params]]
3737
==== {api-query-parms-title}
3838

39-
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
40-
4139
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4240
+
4341
Defaults to `all`.

docs/reference/indices/apis/reload-analyzers.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ used to limit the request.
7474
=== {api-query-parms-title}
7575

7676
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
77+
+
78+
Defaults to `true`.
7779

7880
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
7981
+

docs/reference/indices/clearcache.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3131
==== {api-query-parms-title}
3232

3333
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
34+
+
35+
Defaults to `true`.
3436

3537
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
3638
+

docs/reference/indices/close.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ or using the <<cluster-update-settings,cluster update settings>> API.
4343
==== {api-query-parms-title}
4444

4545
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
46+
+
47+
Defaults to `true`.
4648

4749
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4850
+

docs/reference/indices/delete-index.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,13 @@ this setting in the `elasticsearch.yml` file or using the
4343
==== {api-query-parms-title}
4444

4545
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
46+
+
47+
Defaults to `true`.
4648

4749
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4850
+
4951
Defaults to `open`.
5052

5153
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
5254

53-
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
55+
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

docs/reference/indices/flush.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ or use a value of `_all` or `*`.
6464
==== {api-query-parms-title}
6565

6666
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
67+
+
68+
Defaults to `true`.
6769

6870
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
6971
+

docs/reference/indices/forcemerge.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ or use a value of `_all` or `*`.
7272
==== {api-query-parms-title}
7373

7474
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
75+
+
76+
Defaults to `true`.
7577

7678
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
7779
+

docs/reference/indices/get-alias.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
4343
==== {api-query-parms-title}
4444

4545
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
46+
+
47+
Defaults to `true`.
4648

4749
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4850
+

docs/reference/indices/get-field-mapping.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ limit returned information.
3737
==== {api-query-parms-title}
3838

3939
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
40+
+
41+
Defaults to `true`.
4042

4143
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4244

docs/reference/indices/get-index.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Use a value of `_all` to retrieve information for all indices in the cluster.
4040
==== {api-query-parms-title}
4141

4242
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
43+
+
44+
Defaults to `true`.
4345

4446
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4547
+
@@ -55,4 +57,4 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
5557

5658
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
5759

58-
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
60+
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

docs/reference/indices/get-mapping.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3535
==== {api-query-parms-title}
3636

3737
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
38+
+
39+
Defaults to `true`.
3840

3941
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4042
+

docs/reference/indices/get-settings.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ used to limit the request.
3737
==== {api-query-parms-title}
3838

3939
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
40+
+
41+
Defaults to `true`.
4042

4143
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4244
+
@@ -82,4 +84,4 @@ as follows:
8284
--------------------------------------------------
8385
GET /log_2013_-*/_settings/index.number_*
8486
--------------------------------------------------
85-
// TEST[continued]
87+
// TEST[continued]

docs/reference/indices/indices-exists.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ i.e. status code `200` is also returned if an alias exists with that name.
3232
==== {api-query-parms-title}
3333

3434
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
35+
+
36+
Defaults to `true`.
3537

3638
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
3739
+

docs/reference/indices/open-close.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ or using the <<cluster-update-settings,cluster update settings>> API.
8080
==== {api-query-parms-title}
8181

8282
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
83+
+
84+
Defaults to `true`.
8385

8486
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
8587
+

docs/reference/indices/put-mapping.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ To update the mapping of all indices, omit this parameter or use a value of
4747
==== {api-query-parms-title}
4848

4949
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
50+
+
51+
Defaults to `false`.
5052

5153
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
5254
+

docs/reference/indices/refresh.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ or use a value of `_all` or `*`.
7272
==== {api-query-parms-title}
7373

7474
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
75+
+
76+
Defaults to `true`.
7577

7678
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
7779
+

docs/reference/indices/segments.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3232
==== {api-query-parms-title}
3333

3434
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
35+
+
36+
Defaults to `true`.
3537

3638
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
3739
+

docs/reference/indices/shard-stores.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ or omit this parameter.
5656
==== {api-query-parms-title}
5757

5858
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
59+
+
60+
Defaults to `true`.
5961

6062
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
6163
+

docs/reference/indices/update-settings.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ use `_all` or exclude this parameter.
3737
==== {api-query-parms-title}
3838

3939
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
40+
+
41+
Defaults to `false`.
4042

4143
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4244
+

docs/reference/search/count.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
4444
==== {api-query-parms-title}
4545

4646
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
47+
+
48+
Defaults to `true`.
4749

4850
include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
4951

docs/reference/search/field-caps.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3939
==== {api-query-parms-title}
4040

4141
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
42+
+
43+
Defaults to `true`.
4244

4345
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4446
+

docs/reference/search/rank-eval.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ generation in your application.
6969
==== {api-query-parms-title}
7070

7171
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
72+
+
73+
Defaults to `true`.
7274

7375
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
7476
+

docs/reference/search/search-shards.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
3535
==== {api-query-parms-title}
3636

3737
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
38+
+
39+
Defaults to `true`.
3840

3941
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4042
+

docs/reference/search/search-template.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
5353
==== {api-query-parms-title}
5454

5555
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
56+
+
57+
Defaults to `true`.
5658

5759
`ccs_minimize_roundtrips`::
5860
(Optional, boolean) If `true`, network round-trips are minimized for

docs/reference/search/search.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
4747
==== {api-query-parms-title}
4848

4949
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
50-
50+
+
51+
Defaults to `true`.
52+
5153
`allow_partial_search_results`::
5254
(Optional, boolean) Indicates if an error should be returned if there is a
5355
partial search failure or timeout. Defaults to `true`.

docs/reference/search/validate.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=query]
4040
instead of one random shard per index. Defaults to `false`.
4141

4242
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
43+
+
44+
Defaults to `false`.
4345

4446
include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
4547

0 commit comments

Comments
 (0)