[Docs] Clarify default value for allow_no_indices
#52635
Conversation
Add a cliarification that default value is `true`, so no error is returned if no index is matched. Fixes: elastic#52534
matriv
added
>docs
|
Pinging @elastic/es-core-features (:Core/Features/Indices APIs) |
|
Pinging @elastic/es-docs (>docs) |
| @@ -42,6 +42,7 @@ tag::allow-no-indices[] | |||
| the request does *not* return an error | |||
| if a wildcard expression | |||
| or `_all` value retrieves only missing or closed indices. | |||
| Defaults to `true`. | |||
There was a problem hiding this comment.
I'm afraid that the default value here depends on the API, or is it true for all APIs?
There was a problem hiding this comment.
I tried some of them like HEAD, _mapping, _forgemerge and they behave the same.
There was a problem hiding this comment.
The default is API dependant. For example the put mapping api defaults to false.
There was a problem hiding this comment.
I see, should we just add a sentence that the default value depends on the API instead?
There was a problem hiding this comment.
You can add the default value where the definition is included instead:
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
|
Checked all usages and added the default value to the doc references. I have another question though, if you check this: https://github.com/elastic/elasticsearch/pull/52635/files#diff-2e0eb1b85aa4eba2d58663601327caffL39 I'm wondering if we should do the same for the index exists api ( |
| include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] | ||
|
|
There was a problem hiding this comment.
I'm not 100% sure.
The mechanism is different, but the outcome the same (status 200 or 404).
If allow_no_indices=false and no index is matched then we get an exception at the index name resolution phase which is translated to 404.
If allow_no_indices=true and no index is matched then no aliases are found and this is again translated to 404.
There was a problem hiding this comment.
I think we should probably remove documentation for this parameter. It's not useful to the end user and the outcome will be the same regardless. Thanks for catching this @matriv.
|
@jrodewig FYI, I added also this: 9902b34#diff-72be49b35e089e3c18cadc2619d1d933R99 |
Add default value to each one of the usages of `allow_no_indices` since it differs between different APIs. Relates to: elastic#52534 (cherry picked from commit 2eb9864)
Add default value to each one of the usages of
allow_no_indicessince it differs between different APIs.
Relates to: #52534