Skip to content

Commit 748237e

Browse files
committed
[DOCS] Adds size and from parameters to data frame APIs (#43212)
1 parent 1a060f0 commit 748237e

File tree

2 files changed

+32
-11
lines changed

2 files changed

+32
-11
lines changed

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,20 @@ Retrieves usage information for {dataframe-transforms}.
3636
specify one of these options, the API returns information for all
3737
{dataframe-transforms}.
3838

39+
`from`::
40+
(integer) Skips the specified number of {dataframe-transforms}. The
41+
default value is `0`.
42+
43+
`size`::
44+
(integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
3945

4046
==== Results
4147

4248
The API returns the following information:
4349

4450
`transforms`::
45-
(array) An array of statistics objects for {dataframe-transforms}.
51+
(array) An array of statistics objects for {dataframe-transforms}, which are
52+
sorted by the `id` value in ascending order.
4653

4754
==== Authorization
4855

@@ -54,6 +61,16 @@ see {stack-ov}/security-privileges.html[Security privileges] and
5461

5562
==== Examples
5663

64+
The following example skips for the first five {dataframe-transforms} and
65+
gets usage information for a maximum of ten results:
66+
67+
[source,js]
68+
--------------------------------------------------
69+
GET _data_frame/transforms/_stats?from=5&size=10
70+
--------------------------------------------------
71+
// CONSOLE
72+
// TEST[skip:todo]
73+
5774
The following example gets usage information for the `ecommerce_transform`
5875
{dataframe-transform}:
5976

docs/reference/data-frames/apis/get-transform.asciidoc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,25 +35,20 @@ Retrieves configuration information for {dataframe-transforms}.
3535
specify one of these options, the API returns information for all
3636
{dataframe-transforms}.
3737

38-
////
39-
==== Request Body
40-
41-
`page`::
42-
`from`:::
38+
`from`::
4339
(integer) Skips the specified number of {dataframe-transforms}. The
4440
default value is `0`.
4541

46-
`size`:::
47-
(integer) Specifies the maximum number of {dataframe-transforms} to obtain.
48-
The default value is `100`.
49-
////
42+
`size`::
43+
(integer) Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
5044

5145
==== Results
5246

5347
The API returns the following information:
5448

5549
`transforms`::
56-
(array) An array of transform resources.
50+
(array) An array of transform resources, which are sorted by the `id` value in
51+
ascending order.
5752

5853
==== Authorization
5954

@@ -65,6 +60,15 @@ see {stack-ov}/security-privileges.html[Security privileges] and
6560

6661
==== Examples
6762

63+
The following example retrieves information about a maximum of ten transforms:
64+
65+
[source,js]
66+
--------------------------------------------------
67+
GET _data_frame/transforms?size=10
68+
--------------------------------------------------
69+
// CONSOLE
70+
// TEST[skip:setup kibana sample data]
71+
6872
The following example gets configuration information for the
6973
`ecommerce_transform` {dataframe-transform}:
7074

0 commit comments

Comments
 (0)