Skip to content

Commit 4ec39ad

Browse files
authored
[DOCS] Adds allow no datafeeds query param to the GET, GET stats and STOP datafeed APIs (7.1-6.1) (#44895)
1 parent 253a5e9 commit 4ec39ad

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

docs/reference/ml/apis/get-datafeed-stats.asciidoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,22 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
4343
wildcard expression. If you do not specify one of these options, the API
4444
returns statistics for all {dfeeds}.
4545

46+
[[ml-get-datafeed-stats-query-parms]]
47+
==== {api-query-parms-title}
48+
49+
`allow_no_datafeeds`::
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+
--
4662

4763
==== Results
4864

@@ -52,6 +68,12 @@ The API returns the following information:
5268
(array) An array of {dfeed} count objects.
5369
For more information, see <<ml-datafeed-counts>>.
5470

71+
[[ml-get-datafeed-stats-response-codes]]
72+
==== {api-response-codes-title}
73+
74+
`404` (Missing resources)::
75+
If `allow_no_datafeeds` is `false`, this code indicates that there are no
76+
resources that match the request or only partial matches for the request.
5577

5678
==== Authorization
5779

docs/reference/ml/apis/get-datafeed.asciidoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,22 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
3838
wildcard expression. If you do not specify one of these options, the API
3939
returns information about all {dfeeds}.
4040

41+
[[ml-get-datafeed-query-parms]]
42+
==== {api-query-parms-title}
43+
44+
`allow_no_datafeeds`::
45+
(Optional, boolean) Specifies what to do when the request:
46+
+
47+
--
48+
* Contains wildcard expressions and there are no {datafeeds} that match.
49+
* Contains the `_all` string or no identifiers and there are no matches.
50+
* Contains wildcard expressions and there are only partial matches.
51+
52+
The default value is `true`, which returns an empty `datafeeds` array when
53+
there are no matches and the subset of results when there are partial matches.
54+
If this parameter is `false`, the request returns a `404` status code when there
55+
are no matches or only partial matches.
56+
--
4157

4258
==== Results
4359

@@ -47,6 +63,12 @@ The API returns the following information:
4763
(array) An array of {dfeed} objects.
4864
For more information, see <<ml-datafeed-resource>>.
4965

66+
[[ml-get-datafeed-response-codes]]
67+
==== {api-response-codes-title}
68+
69+
`404` (Missing resources)::
70+
If `allow_no_datafeeds` is `false`, this code indicates that there are no
71+
resources that match the request or only partial matches for the request.
5072

5173
==== Authorization
5274

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,22 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
3535
(string) Identifier for the {dfeed}. It can be a {dfeed} identifier or a
3636
wildcard expression.
3737

38+
[[ml-stop-datafeed-query-parms]]
39+
==== {api-query-parms-title}
40+
41+
`allow_no_datafeeds`::
42+
(Optional, boolean) Specifies what to do when the request:
43+
+
44+
--
45+
* Contains wildcard expressions and there are no {datafeeds} that match.
46+
* Contains the `_all` string or no identifiers and there are no matches.
47+
* Contains wildcard expressions and there are only partial matches.
48+
49+
The default value is `true`, which returns an empty `datafeeds` array when
50+
there are no matches and the subset of results when there are partial matches.
51+
If this parameter is `false`, the request returns a `404` status code when there
52+
are no matches or only partial matches.
53+
--
3854

3955
==== Request Body
4056

@@ -45,6 +61,12 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
4561
(time) Controls the amount of time to wait until a {dfeed} stops.
4662
The default value is 20 seconds.
4763

64+
[[ml-stop-datafeed-response-codes]]
65+
==== {api-response-codes-title}
66+
67+
`404` (Missing resources)::
68+
If `allow_no_datafeeds` is `false`, this code indicates that there are no
69+
resources that match the request or only partial matches for the request.
4870

4971
==== Authorization
5072

0 commit comments

Comments
 (0)