Skip to content

Commit 17743be

Browse files
committed
[DOCS] Adds deprecated allow_no_jobs and allow_no_datafeeds ML API properties (elastic#80163)
1 parent 5581168 commit 17743be

9 files changed

+28
-1
lines changed

docs/reference/cat/anomaly-detectors.asciidoc

+3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
4040
[[cat-anomaly-detectors-query-params]]
4141
==== {api-query-parms-title}
4242

43+
`allow_no_jobs`::
44+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
45+
4346
`allow_no_match`::
4447
(Optional, Boolean)
4548
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]

docs/reference/cat/datafeeds.asciidoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Returns configuration and usage information about {dfeeds}.
2929
{dfeeds-cap} retrieve data from {es} for analysis by {anomaly-jobs}. For more
3030
information, see {ml-docs}/ml-dfeeds.html[{dfeeds-cap}].
3131

32-
NOTE: This API returns a maximum of 10,000 jobs.
32+
NOTE: This API returns a maximum of 10,000 {dfeeds}.
3333

3434
[[cat-datafeeds-path-params]]
3535
==== {api-path-parms-title}
@@ -41,6 +41,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
4141
[[cat-datafeeds-query-params]]
4242
==== {api-query-parms-title}
4343

44+
`allow_no_datafeeds`::
45+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
46+
4447
`allow_no_match`::
4548
(Optional, Boolean)
4649
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]

docs/reference/ml/anomaly-detection/apis/close-job.asciidoc

+3
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildca
6666
[[ml-close-job-query-parms]]
6767
== {api-query-parms-title}
6868

69+
`allow_no_jobs`::
70+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
71+
6972
`allow_no_match`::
7073
(Optional, Boolean)
7174
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]

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

+3
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ all {dfeeds}.
5656
[[ml-get-datafeed-stats-query-parms]]
5757
== {api-query-parms-title}
5858

59+
`allow_no_datafeeds`::
60+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
61+
5962
`allow_no_match`::
6063
(Optional, Boolean)
6164
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]

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

+3
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ all {dfeeds}.
5353
[[ml-get-datafeed-query-parms]]
5454
== {api-query-parms-title}
5555

56+
`allow_no_datafeeds`::
57+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
58+
5659
`allow_no_match`::
5760
(Optional, Boolean)
5861
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]

docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc

+3
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-defaul
4646
[[ml-get-job-stats-query-parms]]
4747
== {api-query-parms-title}
4848

49+
`allow_no_jobs`::
50+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
51+
4952
`allow_no_match`::
5053
(Optional, Boolean)
5154
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]

docs/reference/ml/anomaly-detection/apis/get-job.asciidoc

+3
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-defaul
4646
[[ml-get-job-query-parms]]
4747
== {api-query-parms-title}
4848

49+
`allow_no_jobs`::
50+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
51+
4952
`allow_no_match`::
5053
(Optional, Boolean)
5154
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]

docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc

+3
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildca
6262
[[ml-get-overall-buckets-request-body]]
6363
== {api-request-body-title}
6464

65+
`allow_no_jobs`::
66+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
67+
6568
`allow_no_match`::
6669
(Optional, Boolean)
6770
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]

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

+3
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
4646
[[ml-stop-datafeed-query-parms]]
4747
== {api-query-parms-title}
4848

49+
`allow_no_datafeeds`::
50+
(Optional, Boolean) deprecated:[7.10,Use `allow_no_match` instead.]
51+
4952
`allow_no_match`::
5053
(Optional, Boolean)
5154
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]

0 commit comments

Comments
 (0)