Skip to content

Commit c9a265b

Browse files
committed
[DOCS] Fixes formatting in data frame analytics API
1 parent ae97d4c commit c9a265b

6 files changed

+33
-28
lines changed

docs/reference/ml/apis/get-dfanalytics-stats.asciidoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
3838
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
3939
these options, the API returns information for the first hundred
4040
{dfanalytics-jobs}.
41-
42-
`allow_no_match` (Optional)
43-
(boolean) If `false` and the `data_frame_analytics_id` does not match any
44-
{dfanalytics-job} an error will be returned. The default value is `true`.
4541

4642
[[ml-get-dfanalytics-stats-query-params]]
4743
==== {api-query-parms-title}
4844

45+
`allow_no_match` (Optional)::
46+
(boolean) If `false` and the `data_frame_analytics_id` does not match any
47+
{dfanalytics-job} an error will be returned. The default value is `true`.
48+
4949
`from` (Optional)::
5050
(integer) Skips the specified number of {dfanalytics-jobs}. The default value
5151
is `0`.
@@ -54,7 +54,6 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
5454
(integer) Specifies the maximum number of {dfanalytics-jobs} to obtain. The
5555
default value is `100`.
5656

57-
[discrete]
5857
[[ml-get-dfanalytics-stats-response-body]]
5958
==== {api-response-body-title}
6059

docs/reference/ml/apis/get-dfanalytics.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying
4545
(string) Identifier for the {dfanalytics-job}. If you do not specify one of
4646
these options, the API returns information for the first hundred
4747
{dfanalytics-jobs}.
48-
49-
`allow_no_match` (Optional)
50-
(boolean) If `false` and the `data_frame_analytics_id` does not match any
51-
{dfanalytics-job} an error will be returned. The default value is `true`.
5248

5349
[[ml-get-dfanalytics-query-params]]
5450
==== {api-query-parms-title}
5551

52+
`allow_no_match` (Optional)::
53+
(boolean) If `false` and the `data_frame_analytics_id` does not match any
54+
{dfanalytics-job} an error will be returned. The default value is `true`.
55+
5656
`from` (Optional)::
5757
(integer) Skips the specified number of {dfanalytics-jobs}. The default value
5858
is `0`.

docs/reference/ml/apis/ml-api.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,22 +141,22 @@ include::flush-job.asciidoc[]
141141
//FORECAST
142142
include::forecast.asciidoc[]
143143
//GET
144-
include::get-calendar.asciidoc[]
145144
include::get-bucket.asciidoc[]
146-
include::get-overall-buckets.asciidoc[]
145+
include::get-calendar.asciidoc[]
147146
include::get-category.asciidoc[]
147+
include::get-dfanalytics.asciidoc[]
148+
include::get-dfanalytics-stats.asciidoc[]
148149
include::get-datafeed.asciidoc[]
149150
include::get-datafeed-stats.asciidoc[]
150151
include::get-influencer.asciidoc[]
151152
include::get-job.asciidoc[]
152153
include::get-job-stats.asciidoc[]
153154
include::get-ml-info.asciidoc[]
154155
include::get-snapshot.asciidoc[]
156+
include::get-overall-buckets.asciidoc[]
155157
include::get-calendar-event.asciidoc[]
156158
include::get-filter.asciidoc[]
157159
include::get-record.asciidoc[]
158-
include::get-dfanalytics.asciidoc[]
159-
include::get-dfanalytics-stats.asciidoc[]
160160
//OPEN
161161
include::open-job.asciidoc[]
162162
//POST

docs/reference/ml/apis/put-dfanalytics.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,6 @@ and mappings.
5656

5757
[[ml-put-dfanalytics-request-body]]
5858
==== {api-request-body-title}
59-
60-
`source` (Required)::
61-
(object) The source configuration, consisting of `index` and optionally a
62-
`query`.
63-
64-
`dest` (Required)::
65-
(object) The destination configuration, consisting of `index` and optionally
66-
`results_field` (`ml` by default).
6759

6860
`analysis` (Required)::
6961
(object) Defines the type of {dfanalytics} you want to perform on your source
@@ -74,6 +66,14 @@ and mappings.
7466
(object) You can specify both `includes` and/or `excludes` patterns. If
7567
`analyzed_fields` is not set, only the relevant fileds will be included. For
7668
example all the numeric fields for {oldetection}.
69+
70+
`dest` (Required)::
71+
(object) The destination configuration, consisting of `index` and optionally
72+
`results_field` (`ml` by default).
73+
74+
`source` (Required)::
75+
(object) The source configuration, consisting of `index` and optionally a
76+
`query`.
7777

7878
[[ml-put-dfanalytics-example]]
7979
==== {api-examples-title}

docs/reference/ml/apis/start-dfanalytics.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ and {stack-ov}/built-in-roles.html[Built-in roles].
3333
(string) Identifier for the {dfanalytics-job}. This identifier can contain
3434
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
3535
must start and end with alphanumeric characters.
36+
37+
[[ml-start-dfanalytics-query-params]]
38+
==== {api-query-parms-title}
3639

3740
`timeout` (Optional)::
3841
(time) Controls the amount of time to wait until the {dfanalytics-job} starts.

docs/reference/ml/apis/stop-dfanalytics.asciidoc

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,19 @@ stop all {dfanalytics-job} by using _all or by specifying * as the
4747
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
4848
must start and end with alphanumeric characters.
4949

50-
`timeout` (Optional)::
51-
Controls the amount of time to wait until the {dfanalytics-job} stops.
52-
The default value is 20 seconds.
50+
[[ml-stop-dfanalytics--query-params]]
51+
==== {api-query-parms-title}
52+
53+
`allow_no_match` (Optional)::
54+
(boolean) If `false` and the `data_frame_analytics_id` does not match any
55+
{dfanalytics-job} an error will be returned. The default value is `true`.
5356

5457
`force` (Optional)::
5558
(boolean) If true, the {dfanalytics-job} is stopped forcefully.
56-
57-
`allow_no_match` (Optional)
58-
(boolean) If `false` and the `data_frame_analytics_id` does not match any
59-
{dfanalytics-job} an error will be returned. The default value is `true`.
59+
60+
`timeout` (Optional)::
61+
Controls the amount of time to wait until the {dfanalytics-job} stops.
62+
The default value is 20 seconds.
6063

6164
[[ml-stop-dfanalytics-example]]
6265
==== {api-examples-title}

0 commit comments

Comments
 (0)