From 5dba9510ec5bd0b042cfe51a34e0dba400115502 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 26 Jul 2019 10:23:26 +0200 Subject: [PATCH] [DOCS] Adds allow no datafeeds query param to the GET, GET stats and STOP datafeed APIs (7.1-6.1) --- .../ml/apis/get-datafeed-stats.asciidoc | 22 +++++++++++++++++++ docs/reference/ml/apis/get-datafeed.asciidoc | 22 +++++++++++++++++++ docs/reference/ml/apis/stop-datafeed.asciidoc | 22 +++++++++++++++++++ 3 files changed, 66 insertions(+) diff --git a/docs/reference/ml/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/apis/get-datafeed-stats.asciidoc index 12f6a98e4e41a..6f78f557f3f50 100644 --- a/docs/reference/ml/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/apis/get-datafeed-stats.asciidoc @@ -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 @@ -52,6 +68,12 @@ The API returns the following information: (array) An array of {dfeed} count objects. For more information, see <>. +[[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 diff --git a/docs/reference/ml/apis/get-datafeed.asciidoc b/docs/reference/ml/apis/get-datafeed.asciidoc index 2c9ef7e3aec74..92e4c804b855e 100644 --- a/docs/reference/ml/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/apis/get-datafeed.asciidoc @@ -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 @@ -47,6 +63,12 @@ The API returns the following information: (array) An array of {dfeed} objects. For more information, see <>. +[[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 diff --git a/docs/reference/ml/apis/stop-datafeed.asciidoc b/docs/reference/ml/apis/stop-datafeed.asciidoc index 1489137b9db07..d43335778eef0 100644 --- a/docs/reference/ml/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/apis/stop-datafeed.asciidoc @@ -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 @@ -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