[DOCS] Adds allow no datafeeds query param to the GET, GET stats and STOP datafeed APIs (#44499)

This commit is contained in:
István Zoltán Szabó 2019-07-25 16:45:06 +02:00
parent 2ca6306452
commit 4a31c426e6
3 changed files with 73 additions and 0 deletions

View File

@ -49,6 +49,24 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
or a wildcard expression. If you do not specify one of these options, the API
returns statistics for all {dfeeds}.
[[ml-get-datafeed-stats-query-parms]]
==== {api-query-parms-title}
`allow_no_datafeeds`::
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {datafeeds} that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.
The default value is `true`, which returns an empty `datafeeds` array when
there are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a `404` status code when there
are no matches or only partial matches.
--
[[ml-get-datafeed-stats-results]]
==== {api-response-body-title}
@ -58,6 +76,13 @@ The API returns the following information:
(array) An array of {dfeed} count objects.
For more information, see <<ml-datafeed-counts>>.
[[ml-get-datafeed-stats-response-codes]]
==== {api-response-codes-title}
`404` (Missing resources)::
If `allow_no_datafeeds` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.
[[ml-get-datafeed-stats-example]]
==== {api-examples-title}

View File

@ -46,6 +46,23 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
or a wildcard expression. If you do not specify one of these options, the API
returns information about all {dfeeds}.
[[ml-get-datafeed-query-parms]]
==== {api-query-parms-title}
`allow_no_datafeeds`::
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {datafeeds} that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.
The default value is `true`, which returns an empty `datafeeds` array when
there are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a `404` status code when there
are no matches or only partial matches.
--
[[ml-get-datafeed-results]]
==== {api-response-body-title}
@ -55,6 +72,13 @@ The API returns the following information:
(array) An array of {dfeed} objects.
For more information, see <<ml-datafeed-resource>>.
[[ml-get-datafeed-response-codes]]
==== {api-response-codes-title}
`404` (Missing resources)::
If `allow_no_datafeeds` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.
[[ml-get-datafeed-example]]
==== {api-examples-title}

View File

@ -43,6 +43,23 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
(Required, string) Identifier for the {dfeed}. It can be a {dfeed} identifier
or a wildcard expression.
[[ml-stop-datafeed-query-parms]]
==== {api-query-parms-title}
`allow_no_datafeeds`::
(Optional, boolean) Specifies what to do when the request:
+
--
* Contains wildcard expressions and there are no {datafeeds} that match.
* Contains the `_all` string or no identifiers and there are no matches.
* Contains wildcard expressions and there are only partial matches.
The default value is `true`, which returns an empty `datafeeds` array when
there are no matches and the subset of results when there are partial matches.
If this parameter is `false`, the request returns a `404` status code when there
are no matches or only partial matches.
--
[[ml-stop-datafeed-request-body]]
==== {api-request-body-title}
@ -53,6 +70,13 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
The default value is 20 seconds.
[[ml-stop-datafeed-response-codes]]
==== {api-response-codes-title}
`404` (Missing resources)::
If `allow_no_datafeeds` is `false`, this code indicates that there are no
resources that match the request or only partial matches for the request.
[[ml-stop-datafeed-example]]
==== {api-examples-title}