Skip to content

Commit 4c99a4a

Browse files
committed
[DOCS] Clarifies data transform source definition (#44504)
1 parent 0ff7014 commit 4c99a4a

File tree

3 files changed

+31
-8
lines changed

3 files changed

+31
-8
lines changed

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

+12-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,18 @@ on all the current data in the source index.
4040
==== {api-request-body-title}
4141

4242
`source`::
43-
(object) Required. The source index or index pattern.
43+
(Required, object) The source configuration, which has the following
44+
properties:
45+
46+
`index`:::
47+
(Required, string or array) The _source indices_ for the
48+
{dataframe-transform}. It can be a single index, an index pattern (for
49+
example, `"myindex*"`), or an array of indices (for example,
50+
`["index1", "index2"]`).
51+
52+
`query`:::
53+
(Optional, object) A query clause that retrieves a subset of data from the
54+
source index. See <<query-dsl>>.
4455

4556
`pivot`::
4657
(object) Required. Defines the pivot function `group by` fields and the

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

+15-5
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
4141
==== {api-path-parms-title}
4242

4343
`<data_frame_transform_id>`::
44-
(string) Required. Identifier for the {dataframe-transform}. This identifier
44+
(Required, string) Identifier for the {dataframe-transform}. This identifier
4545
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
4646
underscores. It must start and end with alphanumeric characters.
4747

4848
[[put-data-frame-transform-request-body]]
4949
==== {api-request-body-title}
5050

5151
`description`::
52-
(string) Optional. Free text description of the {dataframe-transform}.
52+
(Optional, string) Free text description of the {dataframe-transform}.
5353

5454
`dest`::
5555
(Required, object) Required. The destination configuration, which has the
@@ -59,12 +59,22 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
5959
(Required, string) The _destination index_ for the {dataframe-transform}.
6060

6161
`pivot`::
62-
(object) Required. Defines the pivot function `group by` fields and the
62+
(Required, object) Defines the pivot function `group by` fields and the
6363
aggregation to reduce the data. See <<data-frame-transform-pivot>>.
6464

6565
`source`::
66-
(object) Required. The source configuration, which consists of `index` and
67-
optionally a `query`. See <<data-frame-transform-source>>.
66+
(Required, object) The source configuration, which has the following
67+
properties:
68+
69+
`index`:::
70+
(Required, string or array) The _source indices_ for the
71+
{dataframe-transform}. It can be a single index, an index pattern (for
72+
example, `"myindex*"`), or an array of indices (for example,
73+
`["index1", "index2"]`).
74+
75+
`query`:::
76+
(Optional, object) A query clause that retrieves a subset of data from the
77+
source index. See <<query-dsl>>.
6878

6979
[[put-data-frame-transform-example]]
7080
==== {api-examples-title}

docs/reference/data-frames/apis/transformresource.asciidoc

+4-2
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,10 @@ you create a {dataframe-transform}, you must define its source.
5353
[[data-frame-transform-source-properties]]
5454
===== {api-definitions-title}
5555

56-
`index`::
57-
(array) The _source index_ for the {dataframe-transform}.
56+
`index`::
57+
(string or array) The _source indices_ for the {dataframe-transform}. It can
58+
be a single index, an index pattern (for example, `"myindex*"`), or an array
59+
of indices (for example, `["index1", "index2"]`).
5860

5961
`query`::
6062
(object) A query clause that retrieves a subset of data from the source index.

0 commit comments

Comments
 (0)