Browse Source

[DOCS] Adds size and from parameters to data frame APIs (#43212)

Lisa Cawley 6 years ago
parent
commit
41bd5b1e9c

+ 18 - 1
docs/reference/data-frames/apis/get-transform-stats.asciidoc

@@ -36,13 +36,20 @@ Retrieves usage information for {dataframe-transforms}.
   specify one of these options, the API returns information for all
   {dataframe-transforms}.
 
+`from`::
+    (integer) Skips the specified number of {dataframe-transforms}. The
+    default value is `0`.
+
+`size`::
+    (integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
 
 ==== Results
 
 The API returns the following information:
 
 `transforms`::
-  (array) An array of statistics objects for {dataframe-transforms}.
+  (array) An array of statistics objects for {dataframe-transforms}, which are
+  sorted by the `id` value in ascending order.
 
 ==== Authorization
 
@@ -54,6 +61,16 @@ see {stack-ov}/security-privileges.html[Security privileges] and
 
 ==== Examples
 
+The following example skips for the first five {dataframe-transforms} and
+gets usage information for a maximum of ten results: 
+
+[source,js]
+--------------------------------------------------
+GET _data_frame/transforms/_stats?from=5&size=10
+--------------------------------------------------
+// CONSOLE
+// TEST[skip:todo]
+
 The following example gets usage information for the `ecommerce_transform`
 {dataframe-transform}:
 

+ 14 - 10
docs/reference/data-frames/apis/get-transform.asciidoc

@@ -35,25 +35,20 @@ Retrieves configuration information for {dataframe-transforms}.
   specify one of these options, the API returns information for all
   {dataframe-transforms}.
 
-////
-==== Request Body
-
-  `page`::
-  `from`:::
+`from`::
       (integer) Skips the specified number of {dataframe-transforms}. The
       default value is `0`.
 
-  `size`:::
-      (integer) Specifies the maximum number of {dataframe-transforms} to obtain.
-      The default value is `100`.
-////
+`size`::
+      (integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
 
 ==== Results
 
 The API returns the following information:
 
 `transforms`::
-  (array) An array of transform resources.
+  (array) An array of transform resources, which are sorted by the `id` value in
+  ascending order.
 
 ==== Authorization
 
@@ -65,6 +60,15 @@ see {stack-ov}/security-privileges.html[Security privileges] and
 
 ==== Examples
 
+The following example retrieves information about a maximum of ten transforms:
+
+[source,js]
+--------------------------------------------------
+GET _data_frame/transforms?size=10
+--------------------------------------------------
+// CONSOLE
+// TEST[skip:setup kibana sample data]
+
 The following example gets configuration information for the
 `ecommerce_transform` {dataframe-transform}: