Skip to content

Commit

Permalink
[7.11][DOCS] Adds deprecation details for max_page_search_size (#79769)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Oct 26, 2021
1 parent 7819ef3 commit c5c8c6d
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/reference/migration/migrate_7_8.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ See also <<release-highlights>> and <<es-release-notes>>.
* <<breaking_78_aggregation_changes>>
* <<breaking_78_mappings_changes>>
* <<breaking_78_settings_changes>>
* <<breaking_78_transform_changes>>

//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide
Expand Down Expand Up @@ -211,4 +212,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
<<put-transform,create {transform}>> and <<preview-transform,preview {transform}>>
APIs.
*Impact* +
Use the `max_page_search_size` property within `settings` instead.
====
//end::notable-breaking-changes[]
4 changes: 4 additions & 0 deletions docs/reference/transform/apis/preview-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,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

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/transform/apis/put-transform.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,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

Expand Down

0 comments on commit c5c8c6d

Please sign in to comment.