Răsfoiți Sursa

[DOCS] Fixes formatting in data frame analytics API

lcawl 6 ani în urmă
părinte
comite
c9a265b092

+ 4 - 5
docs/reference/ml/apis/get-dfanalytics-stats.asciidoc

@@ -38,14 +38,14 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
   (string) Identifier for the {dfanalytics-job}. If you do not specify one of 
   these options, the API returns information for the first hundred
   {dfanalytics-jobs}.
-  
-`allow_no_match` (Optional)
-  (boolean) If `false` and the `data_frame_analytics_id` does not match any 
-  {dfanalytics-job} an error will be returned. The default value is `true`.
 
 [[ml-get-dfanalytics-stats-query-params]]
 ==== {api-query-parms-title}
 
+`allow_no_match` (Optional)::
+  (boolean) If `false` and the `data_frame_analytics_id` does not match any 
+  {dfanalytics-job} an error will be returned. The default value is `true`.
+
 `from` (Optional)::
   (integer) Skips the specified number of {dfanalytics-jobs}. The default value 
   is `0`.
@@ -54,7 +54,6 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
   (integer) Specifies the maximum number of {dfanalytics-jobs} to obtain. The 
   default value is `100`.
 
-[discrete]
 [[ml-get-dfanalytics-stats-response-body]]
 ==== {api-response-body-title}
 

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

@@ -45,14 +45,14 @@ You can get information for all {dfanalytics-jobs} by using _all, by specifying
   (string) Identifier for the {dfanalytics-job}. If you do not specify one of 
   these options, the API returns information for the first hundred
   {dfanalytics-jobs}.
-  
-`allow_no_match` (Optional)
-  (boolean) If `false` and the `data_frame_analytics_id` does not match any 
-  {dfanalytics-job} an error will be returned. The default value is `true`.
 
 [[ml-get-dfanalytics-query-params]]
 ==== {api-query-parms-title}
 
+`allow_no_match` (Optional)::
+  (boolean) If `false` and the `data_frame_analytics_id` does not match any 
+  {dfanalytics-job} an error will be returned. The default value is `true`.
+
 `from` (Optional)::
   (integer) Skips the specified number of {dfanalytics-jobs}. The default value 
   is `0`.

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

@@ -141,10 +141,11 @@ include::flush-job.asciidoc[]
 //FORECAST
 include::forecast.asciidoc[]
 //GET
-include::get-calendar.asciidoc[]
 include::get-bucket.asciidoc[]
-include::get-overall-buckets.asciidoc[]
+include::get-calendar.asciidoc[]
 include::get-category.asciidoc[]
+include::get-dfanalytics.asciidoc[]
+include::get-dfanalytics-stats.asciidoc[]
 include::get-datafeed.asciidoc[]
 include::get-datafeed-stats.asciidoc[]
 include::get-influencer.asciidoc[]
@@ -152,11 +153,10 @@ include::get-job.asciidoc[]
 include::get-job-stats.asciidoc[]
 include::get-ml-info.asciidoc[]
 include::get-snapshot.asciidoc[]
+include::get-overall-buckets.asciidoc[]
 include::get-calendar-event.asciidoc[]
 include::get-filter.asciidoc[]
 include::get-record.asciidoc[]
-include::get-dfanalytics.asciidoc[]
-include::get-dfanalytics-stats.asciidoc[]
 //OPEN
 include::open-job.asciidoc[]
 //POST

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

@@ -56,14 +56,6 @@ and mappings.
 
 [[ml-put-dfanalytics-request-body]]
 ==== {api-request-body-title}
-
-`source` (Required)::
-  (object) The source configuration, consisting of `index` and optionally a 
-  `query`.
-  
-`dest` (Required)::
-  (object) The destination configuration, consisting of `index` and optionally 
-  `results_field` (`ml` by default).
   
 `analysis` (Required)::
   (object) Defines the type of {dfanalytics} you want to perform on your source 
@@ -74,6 +66,14 @@ and mappings.
   (object) You can specify both `includes` and/or `excludes` patterns. If 
   `analyzed_fields` is not set, only the relevant fileds will be included. For 
   example all the numeric fields for {oldetection}.
+  
+`dest` (Required)::
+  (object) The destination configuration, consisting of `index` and optionally 
+  `results_field` (`ml` by default).
+  
+`source` (Required)::
+  (object) The source configuration, consisting of `index` and optionally a 
+  `query`.
 
 [[ml-put-dfanalytics-example]]
 ==== {api-examples-title}

+ 3 - 0
docs/reference/ml/apis/start-dfanalytics.asciidoc

@@ -33,6 +33,9 @@ and {stack-ov}/built-in-roles.html[Built-in roles].
   (string) Identifier for the {dfanalytics-job}. This identifier can contain
   lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
   must start and end with alphanumeric characters.
+
+[[ml-start-dfanalytics-query-params]]
+==== {api-query-parms-title}
   
 `timeout` (Optional)::
   (time) Controls the amount of time to wait until the {dfanalytics-job} starts. 

+ 10 - 7
docs/reference/ml/apis/stop-dfanalytics.asciidoc

@@ -47,16 +47,19 @@ stop all {dfanalytics-job} by using _all or by specifying * as the
   lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
   must start and end with alphanumeric characters.
   
-`timeout` (Optional)::
-  Controls the amount of time to wait until the {dfanalytics-job} stops. 
-  The default value is 20 seconds.
+[[ml-stop-dfanalytics--query-params]]
+==== {api-query-parms-title}
+
+`allow_no_match` (Optional)::
+  (boolean) If `false` and the `data_frame_analytics_id` does not match any 
+  {dfanalytics-job} an error will be returned. The default value is `true`.
   
 `force` (Optional)::
   (boolean) If true, the {dfanalytics-job} is stopped forcefully.
-  
-`allow_no_match` (Optional)
-  (boolean) If `false` and the `data_frame_analytics_id` does not match any 
-  {dfanalytics-job} an error will be returned. The default value is `true`.
+    
+`timeout` (Optional)::
+  Controls the amount of time to wait until the {dfanalytics-job} stops. 
+  The default value is 20 seconds.
 
 [[ml-stop-dfanalytics-example]]
 ==== {api-examples-title}