Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/reference/ml/apis/get-datafeed-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,22 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
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.
--

==== Results

Expand All @@ -52,6 +68,12 @@ 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.

==== Authorization

Expand Down
22 changes: 22 additions & 0 deletions docs/reference/ml/apis/get-datafeed.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,22 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
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.
--

==== Results

Expand All @@ -47,6 +63,12 @@ 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.

==== Authorization

Expand Down
22 changes: 22 additions & 0 deletions docs/reference/ml/apis/stop-datafeed.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,22 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
(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.
--

==== Request Body

Expand All @@ -45,6 +61,12 @@ comma-separated list of {dfeeds} or a wildcard expression. You can close all
(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.

==== Authorization

Expand Down