Skip to content

Commit 095cba4

Browse files
committed
[DOCS] Addresses feedback on STOP API.
1 parent a3df129 commit 095cba4

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,18 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
4747
==== {api-query-parms-title}
4848

4949
`allow_no_datafeeds`::
50-
(Optional, boolean) If `false` and the `feed_id` does not match any {dfeed} an
51-
error will be returned. The default value is `true`.
50+
(Optional, boolean) Specifies what to do when the request:
51+
+
52+
--
53+
* Contains wildcard expressions and there are no {datafeeds} that match.
54+
* Contains the `_all` string or no identifiers and there are no matches.
55+
* Contains wildcard expressions and there are only partial matches.
56+
57+
The default value is `true`, which returns an empty `datafeeds` array when
58+
there are no matches and the subset of results when there are partial matches.
59+
If this parameter is `false`, the request returns a `404` status code when there
60+
are no matches or only partial matches.
61+
--
5262

5363
[[ml-stop-datafeed-request-body]]
5464
==== {api-request-body-title}
@@ -60,6 +70,13 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
6070
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
6171
The default value is 20 seconds.
6272

73+
[[ml-stop-datafeed-response-codes]]
74+
==== {api-response-codes-title}
75+
76+
`404` (Missing resources)::
77+
If `allow_no_datafeeds` is `false`, this code indicates that there are no
78+
resources that match the request or only partial matches for the request.
79+
6380
[[ml-stop-datafeed-example]]
6481
==== {api-examples-title}
6582

0 commit comments

Comments
 (0)