From 556c71f39e871386c9c20ae59eab3f454ac017eb Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 25 Oct 2021 15:49:21 -0700 Subject: [PATCH] [DOCS] Adds deprecation details for max_page_search_size (#79664) --- docs/reference/migration/migrate_7_8.asciidoc | 15 +++++++++++++++ .../transform/apis/preview-transform.asciidoc | 4 ++++ .../transform/apis/put-transform.asciidoc | 3 +++ .../core/transform/TransformDeprecations.java | 5 +---- .../transform/transforms/pivot/PivotConfig.java | 2 +- .../transforms/TransformConfigTests.java | 6 +++--- 6 files changed, 27 insertions(+), 8 deletions(-) diff --git a/docs/reference/migration/migrate_7_8.asciidoc b/docs/reference/migration/migrate_7_8.asciidoc index d38852b327a1..bc8cf472c0f9 100644 --- a/docs/reference/migration/migrate_7_8.asciidoc +++ b/docs/reference/migration/migrate_7_8.asciidoc @@ -211,4 +211,19 @@ Assign users with the `kibana_user` role to the `kibana_admin` role. Discontinue use of the `kibana_user` role. ==== +[discrete] +[[breaking_78_transform_changes]] +=== Transforms changes + +.The `max_page_search_size` property is deprecated in the `pivot` {transform} configuration object +[%collapsible] +==== +*Details* + +The `max_page_search_size` property within `pivot` is deprecated in the +<> and <> +APIs. + +*Impact* + +Use the `max_page_search_size` property within `settings` instead. +==== //end::notable-breaking-changes[] diff --git a/docs/reference/transform/apis/preview-transform.asciidoc b/docs/reference/transform/apis/preview-transform.asciidoc index bcf0b4f3484a..9c0e09aab1be 100644 --- a/docs/reference/transform/apis/preview-transform.asciidoc +++ b/docs/reference/transform/apis/preview-transform.asciidoc @@ -130,6 +130,10 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs] `group_by`::: (Required, object) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by] + +`max_page_search_size`::: +(Optional, integer) +deprecated:[7.8.0,Moved to `settings`.] ==== //End pivot diff --git a/docs/reference/transform/apis/put-transform.asciidoc b/docs/reference/transform/apis/put-transform.asciidoc index 3b69cc1996d5..59c4930889c9 100644 --- a/docs/reference/transform/apis/put-transform.asciidoc +++ b/docs/reference/transform/apis/put-transform.asciidoc @@ -149,6 +149,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-aggs] (Required, object) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pivot-group-by] +`max_page_search_size`::: +(Optional, integer) +deprecated:[7.8.0,Moved to `settings`.] ==== //End pivot diff --git a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformDeprecations.java b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformDeprecations.java index bfc265fac956..2b0ac1cf6167 100644 --- a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformDeprecations.java +++ b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/TransformDeprecations.java @@ -11,10 +11,6 @@ public class TransformDeprecations { public static final String UPGRADE_TRANSFORM_URL = "https://ela.st/es-7-upgrade-transforms"; - // breaking changes base url for the _next_ major release - public static final String BREAKING_CHANGES_BASE_URL = - "https://www.elastic.co/guide/en/elasticsearch/reference/master/migrating-8.0.html"; - public static final String QUERY_BREAKING_CHANGES_URL = "https://ela.st/es-deprecation-8-transform-query-options"; public static final String AGGS_BREAKING_CHANGES_URL = "https://ela.st/es-deprecation-8-transform-aggregation-options"; @@ -24,5 +20,6 @@ public class TransformDeprecations { public static final String ACTION_MAX_PAGE_SEARCH_SIZE_IS_DEPRECATED = "[max_page_search_size] is deprecated inside pivot. Use settings instead."; + public static final String MAX_PAGE_SEARCH_SIZE_BREAKING_CHANGES_URL = "https://ela.st/es-deprecation-7-transform-max-page-search-size"; private TransformDeprecations() {} } diff --git a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/pivot/PivotConfig.java b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/pivot/PivotConfig.java index 1851b265ec33..d4626d880692 100644 --- a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/pivot/PivotConfig.java +++ b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/transform/transforms/pivot/PivotConfig.java @@ -186,7 +186,7 @@ public class PivotConfig implements Writeable, ToXContentObject { new DeprecationIssue( Level.WARNING, "Transform [" + id + "] uses deprecated max_page_search_size", - TransformDeprecations.BREAKING_CHANGES_BASE_URL, + TransformDeprecations.MAX_PAGE_SEARCH_SIZE_BREAKING_CHANGES_URL, TransformDeprecations.ACTION_MAX_PAGE_SEARCH_SIZE_IS_DEPRECATED, false, null diff --git a/x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/transform/transforms/TransformConfigTests.java b/x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/transform/transforms/TransformConfigTests.java index b62cf0b2b5cc..e4443be671d8 100644 --- a/x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/transform/transforms/TransformConfigTests.java +++ b/x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/transform/transforms/TransformConfigTests.java @@ -750,7 +750,7 @@ public class TransformConfigTests extends AbstractSerializingTransformTestCase