Skip to content

Commit caa0129

Browse files
committed
[DOCS] Adds placeholder for create and delete data frame transform APIs (#40233)
1 parent 0e712d4 commit caa0129

File tree

5 files changed

+130
-3
lines changed

5 files changed

+130
-3
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
[role="xpack"]
2+
[testenv="basic"]
3+
[[delete-data-frame-transform]]
4+
=== Delete {dataframe-transforms} API
5+
++++
6+
<titleabbrev>Delete {dataframe-transforms}</titleabbrev>
7+
++++
8+
9+
Deletes an existing {dataframe-transform}.
10+
11+
12+
==== Request
13+
14+
`DELETE _data_frame/transforms/<data_frame_transform_id>`
15+
16+
//==== Description
17+
18+
==== Path Parameters
19+
20+
`data_frame_transform_id` (required)::
21+
(string) Identifier for the {dataframe-transform}.
22+
23+
//===== Authorization
24+
25+
==== Examples
26+
27+
The following example deletes the `ecommerce_transform` {dataframe-transform}:
28+
29+
[source,js]
30+
--------------------------------------------------
31+
DELETE _data_frame/transforms/ecommerce_transform
32+
--------------------------------------------------
33+
// CONSOLE
34+
// TEST[skip:setup kibana sample data]
35+
36+
When the {dataframe-transform} is deleted, you receive the following results:
37+
[source,js]
38+
----
39+
{
40+
"acknowledged" : true
41+
}
42+
----
43+
// TESTRESPONSE

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,17 @@
77
[[data-frame-transform-apis]]
88
=== {dataframe-transforms-cap}
99

10+
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
11+
* <<put-data-frame-transform,Create {dataframe-transforms}>>,
12+
<<delete-data-frame-transform,delete {dataframe-transforms}>>
13+
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
1014
* <<get-data-frame-transform,Get {dataframe-transform} info>>,
1115
<<get-data-frame-transform-stats,Get {dataframe-transform} statistics>>
12-
* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
1316

17+
//CREATE
18+
include::put-transform.asciidoc[]
19+
//DELETE
20+
include::delete-transform.asciidoc[]
1421
//GET
1522
include::get-transform.asciidoc[]
1623
include::get-transform-stats.asciidoc[]
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
[role="xpack"]
2+
[testenv="basic"]
3+
[[put-data-frame-transform]]
4+
=== Create {dataframe-transforms} API
5+
++++
6+
<titleabbrev>Create {dataframe-transforms}</titleabbrev>
7+
++++
8+
9+
Instantiates a {dataframe-transform}.
10+
11+
12+
==== Request
13+
14+
`PUT _data_frame/transforms/<data_frame_transform_id>`
15+
16+
//===== Description
17+
18+
==== Path Parameters
19+
20+
`data_frame_transform_id` (required)::
21+
(string) Identifier for the {dataframe-transform}. This identifier can contain
22+
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
23+
must start and end with alphanumeric characters.
24+
25+
26+
==== Request Body
27+
28+
`source`:: The source index or index pattern.
29+
30+
`dest`:: The destination index.
31+
32+
`pivot`:: Defines the pivot function `group by` fields and the aggregation to
33+
reduce the data.
34+
35+
36+
//==== Authorization
37+
38+
==== Examples
39+
40+
The following example creates a {dataframe-transform} for the {kib} eCommerce
41+
sample data:
42+
43+
[source,js]
44+
--------------------------------------------------
45+
PUT _data_frame/transforms/ecommerce_transform
46+
{
47+
"source": "kibana_sample_data_ecommerce",
48+
"dest": "kibana_sample_data_ecommerce_transform",
49+
"pivot": {
50+
"group_by": {
51+
"customer_id": {
52+
"terms": {
53+
"field": "customer_id"
54+
}
55+
}
56+
},
57+
"aggregations": {
58+
"max_price": {
59+
"max": {
60+
"field": "taxful_total_price"
61+
}
62+
}
63+
}
64+
}
65+
}
66+
--------------------------------------------------
67+
// CONSOLE
68+
// TEST[skip:add sample kibana data]
69+
70+
When the transform is created, you receive the following results:
71+
[source,js]
72+
----
73+
{
74+
"acknowledged" : true
75+
}
76+
----
77+
// NOTCONSOLE

x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"data_frame.delete_data_frame_transform": {
3-
"documentation": "TODO",
3+
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html",
44
"methods": [ "DELETE" ],
55
"url": {
66
"path": "/_data_frame/transforms/{transform_id}",

x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"data_frame.put_data_frame_transform": {
3-
"documentation": "TODO",
3+
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html",
44
"methods": [ "PUT" ],
55
"url": {
66
"path": "/_data_frame/transforms/{transform_id}",

0 commit comments

Comments
 (0)