Skip to content

Commit 2518e1f

Browse files
lcawllcawl
authored
Add examples for transform APIs (#2505)
1 parent a564338 commit 2518e1f

File tree

15 files changed

+579
-0
lines changed

15 files changed

+579
-0
lines changed

‎specification/transform/delete_transform/examples/200_response/DeleteTransformResponseExample1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"summary": "A successful response when the transform is deleted.",
3+
"value": {
4+
"acknowledged": true
5+
}
6+
}

‎specification/transform/get_transform/examples/200_response/GetTransformResponseExample1.json

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"summary": "A successful response that contains configuration information for a transform.",
3+
"value": {
4+
"count": 1,
5+
"transforms": [
6+
{
7+
"id": "ecommerce_transform1",
8+
"authorization": {
9+
"roles": ["superuser"]
10+
},
11+
"version": "8.4.0",
12+
"create_time": 1656023416565,
13+
"source": {
14+
"index": ["kibana_sample_data_ecommerce"],
15+
"query": {
16+
"term": {
17+
"geoip.continent_name": {
18+
"value": "Asia"
19+
}
20+
}
21+
}
22+
},
23+
"dest": {
24+
"index": "kibana_sample_data_ecommerce_transform1",
25+
"pipeline": "add_timestamp_pipeline"
26+
},
27+
"frequency": "5m",
28+
"sync": {
29+
"time": {
30+
"field": "order_date",
31+
"delay": "60s"
32+
}
33+
},
34+
"pivot": {
35+
"group_by": {
36+
"customer_id": {
37+
"terms": {
38+
"field": "customer_id"
39+
}
40+
}
41+
},
42+
"aggregations": {
43+
"max_price": {
44+
"max": {
45+
"field": "taxful_total_price"
46+
}
47+
}
48+
}
49+
},
50+
"description": "Maximum priced ecommerce data by customer_id in Asia",
51+
"settings": {},
52+
"retention_policy": {
53+
"time": {
54+
"field": "order_date",
55+
"max_age": "30d"
56+
}
57+
}
58+
}
59+
]
60+
}
61+
}

‎specification/transform/get_transform_stats/examples/200_response/GetTransformStatsResponseExample1.json

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"summary": "A successful response that contains usage information for a transform.",
3+
"value": {
4+
"count": 1,
5+
"transforms": [
6+
{
7+
"id": "ecommerce-customer-transform",
8+
"state": "started",
9+
"node": {
10+
"id": "cpTIGMsVQ8Gqwqlxxxxxxx",
11+
"name": "my.home",
12+
"ephemeral_id": "5-L21nFsQxxxxxxxxxx-xx",
13+
"transport_address": "127.0.0.1:9300",
14+
"attributes": {}
15+
},
16+
"stats": {
17+
"pages_processed": 78,
18+
"documents_processed": 6027,
19+
"documents_indexed": 68,
20+
"documents_deleted": 22,
21+
"delete_time_in_ms": 214,
22+
"trigger_count": 168,
23+
"index_time_in_ms": 412,
24+
"index_total": 20,
25+
"index_failures": 0,
26+
"search_time_in_ms": 353,
27+
"search_total": 78,
28+
"search_failures": 0,
29+
"processing_time_in_ms": 8,
30+
"processing_total": 78,
31+
"exponential_avg_checkpoint_duration_ms": 97.30637923893185,
32+
"exponential_avg_documents_indexed": 2.2064915040974062,
33+
"exponential_avg_documents_processed": 179.89419945785045
34+
},
35+
"checkpointing": {
36+
"last": {
37+
"checkpoint": 20,
38+
"timestamp_millis": 1585344558220,
39+
"time_upper_bound_millis": 1585344498220
40+
},
41+
"changes_last_detected_at": 1585344558219
42+
},
43+
"health": {
44+
"status": "green"
45+
}
46+
}
47+
]
48+
}
49+
}

‎specification/transform/preview_transform/examples/200_response/PreviewTransformResponseExample1.json

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
{
2+
"summary": "A successful response contains a preview a transform that uses the pivot method.",
3+
"value": {
4+
"preview": [
5+
{
6+
"max_price": 171,
7+
"customer_id": "10"
8+
},
9+
{
10+
"max_price": 233,
11+
"customer_id": "11"
12+
},
13+
{
14+
"max_price": 200,
15+
"customer_id": "12"
16+
},
17+
{
18+
"max_price": 301,
19+
"customer_id": "13"
20+
},
21+
{
22+
"max_price": 176,
23+
"customer_id": "14"
24+
},
25+
{
26+
"max_price": 2250,
27+
"customer_id": "15"
28+
},
29+
{
30+
"max_price": 170,
31+
"customer_id": "16"
32+
},
33+
{
34+
"max_price": 243,
35+
"customer_id": "17"
36+
},
37+
{
38+
"max_price": 154,
39+
"customer_id": "18"
40+
},
41+
{
42+
"max_price": 393,
43+
"customer_id": "19"
44+
},
45+
{
46+
"max_price": 165,
47+
"customer_id": "20"
48+
},
49+
{
50+
"max_price": 115,
51+
"customer_id": "21"
52+
},
53+
{
54+
"max_price": 192,
55+
"customer_id": "22"
56+
},
57+
{
58+
"max_price": 169,
59+
"customer_id": "23"
60+
},
61+
{
62+
"max_price": 230,
63+
"customer_id": "24"
64+
},
65+
{
66+
"max_price": 278,
67+
"customer_id": "25"
68+
},
69+
{
70+
"max_price": 200,
71+
"customer_id": "26"
72+
},
73+
{
74+
"max_price": 344,
75+
"customer_id": "27"
76+
},
77+
{
78+
"max_price": 175,
79+
"customer_id": "28"
80+
},
81+
{
82+
"max_price": 177,
83+
"customer_id": "29"
84+
},
85+
{
86+
"max_price": 190,
87+
"customer_id": "30"
88+
},
89+
{
90+
"max_price": 190,
91+
"customer_id": "31"
92+
},
93+
{
94+
"max_price": 205,
95+
"customer_id": "32"
96+
},
97+
{
98+
"max_price": 215,
99+
"customer_id": "33"
100+
},
101+
{
102+
"max_price": 270,
103+
"customer_id": "34"
104+
},
105+
{
106+
"max_price": 184,
107+
"customer_id": "36"
108+
},
109+
{
110+
"max_price": 222,
111+
"customer_id": "37"
112+
},
113+
{
114+
"max_price": 370,
115+
"customer_id": "38"
116+
},
117+
{
118+
"max_price": 240,
119+
"customer_id": "39"
120+
},
121+
{
122+
"max_price": 230,
123+
"customer_id": "4"
124+
},
125+
{
126+
"max_price": 229,
127+
"customer_id": "41"
128+
},
129+
{
130+
"max_price": 190,
131+
"customer_id": "42"
132+
},
133+
{
134+
"max_price": 150,
135+
"customer_id": "43"
136+
},
137+
{
138+
"max_price": 175,
139+
"customer_id": "44"
140+
},
141+
{
142+
"max_price": 190,
143+
"customer_id": "45"
144+
},
145+
{
146+
"max_price": 150,
147+
"customer_id": "46"
148+
},
149+
{
150+
"max_price": 310,
151+
"customer_id": "48"
152+
},
153+
{
154+
"max_price": 223,
155+
"customer_id": "49"
156+
},
157+
{
158+
"max_price": 283,
159+
"customer_id": "5"
160+
},
161+
{
162+
"max_price": 185,
163+
"customer_id": "50"
164+
},
165+
{
166+
"max_price": 190,
167+
"customer_id": "51"
168+
},
169+
{
170+
"max_price": 333,
171+
"customer_id": "52"
172+
},
173+
{
174+
"max_price": 165,
175+
"customer_id": "6"
176+
},
177+
{
178+
"max_price": 144,
179+
"customer_id": "7"
180+
},
181+
{
182+
"max_price": 198,
183+
"customer_id": "8"
184+
},
185+
{
186+
"max_price": 210,
187+
"customer_id": "9"
188+
}
189+
],
190+
"generated_dest_index": {
191+
"mappings": {
192+
"_meta": {
193+
"_transform": {
194+
"transform": "transform-preview",
195+
"version": {
196+
"created": "10.0.0"
197+
},
198+
"creation_date_in_millis": 1712948905889
199+
},
200+
"created_by": "transform"
201+
},
202+
"properties": {
203+
"max_price": {
204+
"type": "half_float"
205+
},
206+
"customer_id": {
207+
"type": "keyword"
208+
}
209+
}
210+
},
211+
"settings": {
212+
"index": {
213+
"number_of_shards": "1",
214+
"auto_expand_replicas": "0-1"
215+
}
216+
},
217+
"aliases": {}
218+
}
219+
}
220+
}

‎specification/transform/preview_transform/examples/request/PreviewTransformRequestExample1.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"summary": "A request to preview a transform that uses the pivot method.",
3+
"value": {
4+
"source": {
5+
"index": "kibana_sample_data_ecommerce"
6+
},
7+
"pivot": {
8+
"group_by": {
9+
"customer_id": {
10+
"terms": {
11+
"field": "customer_id",
12+
"missing_bucket": true
13+
}
14+
}
15+
},
16+
"aggregations": {
17+
"max_price": {
18+
"max": {
19+
"field": "taxful_total_price"
20+
}
21+
}
22+
}
23+
}
24+
}
25+
}

‎specification/transform/put_transform/examples/200_response/PutTransformResponseExample1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"summary": "A successful response when creating a transform.",
3+
"value": {
4+
"acknowledged": true
5+
}
6+
}

0 commit comments

Comments
 (0)