Skip to content

Commit 4e18993

Browse files
authored
[DOCS] Add authorization info to get and update transform APIs (#87994)
1 parent fc93f77 commit 4e18993

File tree

2 files changed

+66
-42
lines changed

2 files changed

+66
-42
lines changed

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

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
[role="xpack"]
21
[[get-transform]]
32
= Get {transforms} API
43

@@ -98,11 +97,11 @@ GET _transform?size=10
9897
// TEST[skip:setup kibana sample data]
9998

10099
The following example gets configuration information for the
101-
`ecommerce_transform` {transform}:
100+
`ecommerce_transform1` {transform}:
102101

103102
[source,console]
104103
--------------------------------------------------
105-
GET _transform/ecommerce_transform
104+
GET _transform/ecommerce_transform1
106105
--------------------------------------------------
107106
// TEST[skip:setup kibana sample data]
108107

@@ -114,7 +113,14 @@ The API returns the following results:
114113
"count" : 1,
115114
"transforms" : [
116115
{
117-
"id" : "ecommerce_transform",
116+
"id" : "ecommerce_transform1",
117+
"authorization" : {
118+
"roles" : [
119+
"superuser"
120+
]
121+
},
122+
"version" : "8.4.0",
123+
"create_time" : 1656023416565,
118124
"source" : {
119125
"index" : [
120126
"kibana_sample_data_ecommerce"
@@ -128,9 +134,16 @@ The API returns the following results:
128134
}
129135
},
130136
"dest" : {
131-
"index" : "kibana_sample_data_ecommerce_transform"
137+
"index" : "kibana_sample_data_ecommerce_transform1",
138+
"pipeline" : "add_timestamp_pipeline"
139+
},
140+
"frequency" : "5m",
141+
"sync" : {
142+
"time" : {
143+
"field" : "order_date",
144+
"delay" : "60s"
145+
}
132146
},
133-
"frequency": "1m",
134147
"pivot" : {
135148
"group_by" : {
136149
"customer_id" : {
@@ -149,10 +162,13 @@ The API returns the following results:
149162
},
150163
"description" : "Maximum priced ecommerce data by customer_id in Asia",
151164
"settings" : { },
152-
"version" : "7.5.0",
153-
"create_time" : 1576094542936
165+
"retention_policy" : {
166+
"time" : {
167+
"field" : "order_date",
168+
"max_age" : "30d"
169+
}
170+
}
154171
}
155172
]
156173
}
157-
158174
----

docs/reference/transform/apis/update-transform.asciidoc

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -265,49 +265,57 @@ When the {transform} is updated, you receive the updated configuration:
265265
[source,console-result]
266266
----
267267
{
268-
"id": "simple-kibana-ecomm-pivot",
269-
"source": {
270-
"index": ["kibana_sample_data_ecommerce"],
271-
"query": {
272-
"term": {
273-
"geoip.continent_name": {
274-
"value": "Asia"
268+
"id" : "simple-kibana-ecomm-pivot",
269+
"authorization" : {
270+
"roles" : [
271+
"superuser"
272+
]
273+
},
274+
"version" : "8.4.0",
275+
"create_time" : 1656113450613,
276+
"source" : {
277+
"index" : [
278+
"kibana_sample_data_ecommerce"
279+
],
280+
"query" : {
281+
"term" : {
282+
"geoip.continent_name" : {
283+
"value" : "Asia"
275284
}
276285
}
277286
}
278287
},
279-
"pivot": {
280-
"group_by": {
281-
"customer_id": {
282-
"terms": {
283-
"field": "customer_id"
288+
"dest" : {
289+
"index" : "kibana_sample_data_ecommerce_transform_v2",
290+
"pipeline" : "add_timestamp_pipeline"
291+
},
292+
"frequency" : "15m",
293+
"sync" : {
294+
"time" : {
295+
"field" : "order_date",
296+
"delay" : "120s"
297+
}
298+
},
299+
"pivot" : {
300+
"group_by" : {
301+
"customer_id" : {
302+
"terms" : {
303+
"field" : "customer_id"
284304
}
285305
}
286306
},
287-
"aggregations": {
288-
"max_price": {
289-
"max": {
290-
"field": "taxful_total_price"
307+
"aggregations" : {
308+
"max_price" : {
309+
"max" : {
310+
"field" : "taxful_total_price"
291311
}
292312
}
293313
}
294314
},
295-
"description": "Maximum priced ecommerce data by customer_id in Asia",
296-
"dest": {
297-
"index": "kibana_sample_data_ecommerce_transform_v2",
298-
"pipeline": "add_timestamp_pipeline"
299-
},
300-
"frequency": "15m",
301-
"sync": {
302-
"time": {
303-
"field": "order_date",
304-
"delay": "120s"
305-
}
306-
},
307-
"settings": { },
308-
"version": "7.5.0",
309-
"create_time": 1518808660505
315+
"description" : "Maximum priced ecommerce data by customer_id in Asia",
316+
"settings" : { }
310317
}
311318
----
312-
// TESTRESPONSE[s/"version": "7.5.0"/"version": $body.version/]
313-
// TESTRESPONSE[s/"create_time": 1518808660505/"create_time": $body.create_time/]
319+
// TESTRESPONSE[s/"version" : "8.4.0"/"version" : $body.version/]
320+
// TESTRESPONSE[s/"create_time" : 1656113450613/"create_time" : $body.create_time/]
321+
// TESTRESPONSE[s/"authorization" : \{[^}]*\},//]

0 commit comments

Comments
 (0)