diff --git a/docs/reference/data-frames/apis/delete-transform.asciidoc b/docs/reference/data-frames/apis/delete-transform.asciidoc new file mode 100644 index 00000000000..327f55d4bc3 --- /dev/null +++ b/docs/reference/data-frames/apis/delete-transform.asciidoc @@ -0,0 +1,43 @@ +[role="xpack"] +[testenv="basic"] +[[delete-data-frame-transform]] +=== Delete {dataframe-transforms} API +++++ +Delete {dataframe-transforms} +++++ + +Deletes an existing {dataframe-transform}. + + +==== Request + +`DELETE _data_frame/transforms/` + +//==== Description + +==== Path Parameters + +`data_frame_transform_id` (required):: + (string) Identifier for the {dataframe-transform}. + +//===== Authorization + +==== Examples + +The following example deletes the `ecommerce_transform` {dataframe-transform}: + +[source,js] +-------------------------------------------------- +DELETE _data_frame/transforms/ecommerce_transform +-------------------------------------------------- +// CONSOLE +// TEST[skip:setup kibana sample data] + +When the {dataframe-transform} is deleted, you receive the following results: +[source,js] +---- +{ + "acknowledged" : true +} +---- +// TESTRESPONSE diff --git a/docs/reference/data-frames/apis/index.asciidoc b/docs/reference/data-frames/apis/index.asciidoc index 428c696a38c..ff09b75c6d4 100644 --- a/docs/reference/data-frames/apis/index.asciidoc +++ b/docs/reference/data-frames/apis/index.asciidoc @@ -7,10 +7,17 @@ [[data-frame-transform-apis]] === {dataframe-transforms-cap} +* <> +* <>, +<> +* <> * <>, <> -* <> +//CREATE +include::put-transform.asciidoc[] +//DELETE +include::delete-transform.asciidoc[] //GET include::get-transform.asciidoc[] include::get-transform-stats.asciidoc[] diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc new file mode 100644 index 00000000000..68d7b4b0492 --- /dev/null +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -0,0 +1,77 @@ +[role="xpack"] +[testenv="basic"] +[[put-data-frame-transform]] +=== Create {dataframe-transforms} API +++++ +Create {dataframe-transforms} +++++ + +Instantiates a {dataframe-transform}. + + +==== Request + +`PUT _data_frame/transforms/` + +//===== Description + +==== Path Parameters + +`data_frame_transform_id` (required):: + (string) Identifier for the {dataframe-transform}. This identifier can contain + lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It + must start and end with alphanumeric characters. + + +==== Request Body + +`source`:: The source index or index pattern. + +`dest`:: The destination index. + +`pivot`:: Defines the pivot function `group by` fields and the aggregation to +reduce the data. + + +//==== Authorization + +==== Examples + +The following example creates a {dataframe-transform} for the {kib} eCommerce +sample data: + +[source,js] +-------------------------------------------------- +PUT _data_frame/transforms/ecommerce_transform +{ + "source": "kibana_sample_data_ecommerce", + "dest": "kibana_sample_data_ecommerce_transform", + "pivot": { + "group_by": { + "customer_id": { + "terms": { + "field": "customer_id" + } + } + }, + "aggregations": { + "max_price": { + "max": { + "field": "taxful_total_price" + } + } + } + } +} +-------------------------------------------------- +// CONSOLE +// TEST[skip:add sample kibana data] + +When the transform is created, you receive the following results: +[source,js] +---- +{ + "acknowledged" : true +} +---- +// NOTCONSOLE \ No newline at end of file diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json index 78332c1d30f..14478f72c9a 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.delete_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.delete_data_frame_transform": { - "documentation": "TODO", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html", "methods": [ "DELETE" ], "url": { "path": "/_data_frame/transforms/{transform_id}", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json index 8f424bb445e..cef6de3a2b6 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/data_frame.put_data_frame_transform.json @@ -1,6 +1,6 @@ { "data_frame.put_data_frame_transform": { - "documentation": "TODO", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html", "methods": [ "PUT" ], "url": { "path": "/_data_frame/transforms/{transform_id}",