Browse Source

[Docs] Clarify default value for `allow_no_indices` (#52635)

Add default value to each one of the usages of `allow_no_indices`
since it differs between different APIs.

Relates to: #52534
Marios Trivyzas 5 years ago
parent
commit
2eb986488a
29 changed files with 60 additions and 6 deletions
  1. 2 0
      docs/reference/cluster/state.asciidoc
  2. 2 0
      docs/reference/docs/delete-by-query.asciidoc
  3. 2 0
      docs/reference/docs/update-by-query.asciidoc
  4. 0 2
      docs/reference/indices/alias-exists.asciidoc
  5. 2 0
      docs/reference/indices/apis/reload-analyzers.asciidoc
  6. 2 0
      docs/reference/indices/clearcache.asciidoc
  7. 2 0
      docs/reference/indices/close.asciidoc
  8. 3 1
      docs/reference/indices/delete-index.asciidoc
  9. 2 0
      docs/reference/indices/flush.asciidoc
  10. 2 0
      docs/reference/indices/forcemerge.asciidoc
  11. 2 0
      docs/reference/indices/get-alias.asciidoc
  12. 2 0
      docs/reference/indices/get-field-mapping.asciidoc
  13. 3 1
      docs/reference/indices/get-index.asciidoc
  14. 2 0
      docs/reference/indices/get-mapping.asciidoc
  15. 3 1
      docs/reference/indices/get-settings.asciidoc
  16. 2 0
      docs/reference/indices/indices-exists.asciidoc
  17. 2 0
      docs/reference/indices/open-close.asciidoc
  18. 2 0
      docs/reference/indices/put-mapping.asciidoc
  19. 2 0
      docs/reference/indices/refresh.asciidoc
  20. 2 0
      docs/reference/indices/segments.asciidoc
  21. 2 0
      docs/reference/indices/shard-stores.asciidoc
  22. 2 0
      docs/reference/indices/update-settings.asciidoc
  23. 2 0
      docs/reference/search/count.asciidoc
  24. 2 0
      docs/reference/search/field-caps.asciidoc
  25. 2 0
      docs/reference/search/rank-eval.asciidoc
  26. 2 0
      docs/reference/search/search-shards.asciidoc
  27. 2 0
      docs/reference/search/search-template.asciidoc
  28. 3 1
      docs/reference/search/search.asciidoc
  29. 2 0
      docs/reference/search/validate.asciidoc

+ 2 - 0
docs/reference/cluster/state.asciidoc

@@ -96,6 +96,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
     (Optional, boolean) If `true`, the wildcard indices expression that resolves 
     into no concrete indices will be ignored. (This includes `_all` string or 
     when no indices have been specified).
++
+Defaults to `true`.
 
 `expand_wildcards`::
     (Optional, string) Whether to expand wildcard expression to concrete indices 

+ 2 - 0
docs/reference/docs/delete-by-query.asciidoc

@@ -161,6 +161,8 @@ or omit to search all indices.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
 

+ 2 - 0
docs/reference/docs/update-by-query.asciidoc

@@ -156,6 +156,8 @@ or omit to search all indices.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
 

+ 0 - 2
docs/reference/indices/alias-exists.asciidoc

@@ -36,8 +36,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 [[alias-exists-api-query-params]]
 ==== {api-query-parms-title}
 
-include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
-
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +
 Defaults to `all`.

+ 2 - 0
docs/reference/indices/apis/reload-analyzers.asciidoc

@@ -74,6 +74,8 @@ used to limit the request.
 === {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/clearcache.asciidoc

@@ -31,6 +31,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/close.asciidoc

@@ -43,6 +43,8 @@ or using the <<cluster-update-settings,cluster update settings>> API.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 3 - 1
docs/reference/indices/delete-index.asciidoc

@@ -43,6 +43,8 @@ this setting in the `elasticsearch.yml` file or using the
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +
@@ -50,4 +52,4 @@ Defaults to `open`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
 
-include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
+include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

+ 2 - 0
docs/reference/indices/flush.asciidoc

@@ -63,6 +63,8 @@ or use a value of `_all` or `*`.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/forcemerge.asciidoc

@@ -72,6 +72,8 @@ or use a value of `_all` or `*`.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/get-alias.asciidoc

@@ -43,6 +43,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/get-field-mapping.asciidoc

@@ -37,6 +37,8 @@ limit returned information.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 

+ 3 - 1
docs/reference/indices/get-index.asciidoc

@@ -35,6 +35,8 @@ Use a value of `_all` to retrieve information for all indices in the cluster.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +
@@ -48,4 +50,4 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
 
-include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
+include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

+ 2 - 0
docs/reference/indices/get-mapping.asciidoc

@@ -30,6 +30,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 3 - 1
docs/reference/indices/get-settings.asciidoc

@@ -37,6 +37,8 @@ used to limit the request.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +
@@ -82,4 +84,4 @@ as follows:
 --------------------------------------------------
 GET /log_2013_-*/_settings/index.number_*
 --------------------------------------------------
-// TEST[continued]
+// TEST[continued]

+ 2 - 0
docs/reference/indices/indices-exists.asciidoc

@@ -34,6 +34,8 @@ i.e. status code `200` is also returned if an alias exists with that name.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/open-close.asciidoc

@@ -80,6 +80,8 @@ or using the <<cluster-update-settings,cluster update settings>> API.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/put-mapping.asciidoc

@@ -41,6 +41,8 @@ To update the mapping of all indices, omit this parameter or use a value of
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `false`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/refresh.asciidoc

@@ -72,6 +72,8 @@ or use a value of `_all` or `*`.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/segments.asciidoc

@@ -32,6 +32,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/shard-stores.asciidoc

@@ -56,6 +56,8 @@ or omit this parameter.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/indices/update-settings.asciidoc

@@ -37,6 +37,8 @@ use `_all` or exclude this parameter.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `false`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/search/count.asciidoc

@@ -44,6 +44,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
 

+ 2 - 0
docs/reference/search/field-caps.asciidoc

@@ -39,6 +39,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/search/rank-eval.asciidoc

@@ -69,6 +69,8 @@ generation in your application.
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/search/search-shards.asciidoc

@@ -35,6 +35,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
 +

+ 2 - 0
docs/reference/search/search-template.asciidoc

@@ -53,6 +53,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `true`.
 
 `ccs_minimize_roundtrips`::
   (Optional, boolean) If `true`, network round-trips are minimized for 

+ 3 - 1
docs/reference/search/search.asciidoc

@@ -47,7 +47,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
 ==== {api-query-parms-title}
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
-  
++
+Defaults to `true`.
+
 `allow_partial_search_results`::
   (Optional, boolean) Indicates if an error should be returned if there is a 
   partial search failure or timeout. Defaults to `true`.

+ 2 - 0
docs/reference/search/validate.asciidoc

@@ -40,6 +40,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=query]
   instead of one random shard per index. Defaults to `false`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
++
+Defaults to `false`.
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]