Skip to content

Commit cf0fef9

Browse files
authored
[DOCS] Changes level offset for anomaly detection APIs (#59920) (#59930)
1 parent 65315a4 commit cf0fef9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+413
-415
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-close-job]]
4-
=== Close {anomaly-jobs} API
4+
= Close {anomaly-jobs} API
55
++++
66
<titleabbrev>Close jobs</titleabbrev>
77
++++
@@ -13,7 +13,7 @@ A closed job cannot receive data or perform analysis
1313
operations, but you can still explore and navigate results.
1414

1515
[[ml-close-job-request]]
16-
==== {api-request-title}
16+
== {api-request-title}
1717

1818
`POST _ml/anomaly_detectors/<job_id>/_close` +
1919

@@ -22,7 +22,7 @@ operations, but you can still explore and navigate results.
2222
`POST _ml/anomaly_detectors/_all/_close` +
2323

2424
[[ml-close-job-prereqs]]
25-
==== {api-prereq-title}
25+
== {api-prereq-title}
2626

2727
* If the {es} {security-features} are enabled, you must have `manage_ml` or
2828
`manage` cluster privileges to use this API. See
@@ -31,7 +31,7 @@ operations, but you can still explore and navigate results.
3131
<<ml-stop-datafeed>>.
3232

3333
[[ml-close-job-desc]]
34-
==== {api-description-title}
34+
== {api-description-title}
3535

3636
You can close multiple {anomaly-jobs} in a single API request by using a group
3737
name, a comma-separated list of jobs, or a wildcard expression. You can close
@@ -57,14 +57,14 @@ situations where the job has already failed, or where you are not interested in
5757
results the job might have recently produced or might produce in the future.
5858

5959
[[ml-close-job-path-parms]]
60-
==== {api-path-parms-title}
60+
== {api-path-parms-title}
6161

6262
`<job_id>`::
6363
(Required, string)
6464
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildcard]
6565

6666
[[ml-close-job-query-parms]]
67-
==== {api-query-parms-title}
67+
== {api-query-parms-title}
6868

6969
`allow_no_jobs`::
7070
(Optional, boolean)
@@ -79,14 +79,14 @@ which has not responded to its initial close request.
7979
has closed. The default value is 30 minutes.
8080

8181
[[ml-close-job-response-codes]]
82-
==== {api-response-codes-title}
82+
== {api-response-codes-title}
8383

8484
`404` (Missing resources)::
8585
If `allow_no_jobs` is `false`, this code indicates that there are no
8686
resources that match the request or only partial matches for the request.
8787

8888
[[ml-close-job-example]]
89-
==== {api-examples-title}
89+
== {api-examples-title}
9090

9191
[source,console]
9292
--------------------------------------------------

docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-calendar-event]]
4-
=== Delete events from calendar API
4+
= Delete events from calendar API
55
++++
66
<titleabbrev>Delete events from calendar</titleabbrev>
77
++++
88

99
Deletes scheduled events from a calendar.
1010

1111
[[ml-delete-calendar-event-request]]
12-
==== {api-request-title}
12+
== {api-request-title}
1313

1414
`DELETE _ml/calendars/<calendar_id>/events/<event_id>`
1515

1616
[[ml-delete-calendar-event-prereqs]]
17-
==== {api-prereq-title}
17+
== {api-prereq-title}
1818

1919
* If the {es} {security-features} are enabled, you must have `manage_ml` or
2020
`manage` cluster privileges to use this API. See
2121
<<security-privileges>>.
2222

2323
[[ml-delete-calendar-event-desc]]
24-
==== {api-description-title}
24+
== {api-description-title}
2525

2626
This API removes individual events from a calendar. To remove all scheduled
2727
events and delete the calendar, see the
2828
<<ml-delete-calendar,delete calendar API>>.
2929

3030
[[ml-delete-calendar-event-path-parms]]
31-
==== {api-path-parms-title}
31+
== {api-path-parms-title}
3232

3333
`<calendar_id>`::
3434
(Required, string)
@@ -39,7 +39,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
3939
identifier by using the <<ml-get-calendar-event,get calendar events API>>.
4040

4141
[[ml-delete-calendar-event-example]]
42-
==== {api-examples-title}
42+
== {api-examples-title}
4343

4444
[source,console]
4545
--------------------------------------------------

docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-calendar-job]]
4-
=== Delete {anomaly-jobs} from calendar API
4+
= Delete {anomaly-jobs} from calendar API
55
++++
66
<titleabbrev>Delete jobs from calendar</titleabbrev>
77
++++
88

99
Deletes {anomaly-jobs} from a calendar.
1010

1111
[[ml-delete-calendar-job-request]]
12-
==== {api-request-title}
12+
== {api-request-title}
1313

1414
`DELETE _ml/calendars/<calendar_id>/jobs/<job_id>`
1515

1616
[[ml-delete-calendar-job-prereqs]]
17-
==== {api-prereq-title}
17+
== {api-prereq-title}
1818

1919
* If the {es} {security-features} are enabled, you must have `manage_ml` or
2020
`manage` cluster privileges to use this API. See
2121
<<security-privileges>>.
2222

2323
[[ml-delete-calendar-job-path-parms]]
24-
==== {api-path-parms-title}
24+
== {api-path-parms-title}
2525

2626
`<calendar_id>`::
2727
(Required, string)
@@ -32,7 +32,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
3232
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
3333

3434
[[ml-delete-calendar-job-example]]
35-
==== {api-examples-title}
35+
== {api-examples-title}
3636

3737
[source,console]
3838
--------------------------------------------------

docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-calendar]]
4-
=== Delete calendar API
4+
= Delete calendar API
55
++++
66
<titleabbrev>Delete calendar</titleabbrev>
77
++++
88

99
Deletes a calendar.
1010

1111
[[ml-delete-calendar-request]]
12-
==== {api-request-title}
12+
== {api-request-title}
1313

1414
`DELETE _ml/calendars/<calendar_id>`
1515

1616
[[ml-delete-calendar-prereqs]]
17-
==== {api-prereq-title}
17+
== {api-prereq-title}
1818

1919
* If the {es} {security-features} are enabled, you must have `manage_ml` or
2020
`manage` cluster privileges to use this API. See
2121
<<security-privileges>>.
2222

2323
[[ml-delete-calendar-desc]]
24-
==== {api-description-title}
24+
== {api-description-title}
2525

2626
This API removes all scheduled events from the calendar then deletes the
2727
calendar.
2828

2929
[[ml-delete-calendar-path-parms]]
30-
==== {api-path-parms-title}
30+
== {api-path-parms-title}
3131

3232
`<calendar_id>`::
3333
(Required, string)
3434
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
3535

3636
[[ml-delete-calendar-example]]
37-
==== {api-examples-title}
37+
== {api-examples-title}
3838

3939
[source,console]
4040
--------------------------------------------------

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-datafeed]]
4-
=== Delete {dfeeds} API
4+
= Delete {dfeeds} API
55

66
[subs="attributes"]
77
++++
@@ -11,12 +11,12 @@
1111
Deletes an existing {dfeed}.
1212

1313
[[ml-delete-datafeed-request]]
14-
==== {api-request-title}
14+
== {api-request-title}
1515

1616
`DELETE _ml/datafeeds/<feed_id>`
1717

1818
[[ml-delete-datafeed-prereqs]]
19-
==== {api-prereq-title}
19+
== {api-prereq-title}
2020

2121
* Unless you use the `force` parameter, you must stop the {dfeed} before you
2222
can delete it.
@@ -25,21 +25,21 @@ can delete it.
2525
<<security-privileges>>.
2626

2727
[[ml-delete-datafeed-path-parms]]
28-
==== {api-path-parms-title}
28+
== {api-path-parms-title}
2929

3030
`<feed_id>`::
3131
(Required, string)
3232
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
3333

3434
[[ml-delete-datafeed-query-parms]]
35-
==== {api-query-parms-title}
35+
== {api-query-parms-title}
3636

3737
`force`::
3838
(Optional, boolean) Use to forcefully delete a started {dfeed}; this method is
3939
quicker than stopping and deleting the {dfeed}.
4040

4141
[[ml-delete-datafeed-example]]
42-
==== {api-examples-title}
42+
== {api-examples-title}
4343

4444
[source,console]
4545
--------------------------------------------------

docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-expired-data]]
4-
=== Delete expired data API
4+
= Delete expired data API
55
++++
66
<titleabbrev>Delete expired data</titleabbrev>
77
++++
88

99
Deletes expired and unused machine learning data.
1010

1111
[[ml-delete-expired-data-request]]
12-
==== {api-request-title}
12+
== {api-request-title}
1313

1414
`DELETE _ml/_delete_expired_data`
1515

1616
[[ml-delete-expired-data-prereqs]]
17-
==== {api-prereq-title}
17+
== {api-prereq-title}
1818

1919
* If the {es} {security-features} are enabled, you must have `manage_ml` or
2020
`manage` cluster privileges to use this API. See
2121
<<security-privileges>>.
2222

2323
[[ml-delete-expired-data-desc]]
24-
==== {api-description-title}
24+
== {api-description-title}
2525

2626
Deletes all job results, model snapshots and forecast data that have exceeded
2727
their `retention days` period. Machine learning state documents that are not
2828
associated with any job are also deleted.
2929

3030
[[ml-delete-expired-data-request-body]]
31-
==== {api-request-body-title}
31+
== {api-request-body-title}
3232

3333
`requests_per_second`::
3434
(Optional, float) The desired requests per second for the deletion processes.
@@ -39,7 +39,7 @@ The default behavior is no throttling.
3939
The default value is `8h` (8 hours).
4040

4141
[[ml-delete-expired-data-example]]
42-
==== {api-examples-title}
42+
== {api-examples-title}
4343

4444
The endpoint takes no arguments:
4545

docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-filter]]
4-
=== Delete filter API
4+
= Delete filter API
55
++++
66
<titleabbrev>Delete filter</titleabbrev>
77
++++
88

99
Deletes a filter.
1010

1111
[[ml-delete-filter-request]]
12-
==== {api-request-title}
12+
== {api-request-title}
1313

1414
`DELETE _ml/filters/<filter_id>`
1515

1616
[[ml-delete-filter-prereqs]]
17-
==== {api-prereq-title}
17+
== {api-prereq-title}
1818

1919
* If the {es} {security-features} are enabled, you must have `manage_ml` or
2020
`manage` cluster privileges to use this API. See
2121
<<security-privileges>>.
2222

2323
[[ml-delete-filter-desc]]
24-
==== {api-description-title}
24+
== {api-description-title}
2525

2626
This API deletes a {ml-docs}/ml-rules.html[filter].
2727
If a {ml} job references the filter, you cannot delete the filter. You must
2828
update or delete the job before you can delete the filter.
2929

3030
[[ml-delete-filter-path-parms]]
31-
==== {api-path-parms-title}
31+
== {api-path-parms-title}
3232

3333
`<filter_id>`::
3434
(Required, string)
3535
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=filter-id]
3636

3737
[[ml-delete-filter-example]]
38-
==== {api-examples-title}
38+
== {api-examples-title}
3939

4040
[source,console]
4141
--------------------------------------------------

0 commit comments

Comments
 (0)