Skip to content

Commit 4a7492f

Browse files
authored
[DOCS] Fix allow_no_match description for model APIs (#62008)
1 parent 04dff9e commit 4a7492f

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

docs/reference/ml/df-analytics/apis/get-inference-trained-model-stats.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
5656

5757
`allow_no_match`::
5858
(Optional, boolean)
59-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match]
59+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
6060

6161
`from`::
6262
(Optional, integer)

docs/reference/ml/df-analytics/apis/get-inference-trained-model.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
5858

5959
`allow_no_match`::
6060
(Optional, boolean)
61-
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match]
61+
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-match-models]
6262

6363
`decompress_definition`::
6464
(Optional, boolean)

docs/reference/ml/ml-shared.asciidoc

+15
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,21 @@ when there are no matches or only partial matches.
6262
--
6363
end::allow-no-match[]
6464

65+
tag::allow-no-match-models[]
66+
Specifies what to do when the request:
67+
+
68+
--
69+
* Contains wildcard expressions and there are no models that match.
70+
* Contains the `_all` string or no identifiers and there are no matches.
71+
* Contains wildcard expressions and there are only partial matches.
72+
73+
The default value is `true`, which returns an empty array when there are no
74+
matches and the subset of results when there are partial matches. If this
75+
parameter is `false`, the request returns a `404` status code when there are no
76+
matches or only partial matches.
77+
--
78+
end::allow-no-match-models[]
79+
6580
tag::analysis[]
6681
Defines the type of {dfanalytics} you want to perform on your source index. For
6782
example: `outlier_detection`. See <<ml-dfa-analysis-objects>>.

0 commit comments

Comments
 (0)