From 982a23f8c3acdc9c88694ae2d5393da9c28c21c0 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 14 Jun 2019 08:42:18 -0700 Subject: [PATCH] [DOCS] Adds size and from parameters to data frame APIs (#43212) --- .../apis/get-transform-stats.asciidoc | 19 ++++++++++++++- .../data-frames/apis/get-transform.asciidoc | 24 +++++++++++-------- 2 files changed, 32 insertions(+), 11 deletions(-) diff --git a/docs/reference/data-frames/apis/get-transform-stats.asciidoc b/docs/reference/data-frames/apis/get-transform-stats.asciidoc index 822d2fa63c8..4c91c0cf4a6 100644 --- a/docs/reference/data-frames/apis/get-transform-stats.asciidoc +++ b/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}: diff --git a/docs/reference/data-frames/apis/get-transform.asciidoc b/docs/reference/data-frames/apis/get-transform.asciidoc index 75f4eaf7a26..c46bd99138e 100644 --- a/docs/reference/data-frames/apis/get-transform.asciidoc +++ b/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}: